Skip to content

Commit a6fb0a4

Browse files
BUILD.md: Provide more info about build configuration flags (#1486)
1 parent ec2d7c0 commit a6fb0a4

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

BUILD.md

+38
Original file line numberDiff line numberDiff line change
@@ -192,3 +192,41 @@ Then install the dependencies:
192192

193193
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.
194194

195+
## CMake configure flags
196+
Some flags can be passed during CMake configure to customise which features are enabled on build.
197+
198+
Example usage: `cmake -S . -B build -DCMAKE_BUILD_TYPE=release -DENABLE_SDL=ON -DENABLE_VULKAN=OFF`
199+
200+
### All platforms
201+
| Flag | | Description | Default | Note |
202+
|--------------------|:--|-----------------------------------------------------------------------------|---------|--------------------|
203+
| ALLOW_PORTABLE | | Allow Cemu to use the `portable` directory to store configs and data | ON | |
204+
| CEMU_CXX_FLAGS | | Flags passed straight to the compiler, e.g. `-march=native`, `-Wall`, `/W3` | "" | |
205+
| ENABLE_CUBEB | | Enable cubeb audio backend | ON | |
206+
| ENABLE_DISCORD_RPC | | Enable Discord Rich presence support | ON | |
207+
| ENABLE_OPENGL | | Enable OpenGL graphics backend | ON | Currently required |
208+
| ENABLE_HIDAPI | | Enable HIDAPI (used for Wiimote controller API) | ON | |
209+
| ENABLE_SDL | | Enable SDLController controller API | ON | Currently required |
210+
| ENABLE_VCPKG | | Use VCPKG package manager to obtain dependencies | ON | |
211+
| ENABLE_VULKAN | | Enable the Vulkan graphics backend | ON | |
212+
| ENABLE_WXWIDGETS | | Enable wxWidgets UI | ON | Currently required |
213+
214+
### Windows
215+
| Flag | Description | Default | Note |
216+
|--------------------|-----------------------------------|---------|--------------------|
217+
| ENABLE_DIRECTAUDIO | Enable DirectAudio audio backend | ON | Currently required |
218+
| ENABLE_DIRECTINPUT | Enable DirectInput controller API | ON | Currently required |
219+
| ENABLE_XAUDIO | Enable XAudio audio backend | ON | |
220+
| ENABLE_XINPUT | Enable XInput controller API | ON | |
221+
222+
### Linux
223+
| Flag | Description | Default |
224+
|-----------------------|----------------------------------------------------|---------|
225+
| ENABLE_BLUEZ | Build with Bluez (used for Wiimote controller API) | ON |
226+
| ENABLE_FERAL_GAMEMODE | Enable Feral Interactive GameMode support | ON |
227+
| ENABLE_WAYLAND | Enable Wayland support | ON |
228+
229+
### macOS
230+
| Flag | Description | Default |
231+
|--------------|------------------------------------------------|---------|
232+
| MACOS_BUNDLE | MacOS executable will be an application bundle | OFF |

0 commit comments

Comments
 (0)