Getting Started with MRTK

MRTK Logo

The Mixed Reality Toolkit (MRTK) is a cross-platform toolkit for building Mixed Reality experiences for Virtual Reality (VR) and Augmented Reality (AR).

Prerequisites

To get started with the Mixed Reality Toolkit you will need:

Getting started tutorials

If you are new to MRTK, or MR development, we recommend you check out the Getting started tutorials which uses MRTK v2.

Add MRTK to your Unity Project

Get the latest MRTK Unity packages

  1. Go to the MRTK release page.
  2. Under Assets, download
    • Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage
    • Microsoft.MixedRealityToolkit.Unity.Extensions.unitypackage
    • Microsoft.MixedRealityToolkit.Unity.Tools.unitypackage
    • Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage

For additional delivery mechanisms, please see Downloading the MRTK.

Switch your Unity project to the target platform

The next step Import MRTK packages into your Unity project will apply changes to your project specifically for the platform that is selected in the project at that moment you import them.

You should make sure that you select the correct platform before following the next step.

For instance, if you want to create a HoloLens application, switch to Universal Windows Platform:

  • Open menu : File > Build Settings
  • Select Universal Windows Platform in the Platform list
  • Click on the Switch Platform button

Import MRTK packages into your Unity project

  1. Create a new Unity project, or open an existing project. When creating a project, make sure to select "3D" as the template type.
  2. Import the Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage you downloaded by going into "Asset -> Import Package -> Custom Package", selecting the .unitypackage file, ensure all items to import are checked, and then selecting "Import".
  3. Import the Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage following the same steps as above. The examples package is optional and contains useful demonstration scenes for current MRTK features.
  4. Import the Microsoft.MixedRealityToolkit.Unity.Tools.unitypackage following the same steps as for the foundation package. These tools package is optional and contains useful tools, such as the ExtensionServiceCreator, that enhance the MRTK developer experience.
  5. Import the Microsoft.MixedRealityToolkit.Unity.Extensions.unitypackage following the same steps as for the foundation package. The extensions package provides a set of useful optional components for the MRTK.

After importing the Foundation package, you may see a setup prompt like the following:

UnitySetupPrompt

MRTK is attempting to set up your project for building Mixed Reality solutions by doing the following:

  • Enable XR Settings for your current platform (enabling the XR checkbox).
  • Force Text Serialization / Visible Meta files (recommended for Unity projects using source control).

Accepting these options is completely optional, but recommended.

Some prefabs and assets require TextMesh Pro, meaning you have to have the TextMesh Pro package installed and the assets in your project (Window -> TextMeshPro -> Import TMP Essential Resources). After you import TMP Essentials Resources, you need to restart Unity to see changes.

Open and run the HandInteractionExamples scene in editor

HandInteractionExample scene

The hand interaction examples scene is a great place to get started because it shows a wide variety of UX controls and interactions in MRTK. To get started we will import MRTK, open the example scene, and explore the scene in the editor.

  1. Create a new Unity project and then import both the Foundation and Examples unity packages following the steps above.

  2. Open the HandInteractionExamples scene under Assets\MixedRealityToolkit.Examples\Demos\HandTracking\Scenes\HandInteractionExamples

  3. You may get a prompt asking you to import "TMP Essentials".

TMP Essentials

If you get such a prompt, select "Import TMP essentials" button. "TMP Essentials" refers to Text Mesh Pro plugin, which some of the MRTK examples use for improved text rendering. (See Text in Unity for more detailed information)

  1. Close the TMP dialog. After this you need to reload the scene. You can do this by double clicking the scene in the project tab.

  2. Press the play button.

Using the In-Editor Hand Input Simulation to test a scene

The in-editor input simulation allows you to test virtual object behavior given a specific type of input such as hands or eyes.

How to move around in the scene:

  • Use W/A/S/D keys to move the camera forward/left/back/right.
  • Press and hold the right mouse to rotate the camera.

How to simulate hand input:

  • Press and hold the space bar to enable the right hand.
  • While holding the space bar, move your mouse to move the hand.
  • Use the middle mouse scroll to adjust the depth of the hand.
  • Click the left mouse to switch gestures.

Have fun exploring the scene! You can learn more about the UI controls in the hand interaction examples guide. Also, read through input simulation docs to learn more about in-editor hand input simulation in MRTK.

