RomanNum3ral
/
wayvr
mirror of https://github.com/wayvr-org/wayvr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Building from Source (markdown)

galister 2026-01-12 04:12:44 +00:00
parent 6f41e07f61
commit 8ab245edbc
1 changed files with 5 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Building-from-Source.md

@ -8,9 +8,9 @@ Using [Rustup](https://rustup.rs/) is recommended.
Ensure `rustc` is up to date: `rustup update stable` Ensure `rustc` is up to date: `rustup update stable`
The following packages are required: The following packages are required:
- Arch: `base-devel cmake libxkbcommon fontconfig dbus alsa-lib python3` - Arch: `base-devel cmake libxkbcommon fontconfig dbus alsa-lib python3 wayland`
- Fedora: `cmake libxkbcommon libxkbcommon-devel fontconfig fontconfig-devel dbus dbus-devel alsa-lib alsa-lib-devel python3` - Fedora: `cmake libxkbcommon libxkbcommon-devel fontconfig fontconfig-devel dbus dbus-devel alsa-lib alsa-lib-devel python3 wayland-devel`
- Ubuntu: `build-essential pkg-config cmake libstdc++-12-dev libxkbcommon-dev fontconfig libfontconfig-dev libdbus-1-dev libasound2-dev python3` - Ubuntu: `build-essential pkg-config cmake libstdc++-12-dev libxkbcommon-dev fontconfig libfontconfig-dev libdbus-1-dev libasound2-dev python3 libwayland-dev`
## Available features ## Available features
### Feature `openvr` ### Feature `openvr`
@ -56,18 +56,10 @@ Dependencies:
### Feature `osc` ### Feature `osc`
Enable this if you want XSO-compatible OSC parameters in VRChat Enable this if you want XSO-compatible OSC parameters in VRChat
Supported parameters are explained here: [OSC Parameters](https://github.com/galister/wlx-overlay-s/wiki/OSC-Parameters) Supported parameters are explained here: [OSC Parameters](https://github.com/wlx-team/wayvr/wiki/OSC-Parameters)
Dependencies: None Dependencies: None
### Feature `wayvr`
Enable this if you want to run Wayland applications inside wlx-overlay-s.
Dependencies:
- Arch: `wayland libglvnd`
- Fedora: `wayland-devel`
- Ubuntu: `libwayland-dev`
# Execute the build # Execute the build
Here are some examples you can do: Here are some examples you can do:
@ -82,4 +74,4 @@ cargo build --release --no-default-features --features=x11,openvr
cargo build --release --no-default-features --features=wayland,openxr cargo build --release --no-default-features --features=wayland,openxr
``` ```
A single executable will be placed at `target/release/wlx-overlay-s`. A single executable will be placed at `../target/release/wayvr`.