Prerequisites
Install the following tools before cloning the repository.- Git — with submodule support (
--recursiveclone) - CMake 3.31 or later — required by
CMakePresets.json - C++20 compiler:
- Windows: Visual Studio 2022 (MSVC)
- Linux: GCC 11+ or Clang 13+
- Android: NDK r25+
- Vulkan SDK 1.3+ — required for Vulkan builds on Linux and Windows
- Ninja — required for Linux and Android builds (Windows uses Visual Studio generator)
Clone the repository
Clone theprune branch with all submodules. The prune branch focuses on the SDL3 + Vulkan rendering path.
--recursive, initialize submodules manually:
One-command build
Thescripts/build.sh script auto-detects your platform and architecture, selects the appropriate CMake preset, and runs the full configure + build pipeline.
Build steps
1
Configure
Run the CMake configure step using a preset. Presets are defined in For example, to configure the editor for Linux x64 in debug mode:
CMakePresets.json and cover all combinations of target, platform, architecture, and build type.2
Build
Run the build step using the same preset name.Continuing the example above:Build output is placed in
build/<preset-name>/. For example, the Linux x64 debug editor outputs to build/editor-linux-x64-debug/.3
Run
After a successful build, run the resulting binary from the build output directory. The binary name matches the target you built (
Engine, Editor, or Runtime).Platform-specific commands
- Windows
- Linux
- Android
Windows builds use the Visual Studio 17 2022 generator. You can build from the command line using CMake presets or open the project directly in Visual Studio.
Available presets
The table below lists all non-hidden presets defined inCMakePresets.json.
Key CMake options
You can pass these options tocmake --preset via -D flags to override preset defaults.