Prerequisites:
- git
- A recent version of Visual Studio 2022 with the following additional components:
- C++ CMake tools for Windows
- Windows 10/11 SDK
Instructions for Visual Studio 2022:
- Run
git clone --recursive https://github.com/cemu-project/Cemu
- Open the newly created Cemu directory in Visual Studio using the "Open a local folder" option
- In the menu select Project -> Configure CMake. Wait until it is done, this may take a long time
- You can now build, run and debug Cemu
Any other IDE should also work as long as it has CMake and MSVC support. CLion and Visual Studio Code have been confirmed to work.
To compile Cemu, a recent enough compiler and STL with C++20 support is required! Clang-15 or higher is what we recommend.
sudo pacman -S --needed base-devel clang cmake freeglut git glm gtk3 libgcrypt libpulse libsecret linux-headers llvm nasm ninja systemd unzip zip
sudo apt install -y cmake curl clang-15 freeglut3-dev git libgcrypt20-dev libglm-dev libgtk-3-dev libpulse-dev libsecret-1-dev libsystemd-dev libtool nasm ninja-build
You may also need to install libusb-1.0-0-dev
as a workaround for an issue with the vcpkg hidapi package.
At Step 3 in Build Cemu using cmake and clang, use the following command instead:
cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/clang-15 -DCMAKE_CXX_COMPILER=/usr/bin/clang++-15 -G Ninja -DCMAKE_MAKE_PROGRAM=/usr/bin/ninja
sudo dnf install clang cmake cubeb-devel freeglut-devel git glm-devel gtk3-devel kernel-headers libgcrypt-devel libsecret-devel libtool libusb1-devel llvm nasm ninja-build perl-core systemd-devel zlib-devel zlib-static
git clone --recursive https://github.com/cemu-project/Cemu
cd Cemu
cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -G Ninja
cmake --build build
If you are building using GCC, make sure you have g++ installed:
- Installation for Arch and derivatives:
sudo pacman -S gcc
- Installation for Debian, Ubuntu and derivatives:
sudo apt install g++
- Installation for Fedora and derivatives:
sudo dnf install gcc-c++
git clone --recursive https://github.com/cemu-project/Cemu
cd Cemu
cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_C_COMPILER=/usr/bin/gcc -DCMAKE_CXX_COMPILER=/usr/bin/g++ -G Ninja
cmake --build build
git clone --recursive https://github.com/cemu-project/Cemu
cd Cemu
cmake -S . -B build -DCMAKE_BUILD_TYPE=debug -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -G Ninja
cmake --build build
If you are using GCC, replace cmake -S . -B build -DCMAKE_BUILD_TYPE=debug -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -G Ninja
with cmake -S . -B build -DCMAKE_BUILD_TYPE=debug -DCMAKE_C_COMPILER=/usr/bin/gcc -DCMAKE_CXX_COMPILER=/usr/bin/g++ -G Ninja
This section refers to running cmake -S...
(truncated).
vcpkg install failed
- Run the following in the root directory and try running the command again (don't forget to change directories afterwards):
cd dependencies/vcpkg && git fetch --unshallow
- Run the following in the root directory and try running the command again (don't forget to change directories afterwards):
Please ensure you're using the latest port files with git pull and vcpkg update.
- Either:
- Update vcpkg by running by the following command:
git submodule update --remote dependencies/vcpkg
- If you are sure vcpkg is up to date, check the following logs:
Cemu/dependencies/vcpkg/buildtrees/wxwidgets/config-x64-linux-out.log
Cemu/dependencies/vcpkg/buildtrees/libsystemd/config-x64-linux-dbg-meson-log.txt.log
Cemu/dependencies/vcpkg/buildtrees/libsystemd/config-x64-linux-dbg-out.log
- Update vcpkg by running by the following command:
- Either:
- Not able to find Ninja.
- Add the following and try running the command again:
-DCMAKE_MAKE_PROGRAM=/usr/bin/ninja
- Add the following and try running the command again:
- Compiling failed during the boost-build dependency.
- It means you don't have a working/good standard library installation. Check the integrity of your system headers and making sure that C++ related packages are installed and intact.
- Compiling failed during rebuild after
git pull
with an error that mentions RPATH- Add the following and try running the command again:
-DCMAKE_BUILD_WITH_INSTALL_RPATH=ON
- Add the following and try running the command again:
- If you are getting a random error, read the [package-name-and-platform]-out.log and [package-name-and-platform]-err.log for the actual reason to see if you might be lacking the headers from a dependency.
If you are getting a different error than any of the errors listed above, you may either open an issue in this repo or try using GCC. Make sure your standard library and compilers are updated since Cemu uses a lot of modern features!
This section refers to running cmake --build build
.
main.cpp.o: in function 'std::__cxx11::basic_string...
- You likely are experiencing a clang-14 issue. This can only be fixed by either lowering the clang version or using GCC, see GCC.
fatal error: 'span' file not found
- You're either missing
libstdc++
or are using a version that's too old. Install at least v10 with your package manager, egsudo apt install libstdc++-10-dev
. See #644.
- You're either missing
undefined libdecor_xx
- You are likely experiencing an issue with sdl2 package that comes with vcpkg. Delete sdl2 from vcpkg.json in source file and recompile.
If you are getting a different error than any of the errors listed above, you may either open an issue in this repo or try using GCC. Make sure your standard library and compilers are updated since Cemu uses a lot of modern features!
To compile Cemu, a recent enough compiler and STL with C++20 support is required! LLVM 13 and below don't support the C++20 feature set required, so either install LLVM from Homebrew or make sure that you have a recent enough version of Xcode. Xcode 15 is known to work. The OpenGL graphics API isn't supported on macOS, so Vulkan must be used through the Molten-VK compatibility layer.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
- Set up the Homebrew shell environment:
- On an Intel Mac:
eval "$(/usr/local/Homebrew/bin/brew shellenv)"
- On an Apple Silicon Mac: eval
"$(/opt/homebrew/bin/brew shellenv)"
- On an Intel Mac:
The native versions of these can be used regardless of what type of Mac you have.
brew install git cmake ninja nasm automake libtool
On Apple Silicon Macs, Rosetta 2 and the x86_64 version of Homebrew must be used to install these dependencies:
softwareupdate --install-rosetta
# Install Rosetta 2 if you don't have it. This only has to be done oncearch -x86_64 zsh
# run an x64 shell/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
eval "$(/usr/local/Homebrew/bin/brew shellenv)"
Then install the dependencies:
brew install boost molten-vk
git clone --recursive https://github.com/cemu-project/Cemu
cd Cemu
cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DCMAKE_OSX_ARCHITECTURES=x86_64 -G Ninja
cmake --build build
- You should now have a Cemu executable file in the /bin folder, which you can run using
./bin/Cemu_release
.
- If step 3 gives you an error about not being able to find ninja, try appending
-DCMAKE_MAKE_PROGRAM=/usr/local/bin/ninja
to the command and running it again.
- To update your Cemu local repository, use the command
git pull --recurse-submodules
(run this command on the Cemu root).- This should update your local copy of Cemu and all of its dependencies.
- Then, you can rebuild Cemu using the steps listed above, according to whether you use Linux or Windows.
If CMake complains about Cemu already being compiled or another similar error, try deleting the CMakeCache.txt
file inside the build
folder and retry building.