diff --git a/README.md b/README.md index e69b3b1..934628d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## What is this? -This repo contains a collection of tools to enable virtual desktop environments for gaming and productivity on Linux using supported XR glasses. This currently includes XREAL Air 1, 2, 2 Pro and VITURE One, Lite, and Pro models. +This repo contains a collection of tools to enable virtual desktop environments for gaming and productivity on Linux using [supported XR glasses](https://github.com/wheaney/XRLinuxDriver#supported-devices). There are two installations at the moment: * [Breezy GNOME](#breezy-gnome) for desktop support, primarily in GNOME Linux desktop environments @@ -54,6 +54,9 @@ You may still opt to do a manual installation using the instructions below if yo 2. Run the setup script as root (e.g. `sudo ~/Downloads/breezy_vulkan_setup`) 3. If you're not on Steam Deck, you'll need to set the `ENABLE_VKBASALT` environment variable to `1`. You'll either need to set this globally to enable it for all games, or set it as a launch option for individual games (e.g. in Steam's Launch Options field `ENABLE_VKBASALT=1 %command%`). +### Supported Devices +See [XRLinuxDriver's supported devices](https://github.com/wheaney/XRLinuxDriver#supported-devices). + ### Usage Once installed, you'll want to make sure you've enabled the driver (`~/bin/xreal_driver_config -e`) and then you can go into whichever output mode you'd like using (`~/bin/xreal_driver_config -m`) where `-m` is for mouse mode, `-j` for joystick, `-vd` for virtual display, and `-sv` for sideview; note that these two commands can't be combined, they have to be done separately. From there, you should be able to launch any Vulkan game, plug in your glasses (at any point, not just after launching), and see a floating virtual display or a sideview screen (depending on which mode you've chosen).