Get the tools you need to build applications for Microsoft HoloLens and Windows Mixed Reality immersive (VR) headsets. There is no separate SDK for Windows Mixed Reality development; you'll use Visual Studio with the Windows 10 SDK.
Download the HoloToolkit. Basic Configuration and Deployment 2. Basic Configuration and Deployment Configure your Unity project. 6m 18s Build in Unity to Visual Studio. Download “HoloToolkit” from here and place it into your Unity project under Assets. You might have to do this using the file system, outside of Unity. Go to Assets HoloToolkit Input Prefabs. Find and drag InputManager into the scene hierarchy. Then go to Assets HoloToolkit Input Prefabs Cursor.
- Unknown Version MIT License Updated 1 year ago Created on January 28th, 2016. As we transition from the HoloToolkit to the Mixed Reality Toolkit.
- There is a new HoloToolkit-Unity release available. Please go over the release notes. Compatible with Unity 5.5.0f3; Uses the new HoloToolkit input module. InputTapTest scene: Helps you get setup with the input module.; InputManagerTest scene: Is a more end-end scene.; There's also a corresponding unity package for the release to make it easier for folks.
Don't have a mixed reality device? You can install the HoloLens emulator to test some functionality of mixed reality apps without a HoloLens. You can also use the Windows Mixed Reality simulator to test your mixed reality apps for immersive headsets. If you're using Unity, you can use Mixed Reality Toolkit (MRTK)'s input simulation to test various types of input interactions such as hand-tracking and eye-tracking input.
We recommend installing the Unity game engine as the easiest way to get started creating mixed reality apps. However, you can also build against DirectX if you'd like to use a custom engine.
Tip
Bookmark this page and check it regularly to keep up-to-date on the most recent version of each tool recommended for mixed reality development.
Installation checklist
| Tool | Notes |
|---|---|
Windows 10 (Manual install link) Install the most recent version of Windows 10 so your PC's operating system matches the platform for which you're building mixed reality applications. | Installing Windows 10 You can install the most recent version of Windows 10 via Windows Update in Settings or by creating installation media, using the link in the left column. See current release notes for information about the newest mixed reality features available with each release of Windows 10. Enable developer mode on your PC at Settings > Update & Security > For developers. Note for enterprise and corporate-managed PCs If your PC is managed by an your organization's IT department, you might need to contact them in order to update. 'N' versions of Windows Windows Mixed Reality immersive (VR) headsets are not supported on 'N' versions of Windows. |
Visual Studio 2019 (16.8 or higher) (Install link) Fully-featured integrated development environment (IDE) for Windows and more. You'll use Visual Studio to write code, debug, test, and deploy. | Installing Visual Studio 2019 Be sure you install the following workloads: ● Desktop development with C++ ● Universal Windows Platform (UWP) development Within the UWP workload, be sure to check the following optional component if you'll be developing for HoloLens: ● USB Device Connectivity Note about Unity Unless you're intentionally trying to install a newer (non-LTS) version of Unity for a specific purpose, we recommend not installing the Unity workload as part of Visual Studio installation, and instead install the Unity 2019 LTS stream as noted below. Known issues There are some known issues with debugging mixed reality apps in Visual Studio 2019 version 16.0. Please ensure that you update to Visual Studio 2019 version 16.8 or higher. |
Windows 10 SDK (10.0.18362.0) (Manual install link) Provides the latest headers, libraries, metadata, and tools for building Windows 10 apps on HoloLens 2. | To build HoloLens 2 apps, you must install the Windows SDK, build 18362 or later. If you are only developing applications for desktop Windows Mixed Reality headsets or HoloLens (1st gen), you can use the Windows SDK installed by Visual Studio 2017. |
HoloLens 2 Emulator (Windows Holographic, version 20H2 December 2020 Update) (Install link: 10.0.19041.1131) HoloLens (1st gen) Emulator (Install link: 10.0.17763.134) The emulator lets you run applications on a HoloLens virtual machine image without a physical HoloLens. | See Using the HoloLens emulator for more information on getting started with the emulator. Your system must support Hyper-V for the emulator installation to succeed. Reference the System Requirements section below for details. Note on HoloLens (1st gen) Emulator Visual Studio 2017 is required to successfully complete the installation. If you're installing the HoloLens (1st gen) emulator with Visual Studio 2019 you need to deselect the VS templates and install them from the Visual Studio Marketplace. |
Choose your engine
Now that you have your Windows 10, Visual Studio, and Windows 10 SDK ready to go, let's choose an engine to build on.
1. Download the latest version
We recommend the Unity LTS (Long Term Support) stream as the best version to use when starting new projects, updating to its latest revision to pick up the latest stable fixes.
- The current recommendation is to use Unity 2019, which is the LTS build required for MRTK v2 below.
- If you need to use a different version of Unity for specific reasons, Unity supports side-by-side installs of different versions.
2. Import Mixed Reality Toolkit (MRTK)
Mixed Reality Toolkit (MRTK) is an open-source, cross-platform development kit for mixed reality applications. MRTK provides a cross-platform input system, foundational components, and common building blocks for spatial interactions. The toolkit is intended to accelerate the development of applications targeting Microsoft HoloLens, Windows Mixed Reality immersive (VR) headsets, and the OpenVR platform.
For installation, we recommend completing the Getting Started section of our curated Unity development journey. If you're already following the Unity development journey, finish up the rest of the setup steps listed below and continue on to the HoloLens 2 Getting Started tutorials.
Important
Note that installation instructions are targeted for the latest stable combination of MRTK and Unity releases, which are MRTK 2.4.0 and Unity 2019.3.15.
Note
If you don't want to use MRTK for Unity, you'll need to script all interactions and behaviors yourself.
Other tools [optional]
- Mixed Reality Companion Kit (GitHub) - code bits and components that might not run directly on HoloLens or immersive (VR) headsets, but instead pair with them to build experiences targeting Windows Mixed Reality.
- Mixed Reality Toolkit - Common (GitHub) - a collection of shared scripts and components.
3. Set up your PC for Mixed Reality development
The Windows 10 SDK works best on the Windows 10 operating system. This SDK is also supported on Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2. Note that not all tools are supported on older operating systems.
Note
You can develop and deploy your apps for HoloLens, VR immersive headsets, or both. Make sure you fulfill the requirements below depending on your needs.
For HoloLens development
When setting up your development PC for HoloLens development, please make sure it meets the system requirements for both Unity and Visual Studio. If you want to run your app on a HoloLens device, you need to follow the Windows Device Portal setup instructions. If you plan on using the HoloLens emulator, you'll want to make sure your PC meets the HoloLens emulator system requirements as well.
To get started with the HoloLens emulator, see Using the HoloLens emulator.
If you plan to develop for both HoloLens and Windows Mixed Reality immersive (VR) headsets, use the system recommendations and requirements in the section below.
HoloLens troubleshooting
Setting Developer Mode is grayed out
If you're running into issues enabling Developer Mode on your device you might not be the device owner. In multi-user mode, the person who uses the device first is the device owner - any subsequent users won't have the required permissions to enable Developer Mode or other configuration changes. However, there is an exception where the first user may not be the device owner in an Autopilot environment, which is detailed in the HoloLens security documentation.
My dear bootham sun tv serial cast. Possible solutions include:
- Having the device owner turn Developer Mode on before passing the device to other users or developers
- Suggesting that your IT/MDM Admin enables CSP Policy ApplicationManagement/AllowDeveloperUnlock for the specific device or a developer device group.
- This policy can be set by Provisioning Packages or via MDM for HoloLens devices
- Using the Advanced Recovery Companion (ARC)
Holotoolkit Unity Package Download
Note
You can learn more about device management in the HoloLens device management overview.
I can't deploy over USB
If you're not able to deploy an application directly over USB, make sure you've met all the installation requirements listed above and follow our step-by-step tutorial.
Immersive (VR) headset requirements
Note
The following guidelines are the current minimum and recommended specs for your immersive (VR) headset development PC, and are updated regularly.
Warning
Do not confuse this with the minimum PC hardware compatibility guidelines, which outlines the consumer PC specs to which you should target your immersive (VR) headset app or game.
If you're using a Reverb G2 headset, download the Microsoft-Valve OpenXR plugin (TODO: // Need link).
If your immersive headset development PC does not have full-sized HDMI and/or USB 3.0 ports, you'll need adapters to connect your headset.
There are currently known issues with some hardware configurations, particularly notebooks that have hybrid graphics.
| Minimum | Recommended | |
|---|---|---|
| Processor | Notebook: Intel Mobile Core i5 7th generation CPU, Dual-Core with Hyper Threading Desktop: Intel Desktop i5 6th generation CPU, Dual-Core with Hyper Threading OR AMD FX4350 4.2Ghz Quad-Core equivalent | Desktop: Intel Desktop i7 6th generation (6 Core) OR AMD Ryzen 5 1600 (6 Core, 12 threads) |
| GPU | Notebook: NVIDIA GTX 965M, AMD RX 460M (2GB) equivalent or greater DX12 capable GPU Desktop: NVIDIA GTX 960/1050, AMD Radeon RX 460 (2GB) equivalent or greater DX12 capable GPU | Desktop: NVIDIA GTX 980/1060, AMD Radeon RX 480 (2GB) equivalent or greater DX12 capable GPU |
| GPU driver WDDM version | WDDM 2.2 driver | |
| Thermal Design Power | 15W or greater | |
| Graphics display ports | 1x available graphics display port for headset (HDMI 1.4 or DisplayPort 1.2 for 60Hz headsets, HDMI 2.0 or DisplayPort 1.2 for 90Hz headsets) | |
| Display resolution | Resolution: SVGA (800x600) or greater Bit depth: 32 bits of color per pixel | |
| Memory | 8 GB of RAM or greater | 16 GB of RAM or greater |
| Storage | >10 GB additional free space | |
| USB Ports | 1x available USB port for headset (USB 3.0 Type-A) Note: USB must supply a minimum of 900mA | |
| Bluetooth | Bluetooth 4.0 (for accessory connectivity) | |
If you're new to MRTK development with Unity, we recommend following our curated Unity development journey:
Next Development Checkpoint
If you're following the Unity development checkpoint journey we've laid out, your next task is to work through our HoloLens 2 tutorial series.
You can always go back to the Unity development checkpoints at any time.
1. Download the latest version
We recommend installing Unreal Engine version 4.25 or later to take full advantage of built-in HoloLens support.
2. Import Mixed Reality Toolkit (MRTK)
Mixed Reality Toolkit (MRTK) is an open-source, cross-platform development kit for mixed reality applications. MRTK provides a cross-platform input system, foundational components, and common building blocks for spatial interactions. The toolkit is intended to accelerate the development of applications targeting Microsoft HoloLens, Windows Mixed Reality immersive (VR) headsets, and the OpenVR platform.
For installation, we recommend completing the Getting Started section of our curated Unreal development journey. If you're already following the Unreal development journey, finish up the rest of the setup steps listed below and continue on to the HoloLens 2 Getting Started tutorials.
Note
If you don't want to use MRTK for Unreal, you'll need to script all interactions and behaviors yourself.
Other tools [optional]
- Mixed Reality Companion Kit (GitHub) - code bits and components that might not run directly on HoloLens or immersive (VR) headsets, but instead pair with them to build experiences targeting Windows Mixed Reality.
- Mixed Reality Toolkit - Co mmon (GitHub) - a collection of shared scripts and components.
3. Set up your PC for mixed reality development
The Windows 10 SDK works best on the Windows 10 operating system. This SDK is also supported on Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2. Note that not all tools are supported on older operating systems.
Note
You can develop and deploy your apps for HoloLens, VR immersive headsets, or both. Make sure you fulfill the requirements below depending on your needs.
For HoloLens development
When setting up your development PC for HoloLens development, please make sure you meet the system requirements for Unreal and and Visual Studio. If you want to run your app on a HoloLens device, you need to follow the Windows Device Portal setup instructions. If you plan on using the HoloLens emulator, you'll want to make sure your PC meets the HoloLens emulator system requirements as well.
If you plan to develop for both HoloLens and Windows Mixed Reality immersive (VR) headsets, use the system recommendations and requirements in the section below.
HoloLens troubleshooting
Setting Developer Mode is grayed out
If you're running into issues enabling Developer Mode on your device you might not be the device owner. In multi-user mode, the person who uses the device first is the device owner - any subsequent users won't have the required permissions to enable Developer Mode or other configuration changes. However, there is an exception where the first user may not be the device owner in an Autopilot environment, which is detailed in the HoloLens security documentation.
Possible solutions include:
- Having the device owner turn Developer Mode on before passing the device to other users or developers
- Suggesting that your IT/MDM Admin enables CSP Policy ApplicationManagement/AllowDeveloperUnlock for the specific device or a developer device group.
- This policy can be set by Provisioning Packages or via MDM for HoloLens devices
- Using the Advanced Recovery Companion (ARC)
Note
You can learn more about device management in the HoloLens device management overview.
I can't deploy over USB
If you're not able to deploy an application directly over USB, make sure you've met all the installation requirements listed above and follow our step-by-step tutorial.
Immersive (VR) headset requirements
Note
The following guidelines are the current minimum and recommended specs for your immersive (VR) headset development PC, and are updated regularly.
Warning
Do not confuse this with the minimum PC hardware compatibility guidelines, which outlines the consumer PC specs to which you should target your immersive (VR) headset app or game.
If you're using a Reverb G2 headset, download the Microsoft-Valve OpenXR plugin (TODO: // Need link).
If your immersive headset development PC does not have full-sized HDMI and/or USB 3.0 ports, you'll need adapters to connect your headset.
There are currently known issues with some hardware configurations, particularly notebooks that have hybrid graphics.
| Minimum | Recommended | |
|---|---|---|
| Processor | Notebook: Intel Mobile Core i5 7th generation CPU, Dual-Core with Hyper Threading Desktop: Intel Desktop i5 6th generation CPU, Dual-Core with Hyper Threading OR AMD FX4350 4.2Ghz Quad-Core equivalent | Desktop: Intel Desktop i7 6th generation (6 Core) OR AMD Ryzen 5 1600 (6 Core, 12 threads) |
| GPU | Notebook: NVIDIA GTX 965M, AMD RX 460M (2GB) equivalent or greater DX12 capable GPU Desktop: NVIDIA GTX 960/1050, AMD Radeon RX 460 (2GB) equivalent or greater DX12 capable GPU | Desktop: NVIDIA GTX 980/1060, AMD Radeon RX 480 (2GB) equivalent or greater DX12 capable GPU |
| GPU driver WDDM version | WDDM 2.2 driver | |
| Thermal Design Power | 15W or greater | |
| Graphics display ports | 1x available graphics display port for headset (HDMI 1.4 or DisplayPort 1.2 for 60Hz headsets, HDMI 2.0 or DisplayPort 1.2 for 90Hz headsets) | |
| Display resolution | Resolution: SVGA (800x600) or greater Bit depth: 32 bits of color per pixel | |
| Memory | 8 GB of RAM or greater | 16 GB of RAM or greater |
| Storage | >10 GB additional free space | |
| USB Ports | 1x available USB port for headset (USB 3.0 Type-A) Note: USB must supply a minimum of 900mA | |
| Bluetooth | Bluetooth 4.0 (for accessory connectivity) | |
If you're new to MRTK development with Unreal, we recommend following our curated Unreal development journey:
Next Development Checkpoint
If you're following the Unreal development checkpoint journey we've laid out, your next task is to work through our HoloLens 2 tutorial series.
You can always go back to the Unreal development checkpoints at any time.
Native OpenXR development doesn't have an engine for you to download. You can find everything you need to begin development in the Getting started with OpenXR document.
1. Set up your PC for mixed reality development
The Windows 10 SDK works best on the Windows 10 operating system. This SDK is also supported on Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2. Note that not all tools are supported on older operating systems.
For HoloLens development
When setting up your development PC for HoloLens development, please make sure you meet the system requirements for Visual Studio. If you want to run your app on a HoloLens device, you need to follow the Windows Device Portal setup instructions. If you plan on using the HoloLens emulator, you'll want to make sure your PC meets the HoloLens emulator system requirements as well.
If you plan to develop for both HoloLens and Windows Mixed Reality immersive (VR) headsets, use the system recommendations and requirements in the section below.
Note
You can develop and deploy your apps for HoloLens, VR immersive headsets, or both. Make sure you fulfill the requirements below depending on your needs.
HoloLens troubleshooting
Setting Developer Mode is grayed out
If you're running into issues enabling Developer Mode on your device you might not be the device owner. In multi-user mode, the person who uses the device first is the device owner - any subsequent users won't have the required permissions to enable Developer Mode or other configuration changes. However, there is an exception where the first user may not be the device owner in an Autopilot environment, which is detailed in the HoloLens security documentation.
Possible solutions include:
- Having the device owner turn Developer Mode on before passing the device to other users or developers
- Suggesting that your IT/MDM Admin enables CSP Policy ApplicationManagement/AllowDeveloperUnlock for the specific device or a developer device group.
- This policy can be set by Provisioning Packages or via MDM for HoloLens devices
- Using the Advanced Recovery Companion (ARC)
Note
You can learn more about device management in the HoloLens device management overview.
Immersive (VR) headset requirements
Note
The following guidelines are the current minimum and recommended specs for your immersive (VR) headset development PC, and are updated regularly.
Warning
Do not confuse this with the minimum PC hardware compatibility guidelines, which outlines the consumer PC specs to which you should target your immersive (VR) headset app or game.
If your immersive headset development PC does not have full-sized HDMI and/or USB 3.0 ports, you'll need adapters to connect your headset.
There are currently known issues with some hardware configurations, particularly notebooks that have hybrid graphics.
| Minimum | Recommended | |
|---|---|---|
| Processor | Notebook: Intel Mobile Core i5 7th generation CPU, Dual-Core with Hyper Threading Desktop: Intel Desktop i5 6th generation CPU, Dual-Core with Hyper Threading OR AMD FX4350 4.2Ghz Quad-Core equivalent | Desktop: Intel Desktop i7 6th generation (6 Core) OR AMD Ryzen 5 1600 (6 Core, 12 threads) |
| GPU | Notebook: NVIDIA GTX 965M, AMD RX 460M (2GB) equivalent or greater DX12 capable GPU Desktop: NVIDIA GTX 960/1050, AMD Radeon RX 460 (2GB) equivalent or greater DX12 capable GPU | Desktop: NVIDIA GTX 980/1060, AMD Radeon RX 480 (2GB) equivalent or greater DX12 capable GPU |
| GPU driver WDDM version | WDDM 2.2 driver | |
| Thermal Design Power | 15W or greater | |
| Graphics display ports | 1x available graphics display port for headset (HDMI 1.4 or DisplayPort 1.2 for 60Hz headsets, HDMI 2.0 or DisplayPort 1.2 for 90Hz headsets) | |
| Display resolution | Resolution: SVGA (800x600) or greater Bit depth: 32 bits of color per pixel | |
| Memory | 8 GB of RAM or greater | 16 GB of RAM or greater |
| Storage | >10 GB additional free space | |
| USB Ports | 1x available USB port for headset (USB 3.0 Type-A) Note: USB must supply a minimum of 900mA | |
| Bluetooth | Bluetooth 4.0 (for accessory connectivity) | |
If you're new to Native development with MRTK, we recommend following our curated Native development journey:
Next Development Checkpoint
If you're following the Native development checkpoint journey we've laid out, your next task is to configure your development environment for HoloLens 2. Tsvncache exe disable.
You can always go back to the Native development checkpoints at any time.
Please note that on December 5, 2018, the default branch for this repository will change (from master to mrtk_release) as we transition from the HoloToolkit to the Mixed Reality Toolkit.
The Mixed Reality Toolkit is a collection of scripts and components intended to accelerate development of applications targeting Microsoft HoloLens and Windows Mixed Reality headsets.The project is aimed at reducing barriers to entry to create mixed reality applications and contribute back to the community as we all grow.
For details on the different branches used in the Mixed Reality Toolkit repositories, check this Branch Guide here.
MixedRealityToolkit-Unity uses code from the base MixedRealityToolkit and makes it easier to consume in Unity.
Learn more about Windows Mixed Reality here.
Note: The latest release should work for both HoloLens and Windows Mixed Reality development.
Check out the MRTK-Unity Roadmap.
Check out the updates from the Fall Creators update for Windows Mixed Reality.
Check out the Breaking Changes from the previous release.
Looking to upgrade your projects to Windows Mixed Reality? Follow the Upgrade Guide.
The Mixed Reality Toolkit for Unity includes many APIs to accelerate the development of Mixed Reality projects for both HoloLens and the newer Immersive Headsets (IHMD)
| Scripts that leverage inputs such as gaze, gesture, voice and motion controllers. Includes the Mixed Reality camera prefabs. | Sharing library enables collaboration across multiple devices. | Scripts that allow applications to bring the real world into the digital using HoloLens. |
| Scripts to help plug spatial audio into your application. | Building blocks for creating good UX in your application like common controls. | Common helpers and tools that you can leverage in your application. |
| Tailor experiences based on room semantics like couch, wall etc. | Build and deploy automation window for Unity Editor. | Scripts that help with rendering the floor and boundaries for Immersive Devices. |
| 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 |
To get up and going as quickly as possible, here are some guides to help you get started building Mixed Reality Projects
| Please go over the Getting started guide to learn more about getting off the ground quickly. | Please go over the Contributing guidelines to learn more about the process and thinking. | Check out the recent updates for Windows Mixed reality in the Fall Creators update |
| Input and cursor visualization examples for gaze and motion controller pointers | Demonstrates how to access motion controller input events and data | Examples of direct manipulation with motion controllers | Script for manipulating objects with two hands |
Holotoolkit Examples Download
| Standard UI for manipulating objects in 3D space | Modular script for making objects interactable with visual states, including Holographic button | Script for lay out an array of objects in a three-dimensional shape | System style keyboard prefab for Unity projects |
| Dialog / Progress | |||
| Standard UI for notification, approval, or additional information from the user / Data loading indicator | Scripts for various behavious such as tag-along, billboarding, body-lock, constant view size and surface magnetism | UWP style UI controls including radio, toggle and checkboxes | Annotation UI with flexible anchor/pivot system which can be used for labeling motion controllers and object. |
| Example of visualizing and accessing spatial mapping data. | Example of processing the raw spatial mapping data, finding and creating planes based on spatial mapping meshes. | Examples of the room scanning and accessing identified surfaces such as walls, floors, ceilings and platforms. | Example of making an object smoothly align with physical surfaces using SolverSurfaceMagnetism |
Check out the Examples folder for more details.
Check out the article “Open-Source Building Blocks for Windows Mixed Reality Experiences”
ExternalHow 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.
| 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. |