OpenXR Toolkit

This software provides a collection of useful features to customize and improve existing OpenXR applications, including render upscaling and sharpening, foveated rendering, image post-processing and other game-enhancing tweaks.

DISCLAIMER: This software is distributed as-is, without any warranties or conditions of any kind. Use at your own risks.

Table of contents

  1. OpenXR Toolkit
  2. Setup
    1. Downloads
    2. Requirements
      1. Supported headsets
        1. Eye tracking feature
      2. Supported graphics cards
      3. Supported applications
        1. OpenComposite
    3. Installation
      1. 1. Run the OpenXR-Toolkit.msi program.
      2. 2. Follow the instructions to complete the installation procedure.
      3. 3. Launch the OpenXR Toolkit Companion app to confirm that the software is active.
  3. Basic usage
    1. Available options
  4. Recovery
  5. Removal

Setup

READ ALL THE INSTRUCTIONS BELOW - IF YOU DO NOT READ THE INSTRUCTIONS, YOU WILL NOT BE SUCCESSFUL.
IF YOU DO NOT WISH TO READ THE INSTRUCTIONS BELOW, PLEASE DO NOT ATTEMPT TO INSTALL OR USE OPENXR TOOLKIT.

Downloads

Current version: 1.3.2

Download the latest

…or expore all versions.

Requirements

Supported headsets

OpenXR Toolkit is compatible with any headset with OpenXR capabilities on PC, whether through the headset’s specific OpenXR support (sometimes referred to as “native OpenXR runtime”) or through SteamVR OpenXR support. Please refer to the table below for possible combinations of headsets and runtimes.

Headset brandSupports OpenXR Toolkit?OpenXR runtimes available
Windows Mixed Reality (HP Reverb, Samsung Odyssey…)YesOpenXR for Windows Mixed Reality, SteamVR OpenXR
Oculus (Rift, Quest, Quest 2, Quest 3 Quest Pro…) via Oculus LinkYesOculus OpenXR, SteamVR OpenXR
Oculus (Quest, Quest 2, Quest 3 Quest Pro…) via Virtual DesktopYesVirtualDesktopXR (VDXR), SteamVR OpenXR
Oculus (Quest, Quest 2, Quest 3 Quest Pro…) via Steam LinkYesSteamVR OpenXR
Varjo (Aero, VR-3…)YesVarjo OpenXR, SteamVR OpenXR
Pimax (5K, 8K…)YesPimaxXR, SteamVR OpenXR
HTC Tier 1 (Vive original, Vive Pro)YesSteamVR OpenXR
HTC Tier 2 (Vive Cosmos, Vive Focus)YesVive OpenXR, SteamVR OpenXR
Valve IndexYesSteamVR OpenXR
Pico (Neo 3, Neo 4) via Steaming AssistantYesSteamVR OpenXR
Pico (Neo 3, Neo 4) via Virtual DesktopYesVirtualDesktopXR (VDXR), SteamVR OpenXR

Eye tracking feature

The eye tracking feature of OpenXR Toolkit is supported on a majority of headsets with eye tracking capabilities. However, not all OpenXR runtimes for the headset may provide eye tracking support. Please see the table below for possible combinations, and whether a separate add-on is needed for eye tracking.

Headset brandOpenXR runtimeSupports eye tracking in OpenXR Toolkit?
HP Reverb G2 OmniceptOpenXR for Windows Mixed RealityYes
HP Reverb G2 OmniceptSteamVR OpenXRYes [1]
Oculus Quest Pro via Oculus LinkOculus OpenXRYes
Oculus Quest Pro via Oculus LinkSteamVR OpenXRNo
Oculus Quest Pro via Virtual DesktopVirtualDesktopXR (VDXR)Yes
Oculus Quest Pro via Virtual DesktopSteamVR OpenXRYes [1]
Oculus Quest Pro via Steam LinkSteamVR OpenXRYes [1]
Varjo (all models)Varjo OpenXRYes
Varjo (all models)SteamVR OpenXRYes [1]
Pimax CrystalPimaxXRYes
Pimax CrystalSteamVR OpenXRYes [1]
Pimax (5K, 8K) with Droolon Pi1PimaxXRYes
Pimax (5K, 8K) with Droolon Pi1SteamVR OpenXRNo
HTC Vive Pro Eye, Vive Focus 3AllYes [2]
Pico Neo 4 ProAllNo [3]

[1] Support for eye tracking through SteamVR OpenXR is provided through the OpenXR-Eye-Trackers add-on.

[2] Support for eye tracking on Vive headsets is provided through the Vive Console for SteamVR.

[3] Pico devices do not support eye tracking for PC applications. Pico does not provide the necessary tools to implement it. The marketing of Pico devices is misleading for the consumers, and hurts the developers community: a) Pico marketing claims support for eye tracking without mentioning that this feature is only supported for standalone mode (Android apps) and not available to developers on PC; b) This practice makes us developers look bad for not supporting eye tracking, in spite of the shortcoming being on Pico’s side

Supported graphics cards

OpenXR Toolkit is compatible with any graphics card supporting DirectX 11, regardless of brand.

Certain features, like Foveated Rendering, have additional requirements, per the table below. OpenXR Toolkit does not support Vulkan applications, regardless of graphics cards.

