Build instructions

Operating Systems

Windows (10/11)

1. Install Visual Studio Community (Or any other IDE)

Download latest version from visualstudio.microsoft.com
Launch downloaded Visual Studio installer
Select "Desktop development with C++" before installation
Then click Install button to begin installation

2. Install Git

Download and install latest version from git-cms.com

You may use default Git install options or chose any other default Git editor instead of Vim.

3. Install CMake

Download latest release version of installer from cmake.org
Select "Add CMake to the system PATH for the current user" during installation

Ubuntu (22.04/24.04)

1. Install Visual Studio Code (Or any other IDE)

Download and install latest version from code.visualstudio.com
Install "C/C++" And "CMake Tools" extensions inside Visual Studio Code

2. Install required packages

Run sudo apt-get update command using Terminal app
And sudo apt-get install git cmake gcc g++

macOS (14/15)

1. Install Xcode (Or any other IDE)

Download and install latest version from App Store app
Run xcode-select --install command using Terminal app to install Xcode tools

2. Install required packages

Install Homebrew package manager from brew.sh
Run brew update command using Terminal app
And brew install git cmake

Build Project

To build the project run one of the scripts using Terminal, Git Bash or build it using IDE.

Visual Studio (2022)

Open Visual Studio 2022 IDE
Click "Open a local folder" and open the repository folder
Click Build -> Build All to build the project

Visual Studio Code (VS Code)

Open Visual Studio Code IDE
Install "C/C++" And "CMake Tools" extensions
Click File -> Open Folder... and open the repository folder
Click Yes in "Would you like to configure project..."
Select one of the compiler Kits in the opened window
Click Build button at the bottom bar to build the engine