Skip to content

Commit a126986

Browse files
committed
Rework MRFT references
1 parent 0949548 commit a126986

File tree

7 files changed

+85
-22
lines changed

7 files changed

+85
-22
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
%YAML 1.1
2+
%TAG !u! tag:unity3d.com,2011:
3+
--- !u!655991488 &1
4+
MultiplayerManager:
5+
m_ObjectHideFlags: 0
6+
m_EnableMultiplayerRoles: 0
7+
m_StrippingTypes: {}

docs/mrtk3-overview/getting-started/exploring-features/mrtk3-sample-scenes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav_order: 5
66

77
# Exploring MRTK3 sample scenes
88

9-
Unlike MRTK2, MRTK3 isn't distributed as a Unity project. Instead, MRTK3 consists of a loosely coupled collection of individual UPM packages distributed through the [Mixed Reality Feature Tool](https://learn.microsoft.com/windows/mixed-reality/develop/unity/welcome-to-mr-feature-tool), as well as through our official GitHub repository.
9+
Unlike MRTK2, MRTK3 isn't distributed as a Unity project. Instead, MRTK3 consists of a loosely coupled collection of individual UPM packages distributed through our official GitHub repository.
1010

1111
As a result, we no longer ship our sample scenes inside the MRTK library/package itself. Instead, we maintain the `UnityProjects` folder at the top level of the [GitHub repository](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity), which contains any Unity projects we want to ship. Currently, this folder includes the `MRTKDevTemplate` project, which contains all of our example scenes and is configured to align with our recommended best settings.
1212

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Mixed Reality Feature Tool (Deprecated)
3+
parent: Setting up the development environment
4+
---
5+
6+
# Mixed Reality Feature Tool (Deprecated)
7+
8+
| Software | Version | Notes |
9+
| --- | --- | --- |
10+
| [Mixed Reality Feature Tool for Unity](https://aka.ms/mrfeaturetool) | | Used to acquire MR packages |
11+
12+
> [!WARNING]
13+
> Older versions of MRTK3 can be found on the Mixed Reality Feature Tool for Unity. The feed that backs the tool and the publishing infrastructure around it have been decommissioned, and new versions will not be published here.
14+
15+
## Import required dependencies and MRTK3 packages with Mixed Reality Feature Tool
16+
17+
There are a handful of packages that MRTK3 uses that aren't part of this toolkit. To obtain these packages, use the [Mixed Reality Feature Tool](https://learn.microsoft.com/windows/mixed-reality/develop/unity/welcome-to-mr-feature-tool) and select the latest versions of the following in the **Discover Features** step.
18+
19+
To run on **HoloLens 2** or to visualize controller models on a **Quest device**, an additional package is required:
20+
21+
- **Platform Support → Mixed Reality OpenXR Plugin**
22+
23+
To spatialize audio in your scene, an additional package is required:
24+
25+
- **Spatial Audio → Microsoft Spatializer** (Optional)
26+
27+
For MRTK3 packages, we recommend the following two packages to help you get started quickly:
28+
29+
- **MRTK3 → MRTK Input** (Required for this setup)
30+
- **MRTK3 → MRTK UX Components**
31+
32+
These two packages, along with their dependencies (automatically added by the Feature Tool), will enable you to explore most of our UX offerings and create projects ready to be deployed to various XR devices. You can always come back to the Feature Tool and add more packages to your project later.
33+
34+
Be sure to select the `org.mixedrealitytoolkit.*` packages, and not the deprecated packages. The `com.microsoft.mrtk.*` packages have been deprecated and are no longer supported.
35+
36+
![Selecting the default MRTK3 packages in Microsoft's Mixed Reality Feature Tool](../../images/mrtk3-featuretool-setup-packages.png)
37+
38+
> [!NOTE]
39+
> For more information on MRTK3 packages, see the [package overview page](../../packages/packages-overview.md).
40+
41+
When you're finished selecting packages, click **Get Features**, and then follow the instructions in the Mixed Reality Feature Tool to import the selected packages into your Unity project.

docs/mrtk3-overview/getting-started/setting-up/setup-dev-env.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ Before setting up a Unity Project with MRTK3, make sure you have the following s
1111
| Software | Version | Notes |
1212
| --- | --- | --- |
1313
| Unity | 2022.3 LTS or newer | Recommend using an LTS release <br> See [Additional tools](#additional-tools) below for recommended modules |
14-
| [Mixed Reality Feature Tool for Unity](https://aka.ms/mrfeaturetool) | | Used to acquire MRTK3 packages |
1514

1615
## Additional tools
1716

17+
> [!WARNING]
18+
> Older versions of MRTK3 can be found on the [Mixed Reality Feature Tool for Unity](./mixed-reality-feature-tool.md). The feed that backs the tool and the publishing infrastructure around it have been decommissioned, and new versions will not be published here.
19+
1820
### Android
1921

2022
If your target platform is an [AOSP-based](https://source.android.com/) device, like Android XR or Quest, your Unity installation needs to include the Android Build Support module and its submodules.

docs/mrtk3-overview/getting-started/setting-up/setup-new-project.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,49 @@ You're not expected to consume every MRTK package. See [which features are usefu
1616

1717
Create a new Unity project with Unity 2021.3.21f1 or newer. Close the Unity project before proceeding to the next step.
1818

19-
### Import required dependencies and MRTK3 packages with Mixed Reality Feature Tool
19+
### Import MRTK3 packages
2020

21-
There are a handful of packages that MRTK3 uses that aren't part of this toolkit. To obtain these packages, use the [Mixed Reality Feature Tool](https://learn.microsoft.com/windows/mixed-reality/develop/unity/welcome-to-mr-feature-tool) and select the latest versions of the following in the **Discover Features** step.
21+
For MRTK3 packages, we recommend checking for the [latest release on the GitHub repo](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/releases). The package tarballs can be found under the changelogs, under **Assets**:
2222

23-
To run on **HoloLens 2** or to visualize controller models on a **Quest device**, an additional package is required:
24-
25-
- **Platform Support → Mixed Reality OpenXR Plugin**
26-
27-
To spatialize audio in your scene, an additional package is required:
23+
![GitHub release assets](../../images/github-release.png)
2824

29-
- **Spatial Audio → Microsoft Spatializer** (Optional)
25+
- org.mixedrealitytoolkit.core
26+
- org.mixedrealitytoolkit.uxcore
27+
- org.mixedrealitytoolkit.standardassets
28+
- org.mixedrealitytoolkit.spatialmanipulation
29+
- org.mixedrealitytoolkit.uxcomponents
30+
- org.mixedrealitytoolkit.input
3031

31-
For MRTK3 packages, we recommend the following two packages to help you get started quickly:
32+
We'll also need the latest Mixed Reality Graphics Tools package from [its GitHub repo](https://github.com/microsoft/MixedReality-GraphicsTools-Unity/releases), also under **Assets**.
3233

33-
- **MRTK3 → MRTK Input** (Required for this setup)
34-
- **MRTK3 → MRTK UX Components**
34+
- com.microsoft.mrtk.graphicstools.unity
3535

36-
These two packages, along with their dependencies (automatically added by the Feature Tool), will enable you to explore most of our UX offerings and create projects ready to be deployed to various XR devices. You can always come back to the Feature Tool and add more packages to your project later.
36+
Using UPM's ability to [import local tarball files](https://docs.unity3d.com/6000.0/Documentation/Manual/upm-ui-tarball.html), we'll import the above packages in the following order, to correctly resolve dependencies:
3737

38-
Be sure to select the `org.mixedrealitytoolkit.*` packages, and not the deprecated packages. The `com.microsoft.mrtk.*` packages have been deprecated and are no longer supported.
38+
- com.microsoft.mrtk.graphicstools.unity
39+
- org.mixedrealitytoolkit.core
40+
- org.mixedrealitytoolkit.uxcore
41+
- org.mixedrealitytoolkit.standardassets
42+
- org.mixedrealitytoolkit.spatialmanipulation
43+
- org.mixedrealitytoolkit.uxcomponents
44+
- org.mixedrealitytoolkit.input
3945

40-
![Selecting the default MRTK3 packages in Microsoft's Mixed Reality Feature Tool](../../images/mrtk3-featuretool-setup-packages.png)
46+
These packages, along with their Unity dependencies, will enable you to explore most of our UX offerings and create projects ready to be deployed to various XR devices. You can always come back and add more packages to your project later.
4147

4248
> [!NOTE]
4349
> For more information on MRTK3 packages, see the [package overview page](../../packages/packages-overview.md).
4450
45-
When you're finished selecting packages, click **Get Features**, and then follow the instructions in the Mixed Reality Feature Tool to import the selected packages into your Unity project.
51+
#### Additional dependencies
52+
53+
There are a handful of optional packages that MRTK3 uses that aren't part of this toolkit. To obtain these packages, use the [Mixed Reality Feature Tool](./mixed-reality-feature-tool.md) and select the latest versions of the following in the **Discover Features** step.
54+
55+
To run on **HoloLens 2** or to visualize controller models on a **Quest device**, an additional package is required:
56+
57+
- **Platform Support → Mixed Reality OpenXR Plugin**
58+
59+
To spatialize audio in your scene, an additional package is required:
60+
61+
- **Spatial Audio → Microsoft Spatializer** (Optional)
4662

4763
### Open the Unity project
4864

107 KB
Loading

docs/mrtk3-overview/packages/packages-overview.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,16 @@ nav_order: 4
55

66
# Using MRTK3 packages
77

8-
Microsoft MRTK3 is distributed as a set of packages that are imported into Unity using the Mixed Reality Feature Tool for Unity and the Unity Package Manager (UPM). These packages enable developers to customize the MRTK within their projects.
8+
Microsoft MRTK3 is distributed as a set of packages that are imported into Unity using the Unity Package Manager (UPM). These packages enable developers to customize the MRTK within their projects.
99

1010
## Dependencies
1111

12-
Some MRTK3 packages require additional packages, provided by Microsoft and/or Unity, in order to correctly function. Some of these packages are optional and will enable additional functionality.
12+
Some MRTK3 packages require additional packages, some provided by Unity and some by other platform vendors, in order to correctly function. Some of these packages are optional and will enable additional functionality.
1313

1414
The following diagram illustrates the relationship between MRTK packages and some of the Unity dependencies.
1515

1616
![MRTK3 Package Graph](../images/MRTK3_Packages.png)
1717

18-
> [!NOTE]
19-
> When importing packages using the Mixed Reality Feature Tool, dependency management is automatically performed.
20-
2118
The following table describes the Mixed Reality Toolkit package dependencies.
2219

2320
| Display name | Package name | Description | Required | Optional |

0 commit comments

Comments
 (0)