Installation¶
There are two ways to get Doriax Engine: download a prebuilt editor, or build it from source.
Download a prebuilt editor¶
The fastest way to start is to grab a prebuilt build of the editor from the official website:
Builds are available for:
| Platform | Requirements |
|---|---|
| Windows | Windows 10+ · x64 |
| Linux | Ubuntu 22.04+ · x64 |
| macOS | macOS 12+ · Universal |
Each platform offers the latest release, and beside it a build of the current main
branch.
Main branch builds
The main builds are made from the newest commit and are not stable releases.
Expect bugs, incomplete features, and breaking changes. Use them at your own risk.
The Windows download contains two executables: run doriax-editor.exe to open the
editor, and use doriax-editor-cmd.exe for scripting and CI. See
Command-Line Tools.
The Linux download is an AppImage: a single file to run directly, with nothing to install. From the release page it arrives without its executable bit, since no permission survives an HTTP download, so mark it executable once:
The main-branch build is a zip instead, which does carry the bit — unzip it and run. The release also offers the same build as a plain zip of loose binaries.
Adding Doriax to your application menu
An AppImage is a single self-contained file, so nothing registers it with your desktop
on its own — which is why it has no menu entry or icon until you integrate it. Tools
such as Gear Lever or appimaged read the
desktop entry and icons bundled inside the AppImage and register them for you.
The macOS download is a disk image holding Doriax.app. Open the .dmg and drag the app
onto the Applications shortcut inside it.
macOS blocks the first launch
Doriax is signed, but not notarized by Apple — notarization requires a paid Apple Developer membership. macOS therefore reports that it cannot verify the app the first time you open it.
To allow it, open System Settings → Privacy & Security, scroll to the security section near the bottom, and click Open Anyway. You only do this once per version.
Before macOS Sequoia you could Control-click the app and choose Open instead. That shortcut was removed.
Downloading from a terminal skips the prompt altogether, because the quarantine flag is set by the browser rather than by macOS:
Build from source¶
Doriax is built with CMake. The root project builds the desktop editor target
doriax-editor.
Quick build¶
git clone https://github.com/doriaxengine/doriax.git
cd doriax
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
On single-config generators (Ninja, Makefiles) the executable is created under
build/. On multi-config generators such as Visual Studio, look under the
configuration subdirectory (for example build/Release/).
Tip
Each platform has additional dependencies and tooling. See Building from Source for detailed, per-platform instructions.
Repository layout¶
When working from source, it helps to know how the repository is organized:
| Directory | Contents |
|---|---|
editor/ |
Desktop editor, windows, tools, project generation, and export flow |
engine/ |
Runtime engine, platform layers, rendering, ECS, and project templates |
shadercompiler/ |
Shader compilation and translation tools |
libs/ |
Bundled third-party dependencies |
Next steps¶
Once you have the editor running, continue to Your First Project.