Graphics cardSupports Foveated Rendering?Limitations
Nvidia RTX 4000 seriesYesApplication must use Direct3D 11 or Direct3D 12
Nvidia RTX 3000 seriesYesApplication must use Direct3D 11 or Direct3D 12
Nvidia RTX 2000 seriesYesApplication must use Direct3D 11 or Direct3D 12
Nvidia GTX 1600 seriesYesApplication must use Direct3D 11 or Direct3D 12
Nvidia GTX 1000 series (and below)No-
AMD RX 7000 seriesYesApplication must use Direct3D 12 [1]
AMD RX 6000 seriesYesApplication must use Direct3D 12 [1]
AMD RX 5000 series (and below)No-
Intel ArcYesApplication must use Direct3D 12 [1]
Intel Gen11 (Ice Lake and above)Yes (but untested)Application must use Direct3D 12 [1]
Intel (any other model)No-

[1] AMD and Intel do not support foveated rendering with Direct3D 11 applications. This is a limitation of the AMD and Intel drivers and not a limitation of OpenXR Toolkit.

Supported applications

OpenXR Toolkit only works with OpenXR applications. Not all applications are built for OpenXR. Below is a table of applications known to use OpenXR, and whether they are known to work with OpenXR Toolkit.

GameWorks with OpenXR Toolkit?Limitations
A Township Tale- 
Beat SaberYes-
BeamNG.driveNo-
BonelabYesSteam edition only - the Oculus store edition does not use OpenXR
ContractorsYesMust start the game in OpenXR mode (-hmd=openxr parameter)
DCS WorldYesMust start the game in OpenXR mode (--force_OpenXR parameter)
On Varjo headsets, requires the use of OpenXR-InstanceExtensionsWrapper
EVERSLAUGHTYes-
Ghosts of TaborYesOculus store edition only - the Steam edition does not use OpenXR
HubrisYes-
iRacingYesMust start the game in OpenXR mode
Light BrigadeYes-
Microsoft Flight Simulator 2020Yes-
Minecraft for WindowsNo-
Pavlov VRYes-
PhasmophobiaYes-
Pistol WhipYes-
PLAY’A VR Video PlayerYes-
Praydog’s UEVR injectorYesMust use the injector in OpenXR mode
The 7th Guest VRYes-
War ThunderYes-
X-Plane 12No-

OpenComposite

OPENCOMPOSITE IS NOT OFFICIALLY SUPPORTED - USE IT AT YOUR OWN EXPENSE.
REQUEST FOR TROUBLESHOOTING/SUPPORT FOR OPENCOMPOSITE WILL BE IGNORED.

Installation

1. Run the OpenXR-Toolkit.msi program.

Installer file

📝 Note: You may be warned that Windows protected your PC because this software is not trusted. The application is built on a GitHub server hosted in the Microsoft cloud, which greatly limits the risk of contamination from viruses and malware. Additionally, we have digitally signed the software through a reputable organization (Comodo) which helps with guaranteeing that is has not been altered by any third party.

Proceed through the "Windows protected your PC" warning...

Select More info then Run anyway.

Warning not signed Warning not signed

2. Follow the instructions to complete the installation procedure.

Setup wizard

📝 Note: You do not need to uninstall the previous version of OpenXR Toolkit if you had one installed. The new version will overwrite the previous one.

3. Launch the OpenXR Toolkit Companion app to confirm that the software is active.

You can use the shorcut found on the desktop or in the Start menu... Companion app shortcut

The OpenXR Toolkit Companion app may be used sporadically to enable or disable advanced features or perform recovery (see further below). The application displays a green or red status indicating whether the software OpenXR component is active.

The OpenXR Toolkit Companion app can also be used to customize the keyboard shortcuts used to invoke and navigate the menu.

Companion app

💡 Tip: You don’t need to keep the companion app running in order to use the software: the actual settings for the toolkit are available from within your OpenXR application and display directly in the headset! (see below).

Basic usage

Once installed, please run the desired OpenXR application. A welcome message will appear and instruct you to open the menu:

On-screen menu

💡 Troubleshooting: Can’t see the menu? Head to Troubleshooting for help.

In order to navigate the menu, select options and change values:

On-screen menu

  • Use CTRL+F2 to move to the next option (next line) in the menu.
  • Use CTRL+F1 to move selection to the left / decrease the option value.
  • Use CTRL+F3 to move selection to the right / increase the option value.
  • Hold both SHIFT and CTRL together to change values fasters.

💡 Tip: Use the OpenXR Toolkit Companion app to change the default shortcut keys.

Available options

See Features for more details.

Recovery

See Troubleshooting for more details.

If changing some settings render the application unusable, use Ctrl+F1+F2+F3 to hard reset all settings.

Note: if the key combinations were changed from the OpenXR Toolkit Companion app, please use the newly assigned keys.

If an application can no longer start, use the OpenXR Toolkit Companion app (found on the desktop or Start menu) and select the Safe mode before starting the application, then use Ctrl+F1+F2+F3 (regardless of custom key combinations) to hard reset all settings.

Removal

The software can be removed from Windows’ Add or remove programs menu.

Add or remove programs

In the list of applications, select OpenXR-Toolkit, then click Uninstall.

Uninstall