<commit_before># Microsoft Mixed Reality Toolkit Release Notes

- [Version 2.2.0](#version-220)
- [Version 2.1.0](#version-210)
- [Version 2.0.1](#version-201)
- [Version 2.0.0](#version-200)

## Version 2.2.0

- [Upgrading projects](#upgrading-projects-to-220)
- [What's new](#whats-new-in-220)
- [Known issues](#known-issues-in-220)

This release of the Microsoft Mixed Reality Toolkit supports the following devices and platforms.

- Microsoft HoloLens 2
- Microsoft HoloLens (1st gen)
- Windows Mixed Reality Immersive headsets
- OpenVR
- (Experimental) Mobile AR
    - Android
    - iOS

The following software is required.

- Microsoft Visual Studio (2017 or 2019) Community Edition or higher
- Windows 10 SDK 18362 or later (installed by the Visual Studio Installer)
- Unity 2018.4, 2019.1 or 2019.2

NuGet requirements

If importing the Mixed Reality Toolkit's NuGet packages, the following software is recommended.

- [NuGet for Unity](https://github.com/GlitchEnzo/NuGetForUnity)

### Upgrading projects to 2.2.0

The 2.2.0 release has some changes that may impact application projects. Breaking change details, including mitigation guidance, can be found in the [**Updating 2.1.0 to 2.2.0**](Updating.md#updating-210-to-220) article.

**Updating using .unitypackage files**

For the smoothest upgrade path, please use the following steps.

1. Close Unity
1. Delete **MixedRealityToolkit** (the project may not have all listed folders)
    - MixedRealityToolkit
    - MixedRealityToolkit.Examples
    - MixedRealityToolkit.Extensions
    > [!NOTE]
    > If additional extensions have been installed, please make a backup prior to deleting this folder.
    - MixedRealityToolkit.Providers
    - MixedRealityToolkit.SDK
    - MixedRealityToolkit.Services
    - MixedRealityToolkit.Tools
    > [!IMPORTANT]
    > Do NOT delete the **MixedRealityToolkit.Generated** folder.
1. Delete the **Library** folder
1. Re-open the project in Unity
1. Import the new unity packages
    - Foundation - _Import this package first_
    - (Optional) Tools
    - (Optional) Extensions
    > [!NOTE]
    > If additional extensions had been installed, they may need to be re-imported.
    - (Optional) Examples
1. Close Unity and Delete the **Library** folder. This step is necessary to force Unity to refresh its
   asset database and reconcile existing custom profiles.
1. Launch Unity, and for each scene in the project
    - Delete **MixedRealityToolkit** and **MixedRealityPlayspace**, if present, from the hierarchy
    - Select **MixedRealityToolkit -> Add to Scene and Configure**
    - Select **MixedRealityToolkit -> Utilities -> Update -> Controller Mapping Profiles** (only needs to be done once)
            - This will update any custom Controller Mapping Profiles with updated axes and data, while leaving your custom-assigned input actions intact

**Updating from NuGet**

If your project was created using the Mixed Reality Toolkit NuGet packages, please use the following steps.

1. Select **NuGet > Manage NuGet Packages**
1. Select the **Online** tab and click **Refresh**
1. Select the **Installed** tab
1. Click the **Update** button for each installed package
    - Microsoft.MixedReality.Toolkit.Foundation
    - Microsoft.MixedReality.Toolkit.Tools
    - Microsoft.MixedReality.Toolkit.Extensions
    - Microsoft.MixedReality.Toolkit.Examples
1. Re-open the project in Unity

### What's new in 2.2.0

<< todo >>

### Known issues in 2.1.0

The sections below highlight some of the known issues in the Microsoft Mixed Reality Toolkit.

<< todo >>

## Version 2.1.0

- [Upgrading projects](#upgrading-projects-to-210)
- [What's new](#whats-new-in-210)
- [Known issues](#known-issues-in-210)

This release of the Microsoft Mixed Reality Toolkit supports the following devices and platforms.
<commit_msg>add outline for 2.2.0 release notes<commit_after># Microsoft Mixed Reality Toolkit Release Notes

- [Version 2.2.0](#version-220)
- [Version 2.1.0](#version-210)
- [Version 2.0.1](#version-201)
- [Version 2.0.0](#version-200)

## Version 2.2.0

- [Upgrading projects](#upgrading-projects-to-220)
- [What's new](#whats-new-in-220)
- [Known issues](#known-issues-in-220)

This release of the Microsoft Mixed Reality Toolkit supports the following devices and platforms.

- Microsoft HoloLens 2
- Microsoft HoloLens (1st gen)
- Windows Mixed Reality Immersive headsets
- OpenVR
- (Experimental) Mobile AR
    - Android
    - iOS

The following software is required.

- Microsoft Visual Studio (2017 or 2019) Community Edition or higher
- Windows 10 SDK 18362 or later (installed by the Visual Studio Installer)
- Unity 2018.4, 2019.1 or 2019.2

NuGet requirements

If importing the Mixed Reality Toolkit NuGet packages, the following software is recommended.

- [NuGet for Unity](https://github.com/GlitchEnzo/NuGetForUnity)

### Upgrading projects to 2.2.0

The 2.2.0 release has some changes that may impact application projects. Breaking change details, including mitigation guidance, can be found in the [**Updating 2.1.0 to 2.2.0**](Updating.md#updating-210-to-220) article.

**Updating using .unitypackage files**

For the smoothest upgrade path, please use the following steps.

1. Close Unity
1. Delete **MixedRealityToolkit** (the project may not have all listed folders)
    - MixedRealityToolkit
    - MixedRealityToolkit.Examples
    - MixedRealityToolkit.Extensions
    > [!NOTE]
    > If additional extensions have been installed, please make a backup prior to deleting this folder.
    - MixedRealityToolkit.Providers
    - MixedRealityToolkit.SDK
    - MixedRealityToolkit.Services
    - MixedRealityToolkit.Tools
    > [!IMPORTANT]
    > Do NOT delete the **MixedRealityToolkit.Generated** folder.
1. Delete the **Library** folder
1. Re-open the project in Unity
1. Import the new unity packages
    - Foundation - _Import this package first_
    - (Optional) Tools
    - (Optional) Extensions
    > [!NOTE]
    > If additional extensions had been installed, they may need to be re-imported.
    - (Optional) Examples
1. Close Unity and Delete the **Library** folder. This step is necessary to force Unity to refresh its
   asset database and reconcile existing custom profiles.
1. Launch Unity, and for each scene in the project
    - Delete **MixedRealityToolkit** and **MixedRealityPlayspace**, if present, from the hierarchy
    - Select **MixedRealityToolkit -> Add to Scene and Configure**
    - Select **MixedRealityToolkit -> Utilities -> Update -> Controller Mapping Profiles** (only needs to be done once)
            - This will update any custom Controller Mapping Profiles with updated axes and data, while leaving your custom-assigned input actions intact

**Updating from NuGet**

If your project was created using the Mixed Reality Toolkit NuGet packages, please use the following steps.

1. Select **NuGet > Manage NuGet Packages**
1. Select the **Online** tab and click **Refresh**
1. Select the **Installed** tab
1. Click the **Update** button for each installed package
    - Microsoft.MixedReality.Toolkit.Foundation
    - Microsoft.MixedReality.Toolkit.Tools
    - Microsoft.MixedReality.Toolkit.Extensions
    - Microsoft.MixedReality.Toolkit.Examples
1. Re-open the project in Unity

### What's new in 2.2.0

**Camera Settings Providers**

<< todo >>

**Cursor resizing**

<< todo based on distance and angular scale >>

**Directional Indicator Solver**

<< todo >>

**Fingertip cursor translation and alignment*

<< todo >>

**GridObjectCollection supports content alignment**

<< todo asset version has been upgraded to allow for some fixes. All components with layout ColumnsThenRows will be upgraded automatically, keep eye out for logs and remember to check and save assets. >>

**InteractableToggleCollection**

<< todo new custom inspector >>

**Mixed Reality Capture settings (Experimental)**

<< todo >>

**Mobile AR (Android and iOS) support (Experimental)**

<< todo >>

**MSBuild for Unity**

<< todo: optionally installed via the Configure Unity menu >>

**New audio clips for HoloLens 2 style bounding boxes**

<< todo >>

**PressableButtonHoloLens2 icon lift on focus**

<< todo shell parity >>

**Pulse shaders for spatial mesh and hand mesh (Experimental)**

<< todo >>

**Scrolling Object Collection (Experimental)**

<< todo >>

**Search MRTK profiles for keywords**

<< todo >>

**Select HoloLens 2 depth reprojection mode**

<< todo requires >>

**Surface Magnetism Solver and Hand Ray example scene**

<< todo requires MSBuild for Unity installation >>

**Support for hand and eye tracking remoting for Microsoft HoloLens 2**

<< todo requires MSBuild for Unity installation >>

### Known issues in 2.1.0

The sections below highlight some of the known issues in the Microsoft Mixed Reality Toolkit.

**Long paths**

When building on Windows, there is a MAX_PATH limit of 255 characters. Unity is affected by these limits and may fail to build a binary if its resolved output path is longer than 255 characters.

This can manifest as CS0006 errors in Visual Studio that look like:

> CS0006: Metadata file 'C:\path\to\longer\file\that\is\longer\than\255\characters\mrtk.long.binary.name.dll' could not be found.

This can be worked around by moving the Unity project folder closer to the root of the drive, for example:

> C:\src\project

Please see [this issue](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/5469) for more background information.

**Runtime profile swapping**

MRTK does not fully support profile swapping at runtime. This feature is being investigated for a future release. Please see issues [4289](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/4289),
[5465](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/5465) and
[5466](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/5466) for more information.

<< todo >>

**Unity 2018: .NET Backend and AR Foundation**

<< todo >>

**Assembly has reference to non-existent assembly 'Unity.XR.ARFoundation'**

<< todo >>

**Mixed Reality Capture settings (Experimental)**

<< todo off by default. not supported on Unity 2019.1, 2019.2 and some versions of 2018.4 >>

**MRTK Configurator dialog**

<< todo may appear multiple times on project load >>

## Version 2.1.0

- [Upgrading projects](#upgrading-projects-to-210)
- [What's new](#whats-new-in-210)
- [Known issues](#known-issues-in-210)

This release of the Microsoft Mixed Reality Toolkit supports the following devices and platforms.

{'fraction_non_alphanumeric': 0.09537434430138293, 'fraction_numerical': 0.028898426323319026, 'mean_word_length': 4.085354025218234, 'pattern_counts': {'":': 0, '<': 51, '<?xml version=': 0, '>': 75, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '789921', 'n_tokens_mistral': 3278, 'n_tokens_neox': 2924, 'n_words': 1183}