Merge branch 'envision-guide' into 'main'

add envision guide

See merge request lvra/lvra.gitlab.io!16
This commit is contained in:
hypevhs 2024-08-02 18:23:38 +00:00
commit 1382cf546b

View file

@ -18,34 +18,46 @@ Envision attempts to construct a working runtime with both a native OpenXR and a
{{< hint danger >}}
**Warning**
Envision is still to be considered alpha-quality and highly experimental.
Envision is still considered alpha-quality and highly experimental.
{{< /hint >}}
You can download the latest Appimage snapshot from [GitLab Pipelines](https://gitlab.com/gabmus/envision/-/pipelines).
**Please note that WiVRn will not work properly by AppImage, if you utilize the AppImages to run WiVRn you must extract the contents of the AppImage and then execute the Envision binary.**
## Room Setup
## Getting Started
If you're planning to use the SteamVR lighthouse driver (with Index or Vive HMDs, or other lighthouse tracked HMDs), you'll need to go through the SteamVR room setup. You can do that from SteamVR, directly from Envision or manually by running the appropriate scripts. More info in the [SteamVR page](/docs/steamvr).
Upon launching Envision, you will need to select a profile on the bottom of the left side bar.
Profiles that are available by default:
- Lighthouse driver: Proprietary SteamVR Lighthouse driver with top tracking quality. Recommended for Lighthouse HMDs.
- OpenHMD: Recommended for Oculus Rift & DK series.
- Simulated headset: Dummy driver for testing on a flat screen.
- Survive: FOSS Lighthouse driver implementation.
- WMR: Use with Windows Mixed Reality headsets.
- WiVRn: Wireless streaming solution for Quest, Pico, HTC standalone HMDs.
Monado does not have a launcher app, and so after connecting your headset, you will likely see a solid color. This means you can now start your VR title.
You may want to launch [WlxOverlay-S](/docs/fossvr/wlxoverlay-s/) first and use it to access your desktop and other VR titles. You can even start it automatically alongside the Monado session: just enter `wlx-overlay-s --openxr` into the "Autostart" field of your Envision profile.
## Experimental feature settings
The following resources can be entered into your Envision profile repo and branch settings to enable early access to code before its fully upstream in monado itself. Simply edit your profile with these settings and rebuild to enable these feature sets.
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.
### Full body lighthouse tracking
### Full body Lighthouse tracking
Full body is now provided by default in Monado & OpenComposite through the XR_MNDX_xdev_space OpenXR vendor extension. This allows any tracked "xdev" in Monado to be forwarded as a raw pose without bindings to applications. OpenComposite exposes these as fake vive FBT trackers for use.
Full body is now provided by default in Monado & OpenComposite through the XR_MNDX_xdev_space OpenXR vendor extension. This allows any tracked "xdev" in Monado to be forwarded as a raw pose without bindings to applications. OpenComposite exposes these as fake Vive FBT trackers for use.
### WMR Controller tracking
### WMR controller tracking
This enables positional tracking for WMR controllers in full 6dof
This enables positional tracking for WMR controllers in full 6dof.
For the Envision XR Service settings:
Repo `https://gitlab.freedesktop.org/thaytan/monado`
Branch `dev-constellation-controller-tracking`
- Repo: `https://gitlab.freedesktop.org/thaytan/monado`
- Branch: `dev-constellation-controller-tracking`
### Experimental Pimax support branch
@ -53,6 +65,5 @@ Major WIP. Allows certain Pimax HMDs to function with Monado.
For the Envision XR Service settings:
Repo `https://gitlab.freedesktop.org/Coreforge/monado/`
Branch `pimax`
- Repo: `https://gitlab.freedesktop.org/Coreforge/monado/`
- Branch: `pimax`