Skip to content
AssiduousEngine

Installing

For now the engine is built from source. Prebuilt downloads of the editor and its tools come with the first release.

What you need

Section titled “What you need”

  • CMake 3.28 or newer, and Ninja.

  • A GPU that runs Vulkan 1.3, or Direct3D 12 on Windows, to run anything that draws.

  • On Linux (x64): Clang or GCC, the Vulkan development libraries, and SDL3’s build dependencies. On Ubuntu or Debian:

    Terminal window
    sudo apt install cmake ninja-build clang pkg-config \
        libvulkan-dev vulkan-tools vulkan-validationlayers mesa-vulkan-drivers \
        libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxss-dev \
        libxtst-dev libwayland-dev wayland-protocols libxkbcommon-dev libasound2-dev

  • On Windows (x64): Clang (LLVM) or MSVC, and the Windows SDK. Run the MSVC presets from a Developer Command Prompt (vcvars64), so the compiler and the SDK are on the path.

  • For web builds: the Emscripten SDK (emsdk 6.0.5). On Windows, emsdk needs a small patch to build the engine; the engine’s Documentation/Guides/emscripten-windows.md has it.

The engine is written in C++23 with modules, so it needs a recent compiler. It is built and tested with Clang 21 and GCC 15 on Linux.

Build

Section titled “Build”

Get the source, then configure and build through a CMake preset:

Terminal window
git clone https://github.com/jayrulez/GameEngine.git
cd GameEngine
cmake --preset clang          # once, to configure
cmake --build --preset clang  # build everything

The presets name a compiler and a configuration:

Preset What it builds
clang, gcc, msvc Debug, the development configuration
clang-reldbg, msvc-reldbg Optimized, with debug information
clang-release, gcc-release, msvc-release Release
clang-shipping, gcc-shipping, msvc-shipping Shipping: no asserts, stripped
wasm, wasm-shipping The web player (Emscripten)

A first build takes a while. If it runs out of memory, build with fewer jobs: cmake --build --preset clang -j4.

Everything a build makes lands in Bin/<configuration>/<platform>-<compiler>/, for example Bin/Debug/Linux64-Clang/.

Run the editor

Section titled “Run the editor”
Terminal window
Bin/Debug/Linux64-Clang/Tools.Editor                 # the project manager
Bin/Debug/Linux64-Clang/Tools.Editor path/to/project # open a project

On Windows the editor is Tools.Editor.exe, in Bin\Debug\Win64-MSVC\ (or Win64-Clang).

Next: your first project.