nintendo-emulators/eden
1
0
Fork 0
mirror of https://git.eden-emu.dev/eden-emu/eden.git synced 2025-10-05 15:52:45 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
eden/docs/Build.md
crueter e1ffeec212 [docs] refactor: full rewrite, generalization + dedup (#488) 
"docs but awesome"

Combines most of the stuff that was repeated thrice over verbatim into a
single common Build Instructions page, with additional caveats marked
elsewhere. Prettifies some stuff too because why not.

cc: @Lizzie @DraVee @MaranBr @SDK-Chan

Co-authored-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/488
Reviewed-by: Lizzie <lizzie@eden-emu.dev>
Reviewed-by: MaranBr <maranbr@eden-emu.dev>
2025-09-18 02:37:02 +02:00

5.5 KiB
Raw Permalink Blame History

Building Eden

Warning

This guide is intended for developers ONLY. If you are not a developer or packager, you are unlikely to receive support.

This is a full-fledged guide to build Eden on all supported platforms.

Dependencies

First, you must install some dependencies.

Clone

Next, you will want to clone Eden via the terminal:

git clone https://git.eden-emu.dev/eden-emu/eden.git
cd eden

Or use Qt Creator (Create Project -> Import Project -> Git Clone).

Android

Android has a completely different build process than other platforms. See its dedicated page.

Initial Configuration

If the configure phase fails, see the Troubleshooting section below. Usually, as long as you followed the dependencies guide, the defaults should successfully configure and build.

Qt Creator

This is the recommended GUI method for Linux, macOS, and Windows.

Click to Open

Warning

On MSYS2, to use Qt Creator you are recommended to also install Qt from the online installer, ensuring to select the "MinGW" version.

Open the CMakeLists.txt file in your cloned directory via File -> Open File or Project (Ctrl+O), if you didn't clone Eden via the project import tool.

Select your desired "kit" (usually, the default is okay). RelWithDebInfo or Release is recommended:

Qt Creator kits

Hit "Configure Project", then wait for CMake to finish configuring (may take a while on Windows).

Command Line

This is recommended for *BSD, Solaris, Linux, and MSYS2. MSVC is possible, but not recommended.

Click to Open

Note that CMake must be in your PATH, and you must be in the cloned Eden directory. On Windows, you must also set up a Visual C++ development environment. This can be done by running C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvars64.bat in the same terminal.

Recommended generators:

  • MSYS2: MSYS Makefiles
  • MSVC: Install ninja and use Ninja, OR use Visual Studio 17 2022
  • macOS: Ninja (preferred) or Xcode
  • Others: Ninja (preferred) or UNIX Makefiles

BUILD_TYPE should usually be Release or RelWithDebInfo (debug symbols--compiled executable will be large). If you are using a debugger and annoyed with stuff getting optimized out, try Debug.

Also see the Options page for additional CMake options.

cmake -S . -B build -G "GENERATOR" -DCMAKE_BUILD_TYPE=<BUILD_TYPE> -DYUZU_TESTS=OFF

If you are on Windows and prefer to use Clang:

cmake -S . -B build -G "GENERATOR" -DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPILER=clang-cl

CLion

Click to Open
  • Clone the Repository:

Building & Setup

  • Once Cloned, You will be taken to a prompt like the image below:
  • Set the settings to the image below:
  • Change Build type: Release
  • Change Name: Release
  • Change Toolchain Visual Studio
  • Change Generator: Let CMake decide
  • Change Build directory: build
  • Click OK; now Clion will build a directory and index your code to allow for IntelliSense. Please be patient.
  • Once this process has been completed (No loading bar bottom right), you can now build eden
  • In the top right, click on the drop-down menu, select all configurations, then select eden
  • Now run by clicking the play button or pressing Shift+F10, and eden will auto-launch once built.

Troubleshooting

If your initial configure failed:

  • Carefully re-read the dependencies guide
  • Clear the CPM cache (.cache/cpm) and CMake cache (<build directory>/CMakeCache.txt)
  • Evaluate the error and find any related settings
  • See the CPM docs to see if you may need to forcefully bundle any packages

Otherwise, feel free to ask for help in Revolt or Discord.

Caveats

Many platforms have quirks, bugs, and other fun stuff that may cause issues when building OR running. See the Caveats page before continuing.

Building & Running

Qt Creator

Simply hit Ctrl+B, or the "hammer" icon in the bottom left. To run, hit the "play" icon, or Ctrl+R.

Command Line

If you are not on Windows and are using the UNIX Makefiles generator, you must also add -j$(nproc) to this command.

cmake --build build

Your compiled executable will be in:

  • build/bin/eden.exe for Windows,
  • build/bin/eden.app/Contents/MacOS/eden for macOS,
  • and build/bin/eden for others.

Scripts

Some platforms have convenience scripts provided for building.

macOS scripts will come soon.