Upgrading To the Unity Plugin from Unity Modules

Follow this guide to upgrade to the new Ultraleap Hand Tracking Plugin for Unity from our Unity Modules.

Removing the Existing Modules

The existing Unity Modules can be found at Assets/Plugins/LeapMotion. You will need to remove these assets from your project before upgrading to the Unity Plugin.

Quick Checks:

  • Make sure any unsaved changes you wish to keep are saved.

  • Make sure any assets for your project are not located in the Plugins Folder before pressing delete.

  • Ensure Unity is closed before pressing delete on the Plugins Folder.

Once the Modules are deleted you are able to re-open Unity, you will be faced with a wall of errors relating to missing scripts. You now need to install the new Unity Plugin.

Installing the Unity Plugin via OpenUPM

You can now get our Unity Plugin via OpenUPM.

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

  • Remove any existing Ultraleap Unity modules from your project.

  • 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

scoped registry
  • Open the Package Manager (Window -> Package Manager) and navigate to “My Registries” in the dropdown at the top left of the window.

my registries
  • Ultraleap UPM packages should be available in the list. Click on the package you wish to modify.

package list

Installing the Unity Plugin via .unitypackage files

If you prefer you can still use .unitypackage files to get your Ultraleap Hand Tracking Plugin for Unity. This can be helpful if you need to modify the package content. You need to be comfortable that you will have to check back regularly to get updated versions.

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

  • Remove any existing Ultraleap Unity modules from your project.

  • Download Unity Package file

  • 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, and/or the Tracking Preview.unitypackage and Preview Examples.unitypackage for experimental content and examples.

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

Other installation options

Other installation options are also available. See our Github repo for more information.

Requirements

Dependencies

If you are using Unity 2020.4 (LTS) or newer with XR then you will need to follow the Unity documentation on how to configure your project.

If you are using any of the scriptable render pipelines (SRP) then you will need to follow the appropriate Unity documentation for upgrading shaders:

If you are using Unity 2019.4 (LTS) and you get errors related to “SpatialTracking” upon importing, you will need to install the following package:

If you are using Unity 2020.1 or newer and you get errors related to “SpatialTracking” upon importing, you will need to install the following package:

Changelog

You can find information regarding changes in the Changelog, this will be updated with each new release.

Support

Internal testing suggests these are a few manual steps to update from the Modules to the Plugin:

Core

Leap Rig - This has been deleted as we no longer enforce a camera hierachy or a Hand Model Manager.
To re-create this in your scene, you will need to use:
  • Service Provider (XR) - Make sure to include a reference to the camera

  • A hand model of your choosing - Capsule hands can be found in the core folder All other hands can be found in the hands folder

LoPoly Rigged Hand Left LoPoly Rigged Hand Right

These have been moved to the Hands Module Folder.

Interaction Engine

Scripts lose references to interaction manager - You will need to manually update the reference to the Interaction Manager if its missing in the inspector