OpenXR Runtime

Learn how to install the OpenXR runtime and set up your projects for OpenXR.

OpenXR Runtime

To develop OpenXR projects in Unreal Engine (UE), you must install the OpenXR runtime for the platform and hardware you are developing for. The following sections cover how to install the correct OpenXR runtime and which plugins are needed for each platform.

Currently, some of the platform-specific plugins in UE are incompatible with the OpenXR plugin. Make sure you disable the Oculus, SteamVR and Windows Mixed Reality plugins when using the OpenXR plugin in your Unreal project.

Windows Mixed Reality

Complete the following items to begin using your Windows Mixed Reality devices with OpenXR in the Unreal Editor:

HoloLens

Complete the following items to begin using your HoloLens devices with OpenXR in the Unreal Editor:

  • Complete the steps in HoloLens Prerequisites to set up your computer and device.

  • Disable the Windows Mixed Reality plugin in your Unreal project.

  • Enable the OpenXR plugin in your Unreal project.

  • Install the latest OpenXR runtime on your HoloLens. Follow the instructions in Microsoft's documentation to update the OpenXR runtime on your device.

  • Optional: Install the Microsoft OpenXR Plugin

To use HoloLens specific features, such as HoloLens remoting, you need to download and install the Microsoft OpenXR plugin from the Marketplace

Oculus

Complete the following items to begin using your Oculus devices with OpenXR in the Unreal Editor:

  • Complete the steps in Oculus Prerequisites to set up your computer and device.

  • Enable the OpenXR plugin in your Unreal project.

SteamVR

Complete the following items to begin using your SteamVR devices with OpenXR in the Unreal Editor:

  • Complete the steps in SteamVR Prerequisites to set up your computer and device.

  • Enable the OpenXR plugin in your Unreal project.

OpenXR Runtime Environment Variable

If there are several OpenXR runtimes on your computer, you will need to set an environment variable so that Unreal Engine can find the correct OpenXR runtime.

While each OpenXR compatible runtime should support any OpenXR device, for best results, install the official runtime (SteamVR for Vive/Index, Oculus app for Quest, etc). You can do this manually but we use, and recommend using OpenXR Explorer. It allows for easy switching between OpenXR runtimes, shows lists of the runtime's supported extensions, and allows for inspection of common properties and enumerations, with direct links to relevant parts of the OpenXR specification.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel