README.md

\page install_readme Installation

Install

This document provides an overview of the project and instructions on how to build and use it.

Table of Contents

• Install
  • Table of Contents
  • Project Overview
  • Building the Project
    • Dependencies
    • Building on Windows
      • Installing CMake on Windows
    • Building on Unix-like Systems
  • Running the Project
    • Server
    • Client
    • Game Engine GUI

Project Overview

The project consists of a server and a client component. The server handles some functionality, and the client interacts with it.

There is also a game engine GUI that allows you to create and edit game objects and scenes.

Building the Project

Dependencies

The project relies on the following dependencies:

• Raylib 5.0
• Boost
• CMake (for building the project)

Building on Windows

Installing CMake on Windows

Before building the project, you need to install CMake. Follow the CMake Installation Guide for Windows to install CMake on your Windows machine.

After installing CMake, you can proceed with building the project.

1. Install Visual Studio.
2. Open a command prompt and navigate to the project root directory.
3. Run the following commands:

   git submodule init
   git pull --recurse-submodules
   .\vcpkg\bootstrap-vcpkg.bat
   .\vcpkg\vcpkg integrate install
   cmake -B build
   cmake --build build

Building on Unix-like Systems

1. Install CMake and a C++ compiler (e.g., g++).
2. Open a terminal and navigate to the project root directory.
3. Run the following commands:

   git submodule init
   git pull --recurse-submodules
   cmake -B build
   cmake --build build

Running the Project

Server

1. After building, navigate to the build directory.
2. Run the server executable at root:

   ./build/server

Note

On Windows change '/' to '' and add '.exe' to the end of the executable name.

Client

1. After building, navigate to the build directory.
2. Run the client executable at root:

   ./build/client

Note

On Windows change '/' to '' and add '.exe' to the end of the executable name.

Game Engine GUI

1. After building, navigate to the build directory.
2. Run the client executable at root:

   ./build/game_engine

Note

On Windows change '/' to '' and add '.exe' to the end of the executable name.