# Building # Server (PC) ## Compile From your checkout directory ```bash cmake -B build-server . -GNinja -DWIVRN_BUILD_CLIENT=OFF -DCMAKE_BUILD_TYPE=RelWithDebInfo cmake --build build-server ``` By default, all encoders are enabled. It is possible to disable them at build time with the following options: ``` -DWIVRN_USE_NVENC=OFF -DWIVRN_USE_VAAPI=OFF -DWIVRN_USE_VULKAN_ENCODE=OFF -DWIVRN_USE_X264=OFF ``` wivrnctl is an optional tool enabled by default and the only part that requires libsystemd/libelogind. It can be disabled with ``` -DWIVRN_USE_WIVRNCTL=OFF ``` Lighthouse driver support for use with lighthouse-tracked devices ``` -DWIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON ``` For a few dependencies it is possible to select system or embedded versions, check `WIVRN_USE_SYSTEM_xxx` in case you are missing dependencies. For more advanced options, check [CMakeLists.txt](../CMakeLists.txt). For the Flatpak, see [flatpak](flatpak.md). ## Profiling / tracing build To build the server with Perfetto tracing for local profiling, use the `server-tracing` preset (it is the `server` preset plus `WIVRN_USE_PERFETTO=ON`): ```bash cmake --preset server-tracing cmake --build build-server-tracing ``` This requires the Perfetto amalgamated SDK installed where CMake looks for it (`/usr/share/perfetto/sdk/perfetto.{h,cc}`, override with `-DPERFETTO_SDK_DIR=`). Tracing is gated at runtime by the `WIVRN_TRACING` env var, so a tracing-enabled build has no cost until you set it. To also instrument Monado under the same switch, use the `server-tracing-monado` preset (adds `WIVRN_TRACE_MONADO=ON`); this requires [percetto](https://github.com/olvaffe/percetto/) to be discoverable at configure time. See [profiling](profiling.md) for how to run the server with tracing and capture/analyse traces. # Dashboard The WiVRn dashboard requires Qt6, Kirigami, and the WiVRn server. ## Compile From your checkout directory, compile both the server and the dashboard: ```bash cmake -B build-dashboard . -GNinja -DWIVRN_BUILD_CLIENT=OFF -DWIVRN_BUILD_SERVER=ON -DWIVRN_BUILD_DASHBOARD=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo cmake --build build-dashboard ``` See [Server](#server-pc) for the server compile options. # Client (headset) #### Build dependencies As Arch package names: git pkgconf glslang cmake jdk17-openjdk librsvg cli11 ktx-software-bin ([AUR](https://aur.archlinux.org/packages/ktx-software-bin)) OpenSSL build dependencies are also needed, as described [here](https://github.com/openssl/openssl/blob/master/INSTALL.md#prerequisites), in particular perl 5. #### Android environment Download [sdkmanager](https://developer.android.com/tools/sdkmanager) commandline tool and extract it to any directory. Create your `ANDROID_HOME` directory, for instance `~/Android`. Review and accept the licenses with ```bash sdkmanager --sdk_root="${HOME}/Android" --licenses ``` Install the correct cmake version with ```bash sdkmanager --install "cmake;3.31.5" ``` #### Apk signing Your device may refuse to install an unsigned apk, so you must create signing keys before building the client ``` # Create key, then enter the password and other information that the tool asks for keytool -genkey -v -keystore ks.keystore -alias default_key -keyalg RSA -keysize 2048 -validity 10000 # Substitute your password that you entered in the command above instead of YOUR_PASSWORD echo signingKeyPassword="YOUR_PASSWORD" > gradle.properties ``` Once you have generated the keys, the apk will be automatically signed at build time #### Client build From the main directory. ```bash export ANDROID_HOME=~/Android export JAVA_HOME=/usr/lib/jvm/java-17-openjdk/ ./gradlew assembleRelease ``` Outputs will be in `build/outputs/apk/release/WiVRn-release.apk` #### Install apk with adb Before using adb you must enable usb debugging on your device: * Pico - https://developer.picoxr.com/document/unity-openxr/set-up-the-development-environment/ (see first step) * Quest - https://developer.oculus.com/documentation/unity/unity-env-device-setup/#headset-setup (see "Set Up Meta Headset" and "Test an App on Headset" until step 4) Also add your device in udev rules: https://wiki.archlinux.org/title/Android_Debug_Bridge#Adding_udev_rules Then connect the device via usb to your computer and execute the following commands ``` # Start adb server adb start-server # Check if the device is connected adb devices # Install apk adb install build/outputs/apk/release/WiVRn-release.apk # When you're done, you can stop the adb server adb kill-server ```