Skip to content

Commit 59221ef

Browse files
committed
Add some notes on XR SDK
1 parent c5b9c7d commit 59221ef

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

Documentation/GettingStartedWithTheMRTK.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,9 @@ To create a **HoloLens application**, switch to the Universal Windows Platform:
101101
Profiles configure the behavior of MRTK core components and are described in more detail in the [profiles](Profiles/Profiles.md) article.
102102

103103
> [!NOTE]
104-
> If you are getting started on the HoloLens or HoloLens 2, you should choose the "DefaultHoloLens1ConfigurationProfile" or DefaultHoloLens2ConfigurationProfile" instead.
105-
> See the [profiles](Profiles/Profiles.md#hololens-2-profile) for more information on the differences between DefaultMixedRealityToolkitConfigurationProfile and DefaultHoloLens2ConfigurationProfile.
104+
> * If you're using Unity's XR SDK in Unity 2019.3 or later, you should choose the "DefaultXRSDKConfigurationProfile". This profile is set up with MRTK's XR SDK systems and providers, where needed.
105+
> * If you're getting started on the HoloLens or HoloLens 2, you should choose the "DefaultHoloLens1ConfigurationProfile" or DefaultHoloLens2ConfigurationProfile" instead.
106+
> * See the [profiles](Profiles/Profiles.md#hololens-2-profile) for more information on the differences between DefaultMixedRealityToolkitConfigurationProfile and DefaultHoloLens2ConfigurationProfile.
106107
107108
You will then see the following in your Scene hierarchy:
108109

@@ -188,3 +189,18 @@ Here are some suggested next steps:
188189
## Upgrading from the HoloToolkit (HTK/MRTK v1)
189190

190191
There is not a direct upgrade path from the HoloToolkit to Mixed Reality Toolkit v2 due to the rebuilt framework. However, it is possible to import the MRTK into your HoloToolkit project and migrate your implementation. For more information, see the [HoloToolkit to Mixed Reality Toolkit Porting Guide](HTKToMRTKPortingGuide.md)
192+
193+
## Getting started with Unity's XR SDK
194+
195+
If you're using Unity's XR SDK in Unity 2019.3 or later, you should choose the "DefaultXRSDKConfigurationProfile" as your active profile. This profile is set up with MRTK's XR SDK systems and providers, where needed.
196+
Then, follow these steps to set up support in Unity:
197+
198+
1. Go into Unity's Package Manager and install the Windows XR Plugin package, which adds support for Windows Mixed Reality on XR SDK. This will pull down a few dependency packages as well. Ensure the following are all installed:
199+
1. XR Management
200+
1. Windows XR Plugin
201+
1. XR Legacy Input Helpers
202+
1. Go to Edit > Project Settings.
203+
1. Click on the XR Plugin Management tab in the Project Settings window.
204+
1. Go to the Universal Windows Platform settings, then click the + to add a Windows MR Loader.
205+
1. Ensure that Initialize on Startup is checked.
206+
1. (**_Optional_**) Click on the Windows Mixed Reality tab under XR Plugin Management and create a custom settings profile to change the defaults.

0 commit comments

Comments
 (0)