Congratulations, you just used your first MRTK scene. Now onto creating your own experiences...

Add MRTK to a new scene or new project

  1. Create a new Unity project, or start a new scene in your current project.

  2. Make sure you have imported the MRTK packages (we recommend both Foundation and Examples, though Examples is not required) following the steps above.

  3. From the menu bar, select Mixed Reality Toolkit -> Add to Scene and Configure

Configure to scene

  1. You will see a prompt like this:

MRTK Configure Dialog

Click "OK".

  1. You will then be prompted to choose an MRTK Configuration profile. Double click "DefaultMixedRealityToolkitConfigurationProfile".

MRTK Select Configure Dialog

NOTE: Note that if you are getting started on the HoloLens 2, you should choose the "DefaultHoloLens2ConfigurationProfile" instead. See the profiles for more information on the differences between DefaultMixedRealityToolkitConfigurationProfile and DefaultHoloLens2ConfigurationProfile.

You will then see the following in your Scene hierarchy:

MRTK Scene Setup

Which contains the following:

  • Mixed Reality Toolkit - The toolkit itself, providing the central configuration entry point for the entire framework.
  • MixedRealityPlayspace - The parent object for the headset, which ensures the headset / controllers and other required systems are managed correctly in the scene.
  • The Main Camera is moved as a child to the Playspace - Which allows the playspace to manage the camera in conjunction with the SDKs

Note While working in your scene, DO NOT move the Main Camera (or the playspace) from the scene origin (0,0,0). This is controlled by the MRTK and the active SDK. If you need to move the players start point, then move the scene content and NOT the camera!

  1. Hit play and test out hand simulation by pressing spacebar.

You are now ready to build and deploy to device! Follow the steps instructions at Build and Deploy MRTK.

Next steps

Here are some suggested next steps:

Building blocks for UI and interactions

Button Button Bounding Box Bounding Box Manipulation Handler Manipulation Handler
A button control which supports various input methods including HoloLens 2's articulated hand Standard UI for manipulating objects in 3D space Script for manipulating objects with one or two hands
Slate Slate System Keyboard System Keyboard Interactable Interactable
2D style plane which supports scrolling with articulated hand input Example script of using the system keyboard in Unity A script for making objects interactable with visual states and theme support
Solver Solver Object Collection Object Collection Tooltip Tooltip
Various object positioning behaviors such as tag-along, body-lock, constant view size and surface magnetism Script for lay out an array of objects in a three-dimensional shape Annotation UI with flexible anchor/pivot system which can be used for labeling motion controllers and object.
App Bar App Bar Pointers Pointers Fingertip Visualization Fingertip Visualization
UI for Bounding Box's manual activation Learn about various types of pointers Visual affordance on the fingertip which improves the confidence for the direct interaction
Slider Slider MRTK Standard Shader MRTK Standard Shader Hand Joint Chaser Hand Joint Chaser
Slider UI for adjusting values supporting direct hand tracking interaction MRTK's standard shader supports various fluent design elements with performance Demonstrates how to use solver to attach objects to the hand joints
Eye Tracking: Target Selection Eye Tracking: Target Selection Eye Tracking: Navigation Eye Tracking: Navigation Eye Tracking: Heat Map Eye Tracking: Heat Map
Combine eyes, voice and hand input to quickly and effortlessly select holograms across your scene Learn how to auto scroll text or fluently zoom into focused content based on what you are looking at Examples for logging, loading and visualizing what users have been looking at in your app

Tools

| Optimize Window Optimize Window | Dependency Window Dependency Window | Build Window Build Window | Input recording Input recording |

| :--- | :--- | :--- | :--- | | Automate configuration of Mixed Reality projects for performance optimizations | Analyze dependencies between assets and identify unused assets | Configure and execute end-to-end build process for Mixed Reality applications | Record and playback head movement and hand tracking data in-editor |

Upgrading from the HoloToolkit (HTK/MRTK v1)

There is not a direct upgrade path from the HoloToolkit to Mixed Reality Toolkit v2 due to the rebuilt framework. However, it is possible to import the MRTK into your HoloToolkit project and migrate your implementation. For more information please see the HoloToolkit to Mixed Reality Toolkit Porting Guide