Merge pull request #7088 from keveleigh/xr-sdk-docs-init

keveleigh · web-flow · commit 2e076234342b · 2020-01-17T13:27:54.000-08:00
Add initial XR SDK docs and reserialize some XR SDK assets
diff --git a/Assets/MixedRealityToolkit.Extensions/HandPhysicsService/README.md b/Assets/MixedRealityToolkit.Extensions/HandPhysicsService/README.md
@@ -3,6 +3,7 @@
 The hand physics service enables rigid body collision events and interactions with articulated hands.
 
 ## Getting started with hand physics extension service
+
 Add the hand physics service to the list of extension services and use the default profile.
 
 Once enabled, use any collider's IsTrigger property to receive collision events from all 10 digits (and palms if they're enabled).
@@ -11,7 +12,7 @@ Once enabled, use any collider's IsTrigger property to receive collision events
 
 - Enabled the extension service
 - Assign an appropriate prefab to the finger/palm joint.
- 
+
 ## Recommendations
 
-While the service defaults to the "default" layer, it is recommended to use a separate layer for HandPhysics objects. Otherwise there may be unwanted collisions and/or inaccurate raycasts.
+While the service defaults to the "default" layer, it is recommended to use a separate layer for HandPhysics objects. Otherwise there may be unwanted collisions and/or inaccurate raycasts.
diff --git a/Assets/XR/Settings/Windows MR Package Settings.asset b/Assets/XR/Settings/Windows MR Package Settings.asset
@@ -1,6 +1,6 @@
 %YAML 1.1
 %TAG !u! tag:unity3d.com,2011:
---- !u!114 &-8196618691911559044
+--- !u!114 &-9138172715340701070
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -9,12 +9,11 @@ MonoBehaviour:
   m_GameObject: {fileID: 0}
   m_Enabled: 1
   m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: ed912223f7b3af74d8e196b2a4e662b3, type: 3}
+  m_Script: {fileID: 11500000, guid: 3a6c5bd16b42a1542ad52d1d47746bdb, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  DepthBufferFormat: 0
-  UseSharedDepthBuffer: 0
---- !u!114 &-7462731363317155659
+  UsePrimaryWindowForDisplay: 1
+--- !u!114 &11400000
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -23,11 +22,16 @@ MonoBehaviour:
   m_GameObject: {fileID: 0}
   m_Enabled: 1
   m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 3a6c5bd16b42a1542ad52d1d47746bdb, type: 3}
-  m_Name: 
+  m_Script: {fileID: 11500000, guid: e679265d16d650945812b915bb9d5cc3, type: 3}
+  m_Name: Windows MR Package Settings
   m_EditorClassIdentifier: 
-  UsePrimaryWindowForDisplay: 1
---- !u!114 &11400000
+  Keys: 0e00000001000000
+  Values:
+  - {fileID: 8764183953860033900}
+  - {fileID: 3955096188411757935}
+  BuildValues:
+  - {fileID: -9138172715340701070}
+--- !u!114 &3955096188411757935
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -36,16 +40,12 @@ MonoBehaviour:
   m_GameObject: {fileID: 0}
   m_Enabled: 1
   m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: e679265d16d650945812b915bb9d5cc3, type: 3}
-  m_Name: Windows MR Package Settings
+  m_Script: {fileID: 11500000, guid: ed912223f7b3af74d8e196b2a4e662b3, type: 3}
+  m_Name: 
   m_EditorClassIdentifier: 
-  Keys: 0e00000001000000
-  Values:
-  - {fileID: 3397675408405997788}
-  - {fileID: -8196618691911559044}
-  BuildValues:
-  - {fileID: -7462731363317155659}
---- !u!114 &3397675408405997788
+  DepthBufferFormat: 1
+  UseSharedDepthBuffer: 1
+--- !u!114 &8764183953860033900
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
diff --git a/Assets/XR/XRGeneralSettings.asset b/Assets/XR/XRGeneralSettings.asset
@@ -1,20 +1,6 @@
 %YAML 1.1
 %TAG !u! tag:unity3d.com,2011:
