Documentation Index
Fetch the complete documentation index at: https://mintlify.com/eden-emulator/mirror/llms.txt
Use this file to discover all available pages before exploring further.
Building Eden from source gives you full control over build options, lets you test patches, and is necessary for packaging. Before you start, make sure you have installed all required dependencies.
This guide is intended for developers and packagers only. If you are not building Eden for development or distribution purposes, you are unlikely to receive support for issues encountered here.
Clone the repository
Start by cloning Eden with Git:
git clone https://git.eden-emu.dev/eden-emu/eden.git
cd eden
Initial configuration
If the configure phase fails, check the Troubleshooting section. As long as dependencies are installed correctly, the defaults should configure and build successfully.
Qt Creator (recommended)
Command Line
CLion
Qt Creator is the recommended GUI method for Linux, macOS, and Windows.On MSYS2, it is recommended to also install Qt from the official online installer, making sure to select the MinGW variant, in addition to the MSYS2 package.
Open the project
Open the CMakeLists.txt file in your cloned directory via File → Open File or Project (Ctrl+O), unless you already cloned Eden through Qt Creator’s project import tool.
Select a kit
Select your desired kit from the list. The default is usually fine. RelWithDebInfo or Release is recommended for most use cases.
Configure
Click Configure Project and wait for CMake to finish. This may take a while on Windows.
Build
Press Ctrl+B or click the hammer icon in the bottom left to build. To run, press Ctrl+R or the play icon.
Before running CMake:
- CMake must be in your
PATH (and ninja too, if you are using it as your generator).
- You must be in the cloned Eden directory.
On Windows additionally:
- It is recommended to install Ninja.
- You must load the Visual C++ development environment first. Use one of these convenience scripts:
tools/windows/load-msvc-env.ps1 (PowerShell 5+)tools/windows/load-msvc-env.sh (MSYS2, Git Bash, etc.)
<GENERATOR>):| Environment | Generator |
|---|
| MSYS2 | MSYS Makefiles |
| MSVC | Ninja (preferred) or Visual Studio 17 2022 |
| macOS | Ninja (preferred) or Xcode |
| Others | Ninja (preferred) or UNIX Makefiles |
<BUILD_TYPE>):| Type | Description |
|---|
Release | Default; optimized, no debug symbols |
RelWithDebInfo | Optimized with debug symbols (large binary) |
Debug | Unoptimized; useful when stepping through a debugger |
When building in Debug mode with CCache, set the CL environment variable to /FS to force synchronous PDB writes. See Microsoft’s reference. Configure
Run CMake to configure the build directory:cmake -S . -B build -G "<GENERATOR>" -DCMAKE_BUILD_TYPE=<BUILD_TYPE> -DYUZU_TESTS=OFF
cmake -S . -B build -G "<GENERATOR>" -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPILER=clang-cl
Build
If using UNIX Makefiles or Visual Studio 17 2022 as your generator, add --parallel for faster builds. Clone the repository
Clone the Eden repository directly from CLion’s welcome screen using Get from VCS.
Configure CMake settings
When prompted for CMake settings, apply these values:| Setting | Value |
|---|
| Build type | Release |
| Name | Release |
| Toolchain | Visual Studio |
| Generator | Let CMake decide |
| Build directory | build |
Select the target
In the top-right dropdown, open All configurations and select eden.
Build and run
Click the play button or press Shift+F10 to build and launch Eden automatically.
Output locations
After a successful build, the compiled binary will be at:
| Platform | Path |
|---|
| Windows | build/bin/eden.exe |
| macOS | build/bin/eden.app/Contents/MacOS/eden |
| Linux / others | build/bin/eden |
Troubleshooting
If configuration fails:
- Carefully re-read the dependencies guide.
- Clear the CPM cache at
.cache/cpm and the CMake cache at <build directory>/CMakeCache.txt.
- Evaluate the specific error message and look for related CMake settings.
- Check the CPM docs to see if you need to force-bundle any packages.
Many platforms have quirks that can affect building or running Eden. Review the platform notes in the dependencies guide for your operating system before asking for help.
CI scripts
The Eden CI workflow is available at Eden-CI/Workflow. You can use .ci/common/configure.sh on any POSIX-compliant shell as a reference, though you are encouraged to write your own configure script tailored to your needs.
For additional CMake options, see the CMake options reference.