Prethodna

Dalje

Exercise - Import and configure resources

Completed

Import the MRTK Unity foundation package

To import the Mixed Reality Toolkit into your project we'll use the Mixed Reality Feature Tool, which allows developers to discover, update, and import feature packages. You can search packages by name or category, see their dependencies, and view proposed changes to your project's manifest file before importing.

1. Download the latest version of the Mixed Reality Feature Tool from the Microsoft Download Center.

2. After the download finishes, unzip the file and save it to your desktop.

   Note

   Before you can run the Mixed Reality Feature Tool, you must install the .NET 5.0 runtime. Though this version is no longer supported, it is the correct version for this exercise.

3. In the unzipped folder, navigate to the executable file MixedRealityFeatureTool.exe and then use it to launch the Mixed Reality Feature Tool.

   

Unity 2020 + Openxr

1. In the Mixed Reality Feature Tool, select Start.

   

2. Select the Browse button (it's the "three-dot" button in the image below), then navigate to your project, and then open it.

   

   Note

   The Project Path box in the Tool must contain some value, so it inserts a backslash ("_") by default.

   After you select a folder, the Tool checks to ensure that it's a valid Unity project folder.

   

3. Select Discover Features.

   Note: You may need to wait a few seconds while the Tool refreshes the packages from the feeds.

4. On the Discover Features page, note that there is a list of six package groups.

   

5. Click the "+" button to the left of Mixed Reality Toolkit (0 of 10) and then select the latest version of Mixed Reality Toolkit Foundation.

   Note

   The Mixed Reality Toolkit Foundation package is the only package that must be imported and configured in order to use MRTK with your project. This package includes the core components required to create a mixed reality application.

6. Click the "+" button to the left of Platform Support (0 of 5) and then select the latest version of Mixed Reality OpenXR Plugin.

   

7. After you've made your selection(s), click Get Features.

8. Select Validate to validate the packages you selected. You should see a dialog that says No validation issues were detected. When you do, click OK.

9. On the Import Features page, the left-side column, Features, displays the packages you just selected. The right-side column, Required dependencies, displays any dependencies. You can click the Details link for any of these items to learn more about them.

10. When you're ready to move on, select Import. On the Review and Approve page, you can review information about the packages.

11. Select Approve.

12. Return to the Unity Editor and click a blank area in the UI. You'll see a progress bar showing you that your packages are being imported.

Configure the Unity project

1. After Unity has imported the packages, a warning appears asking if you want to enable the backends by restarting the editor. Select Yes.

   

2. The MRTK Project Configurator should appear. If it doesn't, open it manually: on the menu bar, select Mixed Reality > Toolkit > Utilities > Configure Project for MRTK:

   

3. Select Unity OpenXR Plugin to enable XR Plugin Management and add the Unity OpenXR Plugin to your project.

   

4. On the Welcome to MRTK! screen, select Show XR Plug-In Management Settings.

   

5. The Project Settings window opens. Ensure that you're on the XR Plug-in Management page with the Universal Windows Platform settings (Windows logo tab) displayed.

   

6. Ensure that Initialize XR on Startup is selected, and then, under Plugin Providers, click Open XR.

   

7. The OpenXR Plugin loads, and then two items appear underneath OpenXR. Select the first one, Microsoft HoloLens feature group.

8. Note that there's now a yellow warning triangle next to OpenXR. Hover your cursor over the triangle, then read the message in the popup, and then select the triangle.

   

9. In the OpenXR Project Validation window, there are several issues listed. Select the Fix All button.

   

10. One issue remains and tells you that you must add at least one interaction profile. To do so, click Edit. This takes you to the settings for the OpenXR plugin in the Project Settings window.

    

11. Underneath Interaction Profiles, note the plus sign (+) button.

    

12. Click the button three times, each time choosing a different profile:

    Eye Gaze Interaction Profile

    Microsoft Hand Interaction Profile

    Microsoft Motion Controller Profile

    

    If the Eye Gaze Interaction Profile, or any other profile, appears with a yellow triangle next to it, select the triangle, and then in the OpenXR Project Validation window, click the Fix button. When you're finished, close the OpenXR Project Validation window.

    

13. In the Project Settings window under OpenXR Feature Groups, ensure that the following are selected:

    Microsoft HoloLens

    Hand Tracking

    Motion Controller Model

    

14. Click the Depth Submission Mode drop down and then select Depth 16 Bit.

    

    Tip

    Reducing the Depth Format to 16-bit is optional, but it may improve graphics performance in your project. To learn more, see Depth buffer sharing (HoloLens).

    Note

    The Render Mode setting, located just above Depth Submission Mode, is set by default to Single Pass Instanced. In mixed reality apps, the scene is rendered twice: once for each eye. The result is "stereoscopic vision." This doubles the amount of necessary computing, so it's important to select the most efficient rendering path in Unity to save on both CPU and GPU time. Single pass instanced rendering is the best choice here--we recommend that you enable it by default for every project. To learn more about this, see the Unity documentation.

15. Close the Project Settings window.

16. In the MRTK Project Configurator window, select Apply Settings.

    

17. Select Next and then Apply.

18. Unity must restart in order for the configuration to take effect. When prompted, select Apply to restart the Unity editor.

Configure project settings for OpenXR

1. After Unity restarts, in the menu bar, select Edit > Project Settings....

2. In the Project Settings window's left-side column, select Player.

3. Note that in the Player window, the Product Name is "MRTK Tutorial." This is taken from your project name and will be the name displayed in the HoloLens Start menu.

   

   Tip

   To make the app easier to locate during development, add an underscore in front of the name to sort it to the top of any list.

4. Click the Publishing Settings drop down, and then in the Package name field, enter a suitable name--for example, MRTK-Tutorials-Getting-Started:

   

   Note

   The package name is the unique identifier for the app. If you want to avoid overwriting previously installed versions of the app with the same name, you should change this identifier before deploying the app.

5. Close the Project Settings window.

Unity 2019/2020 + windows xr plugin

1. Once MixedRealityFeatureTool is opened, select Settings, and in the Feature tab, enable Show preview releases.

2. Select OK to save the settings.

   

3. Select Start to launch the Mixed Reality Feature Tool.

   

4. In Mixed Reality Feature Tool, next to Project path, select the ellipsis icon and browse to your project folder; for example, D:\MixedRealityLearning\MRTK Tutorials.

   

5. When you have located your project folder, select Open.

   Note

   When browsing for the Unity project folder, by default, the dialog contains a backslash '_' for the file name. You must provide a value in this field in order to select the folder.

   The Mixed Reality Feature Tool performs validation to ensure that it has been directed to a Unity project folder. The folder must contain Assets, Packages, and Project Settings folders.

6. In the Mixed Reality Feature Tool, select Discover Features. Features are grouped by category.

7. Select Mixed Reality Toolkit to find packages relating to the Mixed Reality Toolkit.

   

8. Ensure Mixed Reality Toolkit Foundation is checked, and then in that field, select MRTK 2.7.0.

9. Select Get features to download the selected packages.

   

10. Select Validate to validate the selected package. The system should display No validation issues were detected.

11. Select OK to close the dialog box, and then select Import.

    

12. When prompted, select Approve to add the Mixed Reality Toolkit to your project.

    

Configure the Unity project

1. When the package has been imported, MRTK Project Configurator appears. If it doesn't, you can manually open it from Mixed Reality > Toolkit > Utilities > Configure Project for MRTK.

   

2. Select Built-in Unity Plugin(non-OpenXR) to enable XR Plugin Management in your project.

   

   Important

   The above screenshot is from Unity 2020. If you're using Unity 2019, please select XR SDK/XR Management.

3. When the import is complete, in MRTK project Configurator, select Show Settings.

   

4. In Project Settings, under XR Plug-in Management, ensure that you are in Universal Windows Platform settings, and that both Initialize XR on Startup and Windows Mixed Reality are checked.

   

5. When Unity has imported the Windows Mixed Reality SDK, MRTK Project Configurator should appear again. If it doesn't, use the Unity menu to open it.

6. In MRTK Project Configurator, select Next, and then in Audio spatializer dropdown list, select MS HRTF Spatializer.

7. Select Apply.

   

8. In MRTK Project Configurator, select Next, and then select Done to complete the configuration for XRSDK.

Configure project settings for XR SDK

1. In the Unity menu, select Edit > Project Settings... to open the Project Settings window:

2. In the Project Settings window, select XR Plug-in Management > Windows Mixed Reality > Runtime Settings, and then in the Depth Buffer Format dropdown list, select 16-bit depth:

   

3. In the Project Settings window, select Player > Publishing Settings, and then, in the Package name field, enter a suitable name, for example, MRTKTutorials-GettingStarted.

   

Legacy wsa

1. In the MixedRealityFeatureTool select Settings, under Feature tab, enable Show preview releases, and then select OK to save your settings.

   

2. Select Start to launch the Mixed Reality Feature Tool.

   

3. In Mixed Reality Feature Tool, under Project path, select the ellipsis icon, and browse to your project folder; for example, D:\MixedRealityLearning\MRTK Tutorials.

   

4. Select Open.

   Note

   When browsing for the Unity project folder, by default, the dialog contains a backslash '_' for the file name. You must provide a value in this field in order to select the folder.

   The Mixed Reality Feature Tool performs validation to ensure that it has been directed to a Unity project folder. The folder must contain Assets, Packages, and Project Settings folders.

5. In the Mixed Reality Feature Tool, select Discover Features. Features are grouped by category.

6. Select the Mixed Reality Toolkit to find packages relating to the Mixed Reality Toolkit.

   

7. Ensure Mixed Reality Toolkit Foundation is checked, and in the dropdown list, select MRTK 2.7.0.

8. Select Get features to download the selected packages.

   

9. Select Validate to validate the selected package. The system should return No validation issues were detected.

10. Select OK to close the dialog, and then select Import.

    

11. Select Approve to add the Mixed Reality Toolkit into the project.

    

Configure the Unity project

1. After Unity has finished importing the package, MRTK Project Configurator should appear. If it doesn't, you can manually open it by going to Mixed Reality > Toolkit > Utilities > Configure Project for MRTK:

   

2. Select Legacy XR to enable it and add its required packages to your project.

   

3. Select Next to enable XR pipeline settings.

   

4. In MRTK Project Configurator, ensure all options are checked.

5. In Audio spatializer, select MS HRTF Spatializer, and then select Apply:

   

6. Select Next, and then select Done to complete project configuration.

Configure project settings for XR

1. In the Unity menu, select Edit > Project Settings... to open Project Settings.

2. In Project Settings, select Player > XR Settings, and then in the Depth Format dropdown list, select 16-bit depth.

   

3. In Project Settings, select Player > Publishing Settings, then in the Package name field, enter a suitable name; for example, MRTKTutorials-GettingStarted:

   

Create the scene and configure MRTK

1. In the menu bar, select File > New Scene.

2. In the New Scene window select Basic (Built-in) and then click Create.

3. In the menu bar, select Mixed Reality > Toolkit > Add to Scene and Configure....

   The Mixed Reality Toolkit settings appear in the Inspector.

   

   After MRTK is added to the scene and configured, two new objects are added to the Hierarchy window:

   MixedRealityToolkit

   MixedRealityPlayspace

   The MixedRealityToolkit object contains the Toolkit itself. The MixedRealityPlayspace object ensures that the headset/controllers and other required systems are managed correctly in the scene.

   The Main Camera object becomes a child to the MixedRealityPlayspace object. This allows the play space to manage the camera simultaneously with the SDKs.

   

4. In the Inspector, verify that the profile drop down displays DefaultMixedRealityToolkitConfigurationProfile:

   

   Note

   One of the main ways that you can configure MRTK is by selecting a profile made available through the Foundation package. Profiles configure the behavior of MRTK core components. When MRTK is added to the scene, "DefaultMixedRealityToolkitConfigurationProfile" is preselected. This profile is for general use--it isn't optimized for any particular use case. MRTK provides additional default profiles that cover most platforms and scenarios that MRTK supports. You may want to choose a profile that's optimized for the specific platform you're using. To learn more about configuration profiles, see the MRTK profile configuration guide.

5. In the menu bar, select File > Save As....

6. Navigate to the Assets > Scenes folder, then name your project, and then save your project.

Continue