Merge branch 'wivrn/distro-packages' into 'main'

wivrn: Add more distro packages, revise wired connection section, minor other edits

See merge request lvra/lvra.gitlab.io!95
This commit is contained in:
xytovl 2025-05-06 08:42:45 +00:00
commit 9020075c44

View file

@ -11,11 +11,11 @@ title: WiVRn
> WiVRn wirelessly connects a standalone VR headset to a Linux computer. You can then play PCVR games on the headset while processing is done on the computer. > WiVRn wirelessly connects a standalone VR headset to a Linux computer. You can then play PCVR games on the headset while processing is done on the computer.
WiVRn is based on [Monado](/docs/fossvr/monado/) and can be used with [OpenComposite](/docs/fossvr/opencomposite/) to support a majority of titles available for SteamVR. A wide range of standalone headsets are supported. WiVRn is based on [Monado](/docs/fossvr/monado/) and can be used with [OpenComposite](/docs/fossvr/opencomposite/) or [xrizer](https://github.com/Supreeeme/xrizer) to support a majority of titles available for SteamVR. A wide range of standalone headsets are supported.
## Installing WiVRn ## Installing WiVRn
We recommend using distribution packages when available or the [WiVRn Flatpak](https://flathub.org/apps/io.github.wivrn.wivrn). We recommend using distribution packages when available (see below) or the [WiVRn Flatpak](https://flathub.org/apps/io.github.wivrn.wivrn) when one is unavailable.
### Arch Linux ### Arch Linux
@ -24,17 +24,29 @@ Packages are available on [AUR](https://wiki.archlinux.org/title/Arch_User_Repos
* `wivrn-server` and `wivrn-dashboard` for base feature + GUI (latest release), or `wivrn-full-git` for development version * `wivrn-server` and `wivrn-dashboard` for base feature + GUI (latest release), or `wivrn-full-git` for development version
* `opencomposite-git` or `xrizer-git` for compatibility with OpenVR and proton * `opencomposite-git` or `xrizer-git` for compatibility with OpenVR and proton
### Fedora
The `wivrn` package will automatically pull `wivrn-dashboard` and `opencomposite` as dependencies, it can be installed with `sudo dnf install wivrn`.
To make use of patented codecs for video encoding like H264/H265, you must [install the codecs from RPMFusion](https://rpmfusion.org/Howto/Multimedia).
### Gentoo Linux ### Gentoo Linux
Packages are available on [Guru](https://wiki.gentoo.org/wiki/Project:GURU), you will need `media-libs/wivrn` and `media-libs/opencomposite` Packages are available on [Guru](https://wiki.gentoo.org/wiki/Project:GURU), you will need `media-libs/wivrn` and `media-libs/opencomposite`.
### NixOS
See [`services.wivrn`](https://search.nixos.org/options?channel=24.11&size=50&sort=relevance&type=packages&query=services.wivrn).
### Flatpak (all distributions) ### Flatpak (all distributions)
The [WiVRn Flatpak](https://flathub.org/apps/io.github.wivrn.wivrn) has the latest released version. For development releases, you can download the `wivrn-flatpak-x86_64` artifact from Github [Build](https://github.com/WiVRn/WiVRn/actions/workflows/Build.yml?query=branch%3Amaster) action The [WiVRn Flatpak](https://flathub.org/apps/io.github.wivrn.wivrn) has the latest released version and can be installed with `flatpak install io.github.wivrn.wivrn` or via your software centre application.
For development releases, you can download the `wivrn-flatpak-x86_64` artifact from the GitHub [Build](https://github.com/WiVRn/WiVRn/actions/workflows/Build.yml?query=branch%3Amaster) action.
### Envision (guided build) ### Envision (guided build)
You can use [Envision](/docs/fossvr/envision/) to install and launch WiVRn & OpenComposite. You can use [Envision](/docs/fossvr/envision/) to install and launch WiVRn & OpenComposite - this may be the easier route if you use SteamVR Lighthouse-tracked devices or SlimeVR trackers.
## General WiVRn Notes ## General WiVRn Notes
@ -44,12 +56,14 @@ systemctl enable --now avahi-daemon
``` ```
If Avahi is not available, `--no-publish-service` bypasses it, and the IP address of the server must be entered into the client. If Avahi is not available, `--no-publish-service` bypasses it, and the IP address of the server must be entered into the client.
If a firewall is installed, make sure ports 5353/UDP and 9757/UDP+TCP are open for Avahi and WiVRn itself, respectively. If a firewall is installed, make sure ports 5353/UDP and 9757/UDP+TCP are open for Avahi and WiVRn respectively.
If using Nvidia proprietary drivers older than 565, install the [Monado Vulkan Layers](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers), otherwise games will crash with a segmentation fault. If using Nvidia proprietary drivers older than 565, install the [Monado Vulkan Layers](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers), otherwise games will crash with a segmentation fault.
For audio in WiVRn, you will need to assign applications, or the system as a whole, to output audio to the virtual output "WiVRn" which is created upon connection between the server and the headset. For audio in WiVRn, you will need to assign applications, or the system as a whole, to output audio to the virtual output "WiVRn" which is created upon connection between the server and the headset.
## Steam Flatpak
It is possible to use WiVRn Flatpak with Steam Flatpak, though Steam Flatpak isn't generally recommended for VR. If you are using Steam Flatpak, you just need to grant it access to the relevant paths: It is possible to use WiVRn Flatpak with Steam Flatpak, though Steam Flatpak isn't generally recommended for VR. If you are using Steam Flatpak, you just need to grant it access to the relevant paths:
```bash ```bash
@ -69,19 +83,19 @@ flatpak override --user --env=PRESSURE_VESSEL_FILESYSTEMS_RW=/run/user/1000/wivr
You can use WiVRn with a cable instead of Wi-Fi. Use a 5Gbps cable & port at the very least. You can use WiVRn with a cable instead of Wi-Fi. Use a 5Gbps cable & port at the very least.
Using Envision: - Install adb on your system - usually the package is named `android-tools` or something similar.
- Connect the headset via USB. - Connect the headset via USB.
- In Envision, click the `Start WiVRn Client (Wired)` button. - Run `adb devices` in your terminal.
- If it's not there, you may need to update Envision. - If you have never authorised USB debugging from this computer before, put the headset on shortly and select 'Always allow USB debugging from this computer'.
Then depending on your installation method, follow these steps:
Manual steps: Using the dashboard:
- Connect the headset via USB. - The 'Connect via USB' button under the pairing toggle should have a list of devices - select any one to initiate a wired connection.
- If WiVRn is running on the headset, close it now.
- While in the system lobby of the headset, run the following `adb` commands on the PC: Using Envision:
```bash - Click the `Start WiVRn Client (Wired)` button in Envision.
adb reverse tcp:9757 tcp:9757
adb shell am start -a android.intent.action.VIEW -d "wivrn+tcp://127.0.0.1" org.meumeu.wivrn Manual steps: See the [README](https://github.com/WiVRn/WiVRn/blob/master/README.md?plain=1#L114).
```
## WiVRn + SlimeVR trackers ## WiVRn + SlimeVR trackers