Skip to main content Link Search Menu Expand Document (external link)

Table of contents

  1. Menu is not showing
  2. Reset all the settings
  3. Disable ReShade
  4. Missing Visual C++ system component:
  5. Start in Safe mode
  6. Inspect the log file
  7. Missing DirectX legacy runtime
  8. Confirming that the Ultraleap OpenXR layer is active
  9. Disabling the OpenXR Toolkit with incompatible applications
  10. Asking for help
  11. Filing a bug report
  12. Checking if you are CPU or GPU limited

This has been reported due to certain keyboards requiring special key presses to use the Function keys (such as Fn+F1 for example). This can also be due to 3rd party software intercepting the Function keys.

Use the Keyboard tester to check if your key combinations work.

Please use the OpenXR Toolkit Companion app to try different hotkeys, selecting keys other than the Function keys.

Reset all the settings

While an application is running, you may at any point reset all the settings to their default values by pressing simultaneously the keys bound to all 3 of the menu actions. If no custom key combinations have been set in the OpenXR Toolkit Companion app, this combination is Ctrl+F1+F2+F3.

Disable ReShade

If you had previously installed ReShade or any similar mod for your application, please disable or delete it in order to use the OpenXR Toolkit.

Missing Visual C++ system component:

If the OpenXR Toolkit makes your application refuse to start, try installing the Visual C++ Redistributables.

Start in Safe mode

If an application fails to start due to some settings changes, you may use the OpenXR Toolkit Companion app (found on the desktop or Start menu) to Enable safe mode. In this mode, the settings for this application will not be loaded.

Enabling safe mode
Enabling safe mode

You may then either:

  • Reset all the settings (see above) with the Ctrl+F1+F2+F3 key combination.

  • Change your settings to avoid the problem. Note that in safe mode, settings are not loaded, but the modified settings are still stored.

Inspect the log file

In order to inspect the log file to try to understand issues with the toolkit, you may open the OpenXR Toolkit Companion app (found on the desktop or Start menu) and click the Open log file button. This will open the file located at %LocalAppData%\OpenXR-Toolkit\logs.

Please note that certain applications may run in a security-sandbox environment. In this case, the log file may be located under the corresponding application subfolder in %LocalAppData%\Packages. You may search for a file named XR_APILAYER_NOVENDOR_toolkit.log if unsure of the exact location.

An example log file
An example log file

Missing DirectX legacy runtime

Check for the following error in the log file:

[OXRTK] 2022-02-28 20:41:32 -0600: HRESULT failure [80004005]
Origin: m_fontWrapperFactory->CreateFontWrapper(get(m_device), m_fontFamily.c_str(), set(m_fontNormal))

To solve this problem, please install the DirectX legacy runtime package.

Confirming that the Ultraleap OpenXR layer is active

Note: this is applicable for troubleshooting hand tracking with Ultraleap devices only.

To confirm that the Ultraleap OpenXR layer is active and loaded in the correct order, open the OpenXR Toolkit Companion app (found on the desktop or Start menu) and hover the mouse cursor on the OpenXR Toolkit layer is active label.

Listing the OpenXR layers
Listing the OpenXR layers

The XR_APILAYER_ULTRALEAP_hand_tracking layer must appear after the XR_APILAYER_NOVENDOR_toolkit layer. If this is not the case, you may re-install either one of the layers to correct the order.

Disabling the OpenXR Toolkit with incompatible applications

You might reach a point where you determine that an application is not compatible with the OpenXR Toolkit. You may use the OpenXR Toolkit Companion app (found on the desktop or Start menu) to disable the OpenXR Toolkit just for that application.

Disable per application
Per-application control

Asking for help

Some issues may be known by the community. Please read the Support channels on our Discord server and ask questions there if you do not find the answer already.

Filing a bug report

Note: please do not file issues for questions about tuning of the settings. Use the Discord server for that.

When filing an issue on GitHub, it is important to include:

  • A good problem description. What were you trying to do? What did you expected to happen? What happened instead?
  • Include the application or game and its version, the make and model of VR device.
  • If possible, include the version of the OpenXR runtime and the make and model of GPU (if you are going to attach your log file, the information is included in it and may be omitted in the description).

There are templates providing fields to input all this information. Please use the templates..

Please include the log file (see above how to retrieve it) as an attachment.

If applicable, you may include screenshots (see Other features).

Thank you for taking the time to report issue and help us improve the software!

Checking if you are CPU or GPU limited

Perform the test below with any form of motion reprojection or asynchronous space warp (ASW) disabled and any frame limiting/throttling feature disabled (eg: in your driver or NVIDIA control panel).

Use the Detailed overlay (see Overlay) to inspect your application CPU and GPU times (respectively app CPU and app GPU).

When the value of app GPU is greater than the value of app CPU, you are limited by your GPU, and you may use features such as Upscaling or Foveated Rendering to relieve your GPU. If you are not GPU limited, then these features will not help to gain performnce. Instead, you may alter other settings of your application, such as details settings, and increase them until you become GPU limited, and can enable the performance-enhancing features previously mentioned.