Creating a New MRTK3 Project

This guide provides instructions on how to create a new Magic Leap 2 project that uses MRTK 3. See the Magic Leap MRTK 3 Overview page for information on which features are currently supported on Magic Leap 2.

Prerequisites

Before starting, download and install the following packages from the Magic Leap Hub:

• Magic Leap SDK v1.2.0 (or later)
• Magic Leap Unity SDK v1.8.0 (or later)
• Unity Editor v2022.2.17f1 (or later)

Create a Magic Leap 2 Project

Ensure that you have a Unity project configured for Magic Leap 2 development. If you have not configure a project for Magic Leap 2, follow the Configure Unity Settings instructions.

Import Standard MRTK 3 Packages

Before importing the Magic Leap MRTK3 Integration Package, make sure to configure your project for MRTK3. This section offers general guidance on downloading and installing MRTK3 packages using the Mixed Reality Feature tool or microsoft's NPM web portal.

Mixed Reality Feature Tool

Use these instructions to install MRTK3 dependencies into your existing Magic Leap 2 project using the Mixed Reality Feature tool. Note that the Mixed Reality Feature Tool is only available for Windows.

Mixed Reality Feature Tool Welcome Screen

caution

Close the Unity project before using the Mixed Reality Feature tool.

1. Open the Mixed Reality Feature Tool.
2. Target your Unity project and select Discover Features
3. At a minimum, install the following required packages:

   - MRTK3 / MRTK Input
   - MRTK3 / MRTK UX Components
   ​ Note: If you do not see MRTK3, you may need to select the Show preview releases option located at the bottom of the window. ​
4. After choosing the packages to install, click Get Features. This will display the package dependencies.
5. Add the packages to your project by pressing Import then Approve.
6. Finally, select Exit to close the Mixed Reality Feature Tool. ​ For more information, see Microsoft's Starting from a new project guide.

Open the Unity project

1. Open the Unity project and wait for Unity to finish importing newly added packages.
2. Clear any errors that appear due to missing dependencies from a prefab or XR provider.

NPM Web Portal

If your development environment does not support the Mixed Reality Feature Tool, you can download the required packages via Microsoft's NPM Web Portal.

caution

Microsoft's NPM does not support being added to the Unity Package Manager as a registry and requires you to download the packages online manually.

Microsoft's NPM Website

Downloading the Packages

This section provides instructions on how to download and import the MRTK 3 packages without the Mixed Reality Feature Tool.

1. At a minimum download the required MRTK3 Packages. (Required packages are listed in bold.)

tip

We recommend placing the packages in your projects root directory to more easily track your project's dependencies and to make your project more compatible with version control systems.

Name	Download Link
MRTK Accessibility Early Preview	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.accessibility/overview/
MRTK Audio Effects	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.audio/overview/
MRTK Core Definitions	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.core/overview/
MRTK Diagnostics	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.diagnostics/overview/
MRTK Extended Assets	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.extendedassets/overview/
MRTK Graphics Tools	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.graphicstools.unity/overview/
MRTK Input	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.input/overview/
MRTK Spatial Manipulation	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.spatialmanipulation/overview/
MRTK Standard Assets	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.standardassets/overview/
MRTK Tools	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.tools/overview/
MRTK UX Components	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.uxcomponents/overview/
MRTK UX Components (Non Canvas)	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.uxcomponents.noncanvas/overview/
MRTK UX Core	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.uxcore/overview/
MRTK Visual Profiler	(Downloaded via git, can be added via package manager ) https://github.com/microsoft/VisualProfiler-Unity.git#v2.2.0
MRTK3 Data Binding and theming (experimental)	https://dev.azure.com/aipmr/MixedReality-Unity-Packages/_artifacts/feed/Unity-packages/Npm/com.microsoft.mrtk.data/overview

2. Open the Package Manager inside your project (Window > Package Manager)
3. Select the + icon, then Add package from tarball...
4. Select and import each of the packages downloaded in Step 1 in this order
   1. com.microsoft.mrtk.core-VERSION.tgz
   2. com.microsoft.mrtk.input-VERSION.tgz
   3. com.microsoft.mrtk.graphicstools-VERSION.tgz
   4. com.microsoft.mrtk.uxcore-VERSION.tgz
   5. com.microsoft.mrtk.spatialmanipulation-VERSION.tgz
   6. com.microsoft.mrtk.standardassets-VERSION.tgz
   7. com.microsoft.mrtk.uxcomponents-VERSION.tgz

note

For more information on MRTK 3 packages and their dependencies, see Microsoft's package overview page.