Unity Starter Samples

The starter samples you will find here are to help you navigate and understand our APIs with more flexibility. We encourage you to look into them, test them out and inspire yourself on how the APIs can be used in your own project.

The Oculus License applies to the samples.

This project was built using the Unity engine.

Getting The Code

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

git clone https://github.com/oculus-samples/Unity-StarterSamples.git

How to run the project in Unity

1. Make sure you're using Unity 2021.3.26f1 or newer.
2. In the Project window, navigate to Assets/StarterSamples/Usage.
3. Click on individual scenes.
4. Click Play button to explore scene functionality in Unity.

How to test on device

1. Navigate to Oculus > Samples > Build Starter Scene to build an APK that will launch the Starter Scene.
   
   * In this apk you will be able to cycle through the different sample scenes to test them out on device.
2. Navigate to the Unity-StarterSamples folder and copy the StartScene.apk to your device using Meta Quest Developer Hub.

SDK Dependencies

All Meta SDKs can be found in the Unity Asset Store. This project depends on SDKs defined in the Packages/manifest.json:

• Meta XR Core SDK
• Meta XR Platform SDK

Integrate Samples to your own project

1. Make sure your project uses the same SDK version

2. Move the samples to your project

   Copy Samples directory

   • Copy Assets/StarterSamples directory to your own project
   Create UnityPackage and Import it

   1. Open Unity-StarterSamples project in Unity
   2. Right-click on Assets/StarterSamples and select Export Package...
   3. Save package in an easy location to retrieve
   4. Open your own project (where you want the samples to be added)
   5. Click on Assets->Import Package->Custom Package... from the menu bar
   6. Find the package we saved in step 3 and click Open