Discover

Discover is a Mixed Reality (MR) project that demonstrates how to use key MR features and quickly integrate them in your own project.

This codebase is available both as a reference and as a template for MR projects. The Oculus License applies to the SDK and supporting material. The MIT License applies to only certain, clearly marked documents. If an individual file does not indicate which license it is subject to, then the Oculus License applies.

The EOS license can be found here.

See the CONTRIBUTING file for how to help out.

This project was built using the Unreal Engine with Epic Online Services (EOS).

You can test out the Unity version of the game on the Horizon Store.

Project Description

In this project you can see how we use Scene API, Interaction SDK, Passthrough, Spatial Anchors and Shared Spatial Anchors.

How to run the project in Unreal Engine

NOTE: This project can only be used with the Meta Quest fork of Unreal Engine. See Dependencies for more information.

1. Configure the project with Meta Quest and EOS

2. Make sure you're using Unreal Engine 5.5 or newer.

3. Load the MainMenuMap level.

4. To test in Editor you will need to use Quest Link:

   Quest Link

   • Enable Quest Link:
     • Put on your headset and navigate to "Quick Settings"; select "Quest Link" (or "Quest Air Link" if using Air Link).
     • Select your desktop from the list and then select, "Launch". This will launch the Quest Link app, allowing you to control your desktop from your headset.
   • With the headset on, select "Desktop" from the control panel in front of you. You should be able to see your desktop in VR!
   • Navigate to Unreal and change the Play Mode to "VR Preview" using the button with 3 stacked dots in UE's main toolbar.
   • The application should launch on your headset automatically

Dependencies

This project requires the Oculus fork of the UE5.5 game engine that you can find here.
NOTE: access to the Oculus fork requires access to Epic's GitHub.

The following is required to test this project within Unreal Engine:

• The Meta Quest Link app

Oculus Unreal fork

The Oculus Unreal fork will give you the most up to date integration of Oculus features. However, you must build the editor from its source.

1. Get access to the Unreal source code
2. Clone the oculus-5.5 branch of the Oculus fork
3. Install Visual Studio
4. Open a command prompt in the root of the Unreal, then run this command:

.\GenerateProjectFiles.bat -Game UnrealDiscover -Engine <full path to Unreal-Discover directory>\UnrealDiscover.uproject

5. Open the UnrealDiscover.sln file that has been generated in the Unreal-Discover directory.
6. Set UnrealDiscover as the start-up project and Development Editor as the configuration.
7. Hit F5 to build and debug the project (and the engine).

Getting the code

First, ensure you have Git LFS installed by running this command:

git lfs install

Then, clone this repo using the "Code" button above, or this command:

git clone https://github.com/oculus-samples/Unreal-Discover.git

Documentation

More information can be found in the Documentation section of this project.

• Configuration
• EOS Configuration
• Discover Overview
• Project Structure
• Shader Cache Scripts