Microtube Docs
Ctrl K
EN中文
SDK 0.9.4DevelopersGitHub ↗
Developers / Godot / Project setup

Godot project setup

Install the HexR addon and set your project up for Meta Quest and PICO.

What you need

RequirementDetails
Godot 4.6 or newerThe standard build; .NET is not needed. Tested on 4.7.2.
Android exportAndroid SDK, JDK 17 and Godot’s export templates, set up as in Godot’s Android export guide.
OpenXR Vendors plugin5.1.0 or newer, for Meta Quest and PICO. HexR Tools installs it for you (below).
A headsetMeta Quest 2, 3, 3S or Pro, or PICO 4 / 4 Ultra, in developer mode.

Install the addon

Where Unity developers paste the package’s git URL into the Package Manager, Godot developers add an addon folder to the project.

  1. Get the release

    Download HexR-Godot.zip from the addon’s latest release ↗. It holds the scripts and the native Bluetooth layers for Android and Windows. 0.2.0 is a preview: its API may still change before 1.0.

  2. Unzip it into your project

    So that you have res://addons/hexr/.

  3. Enable it

    Project → Project Settings → Plugins, tick HexR. This adds the HexR autoload and names physics layers 20 (hexr_touch) and 21 (hexr_interactable). As in Unity, a HexR menu appears in the editor’s menu bar, and the HexR Tools dock under the Inspector.

To update later: HexR Tools → Project Setup → Check for updates (Unity: Package Manager → Update). Coming from 0.1? Delete addons/hexr first, install the new release, then run HexR → Migration → Upgrade 0.1 Scenes before opening your scenes.

Set up the headset

HexR Tools → Project Setup does this for you: tick Meta Quest and PICO, then Install the OpenXR Vendors plugin, Apply the XR settings and Add the export presets. The settings it makes, if you would rather set them by hand:

  1. OpenXR and hand tracking

    Project Settings → XR → OpenXR: Enabled, Extensions → Hand Tracking and Hand Interaction Profile on. XR → Shaders → Enabled.

  2. Android build template

    Project → Install Android Build Template. HEXR’s Bluetooth plugin and the OpenXR Vendors plugin both need Gradle builds.

  3. Export preset

    Add an Android preset: Use Gradle Build on, ARM64 only, XR Mode OpenXR, Enable Meta Plugin, Hand Tracking optional or required, Hand Tracking Frequency high, and the Quest models you target.

  1. OpenXR and hand tracking

    As for Quest: OpenXR enabled, Hand Tracking and Hand Interaction Profile on, XR shaders on.

  2. Android build template

    Project → Install Android Build Template.

  3. Export preset

    Use Gradle Build on, ARM64, XR Mode OpenXR, Enable Pico Plugin, PICO Hand Tracking on, minimum SDK 29 (PICO 4 runs Android 10).

Location on PICO

Android 10 lists Bluetooth devices only while the system Location switch is on, and asks for the Location permission. The status text says so when it is off.

On Windows 10 or 11 (64-bit), the editor itself can connect to a glove, through HexR Tools’ Haptics Tester. Nothing to set up: the addon ships the Bluetooth extension. Windows builds connect the same way. macOS and Linux load cleanly but use simulated gloves.

Check it

HexR → Troubleshoot → Validate Scene Setup opens HexR Tools’ HexR Setup tab: press Fix all, or Fix on any row marked !.

Rather start from a working project? Use the Quest & PICO walkthrough.

Next

Put hands and the HEXR rig in a scene: Scene setup.