Oculus Quest: Quick Start
This guide covers everything you need to know to get started developing Unreal applications for the Oculus Quest.
Select an Unreal Engine Distribution
There are a number of ways that you can obtain the Oculus Unreal distributions:
- A binary distribution is provided through the Epic Game Launcher. This Oculus code may be a version or two behind the latest Oculus SDK. We recommend that beginning developers use this binary distribution. It is stable, and does not require pulling the source from GitHub, setting up Visual Studio, and performing a lengthy compilation of the entire Unreal game engine source code.
- A source distribution is provided through the Epic GitHub Repository. This Oculus code may be a version or two behind the latest Oculus SDK. Please see the Epic GitHub Repository table in Version Compatibility Reference, in order to choose the specific downloads that best suit your development criteria.
- A source distribution is provided through the Oculus GitHub Repository. These distributions are always up to date with the latest Oculus SDKs. We support the current release of UE4 and any preview of the next release of UE4. Please see the Oculus GitHub Repository table in Version Compatibility Reference, in order to choose the specific downloads that best suit your development criteria. While new Oculus features ship first to the Oculus GitHub versions, API changes may occur when these branches are merged back into Epic’s version of the engine. We recommend these distributions for professional developers who would like to access the latest Oculus SDK features. In order to build this source base, see Building UE4 from Source.
To access these GitHub repositories, you must 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 receive a 404 error. An Unreal license is not required.
- All versions of the Oculus Unreal SDK require Windows 7 or later.
- Setup the Oculus Quest for running, debugging, and testing applications, as described in Device Setup - Oculus Quest.
- Install CodeWorks for Android 1R6u1, which can be found in
Developing Applications with the UE4 Editor
- Download and setup the Unreal engine that you wish to use. Make sure you are using a compatible set of SDKs, as shown in the Version Compatibility Reference.
- From the Unreal Engine Launcher, press the Launch button to open the Unreal Project Browser.
- From the New Project tab of the Unreal Project Browser, create a new Blueprint project, with the following settings:
- Blank project
- Mobile / Tablet
- Scalable 3D / 2D
- No Starter Content
- Set the folder location
- Set the project name
Your screen should look like this:
Press the Create Project button to create the project and load a blank project.
Select Edit > Plugins, choose the Virtual Reality section, and make sure that the OculusVR Plugin is enabled.
In order to be able to run any Unreal Engine project when it is deployed to a device, including the Oculus Quest, you must save at least one UE4 Level. To keep the current Level, press the Save icon in the toolbar to save it. Give it a name, such as QSMap.
Select Edit > Project Settings. Then, under Project, select the Maps & Modes section:
Under Default Maps, set both the Editor Startup Map and the Game Default Map to the Level that you just saved:
Scroll down and select Engine > Input. Locate the Mobile section:
Set the Default Touch Interface to None:
The result should look like this:
Scroll down to the Platforms section, select Android. Then scroll down on the right-hand side to the APK Packaging section, and if necessary click Configure Now:
- Set the following settings:
- Minimum SDK Version: 25
- Target SDK Version: 25
- Enable FullScreen Immersive on KitKat and above devices: True
- Open Advanced APKPackaging and check Configure the AndroidManifest for deployment to Oculus Mobile. Also check Remove Oculus Signature Files from Distribution APK unless you’re building development apps for Gear VR.
Click on the Android SDK section, and make sure that Android SDK tools that are needed to build your project point to the correct folder on your PC and set to the correct API levels.
Scroll to the Engine section, select Rendering, and make sure Mobile HDR is turned off:
- You should now be able to develop your Unreal application for the Oculus Quest!
Launch the Unreal Project on the Oculus Quest
This section describes how to launch your UE4 project so that it can be viewed in the Oculus Quest headset.
- Make sure your Oculus Quest is connected to your development PC via the USB cable.
- Make sure you have installed and can run the Android Debug Bridge (ADB), and that your PC can see the Oculus Quest using the ADB command adb devices. For more information, see Adb in the Mobile SDK Developer Guide.
In the UE4 Editor, click beside the Launch icon to open Options for Launching on a Device:
- From the drop down list, select the device you want to deploy to. If you are prompted to save the project, make sure to do so even if you recently saved it. This will ensure that the latest content resides on your Oculus Quest.
- In the lower corner of the UE4 Editor, a progress bar indicates the status of the packaging process. If this is the first time you are packaging your project, it could take a few minutes, depending on the size of your project.
- When the process is complete, you should be able to launch the project and view it within your Oculus Quest headset.
Adding the Entitlement Check
All Unreal apps that ship on the Oculus Store are recommended to implement the Entitlement Check to verify that the user’s app is legitimate. For information about how to implement the Entitlement Check, please see the Unreal Development Getting Started in the Platform SDK guide.
Application Distribution Requirements and Guidelines
When you are ready to distribute your application, an Android Distribution Keystore is required for submission to the Oculus Store.
Before building your final release package, create a new Android keystore as described in the section “Manually Sign an APK” in Android’s Sign your Applications guide. Once you have generated your distribution keystore, in the Unreal Editor, go to Edit > Project Settings > Platforms > Android, scroll down to Distribution Signing, and enter the required information.
See the Application Signing section of the Mobile SDK documentation for more information.
Note: It is important to review Distribute, which covers Oculus Store submission requirements and guidelines.