Documentation

Introduction and Version Compatibility

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). The OculusPlatform plugin provides an online subsystem which interfaces with Oculus Platform features. The OculusInput plugin provides support for Oculus Touch and Oculus Remote controllers.

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 most professional developers, we recommend the source distribution hosted on Epic’s private GitHub repository here: https://github.com/EpicGames/UnrealEngine. It is available to developers who are subscribed to the private EpicGames/UnrealEngine repository. For more information on accessing this repository, see https://www.unrealengine.com/ue4-on-github.

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 https://www.unrealengine.com/ue4-on-github for details).

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/.

Unreal/Oculus SDK Version Compatibility

The Oculus Unreal SDK requires Windows 7 or later.

Oculus GitHub Repository
Branch Oculus PC SDK Oculus Mobile SDK Tag
4.10 1.4.0 1.0.2 oculus-4.10.4-release-1.4.0
4.11 1.6.0 1.0.3 oculus-4.11.2-release-1.6.0
4.12 1.10.1 1.0.3 oculus-4.12.5-release-1.10.1
4.13 1.11.0 1.0.3 oculus-4.13.2-release-1.11.0
4.14 1.13.0 1.0.3 oculus-4.14.3-release-1.13.0
4.15 1.13.0 1.0.4 oculus-4.15.1-release-1.13.0
Epic GitHub Repository
Branch Oculus PC SDK Oculus Mobile SDK Tag
4.10 0.8.0 0.6.2 4.10.4-release
4.11 1.3.0 1.0.1 4.11.2-release
4.12 1.3.2 1.0.1 4.12.5-release
4.13 1.6.0 1.0.3 4.13.2-release
4.14 1.8.0 1.0.3 4.14.3-release
4.15 1.10.0 1.0.3 4.15.1-release
Loading…