From 9f7a309b2eff467aafc08c24f3fbdb70cbc12cd2 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 15:21:23 -0700 Subject: [PATCH 1/8] Additional improvement to remoting doc Co-Authored-By: Kurtis <3580640+keveleigh@users.noreply.github.com> --- Documentation/Tools/HolographicRemoting.md | 25 ++++++++++++++-------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/Documentation/Tools/HolographicRemoting.md b/Documentation/Tools/HolographicRemoting.md index d78cbff8931..4228c3265b4 100644 --- a/Documentation/Tools/HolographicRemoting.md +++ b/Documentation/Tools/HolographicRemoting.md @@ -2,11 +2,22 @@ Holographic remoting streams holographic content from a PC to your Microsoft HoloLens in real-time, using a Wi-Fi or USB cable connection. This feature can significantly increase developer productivity when developing mixed reality applications. +XR SDK as mentioned below refers to Unity's [new XR pipeline in Unity 2019.3 and beyond](https://blogs.unity3d.com/2020/01/24/unity-xr-platform-updates/). See [here](../GettingStartedWithMRTKAndXRSDK.md) for more information on using XR SDK with MRTK. Legacy XR refers to the existing XR pipeline that is included in Unity 2018, deprecated in Unity 2019.3 and removed in Unity 2020. + ## Initial setup -To enable remoting to a HoloLens, it is important to ensure the latest Holographic Remoting application is installed, on the HoloLens, via the Microsoft Store. +To enable remoting to a HoloLens, it is important to ensure that the project is using the latest remoting components. + +1. Open **Window > Package Manager** + - If using legacy XR: Verify that latest version of the **Windows Mixed Reality** package is installed. + - If using XR SDK: Verify that latest version of the **Windows XR Plugin** package is installed. +1. Ensure the latest Holographic Remoting application is installed, on the HoloLens, via the Microsoft Store. + +Please continue to [Legacy XR setup instructions](#Legacy XR setup instructions) or [XR SDK setup instructions](#XR SDK setup instructions) depending on which pipeline is used in the project. + +## Legacy XR setup instructions -### HoloLens 2 Legacy XR setup instructions +The instructions below only apply to remoting with HoloLens 2. If you only perform remoting with HoloLens (1st Gen), skip to [Connecting to the HoloLens with Wi-Fi](#Connecting to the HoloLens with Wi-Fi). When using a HoloLens 2, support for remoting articulated hand and eye tracking data has been added to MRTK. To enable these features, please select **Mixed Reality Toolkit** > **MSBuild** > **Use MSBuild for Unity dependency resolution**. This will install the required dependencies for Holographic Remoting. @@ -18,7 +29,7 @@ Some versions of Unity 2019 have encountered issues when using MSBuild for Unity 1. If it does not automatically display, run the MRTK Configurator Utility (**Mixed Reality Toolkit > Utilities > Configure Unity Project**) 1. Click **Apply** 1. Open **Window > Package Manager** - - Ensure that the **Windows XR Plugin** is not installed if the project isn't using [XR SDK](../GettingStartedWithMRTKAndXRSDK.md), as the legacy **Windows Mixed Reality** package will not function alongside it + - Ensure that the **Windows XR Plugin** is not installed 1. Open **Edit > Project Settings > Player** ![Windows Mixed Reality SDK](../Images/Tools/Remoting/WindowsMixedRealitySDK.png) @@ -111,13 +122,9 @@ You can also temporarily remove the adapter to workaround your issue via the fol 1. (Optional) Navigate to MRTK / Providers / WindowsMixedReality / Shared / DotNetAdapter in your file explorer (not Unity's Assets view) and delete the `.bin` and `.obj` folders. This removes the local cache of NuGet restored packages for DotNetWinRT. 1. If you run the MRTK Configurator again, make sure you don't re-enable MSBuild for Unity. -### XR SDK setup instructions +## XR SDK setup instructions -1. Open **Window > Package Manager** - - Verify that latest version of the **Windows Mixed Reality** package is installed. -1. Go to the Standalone settings and ensure Windows Mixed Reality is checked under Plug-in Providers. Also ensure that Initialize XR on Startup is checked. -1. (**_Optional_**) Click on the Windows Mixed Reality tab under XR Plug-in Management and create a custom settings profile to change the defaults. If the list of settings are already there, no profile needs to be created. -1. Select **Mixed Reality Toolkit** > **Utilities** > **Windows Mixed Reality** > **Check Configuration** to make sure the correct scripting define is set. +Follow the [Windows Mixed Reality setup instructions on the Getting started with MRTK and XR SDK page](../GettingStartedWithMRTKAndXRSDK.md#windows-mixed-reality) and make sure to perform the step required for in-editor HoloLens Remoting. ## Connecting to the HoloLens with Wi-Fi From f7e44b22951099df273af56956385fca9f00fc15 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 15:38:30 -0700 Subject: [PATCH 2/8] Link update --- Documentation/ReleaseNotes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/ReleaseNotes.md b/Documentation/ReleaseNotes.md index 539e29976a0..bca3b95a5fa 100644 --- a/Documentation/ReleaseNotes.md +++ b/Documentation/ReleaseNotes.md @@ -121,7 +121,7 @@ In some cases there was a tradeoff that had to be made: - See [Leap Motion Hand Tracking Configuration](CrossPlatform/LeapMotionMRTK.md) for the extra integration step. - For those who are using ARFoundation, there's now an additional manual step in its getting started steps. See [ARFoundation](CrossPlatform/UsingARFoundation.md#install-required-packages) for the new steps. -- For those who will be using [Holographic Remoting](Tools/HolographicRemoting.md#hololens-2-legacy-xr-setup-instructions) on HoloLens 2, there is now a manual step to perform. +- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy XR setup instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#`DOTNETWINRT_PRESENT` #define written into player settings) to perform. ### Bounds control graduated ![Bounds control](../Documentation/Images/BoundsControl/MRTK_BoundsControl_Main.png) From f23323f46efe23a6c8c05ee2e3beaa29468ac5c7 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 15:48:50 -0700 Subject: [PATCH 3/8] Update ReleaseNotes.md --- Documentation/ReleaseNotes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/ReleaseNotes.md b/Documentation/ReleaseNotes.md index bca3b95a5fa..f1ea6baf0b0 100644 --- a/Documentation/ReleaseNotes.md +++ b/Documentation/ReleaseNotes.md @@ -121,7 +121,7 @@ In some cases there was a tradeoff that had to be made: - See [Leap Motion Hand Tracking Configuration](CrossPlatform/LeapMotionMRTK.md) for the extra integration step. - For those who are using ARFoundation, there's now an additional manual step in its getting started steps. See [ARFoundation](CrossPlatform/UsingARFoundation.md#install-required-packages) for the new steps. -- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy XR setup instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#`DOTNETWINRT_PRESENT` #define written into player settings) to perform. +- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy-XR-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#`DOTNETWINRT_PRESENT`-#define-written-into-player-settings) to perform. ### Bounds control graduated ![Bounds control](../Documentation/Images/BoundsControl/MRTK_BoundsControl_Main.png) From e21543e7553f41b125c03e5864291d7082a32f15 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 15:57:47 -0700 Subject: [PATCH 4/8] More link fixes --- Documentation/ReleaseNotes.md | 2 +- Documentation/Tools/HolographicRemoting.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/ReleaseNotes.md b/Documentation/ReleaseNotes.md index f1ea6baf0b0..f4b5d5377e6 100644 --- a/Documentation/ReleaseNotes.md +++ b/Documentation/ReleaseNotes.md @@ -121,7 +121,7 @@ In some cases there was a tradeoff that had to be made: - See [Leap Motion Hand Tracking Configuration](CrossPlatform/LeapMotionMRTK.md) for the extra integration step. - For those who are using ARFoundation, there's now an additional manual step in its getting started steps. See [ARFoundation](CrossPlatform/UsingARFoundation.md#install-required-packages) for the new steps. -- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy-XR-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#`DOTNETWINRT_PRESENT`-#define-written-into-player-settings) to perform. +- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy-XR-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#DOTNETWINRT_PRESENT-#define-written-into-player-settings) to perform. ### Bounds control graduated ![Bounds control](../Documentation/Images/BoundsControl/MRTK_BoundsControl_Main.png) diff --git a/Documentation/Tools/HolographicRemoting.md b/Documentation/Tools/HolographicRemoting.md index 4228c3265b4..1ffbfa454e4 100644 --- a/Documentation/Tools/HolographicRemoting.md +++ b/Documentation/Tools/HolographicRemoting.md @@ -13,11 +13,11 @@ To enable remoting to a HoloLens, it is important to ensure that the project is - If using XR SDK: Verify that latest version of the **Windows XR Plugin** package is installed. 1. Ensure the latest Holographic Remoting application is installed, on the HoloLens, via the Microsoft Store. -Please continue to [Legacy XR setup instructions](#Legacy XR setup instructions) or [XR SDK setup instructions](#XR SDK setup instructions) depending on which pipeline is used in the project. +Please continue to [Legacy XR setup instructions](#Legacy-XR-setup-instructions) or [XR SDK setup instructions](#XR-SDK-setup-instructions) depending on which pipeline is used in the project. ## Legacy XR setup instructions -The instructions below only apply to remoting with HoloLens 2. If you only perform remoting with HoloLens (1st Gen), skip to [Connecting to the HoloLens with Wi-Fi](#Connecting to the HoloLens with Wi-Fi). +The instructions below only apply to remoting with HoloLens 2. If you only perform remoting with HoloLens (1st Gen), skip to [Connecting to the HoloLens with Wi-Fi](#Connecting-to-the-HoloLens-with-Wi-Fi). When using a HoloLens 2, support for remoting articulated hand and eye tracking data has been added to MRTK. To enable these features, please select **Mixed Reality Toolkit** > **MSBuild** > **Use MSBuild for Unity dependency resolution**. This will install the required dependencies for Holographic Remoting. @@ -65,7 +65,7 @@ The best way to check is to search the Assets folder for DotNetWinRT.dll. If thi If the previous step didn't succeed, it's good to double check that the appropriate csproj exists in your project. Check under **MRTK** / **Providers** / **WindowsMixedReality** / **Shared** / **DotNetAdapter** and confirm that DotNetAdapter.csproj exists. One common case where this file might not exist is if your .gitignore ignores csproj files and you've committed the MRTK files to a remote repo. In this case, please make sure you force add DotNetAdapter.csproj with `git add -f [path/to]/DotNetAdapter.csproj` to make sure it gets committed and cloned for all other collaborators or computers. -#### `DOTNETWINRT_PRESENT` #define written into player settings +#### DOTNETWINRT_PRESENT #define written into player settings Beginning with MRTK version 2.5.0, for performance reasons, this define is no longer automatically set. To enable this flag, please use the **Mixed Reality Toolkit** > **Utilities** > **Windows Mixed Reality** > **Check Configuration** menu item. From fea5e5382778784bb488bd5c78b930e2d4cf0598 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 16:01:54 -0700 Subject: [PATCH 5/8] Link fix --- Documentation/ReleaseNotes.md | 2 +- Documentation/Tools/HolographicRemoting.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/ReleaseNotes.md b/Documentation/ReleaseNotes.md index f4b5d5377e6..284e42c1d0d 100644 --- a/Documentation/ReleaseNotes.md +++ b/Documentation/ReleaseNotes.md @@ -121,7 +121,7 @@ In some cases there was a tradeoff that had to be made: - See [Leap Motion Hand Tracking Configuration](CrossPlatform/LeapMotionMRTK.md) for the extra integration step. - For those who are using ARFoundation, there's now an additional manual step in its getting started steps. See [ARFoundation](CrossPlatform/UsingARFoundation.md#install-required-packages) for the new steps. -- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy-XR-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#DOTNETWINRT_PRESENT-#define-written-into-player-settings) to perform. +- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy-XR-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#DOTNETWINRT_PRESENT-define-written-into-player-settings) to perform. ### Bounds control graduated ![Bounds control](../Documentation/Images/BoundsControl/MRTK_BoundsControl_Main.png) diff --git a/Documentation/Tools/HolographicRemoting.md b/Documentation/Tools/HolographicRemoting.md index 1ffbfa454e4..7315e268732 100644 --- a/Documentation/Tools/HolographicRemoting.md +++ b/Documentation/Tools/HolographicRemoting.md @@ -65,9 +65,9 @@ The best way to check is to search the Assets folder for DotNetWinRT.dll. If thi If the previous step didn't succeed, it's good to double check that the appropriate csproj exists in your project. Check under **MRTK** / **Providers** / **WindowsMixedReality** / **Shared** / **DotNetAdapter** and confirm that DotNetAdapter.csproj exists. One common case where this file might not exist is if your .gitignore ignores csproj files and you've committed the MRTK files to a remote repo. In this case, please make sure you force add DotNetAdapter.csproj with `git add -f [path/to]/DotNetAdapter.csproj` to make sure it gets committed and cloned for all other collaborators or computers. -#### DOTNETWINRT_PRESENT #define written into player settings +#### DOTNETWINRT_PRESENT define written into player settings -Beginning with MRTK version 2.5.0, for performance reasons, this define is no longer automatically set. To enable this flag, please use the **Mixed Reality Toolkit** > **Utilities** > **Windows Mixed Reality** > **Check Configuration** menu item. +Beginning with MRTK version 2.5.0, for performance reasons, this #define is no longer automatically set. To enable this flag, please use the **Mixed Reality Toolkit** > **Utilities** > **Windows Mixed Reality** > **Check Configuration** menu item. > [!Note] > The Check Configuration item does not display a confirmation. To confirm that the define has been set, please navigate to the Unity Player Settings. From there, under the UWP tab, check under Other Settings for the Scripting Define Symbols. Make sure DOTNETWINRT_PRESENT is properly written in that list. If that's there, this step succeeded. From 5f695fc561d04df63b65b1a5b6e7cb7b5ebd9419 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 16:27:36 -0700 Subject: [PATCH 6/8] Update ReleaseNotes.md --- Documentation/ReleaseNotes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/ReleaseNotes.md b/Documentation/ReleaseNotes.md index 284e42c1d0d..103d121e7c7 100644 --- a/Documentation/ReleaseNotes.md +++ b/Documentation/ReleaseNotes.md @@ -121,7 +121,7 @@ In some cases there was a tradeoff that had to be made: - See [Leap Motion Hand Tracking Configuration](CrossPlatform/LeapMotionMRTK.md) for the extra integration step. - For those who are using ARFoundation, there's now an additional manual step in its getting started steps. See [ARFoundation](CrossPlatform/UsingARFoundation.md#install-required-packages) for the new steps. -- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#Legacy-XR-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#DOTNETWINRT_PRESENT-define-written-into-player-settings) to perform. +- For those who will be using [Holographic Remoting with legacy XR pipeline](Tools/HolographicRemoting.md#legacy-xr-setup-instructions) on HoloLens 2, there is now a [manual step](Tools/HolographicRemoting.md#dotnetwinrt_present-define-written-into-player-settings) to perform. ### Bounds control graduated ![Bounds control](../Documentation/Images/BoundsControl/MRTK_BoundsControl_Main.png) From bf849ab70042b96a2a5d0fb3a3b55041d9706e72 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 16:28:02 -0700 Subject: [PATCH 7/8] Update HolographicRemoting.md --- Documentation/Tools/HolographicRemoting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Tools/HolographicRemoting.md b/Documentation/Tools/HolographicRemoting.md index 7315e268732..f983bd0b915 100644 --- a/Documentation/Tools/HolographicRemoting.md +++ b/Documentation/Tools/HolographicRemoting.md @@ -13,11 +13,11 @@ To enable remoting to a HoloLens, it is important to ensure that the project is - If using XR SDK: Verify that latest version of the **Windows XR Plugin** package is installed. 1. Ensure the latest Holographic Remoting application is installed, on the HoloLens, via the Microsoft Store. -Please continue to [Legacy XR setup instructions](#Legacy-XR-setup-instructions) or [XR SDK setup instructions](#XR-SDK-setup-instructions) depending on which pipeline is used in the project. +Please continue to [Legacy XR setup instructions](#legacy-xr-setup-instructions) or [XR SDK setup instructions](#xr-sdk-setup-instructions) depending on which pipeline is used in the project. ## Legacy XR setup instructions -The instructions below only apply to remoting with HoloLens 2. If you only perform remoting with HoloLens (1st Gen), skip to [Connecting to the HoloLens with Wi-Fi](#Connecting-to-the-HoloLens-with-Wi-Fi). +The instructions below only apply to remoting with HoloLens 2. If you only perform remoting with HoloLens (1st Gen), skip to [Connecting to the HoloLens with Wi-Fi](#connecting-to-the-holoLens-with-wi-fi). When using a HoloLens 2, support for remoting articulated hand and eye tracking data has been added to MRTK. To enable these features, please select **Mixed Reality Toolkit** > **MSBuild** > **Use MSBuild for Unity dependency resolution**. This will install the required dependencies for Holographic Remoting. From cf527a5bcdd63deba242a3673dddc67b116e91a5 Mon Sep 17 00:00:00 2001 From: MaxWang-MS <68253937+MaxWang-MS@users.noreply.github.com> Date: Wed, 30 Sep 2020 16:41:41 -0700 Subject: [PATCH 8/8] Update HolographicRemoting.md --- Documentation/Tools/HolographicRemoting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Tools/HolographicRemoting.md b/Documentation/Tools/HolographicRemoting.md index f983bd0b915..4578f04ccb4 100644 --- a/Documentation/Tools/HolographicRemoting.md +++ b/Documentation/Tools/HolographicRemoting.md @@ -17,7 +17,7 @@ Please continue to [Legacy XR setup instructions](#legacy-xr-setup-instructions) ## Legacy XR setup instructions -The instructions below only apply to remoting with HoloLens 2. If you only perform remoting with HoloLens (1st Gen), skip to [Connecting to the HoloLens with Wi-Fi](#connecting-to-the-holoLens-with-wi-fi). +The instructions below only apply to remoting with HoloLens 2. If you only perform remoting with HoloLens (1st Gen), skip to [Connecting to the HoloLens with Wi-Fi](#connecting-to-the-hololens-with-wi-fi). When using a HoloLens 2, support for remoting articulated hand and eye tracking data has been added to MRTK. To enable these features, please select **Mixed Reality Toolkit** > **MSBuild** > **Use MSBuild for Unity dependency resolution**. This will install the required dependencies for Holographic Remoting.