Merge pull request #9652 from MaxWang-MS/add_configurator

Add a multistep configurator to facilitate project setup after importing MRTK

Author: MaxWang-MS

Assets/MRTK/Core/Inspectors/MRTK.Inspectors.asmdef

@@ -6,7 +6,8 @@
         "Microsoft.MixedReality.Toolkit.Editor.BuildAndDeploy",
         "Microsoft.MixedReality.Toolkit.Editor.ClassExtensions",
         "Microsoft.MixedReality.Toolkit.Editor.Utilities",
-        "Unity.TextMeshPro.Editor"
+        "Unity.TextMeshPro.Editor",
+        "Unity.TextMeshPro"
     ],
     "optionalUnityReferences": [],
     "includePlatforms": [
@@ -17,5 +18,7 @@
     "overrideReferences": false,
     "precompiledReferences": [],
     "autoReferenced": true,
-    "defineConstraints": []
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
 }

Assets/MRTK/Core/Inspectors/MixedRealityToolkitHelpLinks.cs

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using UnityEditor;
+using UnityEngine;
+
+namespace Microsoft.MixedReality.Toolkit.Editor
+{
+    /// <summary>
+    /// Creates menu items to show users how to get help
+    /// </summary>
+    public class MixedRealityToolkitHelpLinks : MonoBehaviour
+    {
+        internal const string MRTKIssuePageUrl = "https://github.com/microsoft/MixedRealityToolkit-Unity/issues";
+        internal const string MRTKDocsUrl = "https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/";
+        internal const string MRTKAPIRefUrl = "https://docs.microsoft.com/dotnet/api/microsoft.mixedreality.toolkit";
+
+        [MenuItem("Mixed Reality/Toolkit/Help/Show Documentation", false)]
+        private static void ShowDocumentation()
+        {
+            Application.OpenURL(MRTKDocsUrl);
+        }
+        [MenuItem("Mixed Reality/Toolkit/Help/Show API Reference", false)]
+        private static void ShowAPIReference()
+        {
+            Application.OpenURL(MRTKAPIRefUrl);
+        }
+        [MenuItem("Mixed Reality/Toolkit/Help/File a bug report", false)]
+        private static void FileBugReport()
+        {
+            Application.OpenURL(MRTKIssuePageUrl);
+        }
+    }
+}

Assets/MRTK/Core/Inspectors/MixedRealityToolkitHelpLinks.cs.meta

@@ -86,10 +86,16 @@ private static void ShowProjectConfigurationDialog()
         {
             if (!EditorApplication.isPlayingOrWillChangePlaymode
                 && !IgnoreProjectConfigForSession
-                && !MixedRealityProjectPreferences.IgnoreSettingsPrompt
-                && !MixedRealityProjectConfigurator.IsProjectConfigured())
+                && !MixedRealityProjectPreferences.IgnoreSettingsPrompt)
             {
-                MixedRealityProjectConfiguratorWindow.ShowWindow();
+                if (!XRSettingsUtilities.XREnabled)
+                {
+                    MixedRealityProjectConfiguratorWindow.ShowWindowOnInit(false);
+                }
+                else if (!MixedRealityProjectConfigurator.IsProjectConfigured())
+                {
+                    MixedRealityProjectConfiguratorWindow.ShowWindowOnInit(true);
+                }
             }
         }
 
@@ -98,11 +104,9 @@ private static void ShowProjectConfigurationDialog()
         /// </summary>
         private static void LogConfigurationWarnings()
         {
-            // Ensure compatibility with the pre-2019.3 XR architecture for customers / platforms
-            // with legacy requirements.
-            if (!XRSettingsUtilities.LegacyXREnabled)
+            if (!XRSettingsUtilities.XREnabled)
             {
-                Debug.LogWarning("<b>Virtual reality supported</b> not enabled. Check <i>XR Settings</i> under <i>Player Settings</i>");
+                Debug.LogWarning("There is no properly configured XR pipeline in the project! Please run the configurator by clicking on Mixed Reality (menu bar) -> Toolkit -> Utilities -> Configure Project for MRTK if the current settings are not desired.");
             }
 
             if (!MixedRealityOptimizeUtils.IsOptimalRenderingPath())