Skip to content

Suriya-Palaniswami/Hand-Tracking-Template-OpenXR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hand Tracking Template – OpenXR

A Unity OpenXR template showcasing hand-tracking interactions built on top of the XR Interaction Toolkit and XR Hands packages. The project is pre-configured for Meta Quest and Pico standalone headsets, letting you build for either target from the same code base via custom Platform Build Tools editor scripts.


Prerequisites

  1. Unity Editor 6000.0.23f1 (or a newer Unity 6.0 Tech-Stream build).
    • Install through Unity Hub.
    • Add Android Build Support (SDK + NDK + OpenJDK) when installing.
  2. Git LFS – large binary assets are tracked with LFS. Install from https://git-lfs.com/ and run git lfs install once.
  3. Meta Quest / Pico VR headset (for deployment & testing).
  4. Optional – Pico OpenXR plugin
    • The project references the Pico OpenXR package via a local path in Packages/manifest.json:
      "com.unity.xr.openxr.picoxr": "file:C:/Users/suriy/Documents/PICO-OpenXR"
    • Clone (or download) Pico’s OpenXR SDK into any folder on your machine and update that path in manifest.json accordingly, e.g.
      "com.unity.xr.openxr.picoxr": "file:D:/SDKs/PICO-OpenXR"

Why Unity 6000? Unity 6.0 adds native support for the XR Hands package used by this template. Opening the project in earlier Unity versions will lead to compilation errors.


Getting the Project

# Clone with submodules & LFS
git clone https://github.com/<your-org>/hand-tracking-template-openxr.git
cd hand-tracking-template-openxr

# Pull down large binary files
git lfs pull

Alternatively download the repository as a zip from GitHub and unzip it.


Opening in Unity

  1. Open Unity Hub → Projects → Open and select the project folder.
  2. Unity will prompt to install the correct editor version if it isn’t installed yet – accept the prompt.
  3. Wait while Unity restores packages (watch the Package Manager window).
  4. Open Assets/Scenes/SampleScene.unity or any demo scene.
  5. Press Play – you should see articulated hand models in the Game view when using a supported XR runtime.

Building & Deploying

Custom editor menu items automate platform configuration and builds.

  1. Switch the Build Target to Android (File → Build Settings… → Android → Switch Platform).
  2. Use the Build menu:
    • Build → Build for Meta Quest
    • Build → Build for Pico

The script will:

  • Enable / disable the correct OpenXR Interaction Profiles.
  • Adjust OpenXR feature sets (hand tracking, controller profiles, etc.).
  • Increment the PlayerSettings.bundleVersion and bundleVersionCode.
  • Create an APK in a Builds/<Platform>/ folder.

💡 Connect the headset via USB and enable USB Debugging to install & launch the build automatically.


Package List (excerpt)

  • com.unity.xr.hands 1.6.0 – Hand tracking data provider.
  • com.unity.xr.interaction.toolkit 3.0.8 – Interaction system.
  • com.unity.xr.openxr 1.12.1 – OpenXR loader.
  • com.unity.render-pipelines.universal 17.0.3 – URP rendering.

Troubleshooting

Issue Fix
Packages fail to resolve Make sure you’re using Unity 6.0 Tech-Stream or later.
Pico build errors Verify the com.unity.xr.openxr.picoxr path in Packages/manifest.json points to a valid Pico OpenXR SDK folder.
Hand mesh invisible Check that XR Hand Mesh Controller feature is enabled in Project Settings → XR Plug-in Management → OpenXR → Features.

License

This project is licensed under the MIT License.


Made with ♥ and Unity OpenXR.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors