This repository is for the legacy Mixed Reality Toolkit (MRTK) v2. For the latest version of the MRTK please visit https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity
MIT License
Bot releases are hidden (Show)
Published by david-c-kline about 5 years ago
Welcome to the first official release of Microsoft Mixed Reality Toolkit version 2!
To help you get started using MRTK v2, please see the Documentation Portal.
The Getting Started page covers software requirements and the initial steps required to use MRTK.
There have been some significant changes in this release of MRTK. For those with projects that are currently using one of the RC2 releases, please review the Upgrade Guide.
Please see Release Notes for information on new features, known issues and changes.
To help you experience various example scenes in MRTK, we added pre-built MRTK Examples Hub app packages for HoloLens (x86), HoloLens 2 (ARM), and immersive headset (x64 PC). Please use Device Portal to install the app package.
Published by wiwei over 5 years ago
MRTK v2 Release Candidate 2.1 provides new stabilization fixes and a few additional features.
This is an incremental release on top of 2.0, which fixes PressableButton usability issues.
To help you get started using MRTK v2, please see the Documentation Portal.
MixedRealityToolkit
and MixedRealityPlaySpace
objectsDefault HoloLens 2 Profile
We have added a new profile for HoloLens 2 development that includes some of the recommended MRTK configurations for best performance. #4780 #4442
Please note that this profile will only contain MRTK specific settings, you will still need to update Unity settings using recommendations in this doc.
Improved porting experience from HTK to MRTK v2
This change enables side-by-side import of HTK and MRTK to make porting to MRTK v2 easier.
Experimental Attribute
Some features the MRTK team works on appear to have a lot of initial value even if we haven’t fully fleshed out the details. For these types of features, we want the community to get a chance to see them early. Because they are early in the cycle, we label them as experimental to indicate that they are still evolving, and subject to change over time. See Experimental Features for more details
Hand-Attached menu (Experimental)
First experimental feature: a hand-attached menu. Please see #4532 for a description.
MRTK Standard Shader works with Unity’s Lightweight Render Pipeline
An upgrade path to allow developers to utilize Unity's Lightweight Scriptable Render Pipeline (LWRP) with MRTK shaders has been added. To perform the MRTK upgrade select: “Mixed Reality Toolkit -> Utilities -> Upgrade MRTK Standard Shader for Lightweight Render Pipeline” For more information please see #4311.
Input Action Handler
Added an input action handler interface to receive action events regardless of the input source. See #4475 for details.
MixedRealityServiceRegistry
Added the static MixedRealityServiceRegistry class to enable acquiring services when using the MixedRealityToolkit object or a custom service registrar. To acquire a service instance from the registry, call the TryGetService method.
IMixedRealityInputSystem inputSystem = null;
if (!MixedRealityServiceRegistry.TryGetService\<IMixedRealityInputSystem\>(out inputSystem))
{
// The input system has not been registered.
}
MixedRealityPlayspace
Replaced MixedRealityToolkit’s MixedRealityPlayspace property with a static MixedRealityPlayspace class to simplify accessing and transforming the play space in your applications.
IMixedRealityDataProviderAccess
Added the IMixedRealityDataProviderAccess interface to allow applications to request data provider instances from services which utilize data providers. In this release, the input and spatial awareness systems implement the IMixedRealityDataProviderAccess interface.
To acquire a data provider, use the following pattern.
IMixedRealitySpatialAwarenessMeshObserver meshObserver = (SpatialAwarenessSystem as
IMixedRealityDataProviderAccess)?.GetDataProvider\<IMixedRealitySpatialAwarenessMeshObserver\>();
if (meshObserver != null)
{
// Perform mesh observer operations.
}
There have been changes to some API surfaces since the last release drop:
MixedRealityToolkit
Removed the MixedRealityPlayspace property. Please use the static MixedRealityPlayspace class to access and transform the play space.
IMixedRealityBoundarySystem
Added BoundaryVisualizationProfile property to enable easy access to the boundary system’s visualization profile.
IMixedRealityDiagnosticsSystem
Added DiagnosticsSystemProfile property to enable easy access to the diagnostics system’s profile.
IMixedRealityInputSystem
Added InputSystemProfile property to enable easy access to the input system’s profile.
IMixedRealitySpatialAwarenessSystem
Added SpatialAwarenessProfile property to enable easy access to the spatial awareness system’s profile.
The GetObserver and GetObservers methods have been marked as obsolete in RC2 and will be removed from a future release of the Mixed Reality Toolkit, To ensure future source code compatibility, please use the MixedRealityDataProviderAccess interface as documented in “What’s new in this update”.
MixedRealityInputSystem
Implements IMixedRealityDataProviderAccess to enable requesting data provider instances.
MixedRealitySpatialAwarenessSystem
Implements IMixedRealityDataProviderAccess to enable requesting data provider instances.
Other issues fixed
Please check out recent PRs for detailed list of changes.
Works with Unity 2018.4 LTS
Works with Unity 2019.1
Published by wiwei over 5 years ago
MRTK v2 Release Candidate 2 provides new stabilization fixes and a few additional features.
To help you get started using MRTK v2, please see the Documentation Portal. This is the place to learn to use MRTK, and deep dive into MRTK architecture. We have prepared an initial set of documentation to get you started, but we would also like to hear from you if there's anything else you'd like to see added. If you are up to the challenge, help us improve the documentation by contributing your change! Learn how to contribute on our GitHub Wiki, please follow the documentation guide when you make changes.
Default HoloLens 2 Profile
We have added a new profile for HoloLens 2 development that includes some of the recommended MRTK configurations for best performance. #4780 #4442
Please note that this profile will only contain MRTK specific settings, you will still need to update Unity settings using recommendations in this doc.
Improved porting experience from HTK to MRTK v2
This change enables side-by-side import of HTK and MRTK to make porting to MRTK v2 easier.
Experimental Attribute
Some features the MRTK team works on appear to have a lot of initial value even if we haven’t fully fleshed out the details. For these types of features, we want the community to get a chance to see them early. Because they are early in the cycle, we label them as experimental to indicate that they are still evolving, and subject to change over time. See Experimental Features for more details
Hand-Attached menu (Experimental)
First experimental feature: a hand-attached menu. Please see #4532 for a description.
MRTK Standard Shader works with Unity’s Lightweight Render Pipeline
An upgrade path to allow developers to utilize Unity's Lightweight Scriptable Render Pipeline (LWRP) with MRTK shaders has been added. To perform the MRTK upgrade select: “Mixed Reality Toolkit -> Utilities -> Upgrade MRTK Standard Shader for Lightweight Render Pipeline” For more information please see #4311.
Input Action Handler
Added an input action handler interface to receive action events regardless of the input source. See #4475 for details.
MixedRealityServiceRegistry
Added the static MixedRealityServiceRegistry class to enable acquiring services when using the MixedRealityToolkit object or a custom service registrar. To acquire a service instance from the registry, call the TryGetService method.
IMixedRealityInputSystem inputSystem = null;
if (!MixedRealityServiceRegistry.TryGetService\<IMixedRealityInputSystem\>(out inputSystem))
{
// The input system has not been registered.
}
MixedRealityPlayspace
Replaced MixedRealityToolkit’s MixedRealityPlayspace property with a static MixedRealityPlayspace class to simplify accessing and transforming the play space in your applications.
IMixedRealityDataProviderAccess
Added the IMixedRealityDataProviderAccess interface to allow applications to request data provider instances from services which utilize data providers. In this release, the input and spatial awareness systems implement the IMixedRealityDataProviderAccess interface.
To acquire a data provider, use the following pattern.
IMixedRealitySpatialAwarenessMeshObserver meshObserver = (SpatialAwarenessSystem as
IMixedRealityDataProviderAccess)?.GetDataProvider\<IMixedRealitySpatialAwarenessMeshObserver\>();
if (meshObserver != null)
{
// Perform mesh observer operations.
}
MixedRealityToolkit
and MixedRealityPlaySpace
objectsAfter RC1 to RC2 upgrade, pressable buttons may have incorrect planes. To fix, remove and add back the pressable button component.
There have been changes to some API surfaces since the last release drop:
MixedRealityToolkit
Removed the MixedRealityPlayspace property. Please use the static MixedRealityPlayspace class to access and transform the play space.
IMixedRealityBoundarySystem
Added BoundaryVisualizationProfile property to enable easy access to the boundary system’s visualization profile.
IMixedRealityDiagnosticsSystem
Added DiagnosticsSystemProfile property to enable easy access to the diagnostics system’s profile.
IMixedRealityInputSystem
Added InputSystemProfile property to enable easy access to the input system’s profile.
IMixedRealitySpatialAwarenessSystem
Added SpatialAwarenessProfile property to enable easy access to the spatial awareness system’s profile.
The GetObserver and GetObservers methods have been marked as obsolete in RC2 and will be removed from a future release of the Mixed Reality Toolkit, To ensure future source code compatibility, please use the MixedRealityDataProviderAccess interface as documented in “What’s new in this update”.
MixedRealityInputSystem
Implements IMixedRealityDataProviderAccess to enable requesting data provider instances.
MixedRealitySpatialAwarenessSystem
Implements IMixedRealityDataProviderAccess to enable requesting data provider instances.
Other issues fixed
Please check out recent PRs for detailed list of changes.
Works with Unity 2018.4 LTS
Works with Unity 2019.1
Published by wiwei over 5 years ago
MRTK v2 Release Candidate 1 Refresh is an updated version of the RC1 package with stabilization fixes and a few additional features
To help you get started using MRTK v2, please see the Documentation Portal. This is the place to learn to use MRTK, and deep dive into MRTK architecture. We have prepared an initial set of documentation to get you started, but we would also like to hear from you if there's anything else you'd like to see added. If you are up to the challenge, help us improve the documentation by contributing your change! Learn how to contribute on our GitHub Wiki, please follow the documentation guide when you make changes.
Sliders - New UI control that allows you to change a value continuously by grabbing and moving a slider on a track.
Slate zooming support - Two-handed content zooming on Slate with min/max values.
Works with Unity 2019.1
There have been changes to some API surfaces since the last release drop:
The OnPointerDragged was added to this interface, which may cause a build error if you have a class that implements this interface. This can be safely fixed by adding an empty implementation for the new method. Per the discussion in https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/4013, adding this method onto a new interface would have led to an ultimately more complicated pointer API story.
One of the changes that came in RC1 was a refactor of namespaces of classes from deeply nested paths (like Microsoft.MixedReality.Toolkit.Core.Interfaces.InputSystem) to simpler paths (like Microsoft.MixedReality.Toolkit.Input). Several classes were not updated in the previous release, and these were fixed in this release. See https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/4019 for the list of changed classes (along with the new namespaces they now live in).
Published by wiwei over 5 years ago
MRTK v2 Release Candidate 1 is here for anyone who wants to get started with development for HoloLens 2!
What does release candidate mean? A version of a program that is nearly ready for release but may still have a few bugs and polish issues; the status between beta version and release version.
Why the versioning of our release candidate? Well, we want to let you all get started with the tools for building awesome experiences across all our devices, including HoloLens 2, but we know there is more work to be done before we call MRTK "done".
To help you get started using MRTK v2, we are proud to introduce the new Documentation Portal. This is the place to learn to use MRTK, and deep dive into MRTK architecture. We have prepared an initial set of documentation to get you started, but we would also like to hear from you if there's anything else you'd like to see added. If you are up to the challenge, help us improve the documentation by contributing your change! Learn how to contribute on our GitHub Wiki, please follow the documentation guide when you make changes.
In this release we have introduced many exciting new features like articulated hand tracking and eye tracking with HL2; there are also some architectural changes to MRTK in response to community and partner feedback to make MRTK easier to use. Of course, RC1 also supports OpenVR, WMR, and HL1 development.
Supported Platforms:
Here's the set of known issues in RC1 that we are working on fixing
Published by david-c-kline over 5 years ago
Welcome to Beta 2 of the Microsoft Mixed Reality Toolkit version 2 (formerly vNext 2018.x)!
PLEASE NOTE: This release is a significant breaking change from Mixed Reality Toolkit 2018.9.0 (released 2018/10/31) and all HoloToolkit releases.
Documentation for v2 is being written and published to https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki. Please see the sidebar on the right hand of the page for individual links.
This release consists of two packages: Foundation and Examples.
The Foundation package contains all of the packages defined here. This will enable access to the complete Mixed Reality Toolkit foundational feature set without needing to install any other packages.
The Examples package contains demonstration scenes and assets used to help get you started using the systems and features of the Mixed Reality Toolkit.
The following issues are known and under investigation.
Since the release of Mixed Reality Toolkit v2018.9.0 Beta 1, the number and scope of breaking changes is too large to completely enumerate here. The following is a subset of the most impactful breaking changes.
PLEASE NOTE: Many of the breaking changes involved the modularization of the Mixed Reality Toolkit. Configuration profiles created with the Beta 1 release will need to be updated or recreated.
Published by david-c-kline over 5 years ago
Welcome to the release candidate for Beta 2 of the Microsoft Mixed Reality Toolkit version 2 (formerly vNext 2018.x)!
PLEASE NOTE: This release is a significant breaking change from Mixed Reality Toolkit 2018.9.0 (released 2018/10/31) and all HoloToolkit releases.
Documentation for v2 is being written and published to https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki. Please see the sidebar on the right hand of the page for individual links.
This release consists of two packages: Foundation and Examples.
The Foundation package contains all of the packages defined here. This will enable access to the complete Mixed Reality Toolkit foundational feature set without needing to install any other packages.
The Examples package contains demonstration scenes and assets used to help get you started using the systems and features of the Mixed Reality Toolkit.
The following issues are known and under investigation.
Since the release of Mixed Reality Toolkit v2018.9.0 Beta 1, the number and scope of breaking changes is too large to completely enumerate here. The following is a subset of the most impactful breaking changes.
PLEASE NOTE: Many of the breaking changes involved the modularization of the Mixed Reality Toolkit. Configuration profiles created with the Beta 1 release will need to be updated or recreated.
Published by david-c-kline over 5 years ago
This is a zero code change refresh of the 2017.4.3.0 release.
The changes contained within are updates to source comments and documentation.
Published by keveleigh almost 6 years ago
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/18
Attention!
Import HoloToolkit-Unity-Preview-2017.4.3.0.unitypackage to include SpectatorView or QR Code Tracking in your project.
Published by david-c-kline almost 6 years ago
Link to documents coming soon....
- (#3004) Boundary components do not align properly with the platform on OpenVR
- Known issue in Unity 2018.x
- (#3037) If loading a system fails with an exception, no systems are active
- Controller models are not yet loaded from GLTF.
- Custom models can be specified in the Controller Visualization Profile
Published by david-c-kline about 6 years ago
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/15
Attention!
Import HoloToolkit-Unity-Preview-2017.4.2.0.unitypackage to include SpectatorView or QR Code Tracking in your project.
The following items are known and currently being investigated.
Published by david-c-kline about 6 years ago
Published by david-c-kline about 6 years ago
Published by keveleigh about 6 years ago
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/9
Attention!
Import HoloToolkit-Unity-Preview-2017.4.1.0.unitypackage to include SpectatorView in your project.
Handheld
doesn't exist) buildsThe following items are known and currently being investigated.
Published by david-c-kline over 6 years ago
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/8
Attention!
Import HoloToolkit-Unity-PreviewFeatures-2017.4.0.0.unitypackage to include SpectatorView in your project.
The following items are known and currently being investigated.
Published by david-c-kline over 6 years ago
This is the second release candidate for Mixed Reality Toolkit - Unity 2017.4.0.0.
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/8
Attention!
Import HoloToolkit-Unity-PreviewFeatures-2017.4.0.0-rc2.unitypackage to include SpectatorView in your project.
This release re-breaks #1940, in order to restore the keyboard caret (#2132). A fix is being investigated.
The following items are known and currently being investigated.
Published by david-c-kline over 6 years ago
This is a release candidate for Mixed Reality Toolkit - Unity 2017.4.0.0.
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/8
Attention!
This release re-breaks #1940, in order to restore the keyboard caret (#2132). A fix is being investigated.
The following items are known and currently being investigated.
Published by david-c-kline over 6 years ago
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/7
Attention!
Published by david-c-kline over 6 years ago
This is the second release candidate for Mixed Reality Toolkit - Unity 2017.2.1.4.
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/7
Attention!
Published by david-c-kline over 6 years ago
This is a release candidate for Mixed Reality Toolkit - Unity 2017.2.1.4.
Project board: https://github.com/Microsoft/MixedRealityToolkit-Unity/projects/7
Attention!