Add a multistep configurator to facilitate project setup after importing MRTK #9652

MaxWang-MS · 2021-04-13T01:05:30Z

Overview

This PR adds a multistep configurator to help guide users through the project setup phase after importing MRTK. The configurator is based on the original one-page window and now covers more settings. The configurator aims to provide a more streamlined experience for novices and pros alike.

Features

Guide users through choosing the proper XR pipeline
Show users only relevant information on the project setting page (i.e. no legacy XR related settings when XRSDK is used)
Prompt users to import TMP
Show users how to import the samples when MRTK is imported via UPM
Show links to docs and API refs in the configurator and the MRTK menu
Add some Windows XR Plugin and Microsoft OpenXR plugin specific settings to the project setting (non-blocking for this PR, may be separated into a subsequent PR after this one is merged)

Screenshots

Please note the "TO DO" shown in some of the following screenshots are not by mistake - the documentation page has yet to be created and thus TO DO is used as a placeholder.

Changes

Fixes: Hard to figure out how to import samples when using MRFT/UPM #9577, fixes: MRTK Configurator needs to be improved #9578

MaxWang-MS · 2021-04-13T01:07:22Z

/azp run

azure-pipelines · 2021-04-13T01:07:41Z

Azure Pipelines successfully started running 3 pipeline(s).

MaxWang-MS · 2021-04-13T01:35:36Z

/azp run

azure-pipelines · 2021-04-13T01:35:55Z

Azure Pipelines successfully started running 3 pipeline(s).

SimonDarksideJ · 2021-04-15T16:01:41Z

Nice addition as a walk-through guide for new users.

Might also suggest a last step for additional reading and pointers to getting started guides (with pretty pictures :D )
What to do next.

RogPodge

I think the code design side of things looks good, will pull down and make pass of running through the tool itself and add more comments in the future.

Assets/MRTK/Core/Inspectors/Setup/MixedRealityEditorSettings.cs

Assets/MRTK/Core/Utilities/Editor/XRSettingsUtilities.cs

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

RogPodge · 2021-04-17T00:24:55Z

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

-            { MRConfig.SpatialPerceptionCapability, true },
+        public static MixedRealityProjectConfiguratorWindow Instance { get; private set; }
+
+        public static bool IsOpen => Instance != null;


Can Instance ever be set to null? Double checking where how this variable is used even though this was the way we did it before.

Ping on this @MaxWang-MS

Instance cannot be set to null but by default it is null before initialization. We have static functions to show the window and we use this to see if there has been an instance of the window that we can reuse.

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

Co-Authored-By: RogPodge <[email protected]>

keveleigh · 2021-04-19T16:25:07Z

/azp run

azure-pipelines · 2021-04-19T16:25:30Z

Azure Pipelines successfully started running 3 pipeline(s).

RogPodge · 2021-04-19T22:12:03Z

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

