# XR

`v0.1.1-exp.7`   `19 Nov 2025`

The **MeshMap XR** package is *experimental* and contains cross-platform device SDK management systems, player rigs, interactables, interactors, UI, and marker tracking modules.

Some developers will find that building for one target XR device is sufficient, particularly when designing a unique location-based experience (LBE). This package is most useful when designing LBEs that reuse assets across several locations and target devices.

{% hint style="warning" %}
Due to its experimental nature, we do not yet recommend shipping this package in production or commercial projects. APIs may change without notice, and breaking changes are expected. Use is primarily intended for evaluation and prototypes.
{% endhint %}

{% hint style="info" %}
This package depends on a minimally modified version of the Magic Leap SDK to prevent compilation errors when building for multiple target XR devices with Unity OpenXR Plugin 1.15.0. In accordance with the [Magic Leap 2 Software License Agreement](https://www.magicleap.com/legal/software-license-agreement-ml2), the package is included when necessary in sample projects, but not redistributed solely on its own.

This package also depends on a minimally modified version of jp.keijiro.apriltag which includes the 36h11 tag family. It is licensed under the BSD 2-Clause License.
{% endhint %}

[**Changelog**](https://github.com/MeshMap/com.meshmap.sdk.xr/blob/main/CHANGELOG.md)

***

## Features

In addition to the samples below:

* **Cross-platform Management** — Editor tooling that automatically manages package wrapping, build profiles, and Android manifests for the supported target HMD devices and mobile spectator devices.
* **Rigs** — Generic XR rig assets.
* **Interactables** — Simple `XRBaseInteractable`-based classes and related components.
* **Interactors** — Simple `XRBaseInteractor`-based classes and related components.
* **UI** — Generic menu assets.
* **Marker Tracking** — Assets for supporting cross-platform fiducial marker tracking.

***

### Samples

To import a sample into your Unity project, go to `Windows > Package Manager > MeshMap XR > Samples`.

* **Marker Tracking** — Demonstrates how to set up a simple scene with marker tracking to localize content for location-based AR experiences.

***

## Getting Started

The easiest way to get started is to clone the [**MeshMap Location-based AR Sample** repository](https://github.com/MeshMap/LocationBasedARSample) and open the project using [Unity Hub](https://unity.com/unity-hub).

***

### Requirements

* Windows, Mac
* **Unity 6000.0.58f2 LTS**
  * Android Build Support
  * iOS Build Support
  * Universal Render Pipeline (URP)

{% hint style="info" %}
Other Unity versions *may* work but they have **not** been tested. We strongly recommend using the version listed above.
{% endhint %}

***

### Package Dependencies

* VContainer v1.16.8 (scoped registry)
* XR Plugin Management v4.5.1
* XR Interaction Toolkit v3.0.8
  * Starter Assets and Hand Interactions Demo samples.
* AR Foundation v6.2.0
* Google ARCore XR Plugin v6.0.6
* Apple ARKit XR Plugin v6.0.6
* XR Hands v1.5.1
  * Hand Visualizer sample.
* OpenXR Plugin v1.15.0
* XR Composition Layers v2.0.0
* Unity Meta OpenXR v2.2.0
* Unity Meta XR v74.0.0
* Unity Meta MR Utility Kit v74.0.0
* Magic Leap Unity SDK v2.6.0-pre.R15-meshmap
* XREAL Unity SDK v3.0.0
* [Keijiro AprilTag v1.0.2-meshmap.2](https://github.com/MeshMap/jp.keijiro.apriltag.meshmap)

***

### Import

The [com.meshmap.sdk.xr](https://github.com/MeshMap/com.meshmap.sdk.xr) package can be added via Unity Package Manager (UPM) from Git. Follow the import [instructions](https://docs.meshmap.com/unity-sdk/overview/using-our-packages).

***

### Basic Usage

After import, the files will be available in the Packages section of the Project window in Unity Editor.

***

## Settings, Permissions, and Installation

Review these settings configuration guides with reference images for each target device:

* [Magic Leap 2](https://docs.meshmap.com/unity-sdk/xr/cross-platform-management/magic-leap-2)
* [Meta Quest 3](https://docs.meshmap.com/unity-sdk/xr/cross-platform-management/meta-quest-3)
* [XREAL Air 2 Ultra](https://docs.meshmap.com/unity-sdk/xr/cross-platform-management/xreal-air-2-ultra)