From c1907a137e4856954d612011bcbcf8a05e70dd7d Mon Sep 17 00:00:00 2001 From: AnnoyingRains Date: Tue, 11 Mar 2025 12:22:50 +0000 Subject: [PATCH 01/49] Fix typo --- content/docs/distros/nixos.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/distros/nixos.md b/content/docs/distros/nixos.md index 6340f84..9c5874b 100644 --- a/content/docs/distros/nixos.md +++ b/content/docs/distros/nixos.md @@ -28,7 +28,7 @@ You can find WiVRn on the official [NixOS wiki](https://wiki.nixos.org/wiki/VR#W To get VRChat working with monado on nix, use the `env PRESSURE_VESSEL_FILESYSTEMS_RW=$XDG_RUNTIME_DIR/monado_comp_ipc %command%` launch options on steam and click play with the "Launch VRChat in Steam VR" mode. It should open it on your desktop for preview and display it through monado. ## SteamVR -SteamVR works like it does on other distros for the most part. Unfotrunately, if it doesn't work out of the box, troubleshooting it on NixOS can be close to impossible due to NixOS's structure and SteamVR's proprietary nature. +SteamVR works like it does on other distros for the most part. Unfortunately, if it doesn't work out of the box, troubleshooting it on NixOS can be close to impossible due to NixOS's structure and SteamVR's proprietary nature. [Asynchronous reprojection does not work](https://github.com/NixOS/nixpkgs/issues/217119) without a kernel patch. From d0d653b5141f79aa0b1e247391ceef068716701c Mon Sep 17 00:00:00 2001 From: AnnoyingRains Date: Tue, 11 Mar 2025 13:32:31 +0000 Subject: [PATCH 02/49] Update NixOS documentation with setup recommendations, as well as instructions on how to undo the damage that Envision can do to a NixOS VR system. --- content/docs/distros/nixos.md | 79 ++++++++++++++++++++++++++++++++--- 1 file changed, 74 insertions(+), 5 deletions(-) diff --git a/content/docs/distros/nixos.md b/content/docs/distros/nixos.md index 9c5874b..341840f 100644 --- a/content/docs/distros/nixos.md +++ b/content/docs/distros/nixos.md @@ -6,6 +6,59 @@ title: NixOS General documentation about VR is provided on the [NixOS Wiki](https://wiki.nixos.org/wiki/VR). +## Recommendations +The recommended way to set up NixOS for VR is by using [services.monado](https://search.nixos.org/options?channel=unstable&query=services.monado) or [services.wivrn](https://search.nixos.org/options?channel=unstable&query=services.wivrn). + +You may also want to install [opencomposite](https://search.nixos.org/packages?channel=unstable&query=opencomposite) (or xrizer, currently only available in [nixpkgs-xr](https://github.com/nix-community/nixpkgs-xr)) and [wlx-overlay-s](https://search.nixos.org/packages?channel=unstable&query=wlx-overlay-s). + +For OpenComposite or XRizer, you may want to configure `~/.config/openvr/openvrpaths.vrpath` to point to your OpenComposite or XRizer installation. See below for an example using [home-manager](https://github.com/nix-community/home-manager). + +```nix +xdg.configFile."openvr/openvrpaths.vrpath".text = '' + { + "config" : + [ + "~/.local/share/Steam/config" + ], + "external_drivers" : null, + "jsonid" : "vrpathreg", + "log" : + [ + "~/.local/share/Steam/logs" + ], + "runtime" : + [ + "${pkgs.opencomposite}/lib/opencomposite" + ], + "version" : 1 + } +''; +``` + +If you need to run the latest possible version of any of these pieces of software for whatever reason, above what is packaged in NixOS, you may want to check out Community Overlays at the bottom of this article. + +If you need to run a branch of Monado or WiVRn, you can use `.overrideAttrs`, see below for an example of doing this for Coreforge's Monado Pimax fork. + +```nix +monado = { + enable = true; + defaultRuntime = true; + highPriority = true; + + package = (pkgs.monado.overrideAttrs { + pname = "monado-pimax"; # optional but helps distinguishing between packages + + src = pkgs.fetchFromGitLab { + domain = "gitlab.freedesktop.org"; + owner = "Coreforge"; + repo = "monado"; + rev = "f858ee5dd8ca7696bd9219e8278f2671df56fe6e"; + hash = "sha256-Si56yvG+oSfyUaPAlF1FgB7WJo8td1xuVxYnkJvbu4o="; + }; + }); +}; +``` + ## Monado Monado is supported natively on NixOS using the [services.monado](https://search.nixos.org/options?channel=unstable&query=services.monado) since 24.05. @@ -24,19 +77,35 @@ As WiVRn is built around Monado, most, if not all, settings for Monado are also You can find WiVRn on the official [NixOS wiki](https://wiki.nixos.org/wiki/VR#WiVRn). -### VRChat -To get VRChat working with monado on nix, use the `env PRESSURE_VESSEL_FILESYSTEMS_RW=$XDG_RUNTIME_DIR/monado_comp_ipc %command%` launch options on steam and click play with the "Launch VRChat in Steam VR" mode. It should open it on your desktop for preview and display it through monado. +### Steam Games +To get Steam games working with monado on NixOS, use the `env PRESSURE_VESSEL_FILESYSTEMS_RW=$XDG_RUNTIME_DIR/monado_comp_ipc %command%` launch options on steam and, if prompted, choose the SteamVR launch option. + +## OpenXR apps +All OpenXR apps should work out of the box, assuming you have a default runtime set. + +To set a default OpenXR runtime, you can either use `services.monado.defaultRuntime` (the same option is present for WiVRn) or create/modify `~/.config/openxr/1/active_runtime.json`. ## SteamVR SteamVR works like it does on other distros for the most part. Unfortunately, if it doesn't work out of the box, troubleshooting it on NixOS can be close to impossible due to NixOS's structure and SteamVR's proprietary nature. -[Asynchronous reprojection does not work](https://github.com/NixOS/nixpkgs/issues/217119) without a kernel patch. +[Asynchronous reprojection does not work](https://github.com/NixOS/nixpkgs/issues/217119) without a [kernel patch](https://github.com/Frogging-Family/community-patches/blob/a6a468420c0df18d51342ac6864ecd3f99f7011e/linux61-tkg/cap_sys_nice_begone.mypatch). However, this patch is only applicable for AMD GPUs. There is no way to get SteamVR asynchronous reprojection working on Nvidia. [setcap doesn't work](https://github.com/NixOS/nixpkgs/issues/42117#issuecomment-996731579) but can be done manually. ## Envision -[Envision](../../fossvr/envision/) has been packaged in [nixos unstable](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=+envision) but is still in early development and is not recommended. It may also mess with your `monado.service` setup in unexpected ways. +[Envision](../../fossvr/envision/) has been packaged in [nixos 24.11](https://github.com/NixOS/nixpkgs/blob/nixos-24.11/pkgs/by-name/en/envision/package.nix) but is still in early development and is not recommended. It may also mess with your `monado.service` setup in unexpected ways. + +Notably, if you try to use Envision on NixOS, by default, binaries will be dynamically linked, not statically linked, which will cause many issues with VR apps. Also, if you try to use Envision with a dedicated PCVR headset (ie, Monado with an Index, Pimax, etc), asynchronous reprojection will not work without an AMD-only kernel patch, for the same reason as SteamVR. + +### Removing Envision +In case you did not follow the above advice, and attempted to use Envision on NixOS, you may want to undo the changes it has made to your home folder, so `services.monado`, `services.wivrn`, `opencomposite` and/or `xrizer` may work correctly. + +You will want to delete or modify `~/.config/openxr/1/active_runtime.json`. Note that this is an override for `/etc/xdg/openxr/1/active_runtime.json`, so if you are using `services.monado.defaultRuntime = true` (or the WiVRn equivalent) then you can safely delete this file. Otherwise, you'll want to point it to your Monado installation, which will be somewhere in `/nix/store`. + +You will also want to modify `~/.config/openvr/openvrpaths.vrpath`. Remove any runtimes that point to Envision's compiled binaries. + +I recommend using [home-manager](https://github.com/nix-community/home-manager) to automate writing these config files, as these paths will change regularly, due to the nature of NixOS. ## Community Overlays -[Nixpkgs-xr](https://github.com/nix-community/nixpkgs-xr) provides overlays for the exisiting nixpkgs. If the mainline packages are broken for you (whether it be compiling or in function) for any reason, adding this, as described in the readme, might help. +[Nixpkgs-xr](https://github.com/nix-community/nixpkgs-xr) provides overlays for the exisiting nixpkgs. If the mainline packages are broken for you (whether it be compiling or in function) for any reason, adding this, as described in the readme, might help. It also provides XR-related packages considerably before they are available in NixOS. From 28595b46f43d595155ce85476ac334d30cb377dc Mon Sep 17 00:00:00 2001 From: Johnny Mnemonic Date: Wed, 19 Mar 2025 03:06:03 +0000 Subject: [PATCH 03/49] Edit _index.md Updating links and information --- content/docs/fossvr/stardust/_index.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/content/docs/fossvr/stardust/_index.md b/content/docs/fossvr/stardust/_index.md index cf632cd..ea04cb1 100644 --- a/content/docs/fossvr/stardust/_index.md +++ b/content/docs/fossvr/stardust/_index.md @@ -9,19 +9,23 @@ weight: 52 - [Github Organization](https://github.com/StardustXR/) A system UI to make using all your 2D—and eventually OpenXR—apps together intuitive, accessible, and fun by using community-made virtual objects as interfaces. +Stardust provides a 3D environment, where anything from 2D windows (including your existing apps!), to 3D apps built from objects, can exist together in physical space. ![Panels for wayland apps and a CRT panel shell for XR UI.](https://stardustxr.org/img/carousel/panels.png) ## Setup -First you need to install and run the server from https://github.com/StardustXR/server. Follow the README. If you have issues getting OpenXR to work, try running https://gitlab.freedesktop.org/monado/demos/xrgears first. +For full installation instructions and a deeper dive into setting it up with various linux distributions, visit the [Stardust XR website](https://stardustxr.org/docs/get-started/What-is-Stardust) +The quickest way to try out Stardust XR is to install [Telescope](https://stardustxr.org/docs/get-started/Quickstart). It comes with the Stardust XR server, an app launcher called Hexagon Launcher, +and some helpful apps like Flatland to use your 2D apps inside Stardust, and Black Hole to quickly tuck away your objects and apps (kind of like desktop peek on Windows). Note that you'll need to have +the [Terra repository](https://terra.fyralabs.com/) installed. -After the server is running, you'll need to run some clients. Here's a demo showing some off: -![A showcase of some different clients](https://stardustxr.org/img/docs/clients/demo_01.mp4) +``` +sudo dnf install telescope +``` -Non-exhaustive list of clients: -- [Flatland](https://github.com/StardustXR/flatland): A panel item UI (XR equivalent of a window manager) so you can interact with your apps using virtual touchscreens. To show Wayland apps, run them with the proper `WAYLAND_DISPLAY` environment variable, in the server's startup script, or use a stardust launcher such as gravity or protostar. Flatland works great in 3DoF or 6DoF with direct touch and pointer interaction. -![A flat panel containing the prism launcher](https://stardustxr.org/img/docs/clients/flatland.png) -- [Gravity](https://github.com/StardustXR/gravity): Command line tool to launch programs inside of stardust at a particular offset in space. This is nestable so you can run a script using gravity, and then gravity inside that script to make a whole composed setup out of thin air! It also ensures that everything launched through it will properly connect to the stardust server, such as wayland clients. -- [Protostar](https://github.com/StardustXR/protostar): Prototype app launcher library/examples. Grab app icons and drop them in space to launch apps where they're dropped. -- [Magnetar](https://github.com/StardustXR/magnetar): Workspaces in 3D. Any object inside the rings will move with them, so you can move a bunch of stuff out of the way temporarily when you don't need it. \ No newline at end of file + Here's a demo showing some off some of what Stardust XR is like: + + +The full installation of Stardust XR centers around the Stardust XR server, which can run a variety of clients. For a full list of what is available, +check out the [Github repository](https://github.com/StardustXR). \ No newline at end of file From 621af2e3384284ad72a96b1ac677fafc858f6698 Mon Sep 17 00:00:00 2001 From: Aleksander Date: Sat, 22 Mar 2025 10:40:09 +0100 Subject: [PATCH 04/49] SlimeVR: Remove outdated important notes --- content/docs/slimevr/_index.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/content/docs/slimevr/_index.md b/content/docs/slimevr/_index.md index b8c2664..fae1497 100644 --- a/content/docs/slimevr/_index.md +++ b/content/docs/slimevr/_index.md @@ -68,10 +68,6 @@ For Monado, you need compile this fork: **Important note #1**: Do not stop the SlimeVR server during operation, as driver and tracker hot-plugging are not yet supported. -**Important note #2**: SlimeVR will not detect your HMD until you launch a game that supports trackers. For now, body calibration options will be available in-game. - -After launching the game, you should see your trackers being detected. At this point, you can calibrate and use them. - ## Third method: VRChat OSC **This method is only available in VRChat.** From ae430abd23b075f0faf01854001844ce3ae7860b Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Fri, 28 Mar 2025 10:39:55 -0500 Subject: [PATCH 05/49] Envision: discourage AppImageLauncher --- content/docs/fossvr/envision/_index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/docs/fossvr/envision/_index.md b/content/docs/fossvr/envision/_index.md index 10ebb21..4c84684 100644 --- a/content/docs/fossvr/envision/_index.md +++ b/content/docs/fossvr/envision/_index.md @@ -71,6 +71,14 @@ For example, if you installed WlxOverlay-S from AUR or built it from source, you Now starting the profile will also start your custom or AUR version of WlxOverlay-S. +### Plugin troubleshooting + +On some systems, a built-in plugin may not launch. This can happen for a number of reasons, but one in particular is so obtuse that it's worth a mention: + +Please *uninstall* AppImageLauncher. It intercepts the normal AppImage starting behavior in a dirty way that we can't predict. + +You can tell if you are affected if, when you run the WlxOverlay-S AppImage in terminal (whether in plugin form in `~/.local/share/envision/plugins`, or downloaded directly from GitHub), you only get the output `execv error: No such file or directory`. + ## Experimental feature settings The following resources can be entered into your Envision profile repo and branch settings to enable early access to code before it's fully upstream in Monado itself. To enable these feature sets, simply clone your profile, edit it with these settings, then build. From 4868cc9a8ceaa9379cf843c1f3d6ea399880493d Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Fri, 28 Mar 2025 13:08:59 -0500 Subject: [PATCH 06/49] Fix trailing spaces --- content/docs/fossvr/stardust/_index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/fossvr/stardust/_index.md b/content/docs/fossvr/stardust/_index.md index ea04cb1..7fc8037 100644 --- a/content/docs/fossvr/stardust/_index.md +++ b/content/docs/fossvr/stardust/_index.md @@ -16,16 +16,16 @@ Stardust provides a 3D environment, where anything from 2D windows (including yo ## Setup For full installation instructions and a deeper dive into setting it up with various linux distributions, visit the [Stardust XR website](https://stardustxr.org/docs/get-started/What-is-Stardust) -The quickest way to try out Stardust XR is to install [Telescope](https://stardustxr.org/docs/get-started/Quickstart). It comes with the Stardust XR server, an app launcher called Hexagon Launcher, +The quickest way to try out Stardust XR is to install [Telescope](https://stardustxr.org/docs/get-started/Quickstart). It comes with the Stardust XR server, an app launcher called Hexagon Launcher, and some helpful apps like Flatland to use your 2D apps inside Stardust, and Black Hole to quickly tuck away your objects and apps (kind of like desktop peek on Windows). Note that you'll need to have -the [Terra repository](https://terra.fyralabs.com/) installed. +the [Terra repository](https://terra.fyralabs.com/) installed. ``` -sudo dnf install telescope +sudo dnf install telescope ``` Here's a demo showing some off some of what Stardust XR is like: -The full installation of Stardust XR centers around the Stardust XR server, which can run a variety of clients. For a full list of what is available, -check out the [Github repository](https://github.com/StardustXR). \ No newline at end of file +The full installation of Stardust XR centers around the Stardust XR server, which can run a variety of clients. For a full list of what is available, +check out the [Github repository](https://github.com/StardustXR). From e728202c9a5058724a59a56c0a2bc62814728f5e Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Fri, 28 Mar 2025 12:54:55 -0500 Subject: [PATCH 07/49] Remove dead links to vulkan-layers, encourage >=565 --- content/docs/fossvr/wivrn/_index.md | 2 +- content/docs/hardware/_index.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index 8408779..e86ea62 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -29,7 +29,7 @@ systemctl enable --now avahi-daemon If a firewall is installed, make sure ports 5353/UDP and 9757/UDP+TCP are open for Avahi and WiVRn itself, respectively. -If using Nvidia proprietary drivers, have [Monado Vulkan Layers](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers) installed, 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. diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index 8c86869..80b6c14 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -11,7 +11,7 @@ title: VR Gear & GPUs | Manufacturer | Driver | VR Support | Reprojection Support | Hybrid Graphics Support | Notes | |--------------|---------------------------|----------------|--------------------------------|-------------------------------|----------------------------------------------------------------------------------------------| -| Nvidia | Nvidia (Closed Source) | Excellent | Excellent | Supported | Requires an implicit [vulkan-layer](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers) to not segfault: [*AUR*](https://aur.archlinux.org/packages/monado-vulkan-layers-git)・[*Fedora*](https://packages.fedoraproject.org/pkgs/monado-vulkan-layers/monado-vulkan-layers/)・[*Ubuntu*](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers/-/jobs/55337949/artifacts/file/incoming/monado-vulkan-layers_0.9.0.29.git.ae43cdc-1~20240221ubuntu2204_amd64.deb)・[*Debian*](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers/-/jobs/55337947/artifacts/file/incoming/monado-vulkan-layers_0.9.0.29.git.ae43cdc-1~20240221bpo11_amd64.deb) | +| Nvidia | Nvidia (Closed Source) | Excellent | Excellent | Supported | Requires driver version 565 or greater | | Nvidia | Nouveau (Open Source) | Functional | Functional | Supported | Lacks DisplayPort audio. | | Intel | i915 (Open Source) | Functional | Unknown | Supported | Relatively old, most likely poor support for newer GPUs. | Intel | Intel/Xe (Open Source) | No wired HMDs | N/A / Unable to drive wired. | Supported | Lacks direct mode implementation in driver, unable to drive wired HMDs. | @@ -23,7 +23,7 @@ title: VR Gear & GPUs - **VR Support**: Indicates how well supported the necessary Vulkan API components are. - **Reprojection Support**: Describes the support and quality of reprojection features for VR. Poor support indicates that the driver is not able to properly handle Vulkan realtime shaders and it will present as visual stutter. Non-robust solutions will suffer stutter under very high GPU load. - **PRIME/ Hybrid GPU Support**: Compatibility with systems using multiple GPUs for render offload. Monado and all clients must be run on a single select GPU due to memory tiling requirements. -- For Nvidia proprietary drivers, the [vulkan-layer](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers) **must** be installed in order to not crash. +- For Nvidia proprietary drivers *older* than 565, (please try to update!), the [vulkan-layers](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers) must be installed in order to not crash: [*AUR*](https://aur.archlinux.org/packages/monado-vulkan-layers-git)・[*Fedora*](https://packages.fedoraproject.org/pkgs/monado-vulkan-layers/monado-vulkan-layers/) - AMD GPUs lower than RDNA generation have functional but less robust reprojection capabilities, expected to be similar to Intel. - Audio over displayport is known to temporarily cut out when new audio sources spring up on pipewire [without a fix to add alsa headroom](https://wiki.archlinux.org/title/PipeWire#Audio_cutting_out_when_multiple_streams_start_playing) - X11 configurations are discouraged but workable, please upgrade your system to Wayland if at all possible. From ba3cf3f3a3221e35d0af9f6935987ae51523772b Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Fri, 28 Mar 2025 22:06:17 -0500 Subject: [PATCH 08/49] Remove AdGoBye It's been mostly broken for a while, but a recent VRChat change has made it outright impossible to fix, so the project is dead. See: https://github.com/AdGoBye/AdGoBye/issues/105#issuecomment-2763012736 --- content/docs/vrchat/_index.md | 8 +++++++- content/docs/vrchat/adblocker.md | 16 ---------------- 2 files changed, 7 insertions(+), 17 deletions(-) delete mode 100644 content/docs/vrchat/adblocker.md diff --git a/content/docs/vrchat/_index.md b/content/docs/vrchat/_index.md index 80590f2..22c9564 100644 --- a/content/docs/vrchat/_index.md +++ b/content/docs/vrchat/_index.md @@ -27,5 +27,11 @@ Should the game prompt to exit the game upon an anticheat failure, simply try to Given a [few caveats](video_players/) most video players will work. +## Privacy + VRChat drags quite a tangle of privacy concerns. -Please consider your opsec in relation to all VR API input including poses, all voice communication, unsandboxed code execution, the EAC anticheat system which occasionally probes system proc info and much more, and the game maintaining a memory buffered audio video recording of the window contents tied to the report system. \ No newline at end of file + +Please consider your opsec in relation to all VR API input including poses, all voice communication, unsandboxed code execution, the EAC (anticheat) system which occasionally probes the list of all system processes, the game maintaining a memory-buffered audio/video recording of the window contents tied to the report system, and much more. + +In-game analytics can be blocked at the DNS level. These are often external services the game phones into to deliver usage statistics. Opt-out by blocking this domain list in your network or computer firewall/DNS service: https://github.com/Luois45/VRChatAnalyticsBlocklist + diff --git a/content/docs/vrchat/adblocker.md b/content/docs/vrchat/adblocker.md deleted file mode 100644 index 5ea3d66..0000000 --- a/content/docs/vrchat/adblocker.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -weight: 100 -title: Blocking Ads in VRChat ---- - -Ads are annoying, bloated, and wasteful of your time and attention. -They are found prominently in popular worlds, luckily the prefabs can be blocked by the end user with this handy git project: - -![AdGoBye](https://raw.githubusercontent.com/AdGoBye/AdGoBye/main/Marketing/lsmbeforeafter.webp) - -https://github.com/AdGoBye/AdGoBye - - -In-game analytics can also be blocked at the DNS level, these are often external services the game phones into to deliver usage statistics. Opt out by blocking this domain list in your network or computer firewall/ DNS service. - -https://github.com/Luois45/VRChatAnalyticsBlocklist \ No newline at end of file From 9101358589c34dc871312b9dc041f79942de3216 Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Sat, 29 Mar 2025 11:24:06 -0500 Subject: [PATCH 09/49] Index: recommend replug technique --- content/docs/hardware/_index.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index 8c86869..8c01829 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -92,23 +92,16 @@ A non-comprehensive table of various VR/XR devices and the drivers that support ## Hardware note -WiVRn PC XR to WiVRn PC client streaming remains mainly for debug use. - -Vive Pro microphones should be set to use 44.1khz sample rates as feeding in 48khz raises the pitch of the audio. - -Vive Pro creates HDMI Output Source after startup of SteamVR/Monado/etc. Use it instead of Vive Pro USB Audio Source, since the audio might appear distorted. - -Valve index audio output should be set to 48khz or no audio will output. - -Vive Pro Eye HMD functional, eyechip WIP. - -Pimax initialization code WIP. Distortion matrix dump work in progress. - -Eyetrack VR and Project Babble will both be implemented through [oscavmgr](https://github.com/galister/oscavmgr) to emit proper unified flexes over OSC. - -Tracking technologies can be mixed Monado/WiVRn by using [motoc](https://github.com/galister/motoc). - -Having Ultraleap packages installed causes Monado to not compile. +- WiVRn PC XR to WiVRn PC client streaming remains mainly for debug use. +- **Vive Pro** microphones should be set to use 44.1khz sample rates as feeding in 48khz raises the pitch of the audio. +- **Vive Pro** creates HDMI Output Source after startup of SteamVR/Monado/etc. Use it instead of Vive Pro USB Audio Source, since the audio might appear distorted. +- **Valve Index** audio output should be set to 48khz or no audio will output. +- **Valve Index** may bug out once per boot, resulting in VR refusing to start, or your DE seeing it as a normal monitor. Just unplug and replug the barrel connector that provides power to the HMD. +- **Vive Pro Eye** HMD functional, eyechip WIP. +- **Pimax** initialization code WIP. Distortion matrix dump work in progress. +- Eyetrack VR and Project Babble will both be implemented through [oscavmgr](https://github.com/galister/oscavmgr) to emit proper unified flexes over OSC. +- Tracking technologies can be mixed Monado/WiVRn by using [motoc](https://github.com/galister/motoc). +- Having Ultraleap packages installed causes Monado to not compile. ## Applying a kernel patch (for Vive Pro 2, Bigscreen Beyond, Pimax) From b3a7600b4d49d97fe0b61d358ef3bd973385e854 Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Wed, 2 Apr 2025 22:44:27 -0500 Subject: [PATCH 10/49] Resonite: mention OXR_PARALLEL_VIEWS --- content/docs/resonite/_index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/docs/resonite/_index.md b/content/docs/resonite/_index.md index b1187ae..f256357 100644 --- a/content/docs/resonite/_index.md +++ b/content/docs/resonite/_index.md @@ -27,6 +27,12 @@ OpenComposite should now provide a close-to-flawless experience on most controll There are some minor visual bugs specific to running Resonite on Proton, such as textures taking longer to load and appearing black for a few seconds when close to the player. +## Mirrors look cross-eyed + +When playing Resonite under Monado, the 3D effect of mirrors may appear way off, as if looking through them feels like your eyes are crossed. + +To solve this, prepend `OXR_PARALLEL_VIEWS=1` to Resonite's launch options. + ## Crashes Resonite has been seen causing random SteamVR crashes on Linux before. In some situations the engine also tends to freeze. On OpenComposite, the game will rarely close out on its own without leaving any obvious trace of things going wrong — this is being investigated. From 44ee7490f5b8bf3c2ee6bed11b253b59e1c46382 Mon Sep 17 00:00:00 2001 From: Mhowser Date: Thu, 3 Apr 2025 18:01:50 +0000 Subject: [PATCH 11/49] Added links, helpful info in performance section --- content/docs/resonite/_index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/docs/resonite/_index.md b/content/docs/resonite/_index.md index f256357..3dd1f3a 100644 --- a/content/docs/resonite/_index.md +++ b/content/docs/resonite/_index.md @@ -21,7 +21,7 @@ Make sure you have a compatibility tool selected (e.g. GE-Proton-RTSP) before la The current recommended Proton variant is [**GE-Proton-RTSP**](https://github.com/SpookySkeletons/proton-ge-rtsp/releases). -OpenComposite should now provide a close-to-flawless experience on most controllers and when using hand tracking. +[OpenComposite](https://lvra.gitlab.io/docs/fossvr/opencomposite/) should now provide a close-to-flawless experience on most controllers and when using hand tracking. ## Visual bugs @@ -29,7 +29,7 @@ There are some minor visual bugs specific to running Resonite on Proton, such as ## Mirrors look cross-eyed -When playing Resonite under Monado, the 3D effect of mirrors may appear way off, as if looking through them feels like your eyes are crossed. +When playing Resonite under [Monado](https://lvra.gitlab.io/docs/fossvr/monado/) or [WiVRn](https://lvra.gitlab.io/docs/fossvr/wivrn/), the 3D effect of mirrors may appear way off, as if looking through them feels like your eyes are crossed. This only affects headsets with canted displays (e.g. Valve Index, Pimax). To solve this, prepend `OXR_PARALLEL_VIEWS=1` to Resonite's launch options. @@ -42,10 +42,11 @@ The cause of these issues and whether they are Proton-specific isn't currently k ## Performance In larger sessions Resonite is typically CPU-bound, there isn't much that can be done besides upgrading your CPU. In situations where the GPU is a bottleneck, lowering the resolution (either in the OpenXR runtime or through OpenComposite) may help dramatically. +This can be easily done by prepending `OXR_VIEWPORT_SCALE_PERCENTAGE=75` to Resonite's launch options. Experiment with different values to find your preferred balance between performance and quality. ## Crash on loading into a world with video players -On GE-Proton9-10 (for example), loading into a world with e.g. a YouTube video or live stream can crash the game. Try using the latest GE-Proton-RTSP. +On GE-Proton9-10 (for example), loading into a world with e.g. a YouTube video or live stream can crash the game. Try using the latest GE-Proton-RTSP release. ## Controls busted after switching to desktop From d89f9e3dde75eb0e8e2e3d2d3c0534b94fc21f27 Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Thu, 3 Apr 2025 15:16:52 -0500 Subject: [PATCH 12/49] Hardware: install Fedora builddeps --- content/docs/hardware/_index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index e45f08c..351a1ac 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -133,6 +133,9 @@ source=( # replace 41 with your fedora version git switch f41 + # install the build dependencies for the kernel, if you haven't already + sudo dnf builddep kernel.spec + # name this the 'bsb' build sed -i 's/# define buildid .*/%define buildid .bsb/g' kernel.spec ``` From 7672eb111fdfd7828221681743e7c0d4ae2fe1d6 Mon Sep 17 00:00:00 2001 From: Sinus Date: Sat, 5 Apr 2025 15:05:47 +0000 Subject: [PATCH 13/49] Update VRCSDK Patch info --- content/docs/vrchat/unity.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/content/docs/vrchat/unity.md b/content/docs/vrchat/unity.md index d2bdd1e..2128675 100644 --- a/content/docs/vrchat/unity.md +++ b/content/docs/vrchat/unity.md @@ -59,14 +59,20 @@ exec flatpak run com.unity.UnityHub "$@" --> ## World & Avatar SDK +Out of the box, Build & Test doesn't work, for both Avatars and Worlds. Thankfully, we maintain Linux-specific patches, which you can install with ALCOM like any other VCC package. -The VRChat Worlds SDK fails to build the assetbundle and Build and Test doesn't work for either SDK. +{{% hint info %}} + +**Note**: Try to install the latest VRCSDK and the latest LinuxVRChatSDKPatch. +But if you _must_ use VRCSDK version 3.7.5 and below, install LinuxVRChatSDKPatch version 0.0.4. + +{{% /hint %}} > ⚠️ **WARNING** \ > This modifies the VRChat SDK using [Harmony](https://github.com/pardeike/Harmony) to properly work on Linux. \ > This is directly against the VRChat Terms of Service. -Patches for both the Worlds and Avatars SDK are available: https://github.com/BefuddledLabs/LinuxVRChatSDKPatch ([VCC](https://befuddledlabs.github.io/LinuxVRChatSDKPatch/)) +These patches for both the Worlds and Avatars SDK are available through this [LinuxVRChatSDKPatch VCC page](https://befuddledlabs.github.io/LinuxVRChatSDKPatch/), or the [source on GitHub](https://github.com/BefuddledLabs/LinuxVRChatSDKPatch) ## Troubleshooting From 5468b2722e4ab7133c20317c2262d8b234e1270c Mon Sep 17 00:00:00 2001 From: bredo Date: Sat, 5 Apr 2025 14:37:41 +1300 Subject: [PATCH 14/49] resonite: add mention of Linux native build removal --- content/docs/resonite/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/resonite/_index.md b/content/docs/resonite/_index.md index 3dd1f3a..633b459 100644 --- a/content/docs/resonite/_index.md +++ b/content/docs/resonite/_index.md @@ -7,7 +7,7 @@ weight: 50 {{% hint info %}} -**Note**: The Linux-native version of Resonite, amid deprioritization of developer time to fix its numerous issues, was put on indefinite hold in August 2024. This document only covers running under Proton. +**Note**: The Linux-native version of Resonite, amid deprioritization of developer time to fix its numerous issues, was put on indefinite hold in August 2024 and later removed in March 2025. This document only covers running under Proton. {{% /hint %}} From bc19750874ee9d220de049efc6008856897b63dc Mon Sep 17 00:00:00 2001 From: bredo Date: Sat, 5 Apr 2025 14:38:21 +1300 Subject: [PATCH 15/49] resonite: remove mention of linux binary download Steam will now automatically use compatibility tools for Resonite post removal of the Linux native build --- content/docs/resonite/_index.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/content/docs/resonite/_index.md b/content/docs/resonite/_index.md index 633b459..e49601c 100644 --- a/content/docs/resonite/_index.md +++ b/content/docs/resonite/_index.md @@ -11,14 +11,6 @@ weight: 50 {{% /hint %}} -{{% hint warning %}} - -Despite the above deprecation, Steam will still download the native Linux binary by default. - -Make sure you have a compatibility tool selected (e.g. GE-Proton-RTSP) before launching Resonite. - -{{% /hint %}} - The current recommended Proton variant is [**GE-Proton-RTSP**](https://github.com/SpookySkeletons/proton-ge-rtsp/releases). [OpenComposite](https://lvra.gitlab.io/docs/fossvr/opencomposite/) should now provide a close-to-flawless experience on most controllers and when using hand tracking. From ae3dc5372c3d277b0a6c5e84bb6ff1a5f70efb08 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Tue, 8 Apr 2025 21:12:33 +0000 Subject: [PATCH 16/49] Add Monado display troubleshooting --- content/docs/fossvr/monado/_index.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/content/docs/fossvr/monado/_index.md b/content/docs/fossvr/monado/_index.md index 737a817..70dfbbf 100644 --- a/content/docs/fossvr/monado/_index.md +++ b/content/docs/fossvr/monado/_index.md @@ -35,4 +35,16 @@ OpenComposite is REQUIRED to operate Monado in conjunction with Steam games. Pro ## Envision -[Envision](/docs/fossvr/envision/) provides a fairly low-barrier setup and development of both Monado and OpenComposite on most any modern distro. \ No newline at end of file +[Envision](/docs/fossvr/envision/) provides a fairly low-barrier setup and development of both Monado and OpenComposite on most any modern distro. + +# Troubleshooting + +## [NVIDIA-specific] "NVIDIA: No allowlisted displays found!" + +This may be caused by a few different issues: + - NVIDIA driver misnaming the display: If you see a display simply named "NVIDIA" in the output, the NVIDIA driver may be using a fallback name. + This can be worked around by setting the environment variable `XRT_COMPOSITOR_FORCE_NVIDIA_DISPLAY="NVIDIA"`. + - HMD display completely missing from the list: Try unplugging and replugging the power adapter. + +## "vkAcquireXlibDisplayEXT: VK_ERROR_UNKNOWN (0x000058b7a0764a80)" +Try unplugging and replugging the power adapter. \ No newline at end of file From a1bc2b0ad62f956bf64416eb0f5ad8fff8f50e55 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Thu, 10 Apr 2025 18:23:49 -0500 Subject: [PATCH 17/49] fossvr/wivrn: Add SlimeVR section --- content/docs/fossvr/wivrn/_index.md | 38 +++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index e86ea62..4ad3376 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -68,6 +68,44 @@ Manual steps: adb shell am start -a android.intent.action.VIEW -d "wivrn+tcp://127.0.0.1" org.meumeu.wivrn ``` +## WiVRn + SlimeVR trackers + +To use SlimeVR trackers through WiVRn, you currently must use a [fork](https://github.com/notpeelz/WiVRn) of WiVRn: + +### Usage with Envision + +To use this fork within Envision, edit these fields in your profile: +- XR Service Repo: `https://github.com/notpeelz/WiVRn.git` +- XR Service Branch: `solarxr-patches` + +Then save and clean build the profile. + +### NixOS setup +Override the `wivrn` package from nixpkgs with something resembling the following, replacing `[COMMIT HASH HERE]` with the latest commit hash from https://github.com/notpeelz/WiVRn/commits/solarxr-patches and filling in the correct src hash. Do note you may need to adapt this depending on how you install WiVRn: +```nix +{ pkgs, lib, ... }: + +{ + services.wivrn = { + enable = true; + defaultRuntime = true; + package = pkgs.wivrn.overrideAttrs (old: rec { + version = "[COMMIT HASH HERE]"; + src = lib.fetchFromGitHub { + owner = "notpeelz"; + repo = "WiVRn"; + rev = version; + # This will throw an error when evaluating and give you the correct hash - put that here + hash = ""; + }; + cmakeFlags = old.cmakeFlags ++ [ + (lib.cmakeBool "WIVRN_FEATURE_SOLARXR" true) + ]; + }); + }; +} +``` + ## WiVRn + Lighthouse driver This section covers using WiVRn with any Lighthouse-tracked device: Index/Vive controllers, Vive/Tundra trackers, etc. From 3a5d7721278b0851883e3e28931159a61aabd882 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Thu, 10 Apr 2025 19:02:31 -0500 Subject: [PATCH 18/49] fossvr/wivrn: Add NixOS instructions for lighthouse usage --- content/docs/fossvr/wivrn/_index.md | 34 +++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index 4ad3376..7e03540 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -108,13 +108,12 @@ Override the `wivrn` package from nixpkgs with something resembling the followin ## WiVRn + Lighthouse driver -This section covers using WiVRn with any Lighthouse-tracked device: Index/Vive controllers, Vive/Tundra trackers, etc. - -WiVRn version: 0.19+ +This section covers using WiVRn 0.19 and newer with any Lighthouse-tracked device (such as Index/Vive controllers, Vive/Tundra trackers, etc.) You must have SteamVR installed (no need to run it). -In Envision, set WiVRn Profile as such: +### Envision +Set WiVRn Profile as such: - XR Service CMake Flags: - `WIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON` - Environment Variables: @@ -123,14 +122,31 @@ In Envision, set WiVRn Profile as such: Perform a **Clean Build** after changing the CMake flags! -If not using Envision, simply pass `-DWIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON` to CMake and export the above environment variables before starting `wivrn-server`. +### NixOS +Override the `wivrn` package: +```nix +{ + services.wivrn = { + enable = true; + defaultRuntime = true; + package = pkgs.wivrn.overrideAttrs (old: { + cmakeFlags = old.cmakeFlags ++ [ + (lib.cmakeBool "WIVRN_FEATURE_STEAMVR_LIGHTHOUSE" true) + ]; + }); + }; +} +``` + +### Manual +Simply pass `-DWIVRN_FEATURE_STEAMVR_LIGHTHOUSE=ON` to CMake and export the above environment variables before starting `wivrn-server`. + +### Usage tips + +Discovery happens only on first connection, so be sure to **have all Lighthouse devices powered on and in line-of-sight of your base stations before connecting the headset!** Once a device is discovered, you may power it off and on at-will. You can use [Motoc](/docs/fossvr/motoc/) to calibrate the two tracking technologies to work together. -Discovery happens only on first connection, so be sure to **have all Lighthouse devices powered on and in line-of-sight of your base stations before connecting the headset!** - -Once a device is discovered, you may power it off and on at-will. - Once video appears in the headset, check `motoc monitor` to make sure your devices all show up. If one or more devices are missing, try: From 6132a72444bc970789f7805a6d5bd61bc9783743 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Thu, 10 Apr 2025 21:09:06 -0500 Subject: [PATCH 19/49] fossvr/wivrn: Add env vars for NixOS lighthouse setup --- content/docs/fossvr/wivrn/_index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index 7e03540..a03909c 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -123,7 +123,7 @@ Set WiVRn Profile as such: Perform a **Clean Build** after changing the CMake flags! ### NixOS -Override the `wivrn` package: +Override the `wivrn` package and launch wivrn-server with the required environment variables: ```nix { services.wivrn = { @@ -134,6 +134,10 @@ Override the `wivrn` package: (lib.cmakeBool "WIVRN_FEATURE_STEAMVR_LIGHTHOUSE" true) ]; }); + monadoEnvironment = { + WIVRN_USE_STEAMVR_LH = "1"; + LH_DISCOVER_WAIT_MS = "6000"; + }; }; } ``` From 524ea9ee271df386787c0fc0d1935a21e0daba8f Mon Sep 17 00:00:00 2001 From: Mhowser Date: Mon, 14 Apr 2025 17:44:24 +0000 Subject: [PATCH 20/49] Envision: Warn NixOS users --- content/docs/fossvr/envision/_index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/docs/fossvr/envision/_index.md b/content/docs/fossvr/envision/_index.md index 4c84684..54c38b0 100644 --- a/content/docs/fossvr/envision/_index.md +++ b/content/docs/fossvr/envision/_index.md @@ -15,12 +15,16 @@ Envision is a graphical app that acts as an orchestrator to get a full [Monado]( Envision attempts to construct a working runtime with both a native OpenXR and an OpenVR API, provided by [OpenComposite](/docs/fossvr/opencomposite/), for client aplications to utilize. Please note the OpenVR implementation is incomplete and contains only what's necessary to run most games for compatibility. If you plan to implement software, utilize the OpenXR API, specification [here](https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html). -{{% hint danger %}} +{{% hint warning %}} **Warning** Envision is still considered alpha-quality and highly experimental. {{% /hint %}} +{{% hint danger %}} +We recommend **against** using Envision if your distro is NixOS. See [our NixOS page](/docs/distros/nixos/#envision) for more info. +{{% /hint %}} + You can download the latest AppImage snapshot from [GitLab Pipelines](https://gitlab.com/gabmus/envision/-/pipelines?ref=main&status=success). If you are on Arch, You can use the [AUR package](https://aur.archlinux.org/packages/envision-xr-git) `envision-xr-git` From 9a7a5cb6bac8e496000084919e0635c86e42ed82 Mon Sep 17 00:00:00 2001 From: "Romain D." Date: Fri, 21 Feb 2025 12:46:54 +0000 Subject: [PATCH 21/49] SlimeVR: add SolarXR instructions for WiVRn --- content/docs/slimevr/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/docs/slimevr/_index.md b/content/docs/slimevr/_index.md index fae1497..d7615d2 100644 --- a/content/docs/slimevr/_index.md +++ b/content/docs/slimevr/_index.md @@ -64,6 +64,8 @@ To use this method, you need to use SlimeVR v0.14.0 or newer and if not availabl For Monado, you need compile this fork: `https://gitlab.freedesktop.org/rcelyte/monado.git`, branch `solarxr-integration`. You can easily build Monado from this specific branch via [Envision](../fossvr/envision/), by modifying "XR Service Repo" and "XR Service Branch" in your build profile accordingly. +For WiVRn, you need to compile this fork: `https://github.com/notpeelz/WiVRn.git`, branch `solarxr-patches`. You also need the `WIVRN_FEATURE_SOLARXR` CMake flag set to `ON`. + **Important**: Make sure to launch SlimeVR first before launching Monado/Envision. **Important note #1**: Do not stop the SlimeVR server during operation, as driver and tracker hot-plugging are not yet supported. From 62e4e41a726d72176014cf4fa7c12bfb6098b6df Mon Sep 17 00:00:00 2001 From: Lennart Kroll <11020083-lkroll@users.noreply.gitlab.com> Date: Fri, 11 Apr 2025 17:48:13 +0200 Subject: [PATCH 22/49] Add specific information for Void Linux --- content/docs/distros/Void_Linux.md | 38 ++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 content/docs/distros/Void_Linux.md diff --git a/content/docs/distros/Void_Linux.md b/content/docs/distros/Void_Linux.md new file mode 100644 index 0000000..4e5f6bc --- /dev/null +++ b/content/docs/distros/Void_Linux.md @@ -0,0 +1,38 @@ +--- +title: Void Linux +--- + +# Void Linux + +## Envision + +The [official Appimage](https://gitlab.com/gabmus/envision#download-envision) is the easiest way to get Envision working on Void Linux. +Just make sure you have all necessary dependencies installed for building your desired profile. +Envision will warn you if some are missing. +Except for OpenXR these are standard packages which can be found in the Void repositories, you may need `-devel` for some packages like `libbsd-devel` for example. +Getting OpenXR can be a bit tricky, but you can follow the instructions for installing OpenXR on this page to get you started. + +## Installing OpenXR + +As of writing (April 2025) OpenXR is not available in the Void Linux repositories, you can however build and install it yourself using `xbps-src`. +There is a pending PR over on the void-packages Github page: https://github.com/void-linux/void-packages/pull/54896. + +In the meantime you can use the OpenXR template from the PR to build and install OpenXR locally. +Just clone the void-packages repo with the OpenXR template and install using the following steps from within the root dir: + +```bash +./xbps-src binary-bootstrap +./xbps-src pkg openxr +xi openxr openxr-devel +``` + +## Building Monado + +Monado may appear to build fine but if you are missing some dependencies only the null compositor will work. +To make a successful build make sure you have the following dependencies installed: + +```bash +sudo xbps-install pkg-config python3 wayland-devel glslang vulkan-loader-devel libglvnd-devel eigen libusb-devel eudev-libudev-devel v4l-utils-devel libxcb-devel wayland-devel libX11-devel hidapi-devel libopencv-devel libjpeg-turbo-devel libbluetooth-devel SDL2-devel cJSON-devel gstreamer1-devel gst-plugins-base1-devel +``` + +There is another [PR](https://github.com/void-linux/void-packages/pull/53279) with templates for xrgears, Monado and libsurvive that you can use, however it is easier and recommended to just use Envision to build everything for you. From ec854e370f4bad754cec1c06c08c5581d053b814 Mon Sep 17 00:00:00 2001 From: stella Date: Mon, 14 Apr 2025 18:18:54 +0000 Subject: [PATCH 23/49] Add troubleshooting step for Valve Index microphone --- content/docs/hardware/_index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index 351a1ac..24e4c5d 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -97,6 +97,7 @@ A non-comprehensive table of various VR/XR devices and the drivers that support - **Vive Pro** creates HDMI Output Source after startup of SteamVR/Monado/etc. Use it instead of Vive Pro USB Audio Source, since the audio might appear distorted. - **Valve Index** audio output should be set to 48khz or no audio will output. - **Valve Index** may bug out once per boot, resulting in VR refusing to start, or your DE seeing it as a normal monitor. Just unplug and replug the barrel connector that provides power to the HMD. +- **Valve Index** may also exhibit unexpected activity with its microphone. If the microphone doesn't transmit at all during regular VR use, consider changing the DisplayPort slot the headset is currently plugged into. Also, as a reminder, the Index mic only works if the headset is actively being used to display something. - **Vive Pro Eye** HMD functional, eyechip WIP. - **Pimax** initialization code WIP. Distortion matrix dump work in progress. - Eyetrack VR and Project Babble will both be implemented through [oscavmgr](https://github.com/galister/oscavmgr) to emit proper unified flexes over OSC. From 515dbf8d0af1fa183ce1302a5b9be038686612fa Mon Sep 17 00:00:00 2001 From: Sapphire Date: Mon, 21 Apr 2025 08:54:52 -0500 Subject: [PATCH 24/49] fossvr/opencomposite: Add non-tracker-device-as-tracker section --- content/docs/fossvr/opencomposite/_index.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/content/docs/fossvr/opencomposite/_index.md b/content/docs/fossvr/opencomposite/_index.md index 28d468c..70d1164 100644 --- a/content/docs/fossvr/opencomposite/_index.md +++ b/content/docs/fossvr/opencomposite/_index.md @@ -17,7 +17,21 @@ OpenComposite is required for Steam Play games to work in VR regardless of API. Contributions to improve the OpenVR to OpenXR mapping are welcome. -## Rebinding Controls +## Forcing additional devices as trackers + +OpenComposite has the environment variable `OPENCOMPOSITE_TRACKER_SERIALS` to allow using non-tracker devices as trackers in SteamVR games. The expected format is as follows: `serial1;serial2` where each 'serial' is a device serial like `LHR-00000000` or `WiVRn HMD`. You can set this on games by setting this launch option in Steam: `env OPENCOMPOSITE_TRACKER_SERIALS="LHR-00000001;LHR-00000002" %command%`. + +To obtain info for lighthouse devices, you may look at the top of the Monado stdout when using steamvr_lh. For other types of devices there are multiple ways of obtaining device serials: + +- OpenComposite log file + + The OpenComposite log file at `~/.local/state/OpenComposite/logs/opencomposite.log` will log all seen devices when checking for trackers, so you can search for `Checking for generic trackers...` in the log file and look below for `Found usable xdev`. + +- motoc + + motoc has the `show` subcommand for viewing all device names, serials, and positions relative to the space origin. + +## Rebinding controls > Changing OpenVR bindings is currently a very manual process. This will change in the future. From d6f6ea0e57cf32b34b3631554bde6b4f3b29efd9 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Tue, 22 Apr 2025 14:56:31 -0500 Subject: [PATCH 25/49] fossvr/monado: Recommend forcing Wayland direct mode on NVIDIA if acquiring display fails --- content/docs/fossvr/monado/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/fossvr/monado/_index.md b/content/docs/fossvr/monado/_index.md index 70dfbbf..36ce9da 100644 --- a/content/docs/fossvr/monado/_index.md +++ b/content/docs/fossvr/monado/_index.md @@ -47,4 +47,4 @@ This may be caused by a few different issues: - HMD display completely missing from the list: Try unplugging and replugging the power adapter. ## "vkAcquireXlibDisplayEXT: VK_ERROR_UNKNOWN (0x000058b7a0764a80)" -Try unplugging and replugging the power adapter. \ No newline at end of file +Try unplugging and replugging the power adapter. If the issue still occurs and you are on a Wayland session, try setting the environment variable `XRT_COMPOSITOR_FORCE_WAYLAND_DIRECT=1`. \ No newline at end of file From 1ed840500e659decb1b0a1ea0a299c4abe186e91 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Tue, 22 Apr 2025 14:50:31 -0500 Subject: [PATCH 26/49] fossvr/wivrn: Fix missing Envision CMake option step for SolarXR --- content/docs/fossvr/wivrn/_index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index a03909c..6a812bb 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -77,6 +77,7 @@ To use SlimeVR trackers through WiVRn, you currently must use a [fork](https://g To use this fork within Envision, edit these fields in your profile: - XR Service Repo: `https://github.com/notpeelz/WiVRn.git` - XR Service Branch: `solarxr-patches` +- XR Service CMake Flags: Add `WIVRN_FEATURE_SOLARXR=ON` Then save and clean build the profile. From e5276b5b705d0f738fd84856cfa18dedb8b3b795 Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Fri, 30 Aug 2024 02:00:39 +0000 Subject: [PATCH 27/49] VRChat EAC: Rewrite EAC startup errors are really rare now. Let's write the article in the past tense. --- content/docs/vrchat/eac.md | 40 +++++++++++++++++++++++++++++++++++--- 1 file changed, 37 insertions(+), 3 deletions(-) diff --git a/content/docs/vrchat/eac.md b/content/docs/vrchat/eac.md index 6e62018..3134650 100644 --- a/content/docs/vrchat/eac.md +++ b/content/docs/vrchat/eac.md @@ -5,26 +5,58 @@ title: Easy Anti-Cheat # Easy Anti-Cheat -Sometimes, seemingly randomly, you can get an EAC error during the VRChat startup/login screen. It looks like a message box, with the title "Anti-cheat Error", no actual message text, and a single button labeled "Quit". +Running VRChat on Linux *used to be* prone to unwarranted EAC errors. Sometimes, seemingly randomly, you would get an EAC error during the VRChat startup/login screen. It looks like a message box, with the title "Anti-cheat Error", a message referring to a filepath that failed to validate integrity, and a single button labeled "Quit". This would trigger even when all files were unmodified. -## Recommended Workaround +Thankfully, at some point in October or November 2024, **these EAC errors resolved themselves**. While it is still possible to get EAC errors for other reasons, the race condition that made it a coin-flip on startup no longer plagues us. + +If you are running into EAC errors still, try these options: +- Trigger a reinstall of the EAC runtime by moving the [Proton prefix for VRChat](https://www.pcgamingwiki.com/wiki/VRChat#Configuration_file.28s.29_location) somewhere else, forcing Steam to regenerate it on next launch +- Make sure you are not blocking the EAC domains, such as `modules-cdn.eac-prod.on.epicgames.com` +- Do not set `SDL_VIDEODRIVER` env var anywhere - this breaks the splash screen +- Do not use the `VR_OVERRIDE` env var + +The below workaround shouldn't be necessary anymore, but is kept here in case the issue comes back someday. + +## Workaround Wrapper script for starting VRChat: [startvrc.sh on GitHub](https://gist.github.com/galister/ca63a5795694e4c839a8e7f4bb8a35bc) - Set startup options for VRChat: `/path/to/startvrc.sh %command%` If you're using extra env vars, they should go first: `PRESSURE_VESSEL_FILESYSTEMS_RW=/run/user/1000/monado_comp_ipc /path/to/startvrc.sh %command%` + From 394497d81ee1d03babba0e3cceef77de643a0ca6 Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Fri, 25 Apr 2025 18:47:52 -0500 Subject: [PATCH 28/49] CI: Ignore PCGamingWiki --- .htmltest.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.htmltest.yml b/.htmltest.yml index d4f1be6..894e641 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -8,6 +8,8 @@ IgnoreURLs: # For "Edit this page" and "Last modified by": - "https://gitlab.com/lvra/lvra.gitlab.io/-/edit" - "https://gitlab.com/lvra/lvra.gitlab.io/-/commit" +# Uses Cloudflare to block bots: +- "https://www.pcgamingwiki.com/" # IgnoreDirs: # - "lib" CacheExpires: "6h" From 1b85369fd8c8fa28c4aae86cd85864ed06eacf73 Mon Sep 17 00:00:00 2001 From: DeltaNeverUsed Date: Mon, 28 Apr 2025 11:13:26 +0200 Subject: [PATCH 29/49] feat: add VRCFaceTracking.Avalonia as an alternative option to OscAvMgr --- content/docs/hardware/_index.md | 4 ++-- content/docs/vrchat/facetracking.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index 24e4c5d..cf4bf53 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -82,8 +82,8 @@ A non-comprehensive table of various VR/XR devices and the drivers that support | **Trackers** | | | | | Vive/Tundra trackers | ✅ (native or spacecal) | ✅ (native or motoc) | ✅ (motoc) | | SlimeVR trackers | ✅ | ✅ (OSC + experimental driver) | ✅ | -| Project Babble | ✅ (oscavmgr) | ✅ (oscavmgr) | ✅ (oscavmgr) | -| Eyetrack VR | ✅ (oscavmgr) | ✅ (oscavmgr) | ✅ (oscavmgr) | +| Project Babble | ✅ ([OscAvMgr](https://github.com/galister/oscavmgr) or [VRCFT.Avalonia](https://github.com/dfgHiatus/VRCFaceTracking.Avalonia)) | ✅ ([OscAvMgr](https://github.com/galister/oscavmgr) or [VRCFT.Avalonia](https://github.com/dfgHiatus/VRCFaceTracking.Avalonia)) | ✅ ([OscAvMgr](https://github.com/galister/oscavmgr) or [VRCFT.Avalonia](https://github.com/dfgHiatus/VRCFaceTracking.Avalonia)) | +| Eyetrack VR | ✅ ([OscAvMgr](https://github.com/galister/oscavmgr) or [VRCFT.Avalonia](https://github.com/dfgHiatus/VRCFaceTracking.Avalonia)) | ✅ ([OscAvMgr](https://github.com/galister/oscavmgr) or [VRCFT.Avalonia](https://github.com/dfgHiatus/VRCFaceTracking.Avalonia)) | ✅ ([OscAvMgr](https://github.com/galister/oscavmgr) or [VRCFT.Avalonia](https://github.com/dfgHiatus/VRCFaceTracking.Avalonia)) | | Mercury Handtrack | 🚧 (Monado SteamVR plugin, win only) | ✅ (survive driver only) | ❌ | | Ultraleap v1 | ? | ✅ (with `openxr-layer-ultraleap`) | ? | | Lucid VR Gloves | ? | ✅ (survive driver only) | ❌ | diff --git a/content/docs/vrchat/facetracking.md b/content/docs/vrchat/facetracking.md index 71f07a7..f75ef8d 100644 --- a/content/docs/vrchat/facetracking.md +++ b/content/docs/vrchat/facetracking.md @@ -5,4 +5,4 @@ title: Face & Eye Tracking # Face & Eye Tracking -If you have a face and/or eye tracking solution and want to use it for social vr, one option is to use [OscAvMgr](https://github.com/galister/oscavmgr), which fills the same role as VRCFT does on Windows. \ No newline at end of file +If you have a face and/or eye tracking solution and want to use it for social vr, one option is to use [OscAvMgr](https://github.com/galister/oscavmgr). Another alternative is the cross-platform port of VRCFT, [VRCFaceTracking.Avalonia](https://github.com/dfgHiatus/VRCFaceTracking.Avalonia). \ No newline at end of file From 26d8780e2568bdb581c9f0024001400d08e7b814 Mon Sep 17 00:00:00 2001 From: Alicja Michalska Date: Sat, 26 Apr 2025 07:55:55 +0200 Subject: [PATCH 30/49] docs/wmr_controllers: Add warning about firmware --- content/docs/fossvr/envision/wmr_controllers_on_arch.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/docs/fossvr/envision/wmr_controllers_on_arch.md b/content/docs/fossvr/envision/wmr_controllers_on_arch.md index 6d9aff9..bb9cdf4 100644 --- a/content/docs/fossvr/envision/wmr_controllers_on_arch.md +++ b/content/docs/fossvr/envision/wmr_controllers_on_arch.md @@ -67,3 +67,12 @@ paru -S envision-xr-git - Leave Monado open. - Start the new game. - Always turn on the controllers **before** starting Envision. + +- Update controller firmware while running Windows. It's necessary for controllers to work in Linux, updating them from Linux is currently impossible. +- Make sure that you **don't factory-reset the controllers** (performed by long-pressing the pairing button when controllers are off). This action restores the factory firmware version. +- If monado fails to start with the following error, you likely need to update the firmware in Mixed Reality Portal: + ``` + WARN [wmr_controller_send_fw_cmd] Controller fw read timed out after 250 ms + ERROR [wmr_bt_controller_create] WMR Controller (Bluetooth): Failed to create controller + ERROR [wmr_create_bt_controller] Failed to create WMR controller (Bluetooth) + ``` \ No newline at end of file From 6c9d7d9a67bc1189286b91c4f473e80647241476 Mon Sep 17 00:00:00 2001 From: hypevhs <4498312-hypevhs@users.noreply.gitlab.com> Date: Thu, 1 May 2025 22:00:39 -0500 Subject: [PATCH 31/49] OpenSUSE: SteamVR needs setcap --- content/docs/distros/OpenSUSE_Tumbleweed.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/content/docs/distros/OpenSUSE_Tumbleweed.md b/content/docs/distros/OpenSUSE_Tumbleweed.md index b0a4528..cf48886 100644 --- a/content/docs/distros/OpenSUSE_Tumbleweed.md +++ b/content/docs/distros/OpenSUSE_Tumbleweed.md @@ -8,4 +8,17 @@ title: OpenSUSE Tumbleweed - The OpenXR SDK package can be found in the [hardware:xr](https://build.opensuse.org/package/show/hardware:xr/OpenXR-SDK) [Open Build service](https://en.opensuse.org/openSUSE:Build_Service_FAQ) project. To build [Envision](/docs/fossvr/envision/) profiles, the devel package will also have to be installed. - The set of [Monado Vulkan Layers](/docs/hardware/) is provided by a [community package](https://build.opensuse.org/package/show/home:Etch-9:xr/monado-vulkan-layers-git). -Any other package in hardware:xr is really outdated and should not be used. Additional information on third-party repositories can be found here: [Additional package repositories (opensuse.org)](https://en.opensuse.org/Additional_package_repositories) \ No newline at end of file +Any other package in hardware:xr is really outdated and should not be used. Additional information on third-party repositories can be found here: [Additional package repositories (opensuse.org)](https://en.opensuse.org/Additional_package_repositories) + +## SteamVR + +SteamVR may give you a "SteamVR setup is incomplete" error on OpenSUSE Tumbleweed. +This happens because SteamVR needs to run the `setcap`/`getcap` programs, but can't find them. + +To fix it, run these commands: + +```sh +sudo zypper install libcap-progs +sudo ln -s /sbin/getcap /usr/bin/ +sudo ln -s /sbin/setcap /usr/bin/ +``` \ No newline at end of file From 2f2d97a3eb82f4a6866664ddbec5c75e89d4550a Mon Sep 17 00:00:00 2001 From: xytovl Date: Tue, 6 May 2025 08:03:18 +0000 Subject: [PATCH 32/49] Update WiVRn install recommendation --- content/docs/fossvr/wivrn/_index.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index 6a812bb..c4bd957 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -15,9 +15,26 @@ WiVRn is based on [Monado](/docs/fossvr/monado/) and can be used with [OpenCompo ## Installing WiVRn -We recommend using [Envision](/docs/fossvr/envision/) to install and launch WiVRn & OpenComposite. Envision will handle all configuration seamlessly and avoids many of the pitfalls of a manual setup. +We recommend using distribution packages when available or the [WiVRn Flatpak](https://flathub.org/apps/io.github.wivrn.wivrn). -Alternatively, you can use the [WiVRn Flatpak](https://flathub.org/apps/io.github.wivrn.wivrn) which includes OpenComposite as part of it. Processes in Flatpak cannot take advantage of setcap, and so your performance may suffer when compared to Envision. +### Arch Linux + +Packages are available on [AUR](https://wiki.archlinux.org/title/Arch_User_Repository), you will need the following packages: + +* `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 + +### Gentoo Linux + +Packages are available on [Guru](https://wiki.gentoo.org/wiki/Project:GURU), you will need `media-libs/wivrn` and `media-libs/opencomposite` + +### 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 + +### Envision (guided build) + +You can use [Envision](/docs/fossvr/envision/) to install and launch WiVRn & OpenComposite. ## General WiVRn Notes @@ -25,7 +42,7 @@ WiVRn uses Avahi for network discovery. Ensure it is running with the following ```bash systemctl enable --now avahi-daemon ``` -(If Avahi is not available, 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. @@ -52,8 +69,6 @@ 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. -WiVRn version: 0.19+ - Using Envision: - Connect the headset via USB. - In Envision, click the `Start WiVRn Client (Wired)` button. From 2df747a604c0f590be41ad58ca1b1871f4cf3672 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Tue, 6 May 2025 03:36:09 -0500 Subject: [PATCH 33/49] wivrn: Add more distro packages, revise wired connection section, minor other edits --- content/docs/fossvr/wivrn/_index.md | 48 +++++++++++++++++++---------- 1 file changed, 31 insertions(+), 17 deletions(-) diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index c4bd957..67832aa 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -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 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 -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 @@ -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 * `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 -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) -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) -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 @@ -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 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. 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: ```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. -Using Envision: +- Install adb on your system - usually the package is named `android-tools` or something similar. - Connect the headset via USB. -- In Envision, click the `Start WiVRn Client (Wired)` button. - - If it's not there, you may need to update Envision. +- Run `adb devices` in your terminal. +- 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: -- Connect the headset via USB. -- 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: - ```bash - 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 - ``` +Using the dashboard: +- The 'Connect via USB' button under the pairing toggle should have a list of devices - select any one to initiate a wired connection. + +Using Envision: +- Click the `Start WiVRn Client (Wired)` button in Envision. + +Manual steps: See the [README](https://github.com/WiVRn/WiVRn/blob/master/README.md?plain=1#L114). ## WiVRn + SlimeVR trackers From 97cf4665184d55774c5c2a05fcf7acd27662a62f Mon Sep 17 00:00:00 2001 From: Sapphire Date: Tue, 6 May 2025 04:07:24 -0500 Subject: [PATCH 34/49] Add xrizer wiki page --- content/docs/fossvr/_index.md | 2 +- content/docs/fossvr/wivrn/_index.md | 2 +- content/docs/fossvr/xrizer.md | 58 +++++++++++++++++++++++++++++ 3 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 content/docs/fossvr/xrizer.md diff --git a/content/docs/fossvr/_index.md b/content/docs/fossvr/_index.md index 33fefd2..2d04f97 100644 --- a/content/docs/fossvr/_index.md +++ b/content/docs/fossvr/_index.md @@ -12,7 +12,7 @@ If you want an alternative to SteamVR, there are a few options you can use, depe In either case, here are some related projects you might want to check out: -- [OpenComposite](/docs/fossvr/opencomposite/) allows you to run OpenVR games +- [xrizer](/docs/fossvr/xrizer/) and [OpenComposite](/docs/fossvr/opencomposite/) allow you to run OpenVR games - [Envision](/docs/fossvr/envision/) is a GUI to setup and run either Monado or WiVRn - [Stardust XR](/docs/fossvr/stardust/) is an XR environment to run 2D and (eventually) 3D apps - [WlxOverlay-S](/docs/fossvr/wlxoverlay-s/) is an overlay to access your desktop from VR + playspace mover diff --git a/content/docs/fossvr/wivrn/_index.md b/content/docs/fossvr/wivrn/_index.md index 67832aa..9079c1b 100644 --- a/content/docs/fossvr/wivrn/_index.md +++ b/content/docs/fossvr/wivrn/_index.md @@ -11,7 +11,7 @@ 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 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. +WiVRn is based on [Monado](/docs/fossvr/monado/) and can be used with [xrizer](/docs/fossvr/xrizer/) or [OpenComposite](/docs/fossvr/opencomposite/) to support a majority of titles available for SteamVR. A wide range of standalone headsets are supported. ## Installing WiVRn diff --git a/content/docs/fossvr/xrizer.md b/content/docs/fossvr/xrizer.md new file mode 100644 index 0000000..ebfce00 --- /dev/null +++ b/content/docs/fossvr/xrizer.md @@ -0,0 +1,58 @@ +--- +weight: 300 +title: xrizer +--- + +# xrizer +- [xrizer Git repository](https://github.com/Supreeeme/xrizer) + +> xrizer is a reimplementation of OpenVR on top of OpenXR. This enables you to run OpenVR games through any OpenXR runtime without running SteamVR. + +{{% hint warning %}} +**Application developers**: The OpenVR implementation is incomplete and contains only what's necessary to run most games for compatibility and may omit certain information - if you plan to implement software, utilize the [OpenXR API](https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html). +{{% /hint %}} + +## Using full body trackers + +{{% hint warning %}} +**This branch is a work-in-progress!** Unexpected problems may occur while in use, if you encounter issues while using this fork you should not report it upstream unless reproducible on the `main` branch of xrizer. + +If you would like a battle-tested solution, see [OpenComposite](/docs/fossvr/opencomposite/). +{{% /hint %}} + +Currently xrizer does not support full body tracking, however there is a **work-in-progress** [fork by RinLovesYou](https://github.com/RinLovesYou/xrizer/tree/experimental2) with support while using Monado. + +To use the above fork, follow these steps: + +### Envision +- Click the three dots next to the profile selector and select 'Edit profile' +- If a popup asks if you would like to duplicate the profile, click yes. +- Scroll down to 'OpenVR Compatibility' and set the following fields: + - OpenVR Compatibility Repo: `https://github.com/RinLovesYou/xrizer.git` + - OpenVR Compatibility Branch: `experimental2` +- Clean build your profile from the menu at the top right, or use the Ctrl+F5 keybind. + +### NixOS +Apply an overlay over nixpkgs to override the xrizer src: + +```nix +{ + nixpkgs.overlays = [ + (final: prev: { + xrizer = prev.xrizer.overrideAttrs { + src = final.fetchFromGitHub { + owner = "RinLovesYou"; + repo = "xrizer"; + # IMPORTANT: Fill the below field with the latest commit hash from https://github.com/RinLovesYou/xrizer/commits/experimental2 (click the Copy full SHA button on the right side) + rev = ""; + # IMPORTANT: Replace the below field with the correct hash, the error when building with this empty will give you the expected hash. + hash = ""; + }; + }; + }) + ]; +} +``` + +## Rebinding controls +The process is mostly the same as [OpenComposite](/docs/fossvr/opencomposite/#rebinding-controls), but replace the `OpenComposite` directory name with `xrizer`. From 0a7882de8c717fd04b19f451e8cda2faf820c83c Mon Sep 17 00:00:00 2001 From: Aleksandar Dimitrov Date: Tue, 6 May 2025 14:22:30 +0000 Subject: [PATCH 35/49] Edit Pimax headsets to mention AMD GPUs only --- content/docs/hardware/_index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index cf4bf53..c3d863e 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -49,13 +49,13 @@ A non-comprehensive table of various VR/XR devices and the drivers that support | Varjo VR-1 | ? | ? | ? | | Varjo VR-2 | ? | ? | ? | | Varjo VR-3 | ? | ? | ? | -| Pimax 4K | ❌ (Planned) | 🚧 (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch)) | 🚧 (WiVRn PC-PC stream) | -| Pimax 5K Plus | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch)) | 🚧 (WiVRn PC-PC stream) | -| Pimax 5K XR | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch)) | 🚧 (WiVRn PC-PC stream) | -| Pimax 5K SUPER | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch)) | 🚧 (WiVRn PC-PC stream) | -| Pimax 8K | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch)) | 🚧 (WiVRn PC-PC stream) | -| Pimax Vision 8K X | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch)) | 🚧 (WiVRn PC-PC stream) | -| Pimax Vision 8K PLUS | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch)) | 🚧 (WiVRn PC-PC stream) | +| Pimax 4K | ❌ (Planned) | 🚧 (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch), AMD GPUs only.) | 🚧 (WiVRn PC-PC stream) | +| Pimax 5K Plus | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch), AMD GPUs only.) | 🚧 (WiVRn PC-PC stream) | +| Pimax 5K XR | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch), AMD GPUs only.) | 🚧 (WiVRn PC-PC stream) | +| Pimax 5K SUPER | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch), AMD GPUs only.) | 🚧 (WiVRn PC-PC stream) | +| Pimax 8K | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch), AMD GPUs only.) | 🚧 (WiVRn PC-PC stream) | +| Pimax Vision 8K X | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch), AMD GPUs only.) | 🚧 (WiVRn PC-PC stream) | +| Pimax Vision 8K PLUS | ❌ (Planned) | ✅ (WIP, with [kernel patches](https://gist.githubusercontent.com/TayouVR/60e3ee5f95375827a66a8898bea02bec/raw/c85135c8d8821ebb2fa85629d837a41de57e12ef/pimax.patch), AMD GPUs only.) | 🚧 (WiVRn PC-PC stream) | | Lenovo Explorer | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | | Acer AH101 | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | | Dell Visor | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | From 76358ac97e38e76f476b63293574fd4b26d878dc Mon Sep 17 00:00:00 2001 From: notfranko_ Date: Tue, 6 May 2025 18:31:24 +0300 Subject: [PATCH 36/49] Edit Vive Pro Eye as fully supported Add ReVision link in hardware note --- content/docs/hardware/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index c3d863e..b42d76e 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -40,7 +40,7 @@ A non-comprehensive table of various VR/XR devices and the drivers that support | Valve Index | ✅ | ✅ | 🚧 (WiVRn PC-PC stream) | | HTC Vive | ✅ | ✅ | 🚧 (WiVRn PC-PC stream) | | HTC Vive Pro | ✅ | ✅ | 🚧 (WiVRn PC-PC stream) | -| HTC Vive Pro Eye | ✅ (No eyechip) | ✅ (No eyechip) | 🚧 (WiVRn PC-PC stream) | +| HTC Vive Pro Eye | ✅ | ✅ | 🚧 (WiVRn PC-PC stream) | | HTC Vive Pro 2 | ✅ (custom [driver and patches](https://github.com/CertainLach/VivePro2-Linux-Driver)) | ✅ (With two kernel patches [1](https://github.com/CertainLach/VivePro2-Linux-Driver/blob/master/kernel-patches/0002-drm-edid-parse-DRM-VESA-dsc-bpp-target.patch) [2](https://github.com/CertainLach/VivePro2-Linux-Driver/blob/master/kernel-patches/0003-drm-amd-use-fixed-dsc-bits-per-pixel-from-edid.patch), AMD GPUs only.) | -- | | Bigscreen Beyond | ✅ (with [kernel patch](https://gist.github.com/galister/08cddf10ac18929647d5fb6308df3e4b/raw/0f6417b6cb069f19d6c28b730499c07de06ec413/combined-bsb-6-10.patch), AMD GPUs only.) | ✅ (with [kernel patch](https://gist.github.com/galister/08cddf10ac18929647d5fb6308df3e4b/raw/0f6417b6cb069f19d6c28b730499c07de06ec413/combined-bsb-6-10.patch), AMD GPUs only.) | -- | | Somnium VR1 | ? | ? | ? | @@ -98,7 +98,7 @@ A non-comprehensive table of various VR/XR devices and the drivers that support - **Valve Index** audio output should be set to 48khz or no audio will output. - **Valve Index** may bug out once per boot, resulting in VR refusing to start, or your DE seeing it as a normal monitor. Just unplug and replug the barrel connector that provides power to the HMD. - **Valve Index** may also exhibit unexpected activity with its microphone. If the microphone doesn't transmit at all during regular VR use, consider changing the DisplayPort slot the headset is currently plugged into. Also, as a reminder, the Index mic only works if the headset is actively being used to display something. -- **Vive Pro Eye** HMD functional, eyechip WIP. +- **Vive Pro Eye** HMD functional, eye tracking functionality with [ReVision](https://github.com/Blue-Doggo/ReVision) - **Pimax** initialization code WIP. Distortion matrix dump work in progress. - Eyetrack VR and Project Babble will both be implemented through [oscavmgr](https://github.com/galister/oscavmgr) to emit proper unified flexes over OSC. - Tracking technologies can be mixed Monado/WiVRn by using [motoc](https://github.com/galister/motoc). From 4806289c3577dc59951d887d2bb17b4b978541d8 Mon Sep 17 00:00:00 2001 From: Bones Date: Tue, 6 May 2025 16:13:42 +0000 Subject: [PATCH 37/49] Adjust corectrl info --- content/docs/performance/_index.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/content/docs/performance/_index.md b/content/docs/performance/_index.md index 135deac..c7acae9 100644 --- a/content/docs/performance/_index.md +++ b/content/docs/performance/_index.md @@ -13,9 +13,7 @@ Antialiasing should be avoided when possible and the compositor scale should be AMD GPUs will attempt to power save in between rendering frames, for flatscreen games this is helpful, but for VR this is quite negatively impactful on the VR compositor's ability to timewarp frames so the user's viewport does not stutter or cause sickness. -This is very important to avoid stuttering, do not skip this step if you use AMD. - -You should add a kernel arg for `amdgpu` driven cards. Add `amdgpu.ppfeaturemask=0xffffffff` to your kernel args. [more info](https://gitlab.com/corectrl/corectrl/-/wikis/Setup#full-amd-gpu-controls) +This is step is modestly important to avoid stutter on newer kernels, if you experience stutters under large graphical load please attempt to set this up. ### The simple way: Use CoreCtrl @@ -32,6 +30,14 @@ If you limit yourself to setting the power profile you should be fine, but don't - Set Performance mode to Advanced - Set Power profile to VR +{{% hint danger %}} +Do note that corectrl version 1.4 was not able to separately adjust the GPU performance profile from the speeds. +Your GPU will downclock to absolute minimums after changing your power profile. +To set them back where they should be, adjust the core and memory sliders all the way to the right to obtain your default performance clocks. + +If they present as minimums and maximums in a vertical fashion leave them alone, you are fine. +{{% /hint %}} + ### Enable VR profile using a script ```bash From a7fc2c1016205a083d2170e444c9f41ba96d58a2 Mon Sep 17 00:00:00 2001 From: Bones Date: Tue, 6 May 2025 18:31:09 +0000 Subject: [PATCH 38/49] Warn Nvidia issued on wired headsets --- content/docs/hardware/_index.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index b42d76e..9595100 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -5,13 +5,15 @@ title: VR Gear & GPUs # Hardware - +{{% notice warning %}} +**NVIDIA WIRED VR ISSUES**: Nvidia proprietary drivers currently have a critical issue with DRM lease causing substantial presentation latency for wired VR headsets, resulting in a delayed viewport effect that makes VR uncomfortable. This affects all known driver versions. Wireless VR through WiVRn still works well. Users with Nvidia GPUs should consider wireless options or switching to AMD for the best experience. For details and to report your experience, see [this forum thread](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386). +{{% /notice %}} ## GPU support matrix | Manufacturer | Driver | VR Support | Reprojection Support | Hybrid Graphics Support | Notes | |--------------|---------------------------|----------------|--------------------------------|-------------------------------|----------------------------------------------------------------------------------------------| -| Nvidia | Nvidia (Closed Source) | Excellent | Excellent | Supported | Requires driver version 565 or greater | +| Nvidia | Nvidia (Closed Source) | ⚠️ Limited | ⚠️ Limited | Supported | Requires driver version 565 or greater. [Critical issue with DRM lease causing presentation latency](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386) makes wired VR uncomfortable. Primarily suitable for wireless VR (WiVRn) only. | | Nvidia | Nouveau (Open Source) | Functional | Functional | Supported | Lacks DisplayPort audio. | | Intel | i915 (Open Source) | Functional | Unknown | Supported | Relatively old, most likely poor support for newer GPUs. | Intel | Intel/Xe (Open Source) | No wired HMDs | N/A / Unable to drive wired. | Supported | Lacks direct mode implementation in driver, unable to drive wired HMDs. | @@ -24,6 +26,8 @@ title: VR Gear & GPUs - **Reprojection Support**: Describes the support and quality of reprojection features for VR. Poor support indicates that the driver is not able to properly handle Vulkan realtime shaders and it will present as visual stutter. Non-robust solutions will suffer stutter under very high GPU load. - **PRIME/ Hybrid GPU Support**: Compatibility with systems using multiple GPUs for render offload. Monado and all clients must be run on a single select GPU due to memory tiling requirements. - For Nvidia proprietary drivers *older* than 565, (please try to update!), the [vulkan-layers](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers) must be installed in order to not crash: [*AUR*](https://aur.archlinux.org/packages/monado-vulkan-layers-git)・[*Fedora*](https://packages.fedoraproject.org/pkgs/monado-vulkan-layers/monado-vulkan-layers/) +- **Nvidia Wired VR Workaround**: Some users report setting `U_PACING_COMP_MIN_TIME_MS` to approximately 10 can slightly reduce the latency effect with Nvidia GPUs, but this is only a partial mitigation, not a solution. +- Nvidia GPUs work well for wireless VR through WiVRn, but have significant issues with wired headsets until the DRM lease presentation latency issue is resolved. - AMD GPUs lower than RDNA generation have functional but less robust reprojection capabilities, expected to be similar to Intel. - Audio over displayport is known to temporarily cut out when new audio sources spring up on pipewire [without a fix to add alsa headroom](https://wiki.archlinux.org/title/PipeWire#Audio_cutting_out_when_multiple_streams_start_playing) - X11 configurations are discouraged but workable, please upgrade your system to Wayland if at all possible. @@ -32,7 +36,7 @@ title: VR Gear & GPUs ## XR Devices -A non-comprehensive table of various VR/XR devices and the drivers that support them. +A non-comprehensive table of various VR/XR devices and the drivers that support them. Note that wired headset experiences with Nvidia GPUs will be affected by the [DRM lease presentation latency issue](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386). | Device | [SteamVR](/docs/steamvr/) | [Monado](/docs/fossvr/monado/) | [WiVRn](/docs/fossvr/wivrn/) | |----------------------|:-------------------------------------:|:------------------------------:|:----------------------------:| @@ -92,6 +96,11 @@ A non-comprehensive table of various VR/XR devices and the drivers that support ## Hardware note +- **Nvidia GPU users**: Due to the DRM lease presentation latency issue, wired VR headsets will experience a delayed viewport effect on Nvidia GPUs. This affects all driver versions since 550. Consider these workarounds: + - Use WiVRn or ALVR with standalone headsets for wireless VR (recommended) + - Try setting `U_PACING_COMP_MIN_TIME_MS=10` as an environment variable to slightly reduce the effect + - Consider switching to AMD GPUs for the best wired VR experience + - Monitor the [bug report thread](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386) for updates - WiVRn PC XR to WiVRn PC client streaming remains mainly for debug use. - **Vive Pro** microphones should be set to use 44.1khz sample rates as feeding in 48khz raises the pitch of the audio. - **Vive Pro** creates HDMI Output Source after startup of SteamVR/Monado/etc. Use it instead of Vive Pro USB Audio Source, since the audio might appear distorted. From ce5d3462df826504fd89a1e218caeec93ae77c0d Mon Sep 17 00:00:00 2001 From: BabbleBones Date: Tue, 6 May 2025 15:36:18 -0400 Subject: [PATCH 39/49] Update GPU info --- content/docs/hardware/_index.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index 9595100..60c969e 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -13,13 +13,13 @@ title: VR Gear & GPUs | Manufacturer | Driver | VR Support | Reprojection Support | Hybrid Graphics Support | Notes | |--------------|---------------------------|----------------|--------------------------------|-------------------------------|----------------------------------------------------------------------------------------------| -| Nvidia | Nvidia (Closed Source) | ⚠️ Limited | ⚠️ Limited | Supported | Requires driver version 565 or greater. [Critical issue with DRM lease causing presentation latency](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386) makes wired VR uncomfortable. Primarily suitable for wireless VR (WiVRn) only. | -| Nvidia | Nouveau (Open Source) | Functional | Functional | Supported | Lacks DisplayPort audio. | -| Intel | i915 (Open Source) | Functional | Unknown | Supported | Relatively old, most likely poor support for newer GPUs. -| Intel | Intel/Xe (Open Source) | No wired HMDs | N/A / Unable to drive wired. | Supported | Lacks direct mode implementation in driver, unable to drive wired HMDs. | -| AMD | RADV (Open Source) | Excellent | Robust (RDNA+) | Supported | RDNA generation and up supported with compute tunneling for reprojection. Lower than RDNA are not robust. | -| AMD | AMDVLK (Open Source) | Use RADV | Use RADV | N/A | RADV preferred in all circumstances, unable to drive wired HMDs. Do not use. Do not seek support. | -| AMD | AMDGPU PRO (Closed Source)| Use RADV | Use RADV | N/A | RADV preferred in all circumstances, unable to drive wired HMDs. Do not use. Do not seek support. | +| Nvidia | Nvidia (Closed Source or Open Module) | ⚠️ Limited | ⚠️ Limited | ✅ Supported | Requires driver version 565+. [Critical DRM lease issue](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386) causes uncomfortable latency in wired VR. Best used with wireless solutions (WiVRn). | +| Nvidia | Nouveau (Open Source) | ⚠️ Limited | ❌ Not Viable | ✅ Supported | Cannot reproject due to lack of realtime compute shader support needed by Monado. Lacks DisplayPort audio. Not recommended for VR. | +| AMD | RADV (Open Source) | ✅ Excellent | ✅ Robust (RDNA+) | ✅ Supported | Recommended for wired VR. RDNA generation and newer supported with compute tunneling for reprojection. Pre-RDNA GPUs have functional but less robust reprojection. | +| AMD | AMDVLK (Open Source) | ❌ Not Viable | ❌ Not Viable | ❌ N/A | RADV preferred in all circumstances. Unable to drive wired HMDs. Do not use. Do not seek support. | +| AMD | AMDGPU PRO (Closed Source)| ❌ Not Viable | ❌ Not Viable | ❌ N/A | RADV preferred in all circumstances. Unable to drive wired HMDs. Do not use. Do not seek support. | +| Intel | i915 (Open Source) | ⚡ Functional | ❓ Unknown | ✅ Supported | Relatively old driver, likely poor support for newer GPUs. Limited testing with VR applications. | +| Intel | Intel/Xe (Open Source) | ❌ No wired HMDs | ❌ N/A | ✅ Supported | Lacks direct mode implementation in driver, unable to drive wired HMDs. | **Notes:** - **VR Support**: Indicates how well supported the necessary Vulkan API components are. @@ -67,7 +67,7 @@ A non-comprehensive table of various VR/XR devices and the drivers that support | Samsung Odyssey | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | | Asus HC102 | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | | Samsung Odyssey+ | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | -| HP Reverb | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | +| HP Reverb | ✅ (Monado SteamVR plugin, 60Hz only mode on Nvidia) | ✅ (experimental 6dof controllers, 60Hz only mode on Nvidia) | 🚧 (WiVRn PC-PC stream) | | Acer OJO 500 | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | | HP Reverb G2 | ✅ (Monado SteamVR plugin) | ✅ (experimental 6dof controllers) | 🚧 (WiVRn PC-PC stream) | | Oculus Rift CV1 | ✅ (OpenHMD SteamVR plugin) | ✅ (OpenHMD plugin based support) | 🚧 (WiVRn PC-PC stream) | @@ -82,7 +82,7 @@ A non-comprehensive table of various VR/XR devices and the drivers that support | HTC Vive Focus 3 | ✅ (via [ALVR](/docs/steamvr/alvr/)) | -- | ✅ | | HTC Vive XR Elite | ✅ (via [ALVR](/docs/steamvr/alvr/)) | -- | ✅ | | Lynx R1 | ✅ (via [ALVR](/docs/steamvr/alvr/)) | -- | ✅ | -| Apple Vision Pro | ✅ (via [ALVR](/docs/steamvr/alvr/)) | -- | 🚧 (WIP client) | +| Apple Vision Pro | ✅ (via [ALVR](/docs/steamvr/alvr/)) | -- | ❌ | | **Trackers** | | | | | Vive/Tundra trackers | ✅ (native or spacecal) | ✅ (native or motoc) | ✅ (motoc) | | SlimeVR trackers | ✅ | ✅ (OSC + experimental driver) | ✅ | From 6e63e153c5474fcd4c59bb2ab180e39d83076d90 Mon Sep 17 00:00:00 2001 From: BabbleBones Date: Tue, 6 May 2025 15:42:33 -0400 Subject: [PATCH 40/49] Add snippet about AMDVLK --- content/docs/hardware/_index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index 60c969e..52f6eae 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -101,6 +101,7 @@ A non-comprehensive table of various VR/XR devices and the drivers that support - Try setting `U_PACING_COMP_MIN_TIME_MS=10` as an environment variable to slightly reduce the effect - Consider switching to AMD GPUs for the best wired VR experience - Monitor the [bug report thread](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386) for updates +- **AMD GPU users**: If using WiVRn, make sure you are using the RADV Vulkan driver. A green and broken video stream in WiVRn is a telltale sign that you're using the incompatible AMDVLK driver. Remove AMDVLK and install RADV as AMDVLK is known to be difficult to opt out of as a driver when installed on system. - WiVRn PC XR to WiVRn PC client streaming remains mainly for debug use. - **Vive Pro** microphones should be set to use 44.1khz sample rates as feeding in 48khz raises the pitch of the audio. - **Vive Pro** creates HDMI Output Source after startup of SteamVR/Monado/etc. Use it instead of Vive Pro USB Audio Source, since the audio might appear distorted. From 64310b11ce3c0b5e91afdefcb62d728842ff2ae6 Mon Sep 17 00:00:00 2001 From: Gabriele Musco Date: Wed, 7 May 2025 00:03:37 +0200 Subject: [PATCH 41/49] fix: hint shortcode --- content/docs/hardware/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/hardware/_index.md b/content/docs/hardware/_index.md index 52f6eae..2cc1398 100644 --- a/content/docs/hardware/_index.md +++ b/content/docs/hardware/_index.md @@ -5,9 +5,9 @@ title: VR Gear & GPUs # Hardware -{{% notice warning %}} +{{% hint warning %}} **NVIDIA WIRED VR ISSUES**: Nvidia proprietary drivers currently have a critical issue with DRM lease causing substantial presentation latency for wired VR headsets, resulting in a delayed viewport effect that makes VR uncomfortable. This affects all known driver versions. Wireless VR through WiVRn still works well. Users with Nvidia GPUs should consider wireless options or switching to AMD for the best experience. For details and to report your experience, see [this forum thread](https://forums.developer.nvidia.com/t/substantial-drm-lease-presentation-latency-resulting-in-unusable-vr-hmd-experience/332386). -{{% /notice %}} +{{% /hint %}} ## GPU support matrix From fde61e26376ccfaf6158b01bc2c97962e198a1ac Mon Sep 17 00:00:00 2001 From: Gabriele Musco Date: Wed, 7 May 2025 00:04:00 +0200 Subject: [PATCH 42/49] fix: update theme --- themes/hugo-book | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/hugo-book b/themes/hugo-book index 7c78a39..9405c4c 160000 --- a/themes/hugo-book +++ b/themes/hugo-book @@ -1 +1 @@ -Subproject commit 7c78a39c531aa2492ed7e92f2ce9dfb2c8c0d3fa +Subproject commit 9405c4c3d7c7d81ae5be06589982691efedac3ea From 8d7e2fb8ad29504661703fe0abfa8b5f714c5682 Mon Sep 17 00:00:00 2001 From: Sapphire Date: Fri, 9 May 2025 13:04:35 -0500 Subject: [PATCH 43/49] fossvr/envision: Add instructions for using Envision with Steam Flatpak Co-authored-by: Shiloh Fen Signed-off-by: Sapphire --- content/docs/fossvr/envision/_index.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/content/docs/fossvr/envision/_index.md b/content/docs/fossvr/envision/_index.md index 54c38b0..3c050ee 100644 --- a/content/docs/fossvr/envision/_index.md +++ b/content/docs/fossvr/envision/_index.md @@ -83,6 +83,19 @@ Please *uninstall* AppImageLauncher. It intercepts the normal AppImage starting You can tell if you are affected if, when you run the WlxOverlay-S AppImage in terminal (whether in plugin form in `~/.local/share/envision/plugins`, or downloaded directly from GitHub), you only get the output `execv error: No such file or directory`. +## Steam Flatpak + +To use Envision with the Flatpak version of Steam, you'll need to add the following filesystem overrides to Steam using an application like Flatseal: +- `xdg-data/envision:ro` +- `xdg-run/monado_comp_ipc` +- `xdg-config/openxr:ro` +- `xdg-config/openvr:ro` + +Alternatively, you can use the following command: +```shell +flatpak override --filesystem="xdg-data/envision:ro" --filesystem="xdg-run/monado_comp_ipc" --filesystem="xdg-config/openxr:ro" --filesystem="xdg-config/openvr:ro" com.valvesoftware.Steam +``` + ## Experimental feature settings The following resources can be entered into your Envision profile repo and branch settings to enable early access to code before it's fully upstream in Monado itself. To enable these feature sets, simply clone your profile, edit it with these settings, then build. From 07c1ce5940e9877f8e59c08a6fec8f49ac122b96 Mon Sep 17 00:00:00 2001 From: Mhowser Date: Fri, 9 May 2025 07:20:34 +0000 Subject: [PATCH 44/49] Remove proton warning, add info for fixed bindings --- content/docs/games/outer-wilds-vr-mod/_index.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/content/docs/games/outer-wilds-vr-mod/_index.md b/content/docs/games/outer-wilds-vr-mod/_index.md index 52ce940..08490bc 100644 --- a/content/docs/games/outer-wilds-vr-mod/_index.md +++ b/content/docs/games/outer-wilds-vr-mod/_index.md @@ -5,12 +5,6 @@ weight: 50 # Outer Wilds -{{% hint warning %}} - -You must use Proton 8 as any other version will not work! - -{{% /hint %}} - [Outer Wilds](https://store.steampowered.com/app/753640/Outer_Wilds/) is a flat screen game by design. However, there is a VR mod available to bring greater immersion into the gameplay. To play Outer Wilds in VR, you need to install [NomaiVR](https://github.com/Raicuparta/nomai-vr). @@ -24,3 +18,8 @@ Since Outer Wilds was not designed or optimized to be a VR game, performance wil ## Bugs While in VR, if you have mods that add extra items in the main menu, they will be rotated at an odd angle as well as any UIs. + +### Default Quest/Pico 4 controller bindings only partially work with XRizer + +When plaing the game with [XRizer](/docs/fossvr/xrizer/) and you use Quest or Pico 4 Controllers, it is recommended to use [this custom bindings file](https://github.com/user-attachments/files/19900420/oculustouch.json) ([more info here](https://github.com/Raicuparta/nomai-vr/issues/558#issue-3018649448)). +Simply create a directory called `xrizer` inside of the Outer Wilds game folder and place the bindings file in `xrizer`. This will override the default bindings and should provide a better gameplay experience. \ No newline at end of file From 9588d49e0bfd8cbc9ff888a7ef4b650fdb13906e Mon Sep 17 00:00:00 2001 From: Mhowser Date: Tue, 13 May 2025 23:24:20 +0000 Subject: [PATCH 45/49] Add info for HaritoraX trackers / Slimetora --- content/docs/slimevr/slimetora/.gitkeep | 0 content/docs/slimevr/slimetora/_index.md | 30 ++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 content/docs/slimevr/slimetora/.gitkeep create mode 100644 content/docs/slimevr/slimetora/_index.md diff --git a/content/docs/slimevr/slimetora/.gitkeep b/content/docs/slimevr/slimetora/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/content/docs/slimevr/slimetora/_index.md b/content/docs/slimevr/slimetora/_index.md new file mode 100644 index 0000000..d696d61 --- /dev/null +++ b/content/docs/slimevr/slimetora/_index.md @@ -0,0 +1,30 @@ +--- +title: HaritoraX Trackers +weight: 50 +--- + +# HaritoraX Trackers + +{{% hint info %}} + +For a better full-body experience on Linux, it is recommended to buy the Official SlimeVR Trackers. This article is not an endorsement and is intended for users who have already acquired the hardware and are looking for compatible software. + +{{% /hint %}} + +- [Product website](https://en.shiftall.net/our-products) + +HaritoraX trackers are IMU-based positional trackers. + +## SlimeTora + +- [Project repo](https://github.com/OCSYT/SlimeTora) +- [Project Wiki](https://github.com/OCSYT/SlimeTora/wiki) + +SlimeTora is a program that connects the HaritoraX trackers to the [SlimeVR server](https://docs.slimevr.dev/server/index.html), supporting both the HaritoraX Wireless and HaritoraX Wired (1.1b/1.1/1.0). Supports Bluetooth (low energy), Bluetooth (classic) (w/ COM), and the GX(6/2) communication dongles (w/ COM). + +### HaritoraX Interpreter + +- [Project repo](https://github.com/JovannMC/haritorax-interpreter) +- [NodeJS package](https://www.npmjs.com/package/haritorax-interpreter) + +HaritoraX Interpreter is a Node.js package that enables communication with the HaritoraX FBT trackers to read/write data to the trackers. No HaritoraConfigurator/VR Manager software needed (mostly)! From c92f3ca972b319a0222d54da5d3bc2bdb0640dcc Mon Sep 17 00:00:00 2001 From: Mhowser Date: Wed, 14 May 2025 08:21:18 +0000 Subject: [PATCH 46/49] Minor restructuring to Outer Wilds section (cherry picked from commit 811d920b93f09fde5bdf093ea1ff0b5000c4eec5) Co-authored-by: Mhowser --- content/docs/games/outer-wilds-vr-mod/_index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/docs/games/outer-wilds-vr-mod/_index.md b/content/docs/games/outer-wilds-vr-mod/_index.md index 08490bc..16db472 100644 --- a/content/docs/games/outer-wilds-vr-mod/_index.md +++ b/content/docs/games/outer-wilds-vr-mod/_index.md @@ -11,15 +11,19 @@ To play Outer Wilds in VR, you need to install [NomaiVR](https://github.com/Raic It is recommended to use the [Outer Wilds Mod Manager](https://outerwildsmods.com/mod-manager/) to install NomaiVR along with any additional mods you choose. +[XRizer](/docs/fossvr/xrizer/) is the preferred choice for this game if you do not want to use [SteamVR](/docs/steamvr/). + ## Performance Since Outer Wilds was not designed or optimized to be a VR game, performance will be degraded. Expect low framerates in most scenes. +Prepending `OXR_VIEWPORT_SCALE_PERCENTAGE=60` to the game's launch options can greatly benefit frametimes at the cost of resolution, experiment with the percentage amount to find a balance that suits your needs. + ## Bugs While in VR, if you have mods that add extra items in the main menu, they will be rotated at an odd angle as well as any UIs. ### Default Quest/Pico 4 controller bindings only partially work with XRizer -When plaing the game with [XRizer](/docs/fossvr/xrizer/) and you use Quest or Pico 4 Controllers, it is recommended to use [this custom bindings file](https://github.com/user-attachments/files/19900420/oculustouch.json) ([more info here](https://github.com/Raicuparta/nomai-vr/issues/558#issue-3018649448)). +When playing the game with XRizer and you use Quest or Pico 4 Controllers, it is recommended to use [this custom bindings file](https://github.com/user-attachments/files/19900420/oculustouch.json) ([more info here](https://github.com/Raicuparta/nomai-vr/issues/558#issue-3018649448)). Simply create a directory called `xrizer` inside of the Outer Wilds game folder and place the bindings file in `xrizer`. This will override the default bindings and should provide a better gameplay experience. \ No newline at end of file From da178790c88860cdda4616ad8d244be992e35711 Mon Sep 17 00:00:00 2001 From: Marcus Howser Date: Wed, 14 May 2025 01:26:50 -0700 Subject: [PATCH 47/49] gorp --- content/docs/games/outer-wilds-vr-mod/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/games/outer-wilds-vr-mod/_index.md b/content/docs/games/outer-wilds-vr-mod/_index.md index 16db472..95312c4 100644 --- a/content/docs/games/outer-wilds-vr-mod/_index.md +++ b/content/docs/games/outer-wilds-vr-mod/_index.md @@ -17,7 +17,7 @@ It is recommended to use the [Outer Wilds Mod Manager](https://outerwildsmods.co Since Outer Wilds was not designed or optimized to be a VR game, performance will be degraded. Expect low framerates in most scenes. -Prepending `OXR_VIEWPORT_SCALE_PERCENTAGE=60` to the game's launch options can greatly benefit frametimes at the cost of resolution, experiment with the percentage amount to find a balance that suits your needs. +Prepending `OXR_VIEWPORT_SCALE_PERCENTAGE=60` to the game's launch options can greatly benefit frametimes at the cost of resolution, experiment with the percentage amount to find a balance that suits your needs. ## Bugs From 8186224b018ccccf374b2b1f66e3442dbe8efe79 Mon Sep 17 00:00:00 2001 From: Marcus Howser Date: Wed, 14 May 2025 14:44:53 -0700 Subject: [PATCH 48/49] Add info for LVRA DB website --- content/docs/games/_index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/docs/games/_index.md b/content/docs/games/_index.md index b4dccde..d0b94c5 100644 --- a/content/docs/games/_index.md +++ b/content/docs/games/_index.md @@ -2,3 +2,11 @@ title: More VR Games weight: 60 --- + +# Linux VR Adventure Database + +- [Website](https://db.vronlinux.org/) + +- [Git repository](https://github.com/Respuit/VRDB) + +Here, you can find or report information about various VR games running on Linux. This website is a community-driven effort to provide an open database that helps users determine which games are compatible with Linux and potentially discover solutions or workarounds for specific issues. \ No newline at end of file From b90587e8575bc4d5880ccd6c36341d039ae700fe Mon Sep 17 00:00:00 2001 From: Marcus Howser Date: Wed, 14 May 2025 14:46:46 -0700 Subject: [PATCH 49/49] restructure, add modding info in Resonite section --- content/docs/resonite/_index.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/content/docs/resonite/_index.md b/content/docs/resonite/_index.md index e49601c..b360157 100644 --- a/content/docs/resonite/_index.md +++ b/content/docs/resonite/_index.md @@ -25,18 +25,34 @@ When playing Resonite under [Monado](https://lvra.gitlab.io/docs/fossvr/monado/) To solve this, prepend `OXR_PARALLEL_VIEWS=1` to Resonite's launch options. +## Performance + +In larger sessions Resonite is typically CPU-bound, there isn't much that can be done besides upgrading your CPU. In situations where the GPU is a bottleneck, lowering the resolution (either in the OpenXR runtime or through OpenComposite) may help dramatically. +This can be easily done by prepending `OXR_VIEWPORT_SCALE_PERCENTAGE=75` to Resonite's launch options. Experiment with different values to find your preferred balance between performance and quality. + +## Mods + +Much unlike [VRChat](/docs/vrchat/), Resonite has a thriving modding community with an abundance of [mods](https://wiki.resonite.com/Mods) that offer greater user experience, optimizatons and new features. + +Currently there are 2 mod loaders: + +- [ResoniteModLoader (RML)](https://github.com/resonite-modding-group/ResoniteModLoader) + +- [MonkeyLoader](https://github.com/ResoniteModdingGroup/MonkeyLoader.GamePacks.Resonite) + +You can load RML mods with MonkeyLoader but not the other way around. + +### Resonite randomly gets stuck on initial loading screen when using RML + +The exact cause of this is currently unknown. Consider using MonkeyLoader if you encounter such issues starting the game as it seems to not cause the same problem. + ## Crashes Resonite has been seen causing random SteamVR crashes on Linux before. In some situations the engine also tends to freeze. On OpenComposite, the game will rarely close out on its own without leaving any obvious trace of things going wrong — this is being investigated. The cause of these issues and whether they are Proton-specific isn't currently known. -## Performance - -In larger sessions Resonite is typically CPU-bound, there isn't much that can be done besides upgrading your CPU. In situations where the GPU is a bottleneck, lowering the resolution (either in the OpenXR runtime or through OpenComposite) may help dramatically. -This can be easily done by prepending `OXR_VIEWPORT_SCALE_PERCENTAGE=75` to Resonite's launch options. Experiment with different values to find your preferred balance between performance and quality. - -## Crash on loading into a world with video players +### Crash on loading into a world with video players On GE-Proton9-10 (for example), loading into a world with e.g. a YouTube video or live stream can crash the game. Try using the latest GE-Proton-RTSP release.