Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<div lang="en" dir="ltr" class="mw-content-ltr">
== Monado ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
[https://monado.freedesktop.org/ Monado] is an open source OpenXR runtime. It offers support for a variety of hardware using its built-in drivers and can be used to run any OpenXR and, with the help of OpenComposite, most OpenVR applications.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Monado can be configured using its NixOS options since 24.05:
</div>

{{file|/etc/nixos/configuration.nix|nix|3=services.monado = {
  enable = true;
  defaultRuntime = true; # Register as default OpenXR runtime
};}}

<div lang="en" dir="ltr" class="mw-content-ltr">
In order to configure Monado, you might want to add additional environment variables:
</div>

{{file|/etc/nixos/configuration.nix|nix|3=systemd.user.services.monado.environment = {
  STEAMVR_LH_ENABLE = "1";
  XRT_COMPOSITOR_COMPUTE = "1";
};}}

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Hand Tracking ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You may notice that running <code>monado-services</code> will fail due to the lack of hand tracking data.  There are 2 ways to remedy this, either disable hand tracking altogether, or download the hand tracking data.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To disable hand tracking, modify the environment variable to include <code>WMR_HANDTRACKING = "0";</code>, so that it will look like this.
</div>

{{file|/etc/nixos/configuration.nix|nix|3=systemd.user.services.monado.environment = {
  STEAMVR_LH_ENABLE = "1";
  XRT_COMPOSITOR_COMPUTE = "1";
  WMR_HANDTRACKING = "0";
};}}

<div lang="en" dir="ltr" class="mw-content-ltr">
To get hand tracking to work, you require <code>git-lfs</code> to be enabled.  The standard way of enabling <code>git-lfs</code> is through the configuration below
</div>

{{file|/etc/nixos/configuration.nix|nix|3=programs.git = {
  enable = true;
  lfs.enable = true;
};}}

<div lang="en" dir="ltr" class="mw-content-ltr">
After making sure <code>git-lfs</code> is enabled, run these commands and restart <code>monado-service</code>
</div>

{{Commands|
$ mkdir -p ~/.local/share/monado
$ cd ~/.local/share/monado
$ git clone https://gitlab.freedesktop.org/monado/utilities/hand-tracking-models
}}

<div lang="en" dir="ltr" class="mw-content-ltr">
For further information about available environment variables and tweaks, read the [https://lvra.gitlab.io/docs/fossvr/monado/ Linux VR Adventures wiki] and the [https://monado.freedesktop.org/getting-started.html#environment-variables Monado documentation about environment variables]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== OpenComposite ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
[https://gitlab.com/znixian/OpenOVR OpenComposite] is a compatibility layer for running OpenVR applications on an OpenXR runtime like Monado. It is comparable to tools like DXVK or vkd3d, but for translating OpenVR calls to OpenXR.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
In order to run OpenVR games on anything other than SteamVR, you need to configure the OpenVR runtime path defined in <code>~/.config/openvr/openvrpaths.vrpath</code>. A reliable way to do this is to use [[Home Manager]] to create this file.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{{Warning|Older versions of Proton will always query the current OpenVR and OpenXR runtime. If you use OpenComposite, and it fails to initialize an OpenXR context, Proton will fail to launch. A workaround is to delete the ~/.config/openvr/openvrpaths.vrpath file and then retry launching the game.}}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
If this file is not set to read-only, SteamVR will add its runtime path back, hence the use for Home Manager.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
An example configuration for enabling OpenComposite may look like this:
</div>

{{file|~/.config/home-manager/home.nix|nix|3=# For Monado:
xdg.configFile."openxr/1/active_runtime.json".source = "${pkgs.monado}/share/openxr/1/openxr_monado.json";

# For WiVRn:
xdg.configFile."openxr/1/active_runtime.json".source = "${pkgs.wivrn}/share/openxr/1/openxr_wivrn.json";

xdg.configFile."openvr/openvrpaths.vrpath".text = ''
  {
    "config" :
    [
      "${config.xdg.dataHome}/Steam/config"
    ],
    "external_drivers" : null,
    "jsonid" : "vrpathreg",
    "log" :
    [
      "${config.xdg.dataHome}/Steam/logs"
    ],
    "runtime" :
    [
      "${pkgs.opencomposite}/lib/opencomposite"
    ],
    "version" : 1
  }
'';}}

<div lang="en" dir="ltr" class="mw-content-ltr">
If you are planning to play any OpenVR game on Steam or OpenXR games through Proton, you will have to use OpenComposite in this manner. In most cases you also have to allow access to the socket path of your OpenXR runtime to Steam's runtime, by using the following launch options for XR applications on Steam: <code>env PRESSURE_VESSEL_FILESYSTEMS_RW=$XDG_RUNTIME_DIR/monado_comp_ipc %command%</code>. This example is for Monado, while other XR runtimes might differ.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== WiVRn ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
WiVRn is an OpenXR streaming application built around Monado. It wirelessly connects a standalone VR headset to a Linux computer. If your headset is not wireless, look at [[VR#Monado|Monado]] instead.
Example usage of the WiVRn module:
</div>

{{File|/etc/nixos/configuration.nix|nix|3=services.wivrn = {
  enable = true;
  openFirewall = true;

# Write information to /etc/xdg/openxr/1/active_runtime.json, VR applications
  # will automatically read this and work with WiVRn (Note: This does not currently
  # apply for games run in Valve's Proton)
    defaultRuntime = true;

# Run WiVRn as a systemd service on startup
  autoStart = true;

# Config for WiVRn (https://github.com/WiVRn/WiVRn/blob/master/docs/configuration.md)
  config = {
    enable = true;
    json = {
      # 1.0x foveation scaling
      scale = 1.0;
      # 100 Mb/s
      bitrate = 100000000;
      encoders = [
        {
          encoder = "vaapi";
          codec = "h265";
          # 1.0 x 1.0 scaling
          width = 1.0;
          height = 1.0;
          offset_x = 0.0;
          offset_y = 0.0;
        }
      ];
    };
  };
};}}

<div lang="en" dir="ltr" class="mw-content-ltr">
Like Monado, you will also have to add the launch argument for WiVRn to allow access to the socket: <code>PRESSURE_VESSEL_FILESYSTEMS_RW=$XDG_RUNTIME_DIR/wivrn/comp_ipc %command%</code>
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Envision ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Envision is an orchestrator for the FOSS VR stack. It handles the building and configuration of Monado, WiVRn, OpenComposite, and other utilities of the FOSS VR stack such as the Lighthouse driver, OpenHMD, Survive, and WMR. You can enable it with the Envision module:
</div>

{{File|/etc/nixos/configuration.nix|nix|3=programs.envision = {
  enable = true;
  openFirewall = true; # This is set true by default
};}}

<div lang="en" dir="ltr" class="mw-content-ltr">
== SteamVR ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
[https://store.steampowered.com/app/250820/SteamVR/ SteamVR] is a proprietary OpenVR runtime with compatibility for OpenXR. It is part of [[Steam]] and doesn't need any additional setup on NixOS apart from enabling Steam.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
After installing SteamVR through Steam and plugging in a SteamVR-compatible headset, SteamVR should work for the most part.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
On initial setup, SteamVR will ask for elevated permissions, to set up a file capability for one of its binaries. This is needed to allow asynchronous reprojection to work. Clients need the <code>CAP_SYS_NICE</code> capability to acquire a high-priority context, which is a requirement for asynchronous reprojection.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{{Note|Steam is run in a bubblewrap-based FHS environment. This environment runs Steam in a user namespace, which prevents it from using any capabilities or setuid binaries. This means that asynchronous reprojection can not be used on NixOS, without patching the kernel to remove these restrictions completely. See this [https://github.com/NixOS/nixpkgs/issues/217119 Nixpkgs issue]}}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Patching AMDGPU to allow high priority queues ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
By applying [https://github.com/Frogging-Family/community-patches/blob/a6a468420c0df18d51342ac6864ecd3f99f7011e/linux61-tkg/cap_sys_nice_begone.mypatch this patch], the AMDGPU kernel driver will ignore process privileges and allow any application to create high priority contexts.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{{Warning|This removes intentional restrictions from the kernel, and it could cause scheduling issues. While it has not been reported that it does cause issues, this should be considered an unsupported configuration.}}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Applying as a NixOS kernel patch ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To workaround the <code>CAP_SYS_NICE</code> requirement, we can apply a kernel patch using the following NixOS configuration snippet:
</div>

{{file|/etc/nixos/configuration.nix|nix|3=boot.kernelPatches = [
  {
    name = "amdgpu-ignore-ctx-privileges";
    patch = pkgs.fetchpatch {
      name = "cap_sys_nice_begone.patch";
      url = "https://github.com/Frogging-Family/community-patches/raw/master/linux61-tkg/cap_sys_nice_begone.mypatch";
      hash = "sha256-Y3a0+x2xvHsfLax/uwycdJf3xLxvVfkfDVqjkxNaYEo=";
    };
  }
];
}}

<div lang="en" dir="ltr" class="mw-content-ltr">
It is also possible to just patch amdgpu and build it as an out-of-tree module, as described in [[Linux_kernel#Patching_a_single_In-tree_kernel_module]]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== wlx-overlay-s ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
[https://github.com/galister/wlx-overlay-s wlx-overlay-s] is a lightweight OpenXR/OpenVR overlay for Wayland and X11 desktops. It works with SteamVR as well as Monado/WiVRn natively.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== SteamVR autostart ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
When launching wlx-overlay-s in SteamVR (or any OpenVR compositor) it will register an autostart manifest. Currently, this manifest will reference a Nix store path of wlx-overlay-s, which might get garbage collected after rebuilds of your NixOS/Nix profile. A workaround is to regularly run the following command to update the manifest's store path:{{Commands|
# Run wlx-overlay-s and replace any running instance
$ wlx-overlay-s --replace}}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://lvra.gitlab.io Linux VR Adventures Wiki]
[[Category:Video]]
[[Category:Hardware]]
[[Category:Desktop]]
[[Category:Gaming]]
</div>