Develop
Develop
Select your platform

Getting Started with Interaction SDK

Updated: Aug 7, 2025
This tutorial explains how to create your first interactions using Interaction SDK. You will add the Interaction SDK rig to your scene, set up a UI, and add interactions to enable users to interact with the UI.
Runtime Unity XR and the Project Setup Tool
If you must use Unity XR instead of the Meta XR Core SDK, see Getting Started with Interaction SDK and Unity XR.

Prerequisites

Before proceeding with this tutorial, complete the setup steps outlined in the following sections:

Installation

Follow these steps to add the Meta XR Interaction SDK dependency to your Unity project:
  1. Ensure you are logged into the same Unity account in both Unity Hub and the Unity website.
  2. Navigate to the Meta XR Interaction SDK on the Unity Asset Store.
  3. Select Add to My Assets.
  4. From the Unity Editor, select Window > Package Manager to view your installed packages.
  5. Navigate to My Assets in the Package Manager, select Meta XR Interaction SDK, and click Install.
  6. Confirm that you see the Meta XR Interaction SDK folder in the Packages directory.
Packages listed in the Project window
To import the Interaction SDK samples:
  1. From the Package Manager, select Meta XR Interaction SDK and then select the Samples tab.
  2. Click Import next to each sample you want to import.
    Import samples

Run the Unity Project Setup Tool

The Unity Project Setup Tool optimizes Android project settings for Meta Quest Unity apps, including texture and graphics settings. The tool applies the required settings for creating Meta Quest XR apps, including setting the minimum API version and using ARM64.
  1. Navigate to Meta > Tools > Project Setup Tool.
  2. In the checklist under the Android icon tab of the Project Setup Tool, select Fix All.
  3. If you still see Recommended Items in the list, select Apply All.
    Project Setup Tool Apply All

Add the rig

Instead of manually adding these prefabs to the scene, we recommend using Interaction SDK Quick Actions, which finds or adds any missing dependencies such as the camera rig. You can read a more advanced guide about how to use this rig in Comprehensive Interaction Rig.
  1. Delete the default Main Camera if it exists since since Interaction SDK uses its own camera rig.
  2. Right click on the Hierarchy and select the Interaction SDK > Add OVR Interaction Rig Quick Action.
    Using the Interaction SDK Rig Wizard
  3. If you have an OVRCameraRig in the scene, it will appear referenced in the wizard, click Fix All if there is no camera rig so the wizard creates one.
    Fix All Button
  4. If you don’t need smooth locomotion in your scene, disable the Smooth Locomotion option or your camera might fall infinitely when starting the scene if there is no ground collider present.
  5. In Unity its not possible to save modifications to a rig prefab in a package folder directly, but Unity 2022+ can create a copy of the prefab for you to overwrite as needed. Select Generate as Editable Copy and set the Prefab Path to store a intermediary copy of the rig prefab so you can store as many overrides as needed.
  6. If you want to further customize the rig, adjust the settings in the wizard. For details on the available options, please see the OVR Interaction Rig Quick Action documentation.
  7. Click Create to add the OVR Interaction Rig to the scene.
    Components for the UnityXR Interaction Rig are added
  8. In the Hierarchy, select the OVRCameraRig.
  9. On the Inspector tab, go to OVR Manager > Quest Features, and then on the General tab, in the Hand Tracking Support list, select Controllers and Hands, Hands Only or Controllers only depending on your needs. The Hands Only option lets you use hands as the input modality without any controllers.

Set up your UI

  1. In the Project panel, navigate to the Packages > com.meta.xr.sdk.interaction > Runtime > Sample > Objects > UISet > Prefabs > Backplate folder and add a backplate for the UI by dragging the EmptyUIBackplateWithCanvas prefab to the Hierachy panel.
    Drag and drop the backplate prefab
    The backplate prefab contains a Canvas, a background for the UI, some basic layout components, and ray and poke interactable components to enable direct touch and raycast interactions with the UI.
    UI backplate prefab
  2. In the Hierarchy, select the CanvasRoot. In the Inspector, under Rect Transform, you can use the Width and Height properties to set the size of the Canvas. In this example, we have use the following settings to scale it to a reasonable size for a few components:
    • Rect Transform > Width: 500
    • Rect Transform > Height: 250
  3. In the Hierarchy, select the UIBackplate. In the Inspector, under Rect Transform, set the set the Width and Height properties to match the canvas width and height set in the previous step. In this example, we have use the following settings to match the canvas size:
    • Rect Transform > Width: 500
    • Rect Transform > Height: 250
  4. Add some UI elements to the panel to interact with by dragging and dropping prefabs from the Packages > com.meta.xr.sdk.interaction > Runtime > Sample > Objects > UISet > Prefabs folder. For example, in the Buttons > UnityUIButtonBased folder, drag the PrimaryButton_IconAndLabel_UnityUIButton prefab to the UIBackplate object in the Hierarchy. The button element appears on the UI. Add as many elements as you desire to create your UI.
    UI with elements

Make the UI grabbable

  1. Right-click on the Canvas object for your UI and select Interaction SDK > Add Grab Interaction. The Grab wizard appears.
    The Grab Wizard
  2. In the Grab wizard, select Fix All to fix any errors. This will add missing components or fields if they’re required.
    The fix all option
  3. If you want to further customize the interaction, adjust the interaction’s settings in the wizard. For details on the available options, please see the Grab Quick Action documentation.
  4. Select Create. The wizard automatically adds the required components for the interaction to the GameObject. It also adds components to the camera rig if those components weren’t already there.
    The automatically added GameObjects for a grab interaction.
Use Link to test your project.
  1. Open the Link desktop application on your computer.
  2. Put on your headset, and, when prompted, enable Link.
  3. On your development machine, in Unity Editor, select the Play button.
  4. In your headset, you can interact with the UI directly or at a distance using ray-casting. The UI can be moved around by grabbing it.

Test your Interaction with an APK

Build your project into an .apk to test your project.
  1. Make sure your headset is connected to your development machine.
  2. In Unity Editor, select File > Build Settings. Add your scene to the Scenes In Build list by dragging it from the Project panel or clicking Add Open Scenes.
  3. Click Build and Run to generate an .apk and run it on your headset. In the File Explorer that opens, select a location to save the .apk to and give it a name. The build process may take a few minutes.
  4. In your headset, you can interact with the UI directly or at a distance using ray-casting. The UI can be moved around by grabbing it.

Learn more

Next steps

Add some GameObjects and make them interactable with Quick Actions.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon