Skip to content
  • v2.4.0
  • ed6929b
  • Compare
    Choose a tag to compare
    Search for a tag
  • v2.4.0
  • ed6929b
  • Compare
    Choose a tag to compare
    Search for a tag

@wiwei wiwei released this May 27, 2020

Mixed Reality Toolkit

Download

Scroll down to Assets and download to a known location (typically, this is the Downloads folder on Windows 10):

  • Microsoft.MixedReality.Toolkit.Unity.Foundation.2.4.0.unitypackage
  • [Required if upgrading, optional otherwise] Microsoft.MixedReality.Toolkit.Unity.Tools.2.4.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Examples.2.4.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Extensions.2.4.0.unitypackage

Once downloaded, you can set the target platform and import the desired packages using these instructions.

Getting started

To help you get started using MRTK v2.4.0, please see the Documentation Portal.

The Getting Started page covers software requirements and the initial steps required to use MRTK.

Release notes

Please see Release Notes for information on new features, known issues and changes.

Upgrading from 2.3.0

Please review the Upgrade Guide for guidance on how to upgrade an existing project to 2.4.0.

Note that the Tools package is now required when upgrading to a newer version of MRTK. It includes the migration tool, which automates the updating of projects assets to account for some changes in MRTK.

Assets 8
  • v2.3.0
  • ed5fb9e
  • Compare
    Choose a tag to compare
    Search for a tag
  • v2.3.0
  • ed5fb9e
  • Compare
    Choose a tag to compare
    Search for a tag

@davidkline-ms davidkline-ms released this Feb 13, 2020 · 2 commits to releases/2.3.0 since this release

Mixed Reality Toolkit

Download

Scroll down to Assets and download to a known location (typically, this is the Downloads folder on Windows 10):

  • Microsoft.MixedReality.Toolkit.Unity.Foundation.2.3.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Tools.2.3.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Examples.2.3.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Extensions.2.3.0.unitypackage

Once downloaded, you can set the target platform and import the desired packages using these instructions.

Getting started

To help you get started using MRTK v2.3.0, please see the Documentation Portal.

The Getting Started page covers software requirements and the initial steps required to use MRTK.

Changes since 2.2.0

There have been some functional and architecture changes in this release of MRTK. For those with projects that are currently using version 2.x.x, please review the Upgrade Guide.

Please note that the Microsoft.MixedReality.Toolkit.Providers.UnityAR package has been merged into Microsoft.MixedReality.Toolkit.Foundation in this release.

Release notes

Please see Release Notes for information on new features, known issues and changes.

This [video](coming soon) demonstrates many of the great features that can be found in MRTK 2.3.0.

Assets 8
  • v2.2.0
  • 25acfd3
  • Compare
    Choose a tag to compare
    Search for a tag
  • v2.2.0
  • 25acfd3
  • Compare
    Choose a tag to compare
    Search for a tag

@davidkline-ms davidkline-ms released this Dec 11, 2019

Mixed Reality Toolkit

Download

Scroll down to Assets and download to a known location (typically, this is the Downloads folder on Windows 10):

  • Microsoft.MixedReality.Toolkit.Unity.Foundation.2.2.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Tools.2.2.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Examples.2.2.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Extensions.2.2.0.unitypackage
  • [Optional, Experimental] Microsoft.MixedReality.Toolkit.Unity.Providers.UnityAR.2.2.0.unitypackage

Once downloaded, you can set the target platform and import the desired packages using these instructions.

Getting started

To help you get started using MRTK v2.2, please see the Documentation Portal.

The Getting Started page covers software requirements and the initial steps required to use MRTK.

Changes since 2.1.0

There have been some functional and architecture changes in this release of MRTK. For those with projects that are currently using version 2.x.x, please review the Upgrade Guide.

Release notes

Please see Release Notes for information on new features, known issues and changes.

This video demonstrates many of the great features that can be found in MRTK 2.2.0.

