The Unity Starter Samples project includes sample scenes that demonstrate VR-specific features like hand presence with controllers, locomotion, and custom hands. Load sample scenes in Unity Editor to see feature implementation and integrate them in your projects. You can download the project from the Starter Samples GitHub repository.

You can use this project according to the terms in the license. For more information, see the LICENSE file in the root directory.

Oculus Integration SDK Release Deprecation

Oculus Integration SDK has been replaced by Meta XR UPM packages as of v59. To see instructions for the Sample Framework Scenes that are part of the Oculus Integration SDK, see Unity Sample Framework.

Getting the Starter Samples project

Clone this repo using the Code button in GitHub, or run this command:

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

How to run the project in Unity

Make sure you’re using Unity 2022.3.15f1 or newer (Unity 6+ is recommended).

In the Unity Hub > Project, click Add to add the project from disk.

Click to open the project in Unity.

Find the sample scenes in Assets/StarterSamples/Usage.

Double click on individual scenes to open them.

Click the Play button to explore scene functionality in Unity.

How to test on device

Navigate to Meta > 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.

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

URP support

The Starter Samples project supports using the Universal Render Pipeline.

After setting up your project for URP, use the Window > Rendering > Render Pipeline Converter material upgrade to automatically change all materials using the Standard shader to using the URP equivalent. All materials that have custom shaders have been modified to ensure that they support both the Built-in Render Pipeline and the Universal Render Pipeline.

Integrate samples to your own project

There are two ways to integrate the samples a project that uses the same Unity version.

Move the samples to your project

Copy the Assets > StarterSamples directory to your own project

Create UnityPackage to import

Open Unity-StarterSamples project in Unity.

Navigate to the Assets folder.

Right-click on StarterSamples and select Export Package....

Save package in an easy location to retrieve.

Open your own project.

Click on Assets > Import Package > Custom Package... from the menu bar.

Find the package we saved in step 3 and click Open.

Content and Sample Scenes

The Starter Samples feature reusable components that you can use in your projects, and sample scenes that demonstrate the behavior of these components.

Content used in the scenes can be found at Assets > StarterSamples > Usage.

The Unity Starter Samples project includes the following scenes:

Scene tutorial	Concepts illustrated
CustomControllers	Demonstrates how to use custom controller models and interactive animations, suitable for building tutorials or demos.
CustomHands	Demonstrates how to create and use custom hand models and animations.
EnableDisablePassthrough	Demonstrates how to test enabling and disabling the passthrough feature and layer.
Firebase	Demonstrates how to capture Firebase Analytics and Crashlytics metrics in your Unity app.
Hand Tracking	Demonstrates how to implement hand tracking to interact with objects in the physics system.
Locomotion	Demonstrates various movement control schemes.
OVROverlay	Demonstrates how creating a UI with an `OVROverlay` compositor layer improves image quality and text clarity.
OVROverlayCanvas	Demonstrates how to create a UI that renders a canvas as an overlay in your application.
OVROverlayCanvas_Text	Demonstrates how to display text on an overlay canvas in your application.
OverlayPassthrough	Demonstrates how to adjust the foreground properties of the passthrough layer in relation to virtual objects.
Passthrough	Demonstrates passthrough on augmented objects, lighting, overlay passthrough, hands, and styles. Also demonstrates selective passthrough and surface project passthrough.
PassthroughAtStartup	Demonstrates contextual passthrough.
Spatial Anchors	Demonstrates control and management of spatial anchors.
Start Scene	Demonstrates a scene selection menu containing other scenes from the Unity Starter Samples.
TouchProSample	Demonstrates the status of the index trigger, hand trigger, thumbrest press state, and actuators controlling a stylus pen.
Video	Demonstrates how to play a stereo 180-degree video.
WidevineVideo	Demonstrates how to incorporate WidevineVideo, Google’s digital rights management (DRM) platform in your app.