Home

Awesome

How to Build: Environment

Requirements for building and using the Dagor Engine toolkit: Windows 10 (x64), 16 GB of RAM, 200 GB of HDD/SSD space.

Create a project folder at the root of any drive (the folder name should not contain spaces or non-Latin characters).

md X:\develop && cd X:\develop

Clone the Dagor Engine source code and samples:

git clone https://github.com/GaijinEntertainment/DagorEngine.git
cd DagorEngine

Run the make_devtools.py script. This script will download, install, and configure the build toolkit. You should provide the path to the build toolkit folder as an argument, and the script will create this folder if it doesn't exist.

python3 make_devtools.py X:\develop\devtools

If the script is not run as an administrator, installers of certain programs may request permission for installation, which you should grant. If you plan to use plugins for 3ds Max, press 'Y' when the script asks if you want to install the 3ds Max SDK. The script will also ask to add the path X:\develop\devtools to the PATH environment variable and set the GDEVTOOL variable to point to this folder.

After the script completes its work, the X:\develop\devtools folder will be configured with the following SDKs and tools:

Restart the command line console to make the new environment variables available.

How to Build: Prebuilt Binaries

You will need to download and extract additional binary files from the repository https://github.com/GaijinEntertainment/DagorEngine/releases into the X:\develop\DagorEngine folder:

The directory structure should look like this:

X:\develop\DagorEngine\tools\...

X:\develop\DagorEngine\samples\skiesSample\game
                              \skiesSample\develop
                              \skiesSample\prog

X:\develop\DagorEngine\samples\testGI\game
                              \testGI\develop
                              \testGI\prog

How to Build: Build from Source Code

Run build_all.py in DagorEngine root.

This builds the entire project toolkit from the source code. This process may take a considerable amount of time. After tools are built and ready to be used script builds game and UI resources using daBuild and other utilities.

You can use direct build commands instead of using Python script.<br> For example we will build "skiesSample" sample:<br>

You can also build everything for Outer Space sample game project or daNetGame-based Scene Viewer with their own scripts:<br>

Just be aware that these scripts use DagorEngine tools so they must be built beforehand or downloaded as prebuilt archive as described earlier.

build*.py script may accept optional parameters to limit components to be built: code, shaders, assets, vromfs, gui. If no parameters passed script builds all components.

build*.py script may accept optional parameters to force target architecture to be built, e.g. arch:x86_64, arch:arm64, arch:x86. If none is specified code is built to default architecture (depends on host OS and jamfile settings). Not all code applies target architecture now (only Outer Space and daNetGame-based Scene Viewer).

build_all.py script in addition to components accepts optional list of projects to be built: project:dagorTools, project:physTest, project:skiesSample, project:testGI, project:outerSpace, project:dngSceneViewer. If none is passed script builds all projects.

Example: build_all.py project:dngSceneViewer code shaders will build only code and shaders for daNetGame-based Scene Viewer project.

Basic dagor samples

Documentation

Automatically generated Dagor Documentation contains general architecture description, API reference, tutorials and manuals.<br> It is not complete yet and will be extended.

Open-source roadmap

We are going to open-source more parts of our Engine and tools. These are general and broad plans for next year, can be changed.

Documentation