Getting started with Unity¶
Ultraleap Unity Plugin contains everything you need to get started with Ultraleap hand tracking in Unity.
Note
If you are looking to make use of an additional interaction system such as XR Interaction Toolkit (XRI) or Mixed Reality Toolkit (MRTK) follow this page first, to get set up. Then follow the relevant documentation to integrate with the interaction system of choice.
Prerequisites¶
Ultraleap
A computer that meets the Tracking Requirements
Ultraleap Hand Tracking Software (V5.2+) installed on the development computer. Also install the Hand Tracking Software for your specific XR device if building for an XR headset.
Unity
Familiarity with Unity’s XR project setup
Unity XR Plugin Management Package which can be installed from the Package manager window
An XR runtime plugin Package. We recommend OpenXR where possible.
Note
We recommend that you use OpenXR where possible. However, depending on the headset you may require a specific plugin if OpenXR is not supported. For example Pico, HTC Vive or Meta Quest
Warning
The Ultraleap plugin does not use Unity URP by default. If you are using URP, follow the steps to update the materials.
We do offer URP hand models which can be found in Assets/Samples/Ultraleap Tracking/x.x.x/URP Examples/Example Assets/Hands (URP) without needing to upgrade the materials. (Other assets will still need updating)
Set up hand tracking in Unity¶
How to install
Remove any existing Ultraleap Unity modules from your project
Note
We use OpenUPM to handle installing packages in this tutorial. This is our recommended method as it makes installing and upgrading packages easy.
You can also get the plugin as a .unitypackage or install using the git url. These can both be found on our open source github repository
- In Unity, select
Edit -> Project Settings -> Package Manager, add a new scoped registry with the following details: Name: Ultraleap
URL:
https://package.openupm.comScope(s): com.ultraleap
- In Unity, select
Open the Package Manager (
Window -> Package Manager) and navigate to “My Registries” in the dropdown at the top left of the window.
Ultraleap UPM packages should be available in the list. Add the “Ultraleap Tracking” package by selecting it in the list on the left then clicking install in the bottom right.
Include our example content, which demonstrates a lot of the features of the plugin and can be copied and expanded for your project, select the Samples for the package and import them via the Package Manager as shown below.
To Ensure that everything is set up and working, open the “Capsule Hands” scene in the package samples (
Assets > Samples> Ultraleap Tracking > x.x.x > Examples > 1. XR Examples > 2. Building Blocks > 1. Basics > 1. Capsule Hands.unity). With these steps completed, when pressing play, you should be able to see your hands tracking in the scene.
Note
This scene uses TextMesh Pro to display text. Import TMP Essentials if you are prompted to.
What’s next?¶
Now that you have had your first taste of hand tracking in Unity, why not try out setting up your own project or taking a look at our features.
Your first project teaches you how to set up your own scenes to use Ultraleap hand tracking.
