ULTRALEAP Plugin FOR UNITY

 
 

Tools and utilities to connect Unity applications to hand tracking data. Award-winning Interaction Engine to use and apply real-world physics, tools you need to rig your own 3D hand assets, and optimized and rigged hand models.

There are different options for installation, choose the best one for you:

UNITY PACKAGES

OpenUPM

For more information, including contributor workflows, see the Installation section of the readme.

Requirements

The Unity Plugin is intended to be opened in either Unity 2019.4 LTS or 2020.3 LTS. It also requires the latest version of our Hand Tracking Software, Ultraleap Gemini (V5.2+). If you are upgrading from a previous version of our Unity Plugin, we strongly recommend you read our guide to Upgrading to the Unity Plugin from Unity Modules.

The Ultraleap Unity Plugin is subject to the Ultraleap Tracking SDK Agreement. The Unity Plugin is also available on GitHub and can be used with MRTK-Unity.

What’s Included?

 

Core

A minimal interface between Unity and Ultraleap Hand Tracking Software. Render a basic set of hands, attach objects to hand joints, and more.

 

Interaction Engine

Physics representations of hands and VR controllers, fine-tuned with interaction heuristics to provide a fully-featured interaction API. Includes grasping, throwing, stable “soft” collision feedback, and hand proximity detection. Also comes with a suite of examples and prefabs.

 

Hands module

Set of scripts to help you bind Ultraleap data to your own hand assets. Provides the tools you need to rig your own 3D hand assets, including the powerful hands-auto-binding-tool. Also comes with range of optimized and rigged hand models.

Quick Setup Guide – OpenUPM

You can now get our Unity Plugin via OpenUPM.

  • Ensure that you have the Ultraleap Hand Tracking Software (V5.2+) installed.

  • Remove any existing Ultraleap Unity modules from your project. If you need to do this, we strongly recommend you read our guide to Upgrading to the Unity Plugin from Unity Modules.

  • Setup only needs to be performed once per Unity project. In Unity, select Edit -> Project Settings -> Package Manager, add a new scoped registry with the following details:

    • Name: Ultraleap

    • URL: https://package.openupm.com 

    • Scope(s): com.ultraleap

  • 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.

Quick Setup Guide – Unity package files (.unitypackage)

If you prefer you can get the Ultraleap Hand Tracking Plugin for Unity using .unitypackage files. This can be helpful if you need to modify the package content. Please note that for future releases .unitypackage files will need to be updated manually.

  • Ensure that you have the Ultraleap Hand Tracking Software (V5.2+) installed.

  • Remove any existing Ultraleap Unity modules from your project. If you need to do this, we strongly recommend you read our guide to Upgrading to the Unity Plugin from Unity Modules.

  • Download the Unity Modules package.

  • Right-click in the Assets window, go to Import Package and left-click Custom Package.

  • Find the Tracking.unitypackage and import it. This includes Core, Interaction Engine, and the Hands Module.

  • Optionally import:

    • the Tracking Examples.unitypackage for example content

    • the Tracking Preview.unitypackage and Preview Examples.unitypackage for experimental content and examples. This can go through many changes before it is ready to be fully supported. At some point in the future, preview content might be promoted to the stable package, however it might also be deprecated instead. Because there is no guarantee for future support, we do not recommend using preview packages in production.

  • Our plugin content is added to Assets/ThirdParty/Ultraleap/Tracking from where you will see Core, Hands, Interaction Engine and (optional) Examples folders.

Documentation

Full Unity documentation is available on our Developer Resources site. This includes:

  • Detailed setup guide

  • How to upgrade from previous versions of our Unity Modules

  • Core concepts, components, and prefabs

  • How to get started with each module (Hands, Interaction Engine, Core)

  • Troubleshooting

LEGACY RELEASES [4.9.1 and older]

Past versions of our Unity Plugin can be found in Legacy Releases and our legacy API documentation for 4.9.1 and older.

Next Steps