+                }
+                if (GUILayout.Button("Learn more"))
+                {
+                    Application.OpenURL(XRPipelineDocsUrl);


Clicking on this button didn't open a URL for me in any of my browsers.

That is expected as the page has yet to be created... That will be a separate PR in a separate repo.

Is there a way we can alter the button behavior to make it clearer to users that the page is not yet available?

Just updated the string to point it to a page on our MR docs site describing different Unity versions and choices of plugins. I will update the link to the new MRTK docs page once it gets published.

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

RogPodge · 2021-04-19T22:22:25Z

Tested out in editor and noticed a few readability/wording fixes. Looks good and effective otherwise!

Co-Authored-By: RogPodge <[email protected]> Co-Authored-By: Kurtis <[email protected]>

None of the remaining requested changes are blocking

Assets/MRTK/Core/Inspectors/MixedRealityToolkitHelpLinks.cs

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

Assets/MRTK/Core/Inspectors/Setup/MixedRealityEditorSettings.cs

Assets/MRTK/Core/Utilities/Editor/ConfigurationStage.cs

Co-Authored-By: RogPodge <[email protected]> Co-Authored-By: Kurtis <[email protected]>

MaxWang-MS · 2021-04-21T03:03:13Z

/azp run

azure-pipelines · 2021-04-21T03:03:32Z

Azure Pipelines successfully started running 3 pipeline(s).

MaxWang-MS · 2021-04-21T19:31:51Z

/azp run

azure-pipelines · 2021-04-21T19:32:13Z

Azure Pipelines successfully started running 3 pipeline(s).

Assets/MRTK/Core/Inspectors/MixedRealityToolkitHelpLinks.cs

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

Assets/MRTK/Core/Utilities/Editor/XRSettingsUtilities.cs

keveleigh · 2021-04-22T17:25:22Z

Assets/MRTK/Core/Utilities/Editor/XRSettingsUtilities.cs

+            {
+                BuildTargetGroup currentBuildTarget = BuildPipeline.GetBuildTargetGroup(EditorUserBuildSettings.activeBuildTarget);
+                XRGeneralSettings settingsOfCurrentTarget = XRGeneralSettingsPerBuildTarget.XRGeneralSettingsForBuildTarget(currentBuildTarget);
+#pragma warning disable CS0618 // Suppressing the warning to support xr management plugin 3.x and 4.x


Is there a different way we should be getting the loaders wherever the warning is happening?

This is intended as I do not want to add more version defines... Again this is needed to support 3.x and 4.x XR Plugin Management package.

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

Co-authored-by: Kurtis <[email protected]>

MaxWang-MS · 2021-04-22T19:44:41Z

/azp run

azure-pipelines · 2021-04-22T19:45:03Z

Azure Pipelines successfully started running 3 pipeline(s).

MaxWang-MS · 2021-04-22T20:20:27Z

/azp run

azure-pipelines · 2021-04-22T20:20:46Z

Azure Pipelines successfully started running 3 pipeline(s).

keveleigh

Haven't yet pulled it down to try the flow myself, but the code seems good and the demos I've seen are awesome!

keveleigh · 2021-04-23T21:53:20Z

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

-            { MRConfig.SpatialPerceptionCapability, true },
+        public static MixedRealityProjectConfiguratorWindow Instance { get; private set; }
+
+        public static bool IsOpen => Instance != null;


Ping on this @MaxWang-MS

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

MaxWang-MS added 5 commits April 6, 2021 19:22

Add a new configurator to facilitate setup

8427ef0

Check active XRSDK providers

a0a5e15

Various improvements to the configurator

bd142c7

Configurator flow improvement

9d1037d

Configurator fixes

8ba4bc9

MaxWang-MS added the Build / Tools Issues related to build and tools. label Apr 13, 2021

MaxWang-MS added this to the MRTK 2.7.0 milestone Apr 13, 2021

MaxWang-MS requested review from keveleigh, david-c-kline, RogPodge and CDiaz-MS April 13, 2021 01:05

MaxWang-MS requested a review from MenelvagorMilsom as a code owner April 13, 2021 01:05

CI fixes

f088209

Update MixedRealityProjectConfiguratorWindow.cs

9086324

MaxWang-MS mentioned this pull request Apr 15, 2021

'Virtual reality supported not enabled' warning is generated with no XR pipeline package in a project #9547

Closed

This was linked to issues Apr 15, 2021

'Virtual reality supported not enabled' warning is generated with no XR pipeline package in a project #9547

Closed

Update Project Configurator for Unity 2019/2020 #7513

Closed

MaxWang-MS mentioned this pull request Apr 15, 2021

Update Project Configurator for Unity 2019/2020 #7513

Closed

RogPodge self-assigned this Apr 16, 2021

RogPodge previously requested changes Apr 17, 2021

View reviewed changes

MaxWang-MS and others added 2 commits April 16, 2021 20:26

Address feedback

1df8679

Co-Authored-By: RogPodge <[email protected]>

Merge branch 'main' into add_configurator

701fec5

RogPodge reviewed Apr 19, 2021

View reviewed changes

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs Outdated Show resolved Hide resolved

RogPodge reviewed Apr 19, 2021

View reviewed changes

Assets/MRTK/Core/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs Outdated Show resolved Hide resolved

Update MixedRealityProjectConfiguratorWindow.cs

402fc71

Co-Authored-By: RogPodge <[email protected]> Co-Authored-By: Kurtis <[email protected]>

keveleigh reviewed Apr 20, 2021

View reviewed changes

Assets/MRTK/Core/Inspectors/MixedRealityToolkitHelpLinks.cs Outdated Show resolved Hide resolved

Assets/MRTK/Core/Inspectors/MRTK.Inspectors.asmdef Outdated Show resolved Hide resolved

Assets/MRTK/Core/Inspectors/Setup/MixedRealityEditorSettings.cs Outdated Show resolved Hide resolved

keveleigh reviewed Apr 20, 2021

View reviewed changes

Assets/MRTK/Core/Utilities/Editor/ConfigurationStage.cs Outdated Show resolved Hide resolved

Various configurator improvements

175a292

Co-Authored-By: RogPodge <[email protected]> Co-Authored-By: Kurtis <[email protected]>

MaxWang-MS requested review from keveleigh and RogPodge April 21, 2021 03:02

Fix a Unity 2018 GUI issue

47b1401

keveleigh reviewed Apr 22, 2021

View reviewed changes

MaxWang-MS and others added 2 commits April 22, 2021 12:00

Update Assets/MRTK/Core/Utilities/Editor/XRSettingsUtilities.cs

267a249

Co-authored-by: Kurtis <[email protected]>

Address feedback

db03e84

MaxWang-MS added 2 commits April 22, 2021 13:09

Merge branch 'main' into add_configurator

0794cd4

Update MixedRealityProjectConfiguratorWindow.cs

d9e78ac

MaxWang-MS requested a review from keveleigh April 22, 2021 21:22

keveleigh approved these changes Apr 23, 2021

View reviewed changes

MaxWang-MS merged commit 70689b9 into microsoft:main Apr 23, 2021

MaxWang-MS deleted the add_configurator branch September 6, 2022 23:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a multistep configurator to facilitate project setup after importing MRTK #9652

Add a multistep configurator to facilitate project setup after importing MRTK #9652

MaxWang-MS commented Apr 13, 2021

MaxWang-MS commented Apr 13, 2021

azure-pipelines bot commented Apr 13, 2021

MaxWang-MS commented Apr 13, 2021

azure-pipelines bot commented Apr 13, 2021

SimonDarksideJ commented Apr 15, 2021

RogPodge left a comment

RogPodge Apr 17, 2021

keveleigh Apr 23, 2021

MaxWang-MS Apr 23, 2021

keveleigh commented Apr 19, 2021

azure-pipelines bot commented Apr 19, 2021

RogPodge Apr 19, 2021

MaxWang-MS Apr 20, 2021

RogPodge Apr 20, 2021

MaxWang-MS Apr 21, 2021

RogPodge commented Apr 19, 2021

MaxWang-MS commented Apr 21, 2021

azure-pipelines bot commented Apr 21, 2021

MaxWang-MS commented Apr 21, 2021

azure-pipelines bot commented Apr 21, 2021

keveleigh Apr 22, 2021

MaxWang-MS Apr 22, 2021

MaxWang-MS commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

MaxWang-MS commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

keveleigh left a comment

keveleigh Apr 23, 2021

Add a multistep configurator to facilitate project setup after importing MRTK #9652

Add a multistep configurator to facilitate project setup after importing MRTK #9652

Conversation

MaxWang-MS commented Apr 13, 2021

Overview

Features

Screenshots

Changes

MaxWang-MS commented Apr 13, 2021

azure-pipelines bot commented Apr 13, 2021

MaxWang-MS commented Apr 13, 2021

azure-pipelines bot commented Apr 13, 2021

SimonDarksideJ commented Apr 15, 2021

RogPodge left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keveleigh commented Apr 19, 2021

azure-pipelines bot commented Apr 19, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RogPodge commented Apr 19, 2021

MaxWang-MS commented Apr 21, 2021

azure-pipelines bot commented Apr 21, 2021

MaxWang-MS commented Apr 21, 2021

azure-pipelines bot commented Apr 21, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaxWang-MS commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

MaxWang-MS commented Apr 22, 2021

azure-pipelines bot commented Apr 22, 2021

keveleigh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment