Docs

Building for Windows

1. Install dependencies

  • CMake 3.20 or newer, added to PATH
  • Visual Studio 2022 with Desktop development with C++
  • GLFW 3.4 development package, or SDL2 if building with -DAPI_BACKEND=sdl
  • Python 3 for generated editor API suggestion files

2. Clone the repository

git clone https://github.com/doriaxengine/doriax.git
cd doriax

3. Configure and build

Using the Visual Studio generator:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -G "Visual Studio 17 2022"
cmake --build build --config Release --target doriax-editor

Visual Studio is a multi-config generator, so the resulting doriax-editor executable is placed under a configuration subdirectory such as build/Release/.

The Windows runtime defaults to Direct3D 11 for standalone projects. You can request OpenGL Core instead with -DGRAPHIC_BACKEND=glcore when configuring a runtime build.

Faster builds with Ninja

If you have Ninja installed you can use it instead of the Visual Studio generator:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -G "Ninja"
cmake --build build --config Release --target doriax-editor

With Ninja the executable is created directly under build/.

Runtime project build

For an exported or standalone runtime project, configure the engine directory and pass the project root if it is not the default engine/project folder:

cmake -S engine -B build-runtime -DPROJECT_ROOT="C:/path/to/project" -DCMAKE_BUILD_TYPE=Release
cmake --build build-runtime --config Release --target doriax-project

Use the generated executable from the selected configuration folder.