MixedRealityToolkit-Unity uses code from the base MixedRealityToolkit repository and makes it easier to consume in Unity.
Branch: mrtk_release
Clone or download
Latest commit 2b939bf Feb 22, 2019


What is MixedRealityToolkit-vNext

The V1 Mixed Reality Toolkit is a collection of scripts and components intended to accelerate development of applications targeting Microsoft HoloLens and Windows Mixed Reality headsets.

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

This new version of the MixedRealityToolkit aims to further extend the capabilities of the toolkit and also introduce new features, including the capability to support more VR/AR/XR platforms beyond Microsoft's own Mixed Reality setup.

The vNext branch is taking all the best lessons learned from the original Mixed Reality Toolkit and refactoring / restructuring it to both:

  • Support a wider audience, allowing solutions to be built that will run on multiple VR / AR / XR platforms such as Mixed Reality, Steam/Open VR and OpenXR (initially)

  • Provide an easier to use SDK, to enable rapid prototyping and ease adoption for new users (or users of previous frameworks)

  • Ensure an extensive framework for advanced integrators, with the ability to swap out core components with their own should they wish to, or simply extend the framework to add new capabilities.

Learn more about Windows Mixed Reality here.

Learn more about the architecture behind Windows Mixed Reality - vNext here.

Learn more about the approach behind the Windows Mixed Reality - vNext SDK here.

Feature areas

The Mixed Reality Toolkit vNext will includes many APIs to accelerate the development of MR / XR / VR / AR projects for a range of supported devices, including (but not limited to)

  • Microsoft HoloLens
  • Microsoft Immersive headsets (IHMD)
  • Steam VR (HTC Vive / Oculus Rift)
  • OpenXR platforms

Required Software

Windows 10 Creators Update Windows 10 FCU Unity Unity 3D Visual Studio 2017 Visual Studio 2017 Simulator (optional) Simulator (optional)
To develop apps for 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

Getting started with MRTK-vNext

MRTK-vNext is currently under heavy development. To determine the best branch for starting out, please view the Branch Guide wiki page.

The Mixed Reality team have prepared a few guides for getting up to speed on using the new Mixed Reality Toolkit, which can be found here:

More guides to follow.

Any queries, questions or feedback on using the Mixed Reality Toolkit should be raised as Issues on the site. let us know what you like / dislike or think is incredibly awesome!

Alternatively, reach out to us on the HoloDevelopers slack channels

Examples and QuickStart scenes

One radical change to the Mixed Reality Toolkit vNext, will be the standards and approaches to real world example scenes.

New examples will follow strict guidelines, such as:

  • Each example must have a use and demonstrate a real world test case (no tests).
  • Each example will use a standardized template, so all examples have the same look and feel.
  • Each sample will be fully documented, detailing both the use case it is demonstrating and how to implement the features demonstrated.

Check the "Work In Progress" section of the Windows Mixed Reality - vNext SDK for a peek at the first new example.

External\How To docs folder is meant to help everyone with migrating forward or any simple doubts they might have about the process. Please feel free to grow all these sections. We can't wait to see your additions!

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 Academy Design Design Development Development Community) 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.

How to Contribute

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