MRTK Packages
The Mixed Reality Toolkit (MRTK) is a collection of packages that enable cross platform Mixed Reality application development by providing support for Mixed Reality hardware and platforms in a componentized manner.
There are three categories of MRTK packages:
The Mixed Reality Toolkit Foundation is the set of packages that enable your application to leverage common functionality across Mixed Reality Platforms. These packages are released and supported by Microsoft from source code in the mrtk_release branch on GitHub.
Mixed Reality Toolkit Foundation packages
The MRTK Foundation is comprised of:
The following sections describe the types of packages in each category.
The core package is a required component and is taken as a dependency by all MRTK foundation packages.
The MRTK Core package includes:
- Common interfaces, classes and data types
- MixedRealityToolkit scene component
- MRTK Standard Shader
- Unity Input Provider
- Package Management
The Mixed Reality Toolkit Core package contains the definitions for all of the common interfaces, classes and data types that are used by all other components. It is highly recommended that applications access MRTK components exclusively through the defined interfaces to enable the highest level of compatibility across platforms.
The MixedRealityToolkit scene component is the single, centralized resource manager for the Mixed Reality Toolkit. This component loads and manages the lifespan of the platform and service modules and provides resources for the systems to access their configuration settings.
The MRTK Standard Shader provides the basis for virtually all of the materials provided by the MRTK. This shader is extremely flexible and optimized for the variety of platforms on which MRTK is supported. It is highly recommended that your application's materials use the MRTK standard shader for optimal performance.
The Unity Input Provider provides access to common input devices such as game controllers, touch screens and a 3D spatial mouse.
Coming soon
The Mixed Reality Toolkit Core package provides support for discovering and managing the optional foundation, extension and experimental MRTK packages.
The MRTK Platform Provider packages are the components that enable the Mixed Reality Toolkit to target Mixed Reality hardware and platform functionality.
Supported platforms include:
The Windows Mixed Reality package provides support for Microsoft HoloLens and Windows Mixed Reality Immersive devices. The package contains full platform support, including:
- Gaze targeting
- Gestures
- Windows Mixed Reality Motion controllers
- Spatial Mapping
The OpenVR package provides hardware and platform support for devices using the OpenVR platform.
The Windows Voice package provides support for keyword recognition and dictation functionality on Microsoft Windows 10 devices.
Core platform services are provided in system service packages. These packages contain the Mixed Reality Toolkit's default implementations of the system service interfaces, defined in the core package.
The MRTK foundation includes the following system services:
The MRTK Boundary System provides data about the to virtual reality playspace. On systems for which the user has configured the boundary, the system can provide a floor plane, rectangular playspace, tracked area, and more.
The MRTK Diagnostic System provides real-time performance data within your application experience. At a glace, you will be able to view frame rate, processor time and other key performance metrics as you use your application.
The MRTK Input Systems enables applications to access input in a cross platform manner by specifying user actions and assigning those actions to the most appropriate buttons and axes on target controllers.
The MRTK Spatial Awareness System enables access to real-world environmental data from devices such as the Microsoft HoloLens.
The MRTK Teleport System provides virtual reality locomotion support.
Feature Assets are collections of related functionality delivered as Unity assets and scripts. Some of these features include:
- User Interface Controls
- Standard Assets
- more
MRTK Extension packages are a collection of packages written by Microsoft and the Community that extend and enhance the functionality of the Mixed Reality Toolkit. Extension authors will state any required dependencies, mark the package as compatible with the Mixed Reality Toolkit and provide licensing and support statements.
Extension packages may provide new features and new platform support. Over time, extensions may, with the assistance and approval of the authors, be migrated into the MRTK Foundation at which time they will be released and supported by Microsoft.
Mixed Reality Toolkit Extension packages
Experimental packages provide the ability to flight prototype features, pre-releases and exciting new ideas. The goal of most experimental packages is to try something new and to gauge customer interest. Many, though not all, experimental packages will be re-released as extensions once the prototyping and testing phase completes.
Mixed Reality Toolkit Experimental packages
The Mixed Reality Toolkit packages and package management system are designed to enable a clean and simple method for you to additively build features into your experiences without requiring unnecessary components to be included into the project.
Over time, package management support will be added and enhanced within the Mixed Reality Toolkit. If you have feedback or wish to get involved, please file issue and/or pull requests.