Assets 9
  • v2.1.0
  • 2c711ab
  • Compare
    Choose a tag to compare
    Search for a tag
  • v2.1.0
  • 2c711ab
  • Compare
    Choose a tag to compare
    Search for a tag

@davidkline-ms davidkline-ms released this Oct 9, 2019 · 2 commits to releases/2.1.0 since this release

Mixed Reality Toolkit

Download

Scroll down to Assets and download to a known location (typically, this is the Downloads folder on Windows 10):

  • Microsoft.MixedReality.Toolkit.Unity.Foundation.2.1.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Tools.2.1.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Examples.2.1.0.unitypackage
  • [Optional] Microsoft.MixedReality.Toolkit.Unity.Extensions.2.1.0.unitypackage

Once downloaded, you can set the target platform and import the desired packages using these instructions.

Getting started

To help you get started using MRTK v2.1, please see the Documentation Portal.

The Getting Started page covers software requirements and the initial steps required to use MRTK.

Changes since 2.0.0

There have been some functional and architecture changes in this release of MRTK. For those with projects that are currently using version 2.0.x, please review the Upgrade Guide.

Release notes

Please see Release Notes for information on new features, known issues and changes.

This video demonstrates many of the great features that can be found in MRTK 2.1.0.

Assets 9
  • v2.0.0
  • 89fb1f9
  • Compare
    Choose a tag to compare
    Search for a tag
  • v2.0.0
  • 89fb1f9
  • Compare
    Choose a tag to compare
    Search for a tag

@davidkline-ms davidkline-ms released this Aug 21, 2019 · 5432 commits to mrtk_release since this release

Mixed Reality Toolkit
Welcome to the first official release of Microsoft Mixed Reality Toolkit version 2!

Getting started

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.

Changes since the RC2 releases

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.

Release notes

Please see Release Notes for information on new features, known issues and changes.

MRTK Examples Hub App packages

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.

Assets 9
Pre-release

@wiwei wiwei released this Jun 13, 2019 · 7919 commits to mrtk_release since this release

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.

Getting started

To help you get started using MRTK v2, please see the Documentation Portal.

RC1 to RC2 Upgrade Instructions

  1. Delete all MixedRealityToolkit folders from RC1: MixedRealityToolkit, MixedRealityToolkit.Examples, MixedRealityToolkit.Providers, MixedRealityToolkit.SDK, MixedRealityToolkit.Services
  2. Delete your Library folder
  3. Import the RC2 unity packages
  4. In your scenes, delete and re-add both the MixedRealityToolkit and MixedRealityPlaySpace objects

What's new in RC2

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.  
}

API Surface Changes

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

Assets 4
Pre-release

@wiwei wiwei released this Jun 12, 2019 · 7925 commits to mrtk_release since this release

MRTK v2 Release Candidate 2 provides new stabilization fixes and a few additional features.

Getting started

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.

What's new in RC2

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.  
}

RC1 to RC2 Upgrade Instructions

  1. Delete all MixedRealityToolkit folders from RC1: MixedRealityToolkit, MixedRealityToolkit.Examples, MixedRealityToolkit.Providers, MixedRealityToolkit.SDK, MixedRealityToolkit.Services
  2. Delete your Library folder
  3. Import the RC2 unity pagckages
  4. In your scenes, delete and re-add both the MixedRealityToolkit and MixedRealityPlaySpace objects

RC1 to RC2 Upgrade Known Issues

Pressable buttons may need to be removed and added

After RC1 to RC2 upgrade, pressable buttons may have incorrect planes. To fix, remove and add back the pressable button component.

API Surface Changes

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

Assets 4
Pre-release

@wiwei wiwei released this May 1, 2019 · 8895 commits to mrtk_release since this release

MRTK v2 Release Candidate 1 Refresh

MRTK v2 Release Candidate 1 Refresh is an updated version of the RC1 package with stabilization fixes and a few additional features

Getting started

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.

What's new in the refresh

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

API Surface Changes

There have been changes to some API surfaces since the last release drop:

IMixedRealityPointerHandler

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 #4013, adding this method onto a new interface would have led to an ultimately more complicated pointer API story.

