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: docs/mrtk3-overview/getting-started/exploring-features/mrtk3-sample-scenes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ Unlike MRTK2, MRTK3 isn't distributed as a Unity project. Instead, MRTK3 consist
10
10
11
11
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.
12
12
13
-
We also recommend using the `MRTKDevTemplate` project for local development when submitting fixes or changes. All of the packages are specified as local on-disk dependencies, making editing and submitting changes easy. Clone the repo and ensure you're on the `mrtk3` branch, and open the `MRTKDevTemplate` Unity project.
13
+
We also recommend using the `MRTKDevTemplate` project for local development when submitting fixes or changes. All of the packages are specified as local on-disk dependencies, making editing and submitting changes easy. Clone the repo and open the `MRTKDevTemplate` Unity project.
14
14
15
15
Within `MRTKDevTemplate`, you can find all of our sample scenes. Most of the sample scenes are in `UnityProjects/MRTKDevTemplate/Assets/Scenes`, while some experimental or early-preview sample scenes are located in `UnityProjects/MRTKDevTemplate/Assets/Data Binding Example`.
Copy file name to clipboardExpand all lines: docs/mrtk3-overview/getting-started/overview.md
+3-14Lines changed: 3 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,19 +9,8 @@ Welcome to the MRTK3! This guide serves as a starting point for using MRTK to bu
9
9
10
10
## Where should I go next?
11
11
12
-
[Exploring MRTK features](./exploring-features/mrtk3-tutorials.md): Learn about MRTK's features through our tutorial project and explore our example scenes.
12
+
[Explore MRTK features](./exploring-features/mrtk3-sample-scenes.md): Learn about MRTK's features through exploring our example scenes.
13
13
14
-
[Set up an MRTK Project](./setting-up/setup-dev-env.md): Learn how to create an AR/VR ready Unity project using MRTK
14
+
[Set up an MRTK project](./setting-up/setup-dev-env.md): Learn how to set up your development environment and create an AR/VR ready Unity project using MRTK.
15
15
16
-
[Test and Deploy your app](../test-and-deploy/overview.md): Learn how to test and deploy your application on a device.
17
-
18
-
## Software Requirements
19
-
20
-
To acquire and use MRTK3, the following software tools are required.
21
-
22
-
| Software | Version | Notes |
23
-
| --- | --- | --- |
24
-
|[Microsoft Visual Studio](https://visualstudio.microsoft.com/)| 2019 Community edition or greater | Recommend Visual Studio 2022 |
25
-
| Unity | 2022.3 LTS or newer | Recommend using an LTS release |
26
-
|[Mixed Reality Feature Tool for Unity](https://aka.ms/mrfeaturetool)|| Used to acquire MRTK3 packages |
Copy file name to clipboardExpand all lines: docs/mrtk3-overview/getting-started/setting-up/setup-dev-env.md
+22-11Lines changed: 22 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,24 +6,35 @@ nav_order: 1
6
6
7
7
# Setting up your development environment
8
8
9
-
Before setting up a Unity Project with MRTK3, make sure you have the following prerequisites.
9
+
Before setting up a Unity Project with MRTK3, make sure you have the following software tools installed.
10
10
11
-
- A Windows 10 or 11 PC
12
-
- Visual Studio 2022 with the required workloads (as noted in the [Installation Checklist](https://learn.microsoft.com/windows/mixed-reality/develop/install-the-tools))
13
-
- Windows 10 SDK 10.0.18362.0 or later
14
-
- Unity Hub with Unity 2022.3 LTS or Unity 2021.3 LTS installed
11
+
| Software | Version | Notes |
12
+
| --- | --- | --- |
13
+
| 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 |
15
15
16
-
If your target platform is a HoloLens device, your Unity installation needs to include the Universal Windows Platform Support Module.
If your target platform is a Quest device, your Unity installation needs to include the Android Build Support Module and its submodules. More more information specifics, see the [Oculus Developer documentation](https://developer.oculus.com/documentation/unity/book-unity-gsg/#install-unity-editor).
20
+
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.
|[Microsoft Visual Studio](https://visualstudio.microsoft.com/)| 2022 Community or newer | Add the required workloads as noted in the [Installation Checklist](https://learn.microsoft.com/windows/mixed-reality/develop/install-the-tools)|
29
+
| Windows 10 SDK | 10.0.18362.0 or later ||
30
+
31
+
If your target platform is a HoloLens device, your Unity installation needs to include the Universal Windows Platform Support module.
After setting up the development environment, there are few options for creating a Unity Project with MRTK3.
27
38
28
-
-[Starting from a Template Project](./setup-template.md): This guide walks you through cloning a template project, which is pre-configured to consume all MRTK3 packages. This template project is set up with Unity project settings for running your application on a device.
29
-
-[Starting from a New Project](./setup-new-project.md): This guide walks you through adding vital MRTK3 packages to a new Unity project. The guide also helps you set up the Unity project settings for running your application on a device.
39
+
-[Starting from the template project](./setup-template.md): This guide walks you through cloning a template project, which is pre-configured to consume all MRTK3 packages. This template project is set up with Unity project settings for running your application on a device.
40
+
-[Starting from a new project](./setup-new-project.md): This guide walks you through adding vital MRTK3 packages to a new Unity project. The guide also helps you set up the Unity project settings for running your application on a device.
Copy file name to clipboardExpand all lines: docs/mrtk3-overview/getting-started/setting-up/setup-new-project.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,34 +12,39 @@ You're not expected to consume every MRTK package. See [which features are usefu
12
12
13
13
## Setting up a new Unity project with MRTK3
14
14
15
-
### 1. Create a new Unity project
15
+
### Create a new Unity project
16
16
17
17
Create a new Unity project with Unity 2021.3.21f1 or newer. Close the Unity project before proceeding to the next step.
18
18
19
-
### 2. Import required dependencies and MRTK3 packages with Mixed Reality Feature Tool
19
+
### Import required dependencies and MRTK3 packages with Mixed Reality Feature Tool
20
20
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
+
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.
22
+
23
+
To run on **HoloLens 2** or to visualize controller models on a **Quest device**, an additional package is required:
22
24
23
25
-**Platform Support → Mixed Reality OpenXR Plugin**
26
+
27
+
To spatialize audio in your scene, an additional package is required:
28
+
24
29
-**Spatial Audio → Microsoft Spatializer** (Optional)
25
30
26
-
For MRTK3 packages, we highly recommend the following two packages to help you get started quickly:
31
+
For MRTK3 packages, we recommend the following two packages to help you get started quickly:
27
32
28
33
-**MRTK3 → MRTK Input** (Required for this setup)
29
34
-**MRTK3 → MRTK UX Components**
30
35
31
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.
32
37
33
-
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
+
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.
34
39
35
40

36
41
37
42
> [!NOTE]
38
43
> For more information on MRTK3 packages, see the [package overview page](../../packages/packages-overview.md).
39
44
40
-
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.
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.
41
46
42
-
### 3. Open the Unity project
47
+
### Open the Unity project
43
48
44
49
Open the Unity project and wait for Unity to finish importing the newly added packages. There may be two pop-up messages in this process:
45
50
@@ -48,7 +53,7 @@ Open the Unity project and wait for Unity to finish importing the newly added pa
48
53
49
54
Unity might restart a few times during this process; wait for it to finish before proceeding.
50
55
51
-
### 4. Configure MRTK profile after import
56
+
### Configure MRTK profile after import
52
57
53
58
Once imported, MRTK3 requires a profile to be set for the standalone target platform and each additional target platform.
54
59
@@ -63,18 +68,14 @@ Once imported, MRTK3 requires a profile to be set for the standalone target plat
63
68
64
69
1. Switch to the tabs of other build target(s) you want to use (for example, UWP, Android) and check to see if the profile is assigned. If not, repeat the previous step on the current tab.
65
70
66
-
### 5. Configure OpenXR-related settings
71
+
### Configure OpenXR-related settings
67
72
68
73
Once imported, MRTK3 requires some configuration on OpenXR if you're targeting a specific XR device. Refer to the instructions on the following pages for platform-specific guidance.
69
74
70
75
-[Deploy to an Android XR device](../../test-and-deploy/android-xr-deployment.md)
71
76
-[Deploy to a Quest device](../../test-and-deploy/quest-deployment.md)
72
77
-[Deploy to HoloLens 2](../../test-and-deploy/hololens2-deployment.md)
73
78
74
-
### 6. Congratulations, the project setup is now finished
75
-
76
-
Proceed to [creating a new MRTK3 scene](./setup-new-scene.md).
77
-
78
79
## Next steps
79
80
80
-
Once you've finished setting up your Unity project, learn how to [experience your application on a device](../../test-and-deploy/overview.md)
81
+
Once you've finished setting up your Unity project, proceed to [creating a new MRTK3 scene](./setup-new-scene.md).
The easiest way to acquire and try out MRTK3 is to explore our pre-configured project. This project contains references to all of the current MRTK3 packages, and comes pre-configured with the project settings required to deploy to device. Clone the project from [the MRTK3 GitHub repo](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity). After that, you can simply launch Unity (2021.3.21f1 or newer) on the `MRTKDevTemplate` project under `UnityProjects` and start playing with the sample scenes in the Editor by using remoting or deploying them to devices.
9
+
The easiest way to acquire and try out MRTK3 is to explore our pre-configured project. This project contains references to all of the current MRTK3 packages and comes pre-configured with the project settings required to deploy to device.
10
10
11
-
If you work with Git using the command line, you can clone the repo while specifying the `main` branch:
11
+
1. Clone the project from [the MRTK3 GitHub repo](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity).
12
12
13
-
`git clone --branch main https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity.git`
13
+
> [!NOTE]
14
+
> If you work with Git using the command line, you can clone the repo with `git clone https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity.git`
14
15
15
-
For information on the sample scenes included in the preview, see [Exploring MRTK3 Sample Scenes](../exploring-features/mrtk3-sample-scenes.md).
16
+
1. Launch Unity (2021.3.21f1 or newer) on the `MRTKDevTemplate` project under `UnityProjects` and start playing with the sample scenes in the Unity editor by using input simulation, remoting, or deploying them to devices.
17
+
18
+
For information on the sample scenes included in the preview, see [Exploring MRTK3 sample scenes](../exploring-features/mrtk3-sample-scenes.md).
16
19
17
20
## Next steps
18
21
19
-
Once you've finished setting up your Unity project, learn how to [experience your application on a device](../overview.md)
22
+
Once you've finished setting up your Unity project, choose one of the following options:
23
+
24
+
* Learn how to [experience your application on a device](../../test-and-deploy/overview.md)
25
+
* Proceed to [creating a new MRTK3 scene](./setup-new-scene.md)
Copy file name to clipboardExpand all lines: docs/mrtk3-overview/test-and-deploy/android-xr-deployment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ This page describes how to deploy your Unity Project with MRTK3 onto an Android
13
13
14
14
## Deployment Prerequisites
15
15
16
-
1. Add MRTK to your project and ensure your [project settings](../getting-started/setting-up/setup-new-project.md#5-configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your Android XR device**.
16
+
1. Add MRTK to your project and ensure your [project settings](../getting-started/setting-up/setup-new-project.md#configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your Android XR device**.
17
17
18
18
> [!NOTE]
19
19
> If starting from the [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
Copy file name to clipboardExpand all lines: docs/mrtk3-overview/test-and-deploy/hololens2-deployment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ This page describes how to deploy your Unity Project with MRTK3 onto a HoloLens
13
13
14
14
## Deployment Prerequisites
15
15
16
-
1. Add MRTK to your project and ensure your [project settings](../getting-started/setting-up/setup-new-project.md#5-configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your HoloLens**.
16
+
1. Add MRTK to your project and ensure your [project settings](../getting-started/setting-up/setup-new-project.md#configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your HoloLens**.
17
17
18
18
> [!NOTE]
19
19
> If starting from the [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
Copy file name to clipboardExpand all lines: docs/mrtk3-overview/test-and-deploy/quest-deployment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ These steps are based around OpenXR as your runtime (i.e. XR plugin provider) as
19
19
20
20
1. Ensure that [developer mode](https://developer.oculus.com/documentation/native/android/mobile-device-setup/#enable-developer-mode) is enabled on your device (you may need to [join a developer team](https://developers.meta.com/horizon/documentation/native/android/mobile-device-setup/#joining-or-creating-a-team) first). Installing the Oculus ADB Drivers is optional.
21
21
22
-
1. Add MRTK to your project and ensure that your [project settings](../getting-started/setting-up/setup-new-project.md#5-configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your Quest device**.
22
+
1. Add MRTK to your project and ensure that your [project settings](../getting-started/setting-up/setup-new-project.md#configure-openxr-related-settings) are configured correctly to use the OpenXR pipeline and MRTK's feature set. **These features are required to deploy your project onto your Quest device**.
23
23
24
24
> [!NOTE]
25
25
> If starting from the [template project](../getting-started/setting-up/setup-template.md), these project settings should already be configured for you.
0 commit comments