Getting Started

HEXR ships as a Unity package called com.microtube.hexr. You can add it to any Unity 2022.3 or newer project. Add it by git URL — Add package by name will not find it, because the package is not on a registry.

1. Open Package Manager

   In Unity, go to Window → Package Manager.

2. Add the package from its git URL

   Click the + button in the top-left corner and choose Add package from git URL…. Paste the URL below, then click Add.

https://github.com/MicrotubeTechnologies/com.microtube.hexr.git

That URL has no version on the end, so you get the latest release. If you need a project to stay on one exact version, add #v0.4.0 to the end. Unity remembers whichever one it fetched, so to pick up a newer release later use Window → Package Manager → com.microtube.hexr → Update.

Everything the glove needs comes with the package — the HaptGlove runtime and the Bluetooth support for Windows, Android and macOS. There is nothing else to download.

Next, choose an XR backend. HEXR works with either one, and it does not install one for you — you pick the one your project uses. Open HexR → HexR Tools → Project Setup and install whatever it lists as missing.

• OpenXR — every package comes from Unity's own registry, so the installer handles it in one click.
• Meta OVR — the Meta XR SDK is not on Unity's registry, so you have to add it to your Unity account once before Unity can install it. Open the free Meta XR All-in-One SDK on the Asset Store and click Add to My Assets. Then in Unity: Window → Package Manager → My Assets → Meta XR All-in-One SDK → Install. Project Setup has buttons for this, and a Re-scan to pick it up afterwards.

Prefer to start from a scene that already works? Each tutorial project ships the package plus a demo scene:

• OpenXR tutorial — Unity + OpenXR plugin
• Meta OVR tutorial — Unity + Meta OVR plugin
• MRTK tutorial — Unity + Mixed Reality Toolkit

Once the package is installed and you have chosen a backend, these four steps take a scene from empty to working haptics:

1. Add a hand-tracking rig to your scene

   HEXR attaches to a hand-tracking rig that is already there; it does not create one. Use Meta Building Blocks' Hand Tracking block, or an OpenXR rig with com.unity.xr.hands.

2. HexR → Create HexR Rig

   Pick Open XR or Meta OVR. This drops in the HexR Main rig and the Pressure Controllers that drive the glove.

3. HexR → Auto Setup Scene

   Wires the hand roots, fingertip and palm colliders, and the Pressure Controllers together.

4. HexR → Validate Scene Setup

   Reports anything still unwired before you press Play.

From there, drive the glove directly from any script. PressureTrackerMain is the per-hand haptics controller — one on each Pressure Controller:

using UnityEngine;
using HaptGlove;
using HexR;

public class TouchPulse : MonoBehaviour
{
    public PressureTrackerMain hand;   // the Left or Right Pressure Controller

    void OnTriggerEnter(Collider other)
    {
        // finger, on, intensity 0.1-1, ramp speed 0.1-1, bypass the hand-near check
        hand.CustomSingleHaptics(Haptics.Finger.Index, true, 0.8f, 1f, false);
    }

    void OnTriggerExit(Collider other)
    {
        hand.CustomSingleHaptics(Haptics.Finger.Index, false, 0f, 1f, false);
    }
}

Most scenes never need this: drop a HexRGrabbable or SpecialHaptics component on an object and it fires haptics from physics alone. See the Unity C# reference.