Using MRTK3 packages
Microsoft MRTK3 is distributed as a set of packages that are imported into Unity using the Mixed Reality Feature Tool for Unity and the Unity Package Manager (UPM). These packages enable developers to customize the MRTK within their projects.
Dependencies
Some MRTK3 packages require additional packages, provided by Microsoft and/or Unity, in order to correctly function. Some of these packages are optional and will enable additional functionality.
The following diagram illustrates the relationship between MRTK packages and some of the Unity dependencies.
Note
When importing packages using the Mixed Reality Feature Tool, dependency management is automatically performed.
The following table describes the Mixed Reality Toolkit package dependencies.
| Display name | Package name | Description | Required | Optional |
|---|---|---|---|---|
| MRTK Core Definitions | org.mixedrealitytoolkit.core | Shared definitions, utilities and components. |
|
|
| MRTK Accessibility | org.mixedrealitytoolkit.accessibility | Definitions, features and subsystem for building accessible mixed reality experiences. |
|
|
| MRTK Audio Effects | org.mixedrealitytoolkit.audio | Effects and features that enhance the audio in mixed reality experiences. |
|
|
| MRTK Data Binding and Theming | org.mixedrealitytoolkit.data | Support for data binding and UI element theming. |
|
|
| MRTK Diagnostics | org.mixedrealitytoolkit.diagnostics | Diagnostics and performance monitoring subsystems and tools. |
|
|
| MRTK Environment | org.mixedrealitytoolkit.environment | Environmental features and subsystems, such as Spatial Awareness and boundaries. |
|
|
| MRTK Extended Assets | org.mixedrealitytoolkit.extendedassets | Additional audio, font, texture and other assets for use in applications. |
|
|
| MRTK Graphics Tools | org.mixedrealitytoolkit.graphicstools.unity | Shaders, textures, materials and models. |
|
|
| MRTK Input | org.mixedrealitytoolkit.input | Input components including support for articulated hands, offline speech recognition and in-editor input simulation. |
|
|
| MRTK Spatial Manipulation | org.mixedrealitytoolkit.spatialmanipulation | Spatial positioning and manipulation components and utilities, including solvers. |
|
|
| MRTK Standard Assets | org.mixedrealitytoolkit.standardassets | Standard assets, including materials and textures, for use by applications. |
|
|
| MRTK Tools | org.mixedrealitytoolkit.tools | Collection of Unity Editor tools used to extend and optimize MRTK3 applications. |
|
|
| MRTK UX Components | org.mixedrealitytoolkit.uxcomponents | MRTK UX component library, containing prefabs, visuals, pre-made controls, and everything to get started building 3D user interfaces for mixed reality. |
|
|
| MRTK UX Components (Non-Canvas) | org.mixedrealitytoolkit.uxcomponents.noncanvas | MRTK non-Canvas UX component library, for building 3D UX without Canvas layout. For most production-grade UI, we recommend the dynamic hybrid Canvas-based UX systems, located in org.mixedrealitytoolkit.uxcomponents. However, in some circumstances, static/non-Canvas UI may offer improved performance and batching, and may be desirable in resource-constrained scenarios. |
|
|
| MRTK UX Core | org.mixedrealitytoolkit.uxcore | Core interaction and visualization scripts for building MR user interface components.\n\nNote: this is intended to be consumed in order to build UX libraries. To build MR interfaces with a pre-existing library of components, see org.mixedrealitytoolkit.uxcomponents. |
|
|
| MRTK Windows Speech | org.mixedrealitytoolkit.windowsspeech | Speech subsystem implementation for native Windows speech APIs. Allows for the use of native Windows speech recognition to fire events and drive XRI interactions. |
|
Running package tests
Some MRTK packages contain tests used to validate the included components. In some cases, these tests require additional MRTK packages not asserted as dependencies.
Note
When importing packages into Unity, test assemblies aren't compiled by default. To enable compilation of tests, please use the testables element of the project's manifest.json file.
In order to place minimal overhead on applications importing the Mixed Reality Toolkit, dependencies are asserted only for runtime requirements. The following table describes the additional packages required to enable compiling and running the included test assemblies.
| Display name | Package name | Test requirements |
|---|---|---|
| MRTK Core Definitions | org.mixedrealitytoolkit.core | |
| MRTK Accessibility | org.mixedrealitytoolkit.accessibility | |
| MRTK Data Binding and Theming | org.mixedrealitytoolkit.data | |
| MRTK Diagnostics | org.mixedrealitytoolkit.diagnostics | |
| MRTK Environment | org.mixedrealitytoolkit.environment | |
| MRTK Extended Assets | org.mixedrealitytoolkit.extendedassets | |
| MRTK Input | org.mixedrealitytoolkit.input | |
| MRTK Spatial Manipulation | org.mixedrealitytoolkit.spatialmanipulation |
|
| MRTK Standard Assets | org.mixedrealitytoolkit.standardassets | |
| MRTK UX Components | org.mixedrealitytoolkit.uxcomponents |
|
| MRTK UX Core | org.mixedrealitytoolkit.uxcore |
|
| MRTK Windows Speech | org.mixedrealitytoolkit.windowsspeech |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for