Skip to content

4. Companion App Documentation

Glen Harrison edited this page May 4, 2026 · 2 revisions

Companion App Documentation

DesktopXR Companion App is an application used to create a blank OpenXR session.

This allows you to access the DesktopXR desktop overlay without launching a VR game.

The Companion App is intended for 2D gaming, movie watching, and general desktop use in VR.


Quick Start

1. Launch the application

Run:

DesktopXR-Companion.exe

This starts a blank OpenXR session.

Once the session is running, you can use the DesktopXR desktop overlay without opening a VR game.


2. Close the application

To close the Companion App:

  1. Open the Windows taskbar tray.
  2. Right-click the coloured VR headset icon.
  3. Select Exit.

Usage

The Companion App is useful when you want to use DesktopXR outside a game.

Common use cases include:

  • Playing 2D games in VR
  • Watching movies or videos
  • Using desktop applications in VR
  • Testing DesktopXR settings without launching a game

Notes

  • The Companion App only creates the OpenXR session.
  • DesktopXR must still be installed and enabled as an OpenXR API layer.
  • DesktopXR overlay settings are still controlled by the main DesktopXR configuration file.
  • If you change DesktopXR settings, restart the Companion App for the new settings to apply.

Troubleshooting

If the DesktopXR desktop overlay does not appear:

  1. Confirm DesktopXR is installed.
  2. Confirm DesktopXR is enabled as an OpenXR API layer.
  3. Confirm your OpenXR runtime is configured correctly.
  4. Restart the Companion App.
  5. Restart your VR software if needed.

DesktopXR configuration files are stored in:

%appdata%\DesktopXR

Related Files

The Companion App uses the main DesktopXR configuration file:

%appdata%\DesktopXR\desktopxr.ini

Clone this wiki locally