add SteamVR plugin page

index.md

@@ -96,6 +96,7 @@ without developers having to write a single line of X11 code.
 * [List of Open Source applications and examples]({% link openxr-resources.md %})
 * [Tested Multi-GPU configurations (e.g. Optimus)]({% link multi-gpu.md %})
 * [Read the online Doxygen documentation and start hacking on Monado](https://monado.pages.freedesktop.org/monado/)
+* [Use Monado's hardware drivers in SteamVR]({% link steamvr.md %})
 
 ## Code of Conduct
 

steamvr.md

+---
+title: "Monado - SteamVR Plugin"
+layout: main
+---
+
+Monado 0.5/master comes with a SteamVR plugin.
+
+It enables the use of Monado's VR hardware drivers with Valve's SteamVR runtime.
+
+It does **not** make it possible to run OpenVR games and applications on Monado/OpenXR runtimes. See [OpenComposite](https://gitlab.com/znixian/OpenOVR) for an in-development project focusing on this use case.
+
+# Current status
+
+* All HMDs supported by Monado
+  * Distortion correction for OpenHMD, Panotools (PSVR), Vive/Vive Pro/Valve Index
+  * Arbitrarily orientated displays from `get_view_pose()`, e.g. canted displays like Valve Index
+* All controllers supported by Monado
+  * All controllers emulate Valve Index controllers
+  * Generating input profiles from Monado is planned
+
+# Registering the plugin
+
+The SteamVR plugin is built by default and is installed in `$PREFIX/share/steamvr-monado`. SteamVR will use the plugin only after it is registered with SteamVR's `vrpathreg` tool.
+
+If Monado was installed in the /usr prefix, the command is
+```
+~/.steam/steam/steamapps/common/SteamVR/bin/linux64/vrpathreg adddriver /usr/share/steamvr-monado
+```
+
+The SteamVR plugin will also be placed in the Monado build tree where it can be registered with SteamVR without installing Monado.
+```
+~/.steam/steam/steamapps/common/SteamVR/bin/linux64/vrpathreg adddriver ~/monado/build/steamvr-monado
+```
+
+Depending on the distribution or Steam installation method, Steam may be installed in `~/.local/share/Steam` rather than `~/.steam/steam`.
+```
+~/.local/share/Steam/steamapps/common/SteamVR/bin/linux64/vrpathreg adddriver /usr/share/steamvr-monado
+```
+
+Running `vrpathreg` without arguments lists currently registered plugins listed in "External Drivers".
+```
+~/.steam/steam/steamapps/common/SteamVR/bin/linux64/vrpathreg
+
+<...>
+External Drivers:
+        /usr/share/steamvr-monado
+```
+
+Plugins can be unregistered from Steam by using `vrpathreg removedriver`.
+```
+~/.steam/steam/steamapps/common/SteamVR/bin/linux64/vrpathreg removedriver /usr/share/steamvr-monado
+```
+
+After starting SteamVR, debug output for the plugin can be found in `~/.steam/steam/logs/vrserver.txt`. It will be prefixed with `monado:`.