Namespace cleanup

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 #4019 for the list of changed classes (along with the new namespaces they now live in).

Assets 4
Pre-release

@wiwei wiwei released this Apr 5, 2019 · 9178 commits to mrtk_release since this release

MRTK v2 Release Candidate 1

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".

Getting started

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.

What's new in RC1.

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:

  • UWP (HoloLens, HoloLens 2, WMR Headset)
  • OpenVR

Here's the set of known issues in RC1 that we are working on fixing

  • Slate panning is not working with Far interaction
  • Other issues tagged "RC1 Bug" on the issues list
Assets 4
Pre-release

@davidkline-ms davidkline-ms released this Feb 22, 2019

Overview

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.

Features

  • New version numbering system
    • Adheres to Semantic Versioning 2.0.0
  • Cross-platform Mixed Reality support
    • Windows Mixed Reality
      • Microsoft HoloLens
      • Immersive Headsets
    • OpenVR
  • New, more modular architecture
    • Core
      • Interface definitions
      • Data types
      • Profile system for configuration
      • Mixed Reality Toolkit scene object
      • Unity Input data provider
      • Mixed Reality Toolkit Standard Shader
    • Platform data providers
      • Windows Mixed Reality
      • Windows Voice
      • OpenVR
    • System services
      • Boundary
      • Diagnostics (featuring the Visual Profiler)
      • Input
      • Spatial Awareness
      • Teleportation
    • Features
      • Audio influencer effects
      • Solvers
      • User Experience Controls
      • Standard Assets

Requirements

  • Unity 2018.3.x or later
  • Microsoft Visual Studio 2017
  • Windows SDK 10.0.17134 or later
  • Windows 10 1803 or later

The Packages

This release consists of two packages: Foundation and Examples.

Foundation

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.

Examples

The Examples package contains demonstration scenes and assets used to help get you started using the systems and features of the Mixed Reality Toolkit.

Changes since v2.0.0 Beta2 Release Candidate

  • (#3496) Fix air-tap in Holographic Remoting (workaround for Unity issue #1033526)
  • (#3502) MixedRealityToolkit Profile Inspector
  • (#3503) Small Performance Tweaks Round 2
  • (#3506) Read the default profile and default platforms from the ExtensionServiceAttribute
  • (#3508) Pre-beta2 spell check pass

Known Issues

The following issues are known and under investigation.

  • (#3158) Improve Workflow for Stabilization Plane
  • (#3177) The "select" voice command no longer fires an event on Windows Mixed Reality
  • (#3217) vNEXT Task: Add Application Pause/Focus from Engine to Service Locator
  • (#3308) DeployOptions: Not able to connect to hololens and deploy appx
  • (#3322) Unity UI buttons have priority over MRTK buttons
  • (#3331) Controller visualization for Windows Mixed Reality
  • (#3332) Controller visualization for OpenVR
  • (#3359) FocusManager does not compute distance to Canvas correctly
  • (#3403) If no camera exists in the scene, MRTK Configure doesn't properly set up the scene
  • (#3422) [UWP] Selecting InputFields in the Editor only works outside the center text
  • (#3427) Question: UIRayCastCamera Disappearing on click of create new in profiles
  • (#3429) How to setup uGUI for MRTK?)
  • (#3430) MRTK continually complains about irrelevant joysticks

Breaking Changes

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.

  • (#3074) Refactor Controller Mapping Profile to accept individual controller scriptable objects
  • (#3115) Update inconsistent naming of core system implementations
  • (#3295) Remove requirement for IMixedRealityInputHandler < T > to be an IMixedRealityInputHandler
  • (#3326) Spatial awareness interface changes
  • (#3341) Tree layout and assembly restructure to align with packaging
  • (#3357) Create separate WindowsMixedReality provider assembly
  • (#3358) Create separate OpenVR provider assembly
  • (#3387) Add attribute to make sure we can migrate to data provider in V3
Assets 4
You can’t perform that action at this time.