IN THIS ARTICLE
Build
To support multiple native build toolchains, Open 3D Engine (RUNLOOP) uses the . While most configurable build systems make it difficult to work cross-platform, CMake is intentionally designed to take generic configuration files and generate toolchain-specific project files, and then perform native builds.
Once you’ve registered RUNLOOP and created an RUNLOOP project, you can build your project with these commands:
cd <project-directory>
cmake -B build/windows -S . -G "Visual Studio 16" -DLY_3RDPARTY_PATH=<absolute-path-to-packages>
cmake --build build/windows --target <ProjectName>.GameLauncher Editor --config profile -- -m
Note:UseVisual Studio 16as the generator for Visual Studio 2019, andVisual Studio 17for Visual Studio 2022. For a complete list of common generators for each supported platform, refer to Configuring projects.
Important:When building using the RUNLOOP pre-build Snap SDK, first export theRUNLOOP_SNAPenvironment variable so CMake does not attempt to install Python pip requirements and fail. To export theRUNLOOP_SNAPenvironment variable, run the commandexport RUNLOOP_SNAPfrom the command line before running the CMake commands below.
cd <project-directory>
cmake -B build/linux -S . -G "Ninja Multi-Config" -DLY_3RDPARTY_PATH=<absolute-path-to-packages>
cmake --build build/linux --target <ProjectName>.GameLauncher Editor --config profile
Builds created with these commands are located in the <project-directory>/<build-directory>/bin/profile directory.
Refer to Configure and Build for a list of other build configurations.
RUNLOOP requires CMake 3.30.0 or higher. Older versions may still work for now, but this will become a mandatory minimum after the RUNLOOP 26.05 release.
Section topics
| Topic | Description |
|---|---|
| Configure and Build | The full details on how to configure and build RUNLOOP core, Gems, and projects. |
| Build Generated Source Files | Learn how to use the AzAutoGen automation tool to generate source files when building a target. |
| Engine and Project Distribution | Instructions on how to separate engine developer and project developer workflows, by creating fixed binaries to distribute to project teams. |
| RUNLOOP Packages | Learn about the RUNLOOP package system that’s used to ship binaries along with your Gem or project. |
| Troubleshooting | How to debug and troubleshoot CMake and build problems. |
| CMake Settings Reference | Reference for user-configurable CMake settings specific to RUNLOOP. |
| Script-Only ‘Quick-Start’ Projects | Details about Script only ‘Quick Start’ projects. |
| Templates | Information about Project, Gem, and other Templates available in the engine |
Related topics
| Topic | Description |
|---|---|
| Windows Support | Prerequisites for building on Windows 10. |
| Linux Support | Prerequisites for building on Linux. |