What is the Mixed Reality Toolkit

MRTK is a Microsoft driven open source project.

MRTK-Unity provides a set of foundational components and features to accelerate MR app development in Unity. The latest Release of MRTK (V2) supports HoloLens/HoloLens 2, Windows Mixed Reality, and OpenVR platforms.

• Provides the basic building blocks for unity development on HoloLens, Windows Mixed Reality, and OpenVR.
• Showcases UX best practices with UI controls that match Windows Mixed Reality and HoloLens Shell.
• Enables rapid prototyping via in-editor simulation that allows you to see changes immediately.
• Is extensible. Provides devs ability to swap out core components and extend the framework.
• Supports a wide range of platforms, including
  • Microsoft HoloLens
  • Microsoft HoloLens 2
  • Microsoft Immersive headsets (IHMD)
  • Windows Mixed Reality headsets
  • OpenVR headsets (HTC Vive / Oculus Rift)

Build Status

Branch	Status
mrtk_development

Required Software

Windows SDK 18362+	Unity 2018.3+	Visual Studio 2017	Simulator (optional)
To develop apps for Windows Mixed Reality headsets, you need the Windows 10 Fall Creators Update	The Unity 3D engine provides support for building mixed reality projects in Windows 10	Visual Studio is used for code editing, deploying and building UWP app packages	The Emulators allow you test your app without the device in a simulated environment

Feature Areas

• Input System
• Articulated Hands + Gestures (HoloLens 2)
• Eye Tracking (HoloLens 2)
• Voice Commanding
• Gaze + Select (HoloLens)
• Controller Visualization
• Teleportation
• UI Controls
• Solver and Interactions
• Spatial Understanding
• Diagnostic Tool

Getting Started with MRTK

Please check out the Getting Started Guide

More Documentation

Find this readme, other documentation articles and the MRTK api reference on our MRTK Dev Portal on github.io.

UI and Interaction Building blocks

Button	Bounding Box	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	System Keyboard	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	Object Collection	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	Pointers	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
Eye Tracking: Target Selection	Eye Tracking: Navigation	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

Example Scenes

Explore MRTK's various types of interactions and UI controls in this example scene.

You can find other example scenes under Assets/MixedRealityToolkit.Examples/Demos folder.

Engage with the Community

Join the conversation around MRTK on Slack.

Ask questions about using MRTK on Stack Overflow using the MRTK tag.

Search for known issues or file a new issue if you find something broken in MRTK code.

Join our weekly community shiproom to hear directly from the feature team. (link coming soon)

Deep dive into project plan and learn how you can contribute to MRTK in our wiki.

For issues related to Windows Mixed Reality that aren't directly related to the MRTK, check out the Windows Mixed Reality Developer Forum.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Useful Resources on Microsoft Windows Dev Center

Academy	Design	Development	Community
See code examples. Do a coding tutorial. Watch guest lectures.	Get design guides. Build user interface. Learn interactions and input.	Get development guides. Learn the technology. Understand the science.	Join open source projects. Ask questions on forums. Attend events and meetups.

Learn more about MRTK Project

You can find our planning material on our wiki under Project Management Section. You can always see the items the team is actively working on in the Iteration Plan issue.

How to Contribute

View the How To Contribute wiki page for the most up to date instructions on contributing to the Mixed Reality Toolkit!

For details on the different branches used in the Mixed Reality Toolkit repositories, check this Branch Guide here.