# What is the Mixed Reality Toolkit MRTK-Unity is a Microsoft driven project that provides a set of components and features to accelerate cross-platform MR app development in Unity. Here are some things MRTK does: * Provides the **basic building blocks for Unity development on HoloLens, Windows Mixed Reality, and OpenVR**. * Enables **rapid prototyping** via in-editor simulation that allows you to see changes immediately. * Designed as an **extensible framework** that provides developers ability to swap out core components. * **Supports a wide range of platforms**, including * Microsoft HoloLens * Microsoft HoloLens 2 * Windows Mixed Reality headsets * OpenVR headsets (HTC Vive / Oculus Rift) # Getting Started with MRTK | [![Getting Started](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_GettingStarted.png)](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/GettingStartedWithTheMRTK.html)
[MRTK Getting Started Guide](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/GettingStartedWithTheMRTK.html)| [![Getting Started](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_Documentation.png)](https://microsoft.github.io/MixedRealityToolkit-Unity/)
[MRTK Documentation](https://microsoft.github.io/MixedRealityToolkit-Unity/)| |:---|:---| # Build Status | Branch | CI Status | Docs Status | |---|---|---| | `mrtk_development` |[![CI Status](https://camo.githubusercontent.com/2bc6139afb9721eab824bb9393e9f9274f54992e/68747470733a2f2f6465762e617a7572652e636f6d2f6169706d722f4d697865645265616c697479546f6f6c6b69742d556e6974792d43492f5f617069732f6275696c642f7374617475732f7075626c69632f6d72746b5f43493f6272616e63684e616d653d6d72746b5f646576656c6f706d656e74)](https://dev.azure.com/aipmr/MixedRealityToolkit-Unity-CI/_build/latest?definitionId=15)|[![Docs Status](https://camo.githubusercontent.com/15725dce0763ebfc52f769ecfbaa4824cdab2d5a/68747470733a2f2f6465762e617a7572652e636f6d2f6169706d722f4d697865645265616c697479546f6f6c6b69742d556e6974792d43492f5f617069732f6275696c642f7374617475732f7075626c69632f6d72746b5f646f6373)](https://dev.azure.com/aipmr/MixedRealityToolkit-Unity-CI/_build/latest?definitionId=7) # Required Software | [![Windows SDK 18362+](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK170802_Short_17.png)](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk) [Windows SDK 18362+](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk)| [![Unity](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK170802_Short_18.png)](https://unity3d.com/get-unity/download/archive) [Unity 2018.4.x](https://unity3d.com/get-unity/download/archive)| [![Visual Studio 2017](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK170802_Short_19.png)](http://dev.windows.com/downloads) [Visual Studio 2017](http://dev.windows.com/downloads)| [![Simulator (optional)](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK170802_Short_20.png)](https://go.microsoft.com/fwlink/?linkid=852626) [Simulator (optional)](https://go.microsoft.com/fwlink/?linkid=852626)| | :--- | :--- | :--- | :--- | | To build apps with MRTK v2, you need the Windows 10 May 2019 Update SDK.
To run apps for immersive 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 | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_InputSystem.png) [Input System](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Input/Overview.html)
| ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_HandTracking.png) [Hand Tracking
(HoloLens 2)](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/InputSystem/HandTracking.html) | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_EyeTracking.png) [Eye Tracking
(HoloLens 2)](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/EyeTracking/EyeTracking_Main.html) | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_Profiles.png) [Profiles](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/MixedRealityConfigurationGuide.html)
| ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_GazeSelect.png) [Gaze + Gesture
(HoloLens)](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Input/Gestures.html) | | :--- | :--- | :--- | :--- | :--- | | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_UIControls.png) [UI Controls](https://microsoft.github.io/MixedRealityToolkit-Unity/README.html#ui-and-interaction-building-blocks)
| ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_Solver.png) [Solvers](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/README_Solver.html)
| ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_SceneSystem.png) [Multi-Scene
Manager](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/SceneSystem/SceneSystemGettingStarted.html) | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_SpatialUnderstanding.png) [Spatial
Awareness](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/SpatialAwareness/SpatialAwarenessGettingStarted.html) | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_Diagnostics.png) [Diagnostic
Tool](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Diagnostics/DiagnosticsSystemGettingStarted.html) | | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_StandardShader.png) [MRTK Standard Shader](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/README_MRTKStandardShader.html?q=shader) | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_VoiceCommand.png) [Speech](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Input/Speech.html)
& [Dictation](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Input/Dictation.html) | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_Boundary.png) [Boundary
System](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Boundary/BoundarySystemGettingStarted.html)| ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_InputSystem.png) [In-Editor
Simulation](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/InputSimulation/InputSimulationService.html) | ![](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Icon_Experimental.png) [Experimental
Features](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/ExperimentalFeatures.html)| # UI and Interaction Building blocks | [![Button](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Button/MRTK_Button_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Button.md) [Button](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Button.md) | [![Bounding Box](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/BoundingBox/MRTK_BoundingBox_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_BoundingBox.md) [Bounding Box](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_BoundingBox.md) | [![Manipulation Handler](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/ManipulationHandler/MRTK_Manipulation_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_ManipulationHandler.md) [Manipulation Handler](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_ManipulationHandler.md) | |:--- | :--- | :--- | | 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](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Slate/MRTK_Slate_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Slate.md) [Slate](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Slate.md) | [![System Keyboard](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/SystemKeyboard/MRTK_SystemKeyboard_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_SystemKeyboard.md) [System Keyboard](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_SystemKeyboard.md) | [![Interactable](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Interactable/InteractableExamples.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Interactable.md) [Interactable](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Interactable.md) | | 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](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Solver/MRTK_Solver_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Solver.md) [Solver](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Solver.md) | [![Object Collection](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/ObjectCollection/MRTK_ObjectCollection_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_ObjectCollection.md) [Object Collection](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_ObjectCollection.md) | [![Tooltip](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Tooltip/MRTK_Tooltip_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Tooltip.md) [Tooltip](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Tooltip.md) | | 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](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/AppBar/MRTK_AppBar_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_AppBar.md) [App Bar](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_AppBar.md) | [![Pointers](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Pointers/MRTK_Pointer_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Pointers.md) [Pointers](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Pointers.md) | [![Fingertip Visualization](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Fingertip/MRTK_FingertipVisualization_Main.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_FingertipVisualization.md) [Fingertip Visualization](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_FingertipVisualization.md) | | 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](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/Slider/MRTK_UX_Slider_Main.jpg)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Sliders.md) [Slider](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_Sliders.md) | [![MRTK Standard Shader](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTKStandardShader/MRTK_StandardShader.jpg)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_MRTKStandardShader.md) [MRTK Standard Shader](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_MRTKStandardShader.md) | [![Hand Joint Chaser](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/HandJointChaser/MRTK_HandJointChaser_Main.jpg)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_HandJointChaser.md) [Hand Joint Chaser](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_HandJointChaser.md) | | 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](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/EyeTracking/mrtk_et_targetselect.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/EyeTracking/EyeTracking_TargetSelection.md) [Eye Tracking: Target Selection](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/EyeTracking/EyeTracking_TargetSelection.md) | [![Eye Tracking: Navigation](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/EyeTracking/mrtk_et_navigation.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/EyeTracking/EyeTracking_Navigation.md) [Eye Tracking: Navigation](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/EyeTracking/EyeTracking_Navigation.md) | [![Eye Tracking: Heat Map](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/EyeTracking/mrtk_et_heatmaps.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/EyeTracking/EyeTracking_Visualization.md) [Eye Tracking: Heat Map](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/EyeTracking/EyeTracking_Visualization.md) | | 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](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_HandInteractionExamples.md). You can find other example scenes under [**Assets/MixedRealityToolkit.Examples/Demos**](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Assets/MixedRealityToolkit.Examples/Demos) folder. [![Example Scene](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRTK_Examples.png)](https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Documentation/README_HandInteractionExamples.md) # Sample App [Periodic Table of the Elements](https://github.com/Microsoft/MRDL_Unity_PeriodicTable) is an open-source sample app which demonstrates how to use MRTK's input system and building blocks to create an app experience for HoloLens and Immersive headsets. Read the porting story: [Bringing the Periodic Table of the Elements app to HoloLens 2 with MRTK v2](https://medium.com/@dongyoonpark/bringing-the-periodic-table-of-the-elements-app-to-hololens-2-with-mrtk-v2-a6e3d8362158) [![Periodic Table of the Elements](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/MRDL_PeriodicTable.jpg)](https://medium.com/@dongyoonpark/bringing-the-periodic-table-of-the-elements-app-to-hololens-2-with-mrtk-v2-a6e3d8362158) # Engage with the Community - Join the conversation around MRTK on [Slack](https://holodevelopers.slack.com/). - Ask questions about using MRTK on [Stack Overflow](https://stackoverflow.com/questions/tagged/mrtk) using the **MRTK** tag. - Search for [known issues](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues) or file a [new issue](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues) 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](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki). - For issues related to Windows Mixed Reality that aren't directly related to the MRTK, check out the [Windows Mixed Reality Developer Forum](https://forums.hololens.com/). This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/mailto:opencode@microsoft.com) with any additional questions or comments. # Useful resources on the Mixed Reality Dev Center | ![Discover](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/mrdevcenter/icon-discover.png) [Discover](https://docs.microsoft.com/en-us/windows/mixed-reality/)| ![Design](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/mrdevcenter/icon-design.png) [Design](https://docs.microsoft.com/en-us/windows/mixed-reality/design)| ![Develop](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/mrdevcenter/icon-develop.png) [Develop](https://docs.microsoft.com/en-us/windows/mixed-reality/development)| ![Distribute)](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/mrdevcenter/icon-distribute.png) [Distribute](https://docs.microsoft.com/en-us/windows/mixed-reality/implementing-3d-app-launchers)| | :--------------------- | :----------------- | :------------------ | :------------------------ | | Learn to build mixed reality experiences for HoloLens and immersive headsets (VR). | Get design guides. Build user interface. Learn interactions and input. | Get development guides. Learn the technology. Understand the science. | Get your app ready for others and consider creating a 3D launcher. | # Useful resouces on Azure | ![Spatial Anchors](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/mrdevcenter/icon-azurespatialanchors.png)
[Spatial Anchors](https://docs.microsoft.com/en-us/azure/spatial-anchors/)| ![Speech Services](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/mrdevcenter/icon-azurespeechservices.png) [Speech Services](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/)| ![Vision Services](https://github.com/microsoft/MixedRealityToolkit-Unity/raw/mrtk_release/Documentation/Images/mrdevcenter/icon-azurevisionservices.png) [Vision Services](https://docs.microsoft.com/en-us/azure/cognitive-services/computer-vision/)| | :------------------------| :--------------------- | :---------------------- | | Spatial Anchors is a cross-platform service that allows you to create Mixed Reality experiences using objects that persist their location across devices over time.| Discover and integrate Azure powered speech capabilities like speech to text, speaker recognition or speech translation into your application.| Identify and analyze your image or video content using Vision Services like computer vision, face detection, emotion recognition or video indexer. | ### Learn more about MRTK Project You can find our planning material on [our wiki](https://github.com/Microsoft/MixedRealityToolkit-Unity/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**](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki/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](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki/Branch-Guide).