VR: Difference between revisions - Official NixOS Wiki

(14 intermediate revisions by 10 users not shown)

Line 6:

Monado can be configured using its NixOS options ~~since 24~~.05:

Monado can be configured using its NixOS options {{Nixos:option|services.monado.enable}}:

</translate>

Line 23:

XRT_COMPOSITOR_COMPUTE = "1";

};}}

Once configured, Monado can be started and stopped in a [[systemd]] user session.

For example, the following commands will start Monado and then follow its log output:

</translate>

{{Commands|

$ systemctl --user start monado.service

$ journalctl --user --follow --unit monado.service

}}

Line 64:

Line 77:

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]

~~</translate>~~

~~<translate>~~

== OpenComposite ==

Line 74:

Line 85:

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.

</translate>

{{Warning|<translate> 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.</translate>}}

~~{{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.}}

If this file is not set to read-only, SteamVR will add its runtime path back, hence the use for Home Manager.

Line 88:

Line 100:

xdg.configFile."openxr/1/active_runtime.json".source = "${pkgs.monado}/share/openxr/1/openxr_monado.json";

# For WiVRn:

# For WiVRn v0.22 and below:

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

Line 114:

Line 126:

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.

~~</translate>~~

~~<translate>~~

== WiVRn ==

~~== WiVRn ==~~

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:

</translate>

{{Warning|<translate> As of WiVRn version 0.23, WiVRn now manages the opencomposite paths itself. Only use the above opencomposite configuration when using versions below v0.23.</translate>}}

{{File|/etc/nixos/configuration.nix|nix|3=services.wivrn = {

Line 136:

Line 148:

autoStart = true;

# ~~Config for WiVRn~~ (https://github.com/WiVRn/WiVRn/blob/master/docs/configuration.md)

# If you're running this with an nVidia GPU and want to use GPU Encoding (and don't otherwise have CUDA enabled system wide), you need to override the cudaSupport variable.

~~config = {~~

package = (pkgs.wivrn.override { cudaSupport = true; });

~~enable = true;~~

~~json = {~~

# You should use the default configuration (which is no configuration), as that works the best out of the box.

~~# 1~~.~~0x foveation scaling~~

# However, if you need to configure something see https://github.com/WiVRn/WiVRn/blob/master/docs/configuration.md for configuration options and https://mynixos.com/nixpkgs/option/services.wivrn.config.json for an example configuration.

~~scale = 1~~.0;

};|name=configuration.nix|lang=nix}}

~~# 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;~~

}

];

};

};}}

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>

~~</translate>~~

~~<translate>~~

== Envision ==

~~== Envision ==~~

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:

</translate>

Line 177:

Line 171:

== SteamVR ==

~~== SteamVR ==~~

