Building from Source
Learn how to build Atlas from its source code.
Building Atlas from source allows you to customize the engine, contribute to its development, or simply understand how it works under the hood. This guide will walk you through the steps required to build Atlas on your system.
Prerequisites
- Git with submodule support
- CMake (version 3.21 or higher)
- Ninja
- Clang with C++ 20 support
- Python 3
- Qt 6 with the Widgets component
- Rust and Cargo for the Atlas CLI bundled with the editor
- Internet access during configuration so CMake can download the required dependencies
Install Xcode command line tools, homebrew and tools
Firstly, make sure you have the Xcode command line tools installed. You can install them by running the following command in your terminal:
xcode-select --installAlso you will need Homebrew. Homebrew is a package manager for macOS that makes it easy to install and manage software packages. You can install Homebrew by following the instructions on the Homebrew website. To install the required tools, run the following command in your terminal:
bash brew install cmake ninja qt@6 python rust Using 'just'
You can use the just command to run the build commands. If you don't have
just installed, you can install it using Homebrew by running brew install just.
Clone the Atlas repository
Clone the Atlas repository from GitHub using the following command:
git clone --recurse-submodules https://github.com/neutralsoftware/atlas.gitConfigure and build the editor
To configure and build the Atlas editor, navigate to the cloned repository and run the following commands:
cmake -S . -B build -G Ninja -DBACKEND=AUTO -DCMAKE_PREFIX_PATH="$(brew --prefix qt@6)"
cmake --build build --parallelOr optionally, you can use the just command to configure and build the editor:
just config
just build
just editor