You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[MRTK V2.3](#230)| Next iteration of MRTK | January 2020 |https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/10|
14
-
|[MRTK V2.4](#240)| Future iteration of MRTK | TBD |https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/11|
13
+
|[MRTK V2.4](#240)| Next iteration of MRTK | March 2020 |https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/11|
14
+
15
+
Releases are centered around themes (ex: large feature areas) and are scheduled to occur approximately every 8 weeks.
16
+
15
17
16
18
Release details, including backlog items, can be found on the [GitHub milestone pages](https://github.com/Microsoft/MixedRealityToolkit-Unity/milestones). The complete set of open issues can also be found on [GitHub](https://github.com/microsoft/MixedRealityToolkit-Unity/issues).
17
19
@@ -23,67 +25,49 @@ The Mixed Reality Toolkit will require Unity 2018.4.
23
25
24
26
> When Unity releases an LTS (Long Term Support) product, the Mixed Reality Toolkit will update to the LTS release. MRTK will also support the latest non-beta (ex: 2019.1) tech branch version of Unity, at the time at which MRTK was released.
25
27
26
-
### 2.3.0
28
+
### 2.4.0
27
29
28
-
The version 2.3.0 plan has been finalized. While some details may change as the iteration progresses, the following describes the overall plan for the next MRTK release. For the latest status of the release, please visit the [milestone page](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/10).
30
+
For the latest status of the release, please visit the [milestone page](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/11).
29
31
30
32
Status: In development
31
33
32
-
Timeline: January 2029
34
+
Timeline: March/April 2020
33
35
34
36
Themes:
35
37
36
38
- Stability
37
39
- Developer education
38
-
- Unity 2019.3 XR SDK support
39
40
- User Experience
40
-
-Iterate on mobile AR support
41
+
-Platform expansion: Hands
41
42
42
43
**Stability**
43
44
44
45
Quality and stability are the top priority for this and all Microsoft Mixed Reality Toolkit releases. We will continue to prioritize customer and partner issues that impact the stability of MRTK components.
45
46
46
-
The MRTK build and deploy tools remain a continued area of stability and quality focus.
47
-
48
47
**Developer education**
49
48
50
49
[Developer documentation](https://microsoft.github.io/MixedRealityToolkit-Unity) and example scenes are, like stability, an ongoing priority for the MRTK team.
51
50
52
-
**Unity 2019.3 XR SDK support**
53
-
54
-
XR SDK is Unity's new mixed reality platform. The Microsoft Mixed Reality Toolkit is committed to supporting our customers on this new platform. All new platform support in MRTK is expected to be delivered via XR SDK.
55
-
56
51
**User Experience**
57
52
58
-
User experience (UX) work will include:
59
-
60
53
- Bug fixes
61
-
- Making it easier to add MRTK UX elements to projects
The Mixed Reality Toolkit will gain experimental support for spatial awareness (planes and points) on mobile AR platforms (Android ARCore and iOS ARKit) via ARFoundation. Refinements to the camera support module shipped in version 2.2.0 are also planned.
70
-
71
-
### 2.4.0
60
+
As part of the hand extensibility theme, MRTK plans on adding support for the Leap Motion hands controller and Oculus Quest. Support for Leap Motion is expected to be made available on both Unity 2018.4 and 2019. Oculus Quest, including articulated hands, will be delivered via [Unity's new XR platform](https://blogs.unity3d.com/2020/01/24/unity-xr-platform-updates/).
72
61
73
-
The planning for version 2.4.0 is in the early stages. All of the details below are subject to change. For the latest information, please consult [GitHub](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/11).
62
+
## Backlog
74
63
75
-
Status: Early planning
64
+
The following list highlights some of the key investments the MRTK team intends to pursue.
Copy file name to clipboardExpand all lines: Documentation/ReleaseNotes.md
+126-1Lines changed: 126 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@
16
16
- Microsoft HoloLens (1st gen)
17
17
- Windows Mixed Reality Immersive headsets
18
18
- OpenVR
19
+
- (Experimental) Unity 2019.3 XR platform
19
20
- (Experimental) Mobile AR
20
21
- Android
21
22
- iOS
@@ -36,10 +37,134 @@ If importing the [Mixed Reality Toolkit NuGet packages](MRTKNuGetPackage.md), th
36
37
37
38
The 2.3.0 release has some changes that may impact application projects. Breaking change details, including mitigation guidance, can be found in the [**Updating 2.2.0 to 2.3.0**](Updating.md#updating-220-to-230) article.
38
39
40
+
> [!NOTE]
41
+
> At this time, it is not supported to switch between using .unitypackage files and NuGet.
42
+
43
+
**Updating using .unitypackage files**
44
+
45
+
For the smoothest upgrade path, please use the following steps.
46
+
47
+
1. Close Unity
48
+
1. Inside the *Assets* folder, delete most of the **MixedRealityToolkit** folders, along with their .meta files (the project may not have all listed folders)
49
+
- MixedRealityToolkit
50
+
- MixedRealityToolkit.Examples
51
+
- MixedRealityToolkit.Extensions
52
+
> [!NOTE]
53
+
> If additional extensions have been installed, please make a backup prior to deleting these folders.
54
+
- MixedRealityToolkit.Providers
55
+
- MixedRealityToolkit.SDK
56
+
- MixedRealityToolkit.Services
57
+
- MixedRealityToolkit.Staging
58
+
> [!NOTE]
59
+
> The contents of the MixedRealityToolkit.Staging folder have been moved into the MixedRealityToolkit.Providers folder in MRTK 2.3.0.
60
+
- MixedRealityToolkit.Tools
61
+
> [!IMPORTANT]
62
+
> Do NOT delete the **MixedRealityToolkit.Generated** folder, or its .meta file.
63
+
1. Delete the **Library** folder
64
+
1. Re-open the project in Unity
65
+
1. Import the new unity packages
66
+
- Foundation - _Import this package first_
67
+
- (Optional) Tools
68
+
- (Optional) Extensions
69
+
> [!NOTE]
70
+
> If additional extensions had been installed, they may need to be re-imported.
71
+
- (Optional) Examples
72
+
1. Close Unity and Delete the **Library** folder. This step is necessary to force Unity to refresh its
73
+
asset database and reconcile existing custom profiles.
74
+
1. Launch Unity, and for each scene in the project
75
+
- Delete **MixedRealityToolkit** and **MixedRealityPlayspace**, if present, from the hierarchy. This will delete the main camera, but it will be re-created in the next step. If any properties of the main camera have been manually changed, these will have to be re-applied manually once the new camera is created.
76
+
- Select **MixedRealityToolkit -> Add to Scene and Configure**
77
+
- Select **MixedRealityToolkit -> Utilities -> Update -> Controller Mapping Profiles** (only needs to be done once)
78
+
- This will update any custom Controller Mapping Profiles with updated axes and data, while leaving your custom-assigned input actions intact
79
+
80
+
**Updating from NuGet**
81
+
82
+
If your project was created using the [Mixed Reality Toolkit NuGet packages](MRTKNuGetPackage.md), please use the following steps.
83
+
84
+
1. Select **NuGet > Manage NuGet Packages**
85
+
1. Select the **Online** tab and click **Refresh**
86
+
1. Select the **Installed** tab
87
+
1. Click the **Update** button for each installed package
**Support for Unity 2019.3 new XR platform (Experimental)**
98
+
99
+
MRTK has added initial support for [Unity 2019.3's new XR platform](https://blogs.unity3d.com/2020/01/24/unity-xr-platform-updates/). When using the Windows XR plugin, it is recommended using version **2.0.4 (preview.3)** or newer.
100
+
101
+
Please see [Known issues](#known-issues-in-230) for details on known limitations.
102
+
103
+
**Hand physics extension service**
104
+
105
+
A hand physics extension service has been added to allow for using physics interactions with the HoloLens 2 articulated hands ([#6573](https://github.com/microsoft/MixedRealityToolkit-Unity/pull/6573)).
The Pinch Slider has been updated to orient TrackVisuals, TickMarks and ThumbRoot based on the sliderAxis orientation ([#6858](https://github.com/microsoft/MixedRealityToolkit-Unity/pull/6858))
**Issues with the Unity 2019.3 new XR platform on Windows Mixed Reality**
119
+
120
+
The following issues are known when using the new XR platform and version **2.0.4 (preview.3)** of the Windows XR Plugin:
121
+
122
+
- AirTap does not work on HoloLens (HoloLens 2 and 1st generation)
123
+
- Pointers are using the wrong coordinate system on HoloLens 2 and immersive devices
124
+
125
+
It is recommended to periodically check **Window** > **Package Manager** for newer versions of the Windows XR plugin.
126
+
127
+
**Windows Mixed Reality gesture support on Unity 2019.3 when using the new XR platfom**
128
+
129
+
This release of MRTK does not contain an implementation for Windows Mixed Reality gestures using the new XR platform. It will be added in a future version of MRTK.
130
+
131
+
**Specifying the Depth Reprojection mode in the Windows Mixed Reality Camera Settings Provider is not supported on Unity 2019.3 and Windows XR plugin**
132
+
133
+
This issue is expected to be fixed with upcoming releases of MRTK and the Windows XR plugin.
134
+
135
+
**Mixed Reality Capture setting**
136
+
137
+
This feature is currently not working correctly on Unity 2019.3.0f6. This issue impacts both the legacy and the new XR platform.
138
+
139
+
**Long paths**
140
+
141
+
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.
142
+
143
+
This can manifest as CS0006 errors in Visual Studio that look like:
144
+
145
+
> CS0006: Metadata file 'C:\path\to\longer\file\that\is\longer\than\255\characters\mrtk.long.binary.name.dll' could not be found.
146
+
147
+
This can be worked around by moving the Unity project folder closer to the root of the drive, for example:
148
+
149
+
> C:\src\project
150
+
151
+
Please see [this issue](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/5469) for more background information.
152
+
153
+
**Runtime profile swapping**
154
+
155
+
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),
156
+
[5465](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/5465) and
157
+
[5466](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/5466) for more information.
158
+
159
+
**Unity 2018: .NET Backend and AR Foundation**
160
+
161
+
There is an issue in Unity 2018 where, building a Universal Windows Platform project using the .NET scripting backend, the Unity AR Foundation package will fail.
162
+
163
+
To work around this issue, please perform one of the following steps:
164
+
165
+
- Switch the scripting backend to IL2CPP
166
+
- In the Build Settings window, uncheck **Unity C# Projects"
167
+
43
168
## Version 2.2.0
44
169
45
170
-[How to upgrade projects](#how-to-upgrade-projects-to-220)
@@ -118,7 +243,7 @@ If your project was created using the [Mixed Reality Toolkit NuGet packages](MRT
0 commit comments