[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.

Line 187:

Line 181:

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.

</translate>

{{Note|<translate> 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, or modifying the bubblewrap binary used for running Steam to remove these capability protections. Both of these workarounds come with their own security tradeoffs. See this [https://github.com/NixOS/nixpkgs/issues/217119 Nixpkgs issue]</translate>}}

~~{{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]}}

</translate>

Line 197:

Line 190:

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.

</translate>

{{Warning|<translate> 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.</translate>}}

~~{{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.}}

</translate>

Line 224:

Line 216:

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]]

=== Patching bubblewrap to allow capabilities ===

By modifying the bubblewrap binary used for running Steam, you can allow processes in that FHS environment to acquire capabilities. This removes the need for patching the kernel directly.

</translate>

{{Warning|<translate> This circumvents an intended security mechanism in bubblewrap, and allows all other software launched by steam, or running via steam-run to acquire these capabilities as well.</translate>}}

{{file|/etc/nixos/configuration.nix|nix|3=programs.steam = let

patchedBwrap = pkgs.bubblewrap.overrideAttrs (o: {

patches = (o.patches or []) ++ [

./bwrap.patch

];

});

in {

enable = true;

package = pkgs.steam.override {

buildFHSEnv = (args: ((pkgs.buildFHSEnv.override {

bubblewrap = patchedBwrap;

}) (args // {

extraBwrapArgs = (args.extraBwrapArgs or []) ++ [ "--cap-add ALL" ];

})));

};

}}

{{file|/etc/nixos/bwrap.patch|diff|3=diff --git a/bubblewrap.c b/bubblewrap.c

index 8322ea0..4e20262 100644

--- a/bubblewrap.c

+++ b/bubblewrap.c

@@ -868,13 +868,6 @@ acquire_privs (void)

/* Keep only the required capabilities for setup */

set_required_caps ();

}

- else if (real_uid != 0 && has_caps ())

- {

- /* We have some capabilities in the non-setuid case, which should not happen.

- Probably caused by the binary being setcap instead of setuid which we

- don't support anymore */

- die ("Unexpected capabilities but not setuid, old file caps config?");

- }

else if (real_uid == 0)

{

/* If our uid is 0, default to inheriting all caps; the caller

}}

~~== wlx~~-~~overlay~~-~~s ==~~

as an additional change, you may also need to replace Steam's own bwrap binary with a symbolic link to this modified bwrap binary, found at <code>~/.local/share/Steam/ubuntu12_32/steam-runtime/usr/libexec/steam-runtime-tools-0/srt-bwrap</code>.

Steam will periodically replace this modification with its own binary when steam-runtime updates, so you may need to re-apply this change if it breaks.

== wlx-overlay-s ==

[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.

==== SteamVR autostart ====

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:

</translate>

{{Commands|

# <translate> Run wlx-overlay-s and replace any running instance</translate>

~~==== SteamVR autostart ====~~

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}}

~~</translate>~~

Line 247:

Line 289:

* [https://lvra.gitlab.io Linux VR Adventures Wiki]

[[Category:Video]]

[[Category:Hardware]]

@@ Line 6: / Line 6: @@
 <!--T:3-->
-Monado can be configured using its NixOS options since 24.05:
+Monado can be configured using its NixOS options {{Nixos:option|services.monado.enable}}:
 </translate>
@@ Line 23: / Line 23: @@
    XRT_COMPOSITOR_COMPUTE = "1";
 };}}
+<translate>
+<!--T:40-->
+Once configured, Monado can be started and stopped in a [[systemd]] user session.
+<!--T:41-->
+For example, the following commands will start Monado and then follow its log output:
+</translate>
+{{Commands|
+$ systemctl --user start monado.service
+$ journalctl --user --follow --unit monado.service
+}}
 <translate>
@@ Line 64: / Line 77: @@
 <!--T:10-->
 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]
-</translate>
-<translate>
 == OpenComposite == <!--T:11-->
@@ Line 74: / Line 85: @@
 <!--T:13-->
 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.
+</translate>
-<!--T:14-->
+{{Warning|<translate><!--T:14--> 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.</translate>}}
-{{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.}}
+<translate>
 <!--T:15-->
 If this file is not set to read-only, SteamVR will add its runtime path back, hence the use for Home Manager.
@@ Line 88: / Line 100: @@
 xdg.configFile."openxr/1/active_runtime.json".source = "${pkgs.monado}/share/openxr/1/openxr_monado.json";
-# For WiVRn:
+# For WiVRn v0.22 and below:
 xdg.configFile."openxr/1/active_runtime.json".source = "${pkgs.wivrn}/share/openxr/1/openxr_wivrn.json";
@@ Line 114: / Line 126: @@
 <!--T:17-->
 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.
-</translate>
-<translate>
+== WiVRn == <!--T:18-->
-<!--T:18-->
-== WiVRn ==
+<!--T:35-->
 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:
 </translate>
+{{Warning|<translate><!--T:42--> As of WiVRn version 0.23, WiVRn now manages the opencomposite paths itself. Only use the above opencomposite configuration when using versions below v0.23.</translate>}}
 {{File|/etc/nixos/configuration.nix|nix|3=services.wivrn = {
@@ Line 136: / Line 148: @@
    autoStart = true;
-   # Config for WiVRn (https://github.com/WiVRn/WiVRn/blob/master/docs/configuration.md)
+   # If you're running this with an nVidia GPU and want to use GPU Encoding (and don't otherwise have CUDA enabled system wide), you need to override the cudaSupport variable.
-  config = {
+  package = (pkgs.wivrn.override { cudaSupport = true; });
-    enable = true;
-    json = {
+  # You should use the default configuration (which is no configuration), as that works the best out of the box.
-      # 1.0x foveation scaling
+  # However, if you need to configure something see https://github.com/WiVRn/WiVRn/blob/master/docs/configuration.md for configuration options and https://mynixos.com/nixpkgs/option/services.wivrn.config.json for an example configuration.
-      scale = 1.0;
+};|name=configuration.nix|lang=nix}}
-      # 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;
-        }
-      ];
-    };
-  };
-};}}
 <translate>
 <!--T:19-->
 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>
-</translate>
-<translate>
+== Envision == <!--T:20-->
-<!--T:20-->
-== Envision ==
+<!--T:36-->
 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:
 </translate>
@@ Line 177: / Line 171: @@
 <translate>
-<!--T:21-->
+== SteamVR == <!--T:21-->
-== SteamVR ==
+<!--T:37-->
 [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.
@@ Line 187: / Line 181: @@
 <!--T:23-->
 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.
+</translate>
-<!--T:24-->
+{{Note|<translate><!--T:24--> 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, or modifying the bubblewrap binary used for running Steam to remove these capability protections. Both of these workarounds come with their own security tradeoffs. See this [https://github.com/NixOS/nixpkgs/issues/217119 Nixpkgs issue]</translate>}}
-{{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]}}
-</translate>
 <translate>
@@ Line 197: / Line 190: @@
 <!--T:26-->
 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.
+</translate>
-<!--T:27-->
+{{Warning|<translate><!--T:27--> 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.</translate>}}
-{{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.}}
-</translate>
 <translate>
@@ Line 224: / Line 216: @@
 <!--T:30-->
 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]]
+=== Patching bubblewrap to allow capabilities === <!--T:43-->
+<!--T:44-->
+By modifying the bubblewrap binary used for running Steam, you can allow processes in that FHS environment to acquire capabilities. This removes the need for patching the kernel directly.
 </translate>
+{{Warning|<translate><!--T:45--> This circumvents an intended security mechanism in bubblewrap, and allows all other software launched by steam, or running via steam-run to acquire these capabilities as well.</translate>}}
+{{file|/etc/nixos/configuration.nix|nix|3=programs.steam = let
+  patchedBwrap = pkgs.bubblewrap.overrideAttrs (o: {
+    patches = (o.patches or []) ++ [
+      ./bwrap.patch
+    ];
+  });
+in {
+  enable = true;
+  package = pkgs.steam.override {
+    buildFHSEnv = (args: ((pkgs.buildFHSEnv.override {
+      bubblewrap = patchedBwrap;
+    }) (args // {
+      extraBwrapArgs = (args.extraBwrapArgs or []) ++ [ "--cap-add ALL" ];
+    })));
+  };
+};
+}}
+{{file|/etc/nixos/bwrap.patch|diff|3=diff --git a/bubblewrap.c b/bubblewrap.c
+index 8322ea0..4e20262 100644
+--- a/bubblewrap.c
++++ b/bubblewrap.c
+@@ -868,13 +868,6 @@ acquire_privs (void)
+       /* Keep only the required capabilities for setup */
+       set_required_caps ();
+     }
+-  else if (real_uid != 0 && has_caps ())
+-    {
+-      /* We have some capabilities in the non-setuid case, which should not happen.
+-         Probably caused by the binary being setcap instead of setuid which we
+-         don't support anymore */
+-      die ("Unexpected capabilities but not setuid, old file caps config?");
+-    }
+   else if (real_uid == 0)
+     {
+       /* If our uid is 0, default to inheriting all caps; the caller
+}}
 <translate>
-<!--T:31-->
+<!--T:46-->
-== wlx-overlay-s ==
+as an additional change, you may also need to replace Steam's own bwrap binary with a symbolic link to this modified bwrap binary, found at <code>~/.local/share/Steam/ubuntu12_32/steam-runtime/usr/libexec/steam-runtime-tools-0/srt-bwrap</code>.
+<!--T:47-->
+Steam will periodically replace this modification with its own binary when steam-runtime updates, so you may need to re-apply this change if it breaks.
+== wlx-overlay-s == <!--T:31-->
+<!--T:38-->
 [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.
+==== SteamVR autostart ==== <!--T:32-->
+<!--T:39-->
+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:
 </translate>
-<translate>
+{{Commands|
-<!--T:32-->
+# <translate><!--T:48--> Run wlx-overlay-s and replace any running instance</translate>
-==== SteamVR autostart ====
-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}}
-</translate>
 <translate>
@@ Line 247: / Line 289: @@
 <!--T:34-->
 * [https://lvra.gitlab.io Linux VR Adventures Wiki]
+<!--T:49-->
 [[Category:Video]]
 [[Category:Hardware]]