You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: Documentation/usingupm.md
+15-46
Original file line number
Diff line number
Diff line change
@@ -1,65 +1,34 @@
1
1
# Mixed Reality Toolkit and Unity Package Manager
2
2
3
-
Starting with version 2.5.0, the Microsoft Mixed Reality Toolkit is available using the Unity Package Manager (UPM), on Unity 2019.4 and newer.
3
+
Starting with version 2.5.0, using the [Mixed Reality Feature Tool](https://aka.ms/MRFeatureToolDocs), the Microsoft Mixed Reality Toolkit integrates with the Unity Package Manager (UPM) when using Unity 2019.4 and newer.
4
4
5
-
## Installing Mixed Reality features using the Unity Package Manager
5
+
## Using the Mixed Reality Feature Tool
6
6
7
-
The Unity Package Manager uses a [manifest file](https://docs.unity3d.com/Manual/upm-manifestPkg.html) (manifest.json) to determine which packages to install and the registries (servers) from which they can be installed.
7
+
As described in [Welcome to the Mixed Reality Feature Tool](https://aka.ms/MRFeatureToolDocs) you can download the tool using [this link](https://aka.ms/MRFeatureTool).
8
8
9
-
> [!Note]
10
-
> Initial registration of the server and packages is a per-project, manual procedure, please read the following sections for detailed instructions.
9
+
> [!IMPORTANT]
10
+
> If the project's manifest has a `Microsoft Mixed Reality` entry in the `scopedRegistries` section, it is recommended that it be removed.
11
11
>
12
-
> This process is required due to UPM's use of legacy npm search functionality (/-/all) that is not supported by Azure DevOps.
13
-
14
-
### Registering the Mixed Reality component server
15
-
16
-
For each project that will be using the Microsoft Mixed Reality Toolkit, the `manifest.json` file (in the Packages folder) will need to have the Mixed Reality scoped registry added. The following illustrate how to properly modify `manifest.json` to support Mixed Reality.
17
-
18
-
1. Open `<projectRoot>/Packages/manifest.json` in a text editor, such as [Visual Studio Code](https://code.visualstudio.com/).
19
-
1. At the top of the manifest file, add the Mixed Reality server to the scoped registry section and save the file.
The [Unity Package Manager](Packaging/MRTK_Packages.md#unity-package-manager) section of the [Mixed Reality Toolkit package](Packaging/MRTK_Packages.md) article describes the available MRTK packages, their contents and the scenarios for their use.
16
+
MRTK packages appear under the `Mixed Reality Toolkit` heading when discovering features.
40
17
41
-
To add an MRTK package, modify the dependencies section of the `Packages/manifest.json` file. The following example illustrates adding the foundation, tools and examples packages, the standard assets package will be added automatically as a dependency of the foundation.
When selecting features, there is no need to be concerned with required dependencies, the tool will automatically download and integrate them into the project.
49
21
50
-
> [!IMPORTANT]
51
-
> There is a known compiler issue that impacts applications built for Microsoft HoloLens 2 using
52
-
> ARM64. This issue is fixed by updating Visual Studio 2019 to version 16.8 or later. If you are unable to update Visual Studio,
53
-
> please import the `com.microsoft.mixedreality.toolkit.tools` package to apply a workaround.
## Managing Mixed Reality features with the Unity Package Manager
56
25
57
26
Once a Mixed Reality Toolkit package has been added to the package manifest, it can be managed using the Unity Package Manager user interface.
58
27
59
28

60
29
61
-
> [!Note]
62
-
> If a Mixed Reality Toolkit package is removed using the Unity Package Manager, it will have to be re-added using the [previously described steps](#adding-mrtk-packages).
30
+
> [!NOTE]
31
+
> If a Mixed Reality Toolkit package is removed using the Unity Package Manager, it will have to be re-added using the [previously described steps](#using-the-mixed-reality-feature-tool).
63
32
64
33
### Using Mixed Reality Toolkit examples
65
34
@@ -76,7 +45,7 @@ To utilize one or more of the examples, please use the following steps:
76
45
77
46
When an example package is updated, Unity provides the option to update imported samples.
78
47
79
-
> [!Note]
48
+
> [!NOTE]
80
49
> Updating an imported sample will overwrite any changes that have been made to that sample and the associated assets.
0 commit comments