---- !u!114 &-5609432006805224515
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 0}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: d236b7d11115f2143951f1e14045df39, type: 3}
-  m_Name: Android Settings
-  m_EditorClassIdentifier: 
-  m_LoaderManagerInstance: {fileID: -974958139742406341}
-  m_InitManagerOnStart: 1
---- !u!114 &-3979523859960156722
+--- !u!114 &-5796463592960687092
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -31,23 +17,7 @@ MonoBehaviour:
   m_AutomaticRunning: 0
   m_Loaders:
   - {fileID: 11400000, guid: f71156c4b70809f4a8542fa1ca99fe9f, type: 2}
---- !u!114 &-974958139742406341
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 0}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: f4c3631f5e58749a59194e0cf6baf6d5, type: 3}
-  m_Name: Android Providers
-  m_EditorClassIdentifier: 
-  m_RequiresSettingsUpdate: 0
-  m_AutomaticLoading: 0
-  m_AutomaticRunning: 0
-  m_Loaders: []
---- !u!114 &11400000
+--- !u!114 &-2196315355675890184
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -56,15 +26,12 @@ MonoBehaviour:
   m_GameObject: {fileID: 0}
   m_Enabled: 1
   m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: d2dc886499c26824283350fa532d087d, type: 3}
-  m_Name: XRGeneralSettings
+  m_Script: {fileID: 11500000, guid: d236b7d11115f2143951f1e14045df39, type: 3}
+  m_Name: Standalone Settings
   m_EditorClassIdentifier: 
-  Keys: 0e0000000100000007000000
-  Values:
-  - {fileID: 4268085174510186550}
-  - {fileID: 5555502764924699438}
-  - {fileID: -5609432006805224515}
---- !u!114 &789108825542787325
+  m_LoaderManagerInstance: {fileID: -689958956425743848}
+  m_InitManagerOnStart: 1
+--- !u!114 &-689958956425743848
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -81,7 +48,7 @@ MonoBehaviour:
   m_AutomaticRunning: 0
   m_Loaders:
   - {fileID: 11400000, guid: f71156c4b70809f4a8542fa1ca99fe9f, type: 2}
---- !u!114 &4268085174510186550
+--- !u!114 &11400000
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -90,12 +57,14 @@ MonoBehaviour:
   m_GameObject: {fileID: 0}
   m_Enabled: 1
   m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: d236b7d11115f2143951f1e14045df39, type: 3}
-  m_Name: Metro Settings
+  m_Script: {fileID: 11500000, guid: d2dc886499c26824283350fa532d087d, type: 3}
+  m_Name: XRGeneralSettings
   m_EditorClassIdentifier: 
-  m_LoaderManagerInstance: {fileID: -3979523859960156722}
-  m_InitManagerOnStart: 1
---- !u!114 &5555502764924699438
+  Keys: 0e00000001000000
+  Values:
+  - {fileID: 8889006692710314719}
+  - {fileID: -2196315355675890184}
+--- !u!114 &8889006692710314719
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -105,7 +74,7 @@ MonoBehaviour:
   m_Enabled: 1
   m_EditorHideFlags: 0
   m_Script: {fileID: 11500000, guid: d236b7d11115f2143951f1e14045df39, type: 3}
-  m_Name: Standalone Settings
+  m_Name: Metro Settings
   m_EditorClassIdentifier: 
-  m_LoaderManagerInstance: {fileID: 789108825542787325}
+  m_LoaderManagerInstance: {fileID: -5796463592960687092}
   m_InitManagerOnStart: 1
diff --git a/Documentation/GettingStartedWithTheMRTK.md b/Documentation/GettingStartedWithTheMRTK.md
@@ -29,7 +29,7 @@ To get started with the Mixed Reality Toolkit, you will need:
 
 ### Optional
 
