Skip to content

Installation

Prefer video?

The video above walks through the full getting started flow — from installation to tracking your first object on a real device.

Requirements

  • Unity 6.0 or later (tutorial uses Unity 6.3)
  • Git LFS installed on your machine (required for native plugins)
  • Universal Render Pipeline (URP) recommended; Built-in Render Pipeline also supported
  • AR Foundation 6.x (for iOS/Android AR mode)

Render Pipeline

XRTracker works with both URP and the Built-in Render Pipeline. URP is recommended for new projects. All features, including edge outline visualization, work on both pipelines.

Install from GitHub

Add the package to your project's Packages/manifest.json:

{
  "dependencies": {
    "com.formulaxr.tracker": "https://github.com/FormulaXR/xrtracker-package.git"
  }
}

To pin a specific version:

{
  "dependencies": {
    "com.formulaxr.tracker": "https://github.com/FormulaXR/xrtracker-package.git#v1.0.0"
  }
}

Alternatively, in Unity: Window > Package Manager > + > Add package from git URL and paste:

https://github.com/FormulaXR/xrtracker-package.git

Git LFS Required

XRTracker uses Git LFS for native plugins (.dll, .so, .a). If Git LFS is not installed, the package will import but tracking will fail at runtime. Install it from git-lfs.github.com.

Verify Installation

After importing, you should have:

  • Components available in Add Component: XRTrackerManager, TrackedBody
  • GameObject > XRTracker menu with AR Tracker and PC Tracker shortcuts

Platform-Specific Setup

iOS / Android

Install AR Foundation and the corresponding provider:

  1. Window > Package Manager > Unity Registry
  2. Install AR Foundation
  3. Install ARKit XR Plugin (iOS) or ARCore XR Plugin (Android)

Then configure your build:

  1. Open Player Settings > Other Settings and remove Vulkan from the Graphics APIs list
  2. Open Build Profiles, select your target platform (Android or iOS), and switch the active platform
  3. Run Project Validation and fix any issues that appear

See AR Foundation Guide for detailed setup.

Windows (Desktop)

No additional packages required. XRTracker uses native capture from any connected camera. You may need a camera calibration file for best accuracy — see Camera Sources.

Licensing

Register for a free Developer license from the Unity Editor (Tools > XR Tracker > License Registration) to start tracking. No payment required.

For all license options, see the Licensing page.

Next Steps

Proceed to the Quick Start to track your first object.