Files
website/docs/01-get-started/03-setup-openxr.md
Cyberneticmelon 5c08d6c00c Update docs/01-get-started/03-setup-openxr.md
Co-authored-by: Jaiden Riordan <jade@e.email>
2025-03-06 22:18:09 -05:00

4.5 KiB

sidebar_position
sidebar_position
3

Setup OpenXR Runtime

This guide will help you set up your VR or AR headset for use with Stardust. Although support for many headsets on Linux is still under active development, there are a number of good options available. If you already have OpenXR set up on your Linux distribution, head to the Full Installation page to get Stardust XR installed.

:::info If you want to try Stardust in a window on your existing device you can skip this step and checkout the Quick Start Guide. :::

Envision

:::note Envision

We highly recommend using Envision, as it is an easy to use GUI for utilizing Monado (an Open-Source implementation of OpenXR for Linux) which is what you will most likely be using if you have a wired headset, and Envision also comes with WiVRn for connecting to headsets like the Meta Quest wirelessly. :::

Check the hardware table (for Monado/WiVRn support) to ensure your hardware and headset are compatible. It is very likely you will need Nvidia drivers if that's what you are using. Check the link for the which model graphics card may require different drivers, but the most likely command you will need to run if you have a modern card is:

sudo dnf install akmod-nvidia

AMD graphic cards currently do not require drivers.

Fedora Logo Ultramarine Logo Fedora/Ultramarine Linux

:::info You will need the Terra repository, unless you have Ultramarine Linux which comes pre-installed:

sudo dnf install --nogpgcheck --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' terra-release

::: In your terminal, run:

sudo dnf install envision

Logo Arch Linux

For Arch Linux, Envision is available via the AUR

paru -S envision-xr-git

Logo NixOS

It's generally easiest to follow the instructions at https://lvra.gitlab.io/docs/distros/nixos/ as Envision is currently unstable on NixOS and troubleshooting SteamVR can be tricky.

Other options for installation

You can also download the Envision AppImage directly. Once downloaded, unzip the archive and you should find a file named Envision-x86_64.AppImage. Make it executable either from your file manager with right click > properties > "executable as program", or under permissions enable "is executable" (this depends on your file manager) OR, from the terminal: chmod +x Envision-x86_64.AppImage

Double click the AppImage file to run it. Envision App Image

When you launch Envision, you will have to build a profile depending on what headset and setup you are using, check the Envision website for instructions specific to what you have. You can take a look at [this section] of our Meta Quest setup video for an example using WiVRn. Envision Build Profile

Once you have one of these options installed, a quick way to test it within the headset is by running the command xrgears and see if it works. xrgears is a demo that comes with Monado.

:::tip If you run into any problems during installation, the Meta Quest Walkthrough may contain information helpful in regards to dependencies, firewalls and drivers. :::

ALVR

Another option is ALVR, you can check the github repository for more information https://github.com/alvr-org/ALVR

SteamVR

If you'd like to use SteamVR, head on over to https://lvra.gitlab.io/docs/steamvr/, although it is not the recommended way to use VR within Linux due to current poor support.