-* [Getting started tutorials](#get-the-latest-mrtk-unity-packages)
+* [Getting started tutorials](#getting-started-tutorials)
 * [Learn about the core building blocks of MRTK](#learn-about-the-core-building-blocks-of-mrtk)
 * [Run the HandInteractionExamples scene in the Unity Editor](#run-the-handinteractionexamples-scene-in-the-unity-editor)
 
@@ -101,8 +101,9 @@ To create a **HoloLens application**, switch to the Universal Windows Platform:
     Profiles configure the behavior of MRTK core components and are described in more detail in the [profiles](Profiles/Profiles.md) article.
 
     > [!NOTE]
-    > If you are getting started on the HoloLens or HoloLens 2, you should choose the "DefaultHoloLens1ConfigurationProfile" or DefaultHoloLens2ConfigurationProfile" instead.
-    > See the [profiles](Profiles/Profiles.md#hololens-2-profile) for more information on the differences between DefaultMixedRealityToolkitConfigurationProfile and DefaultHoloLens2ConfigurationProfile.
+    > * 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.  
+    > * If you're getting started on the HoloLens or HoloLens 2, you should choose the "DefaultHoloLens1ConfigurationProfile" or DefaultHoloLens2ConfigurationProfile" instead.  
+    > * See the [profiles](Profiles/Profiles.md#hololens-2-profile) for more information on the differences between DefaultMixedRealityToolkitConfigurationProfile and DefaultHoloLens2ConfigurationProfile.
 
     You will then see the following in your Scene hierarchy:
 
@@ -155,18 +156,18 @@ The in-editor input simulation allows you to test virtual object behavior given
 
 How to move around in the scene:
 
-- Use **W/A/S/D** keys to move the camera forward/left/back/right.
-- Use **Q/E** to move the camera vertically.
-- Press and hold the **right mouse button** to rotate the camera.
+* Use **W/A/S/D** keys to move the camera forward/left/back/right.
+* Use **Q/E** to move the camera vertically.
+* Press and hold the **right mouse button** to rotate the camera.
 
 How to simulate hand input:
 
-- Press and hold the **spacebar** to enable the right hand.
-- While holding the space bar, move your mouse to move the hand.
-- Use the mouse **scroll wheel** to adjust the depth of the hand.
-- Click the **left mouse button** to simulate pinch gesture.
-- Use **T/Y** keys to make the hand persistent in the view.
-- Hold **CTRL** key and move the mouse to rotate the hand.
+* Press and hold the **spacebar** to enable the right hand.
+* While holding the space bar, move your mouse to move the hand.
+* Use the mouse **scroll wheel** to adjust the depth of the hand.
+* Click the **left mouse button** to simulate pinch gesture.
+* Use **T/Y** keys to make the hand persistent in the view.
+* Hold **CTRL** key and move the mouse to rotate the hand.
 
 Have fun exploring the scene! You can learn more about the UI controls [in the hand interaction examples guide](README_HandInteractionExamples.md). Also, read through [input simulation docs](InputSimulation/InputSimulationService.md) to learn more about in-editor hand input simulation in MRTK.
 
@@ -188,3 +189,18 @@ Here are some suggested next steps:
 ## Upgrading from the HoloToolkit (HTK/MRTK v1)
 
 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)
+
+## Getting started with Unity's XR SDK
+
+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.
+Then, follow these steps to set up support in Unity:
+
+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:
+   1. XR Management
+   1. Windows XR Plugin
+   1. XR Legacy Input Helpers
+1. Go to Edit > Project Settings.
+1. Click on the XR Plugin Management tab in the Project Settings window.
+1. Go to the Universal Windows Platform settings, then click the + to add a Windows MR Loader.
+1. Ensure that Initialize on Startup is checked.
+1. (**_Optional_**) Click on the Windows Mixed Reality tab under XR Plugin Management and create a custom settings profile to change the defaults.
