Unreal Engine

Unreal is distributed with Oculus plugins which make it easy to develop for the Oculus Rift and Gear VR.

Applications targeting Oculus devices automatically apply stereoscopic rendering, orientation tracking (Rift and Gear VR), and positional tracking (Rift only).

Unreal Engine Distributions

Epic provides a binary distribution of UE4 through the Launcher, and a source distribution available from their GitHub repository. These distributions all contain Oculus support, but they may be a version or two behind the latest SDK.

Oculus also distributes UE4 through our own GitHub repository. These distributions are always up to date with the latest Oculus SDKs. We support the current release of UE4, the previous release of UE4, and any preview of the next release of UE4.

This development sequence is illustrated in the following chart:

Note that our features ship first to the GitHub versions we maintain in our own repository.

Which distribution should I use?

For beginning developers, we recommend the binary distribution of the Unreal engine available through the Launcher. It is the most stable, and does not require pulling from GitHub or compiling the engine source code. It is typically a few months behind the latest Oculus SDK features.

For professional developers who would like access to the latest SDK features, we recommend the source distributions hosted on Oculus’s private GitHub repository here: https://github.com/Oculus-VR/UnrealEngine.git.

To access this repository, you must hold a UE4 license and be subscribed to the private EpicGames/UnrealEngine repository (see UE4 of GitHub for details). If you are not subscribed and logged into your GitHub account, you will get a 404 error.

The standard source distribution is hosted on Epic’s private GitHub repository here: https://github.com/EpicGames/UnrealEngine.

It is typically about a month behind the Oculus branch in feature support. This branch is available to developers who are subscribed to the private EpicGames/UnrealEngine repository. Note that if you are not subscribed and logged into your GitHub account, you will get a 404 error. For more information on accessing this repository, see UE4 on GitHub.

OculusVR and Legacy Plugins

Beginning with Oculus integration 1.15, all Oculus functionality is provided through the OculusVR plugin. The OculusVR plugin is included with the latest Oculus versions of Unreal source 4.15 and later. All new features will be developed using the OculusVR plugin going forward.

Legacy versions of Unreal, including Unreal versions 4.15 and earlier using Oculus integration 1.14 or earlier, provide functionality through the OculusRiftHMD, GearVR, OculusInput, and OculustFunctionLibrary plugins.

What does this guide cover?

Unless otherwise noted, this documentation covers features included in Unreal versions available from Oculus’s private GitHub repository. Note that API changes may occur when these branches are merged back into Epic’s version of the engine.

For Epic's documentation about Oculus development, go to https://docs.unrealengine.com/latest/INT/Platforms/VR/.

Oculus Resources for the Unreal Developer

Platform SDK

  • The Oculus Platform supports features related to security, community, revenue, and engagement such as entitlement checking, matchmaking, in-app purchase, VoIP, and cloudsaves. For more information on the Platform Unreal plugin, see our Platform Developer Guide.

Avatar SDK

  • The Oculus Avatar SDK includes an Unreal package to assist developers with implementing first-person hand presence for the Rift and Touch controllers. It includes avatar hand and body assets viewable by other users in social applications for Rift and Gear VR. The first-person hand models and third-person hand and body models supported by the Avatar SDK automatically pull the avatar configuration choices the user has made in Oculus Home to provide a consistent sense of identity across applications. For more information, see our Avatar SDK Developer Guide.

Audio Resources

  • The Oculus Audio SDK includes spatialization plugins (OSPs) that provide HRTF spatialization and reverb modeling for audio editing tools commonly used with Unreal, including Audiokinetic Wwise and FMOD Studio. See Unreal VR Audio for more information.

Additional Resources

Facebook 360 Capture SDK

  • This sample SDK allows game and virtual reality developers to easily and quickly integrate 360 photo/video capture capability into their applications. It is available for use with Unreal VR applications, and may be downloaded from the Facebook GitHub repository.

Unreal/Oculus SDK Version Compatibility

The Oculus Unreal SDK requires Windows 7 or later.

Oculus GitHub Repository
BranchOculus PC SDK Oculus Mobile SDKOVRPluginTag
4.17 - - 1.17.0oculus-4.17.0-release-1.17.0
4.16 - - 1.16.0oculus-4.16.1-release-1.16.0 - oculus-4.15.3-release-1.14.0 - oculus-4.14.3-release-1.14.0 - oculus-4.13.2-release-1.11.0 - oculus-4.12.5-release-1.10.1 - oculus-4.11.2-release-1.6.0 - oculus-4.10.4-release-1.4.0
Epic GitHub Repository
BranchOculus PC SDK Oculus Mobile SDKOVRPluginTag
4.17 - - - 4.16.3-release - 4.15.3-release - 4.14.3-release - 4.13.2-release - 4.12.5-release - 4.11.2-release - 4.10.4-release