Skip to content

Commit af51a83

Browse files
committed
Squash the getting-started folder
1 parent 0288524 commit af51a83

7 files changed

Lines changed: 29 additions & 27 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Exploring MRTK3 sample scenes
33
parent: Getting started with MRTK3
4-
nav_order: 1
4+
nav_order: 5
55
---
66

77
# Exploring MRTK3 sample scenes
@@ -22,7 +22,7 @@ We list below just a few of them.
2222

2323
This sample scene offers a wide variety of interaction examples. Despite the name, this scene is a good example of cross-platform input, including hand tracking, controller input, and mouse input. Examples of several different UI controls and interactables are present, including the volumetric UI systems.
2424

25-
![Hand Menu](../../images/hand-interaction-examples.png)
25+
![Hand Menu](../images/hand-interaction-examples.png)
2626

2727
### BoundsControlExamples
2828

docs/mrtk3-overview/getting-started/exploring-features/mrtk3-tutorials.md renamed to docs/mrtk3-overview/getting-started/mrtk3-tutorials.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: MRTK3 tutorials
33
parent: Getting started with MRTK3
4-
nav_order: 2
4+
nav_order: 6
55
---
66

77
# Exploring MRTK3 tutorials
@@ -15,6 +15,6 @@ Several tutorials have been created to help developers learn about MRTK3's vario
1515

1616
The [MRTK3 Aquarium project](https://learn.microsoft.com/windows/mixed-reality/develop/unity/mrtk3-aquarium) provides a Unity in-editor tutorial that explores various MRTK3 features. Set in an underwater scene, you'll be introduced to the creatures of the aquarium and the objects that make up their habitat. Using MRTK3 features, you'll add interactivity to the aquarium, enabling you to create an aquarium of your very own!
1717

18-
## [Zappy's Playground](https://learn.microsoft.comhttps://learn.microsoft.com/windows/mixed-reality/develop/unity/playground-tutorial)
18+
## [Zappy's Playground](https://learn.microsoft.com/windows/mixed-reality/develop/unity/playground-tutorial)
1919

2020
[Zappy's Playground](https://learn.microsoft.com/windows/mixed-reality/develop/unity/playground-tutorial) is a cross-platform developer sample project that showcases how to develop intuitive and comprehensive end-to-end experiences for mixed reality. It makes use of many advanced features present in MRTK3, such as Gaze Interaction, Hand Menus, and Spatial Audio.

docs/mrtk3-overview/getting-started/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Welcome to the MRTK3! This guide serves as a starting point for using MRTK to bu
99

1010
## Where should I go next?
1111

12-
[Exploring MRTK features](exploring-features/mrtk3-tutorials.md): Learn about MRTK's features through our tutorial project and explore our example scenes.
12+
[Exploring MRTK features](./mrtk3-tutorials.md): Learn about MRTK's features through our tutorial project and explore our example scenes.
1313

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](./setup-dev-env.md): Learn how to create an AR/VR ready Unity project using MRTK
1515

1616
[Test and Deploy your app](../test-and-deploy/overview.md): Learn how to test and deploy your application on a device.
1717

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ Before setting up a Unity Project with MRTK3, make sure you have the following p
1515

1616
If your target platform is a HoloLens device, your Unity installation needs to include the Universal Windows Platform Support Module.
1717

18-
![UWP Module Installation](../../images/setting-up/MRTK-Development-Setup-UWPModule.png)
18+
![UWP Module Installation](../images/setting-up/MRTK-Development-Setup-UWPModule.png)
1919

2020
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).
2121

22-
![Android Module Installation](../../images/setting-up/MRTK-Development-Setup-AndroidModule.png)
22+
![Android Module Installation](../images/setting-up/MRTK-Development-Setup-AndroidModule.png)
2323

2424
## Next steps
2525

2626
After setting up the development environment, there are few options for creating a Unity Project with MRTK3.
2727

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.
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.

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

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 3
88

99
Since MRTK3 is a collection of loosely coupled packages, consuming MRTK3 is done differently than the way you consume MRTK 2.x. We don't ship MRTK as a Unity project, so you have to manually add MRTK3 packages to your project in order to consume them.
1010

11-
You're not expected to consume every MRTK package. See [which features are useful to you](../../packages/packages-overview.md) and add only the dependencies that matter.
11+
You're not expected to consume every MRTK package. See [which features are useful to you](../packages/packages-overview.md) and add only the dependencies that matter.
1212

1313
## Setting up a new Unity project with MRTK3
1414

@@ -32,10 +32,10 @@ These two packages, along with their dependencies (automatically added by the Fe
3232

3333
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.
3434

35-
![Selecting the default MRTK3 packages in Microsoft's Mixed Reality Feature Tool](../../images/mrtk3-featuretool-setup-packages.png)
35+
![Selecting the default MRTK3 packages in Microsoft's Mixed Reality Feature Tool](../images/mrtk3-featuretool-setup-packages.png)
3636

3737
> [!NOTE]
38-
> For more information on MRTK3 packages, see the [package overview page](../../packages/packages-overview.md).
38+
> For more information on MRTK3 packages, see the [package overview page](../packages/packages-overview.md).
3939
4040
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.
4141

@@ -55,18 +55,20 @@ Once imported, MRTK3 requires a profile to be set for the standalone target plat
5555
1. Navigate to **Edit > Project Settings**.
5656
1. Under **Project Settings**, navigate to **MRTK3** and then switch to the standalone tab. Note that the profile is initially unspecified.
5757
1. Populate the field with the default MRTK profile that ships with the core package. You can type in the keyword "MRTKprofile" in the search bar of the project window; make sure you search in `All`. Alternatively, you can find the profile under `Packages/org.mixedrealitytoolkit.core/Configuration/Default Profiles/MRTKProfile.asset`.
58-
> [!NOTE]
59-
> Not all of the MRTK subsystems are shown in the screenshot below. The MRTK subsystems that you see may be different depending on the MRTK3 packages you've added to your project.
6058

61-
![assign the default MRTK profile](../../images/mrtk-profile.png)
59+
> [!NOTE]
60+
> Not all of the MRTK subsystems are shown in the screenshot below. The MRTK subsystems that you see may be different depending on the MRTK3 packages you've added to your project.
61+
62+
![assign the default MRTK profile](../images/mrtk-profile.png)
63+
6264
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.
6365

6466
### 5. Configure OpenXR-related settings
6567

6668
Once imported, MRTK3 requires some configuration on OpenXR if you're targeting an XR device such as HoloLens 2 or Quest.
6769

6870
> [!NOTE]
69-
> The following instructions apply to HoloLens 2 or WMR headsets. If you're targeting Quest, refer to the instructions on the [Quest deployment page](../../test-and-deploy/quest-deployment.md#deployment-prerequisites).
71+
> The following instructions apply to HoloLens 2 or WMR headsets. If you're targeting Quest, refer to the instructions on the [Quest deployment page](../test-and-deploy/quest-deployment.md#deployment-prerequisites).
7072
7173
1. Navigate to **Edit > Project Settings**.
7274

@@ -77,11 +79,11 @@ Once imported, MRTK3 requires some configuration on OpenXR if you're targeting a
7779
7880
For standalone:
7981

80-
[![Standalone XR Plug-in Management window](../../images/standalone-xr-plug-in-management.png)](../../images/standalone-xr-plug-in-management.png)
82+
[![Standalone XR Plug-in Management window](../images/standalone-xr-plug-in-management.png)](../images/standalone-xr-plug-in-management.png)
8183

8284
For UWP:
8385

84-
[![UWP XR Plug-in Management window](../../images/uwp-xr-plug-in-management.png)](../../images/uwp-xr-plug-in-management.png)
86+
[![UWP XR Plug-in Management window](../images/uwp-xr-plug-in-management.png)](../images/uwp-xr-plug-in-management.png)
8587

8688
1. Under **Project Settings**, navigate to **XR Plug-in Management > OpenXR > Interaction Profiles** and add the following three profiles for UWP and Standalone:
8789

@@ -94,19 +96,19 @@ Once imported, MRTK3 requires some configuration on OpenXR if you're targeting a
9496
9597
For standalone:
9698

97-
[![Standalone OpenXR](../../images/standalone-openxr.png)](../../images/standalone-openxr.png)
99+
[![Standalone OpenXR](../images/standalone-openxr.png)](../images/standalone-openxr.png)
98100

99101
For UWP:
100102

101-
[![UWP OpenXR](../../images/uwp-openxr.png)](../../images/uwp-openxr.png)
103+
[![UWP OpenXR](../images/uwp-openxr.png)](../images/uwp-openxr.png)
102104

103105
1. For HoloLens 2, we recommend that you set **Depth Submission Mode** to 16-bit in the settings above.
104106
1. For immersive headsets, you can use 24-bit depth submission. See the [Microsoft development docs for Unity](https://learn.microsoft.com/windows/mixed-reality/develop/unity/recommended-settings-for-unity?tabs=openxr#enable-depth-buffer-sharing) for more info.
105107

106108
### 6. Congratulations, the project setup is now finished
107109

108-
Proceed to [creating a new MRTK3 scene](../setting-up/setup-new-scene.md).
110+
Proceed to [creating a new MRTK3 scene](./setup-new-scene.md).
109111

110112
## Next steps
111113

112-
Once you've finished setting up your Unity project, learn how to [experience your application on a device](../../test-and-deploy/overview.md)
114+
Once you've finished setting up your Unity project, learn how to [experience your application on a device](../test-and-deploy/overview.md)

docs/mrtk3-overview/getting-started/setting-up/setup-new-scene.md renamed to docs/mrtk3-overview/getting-started/setup-new-scene.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ The following will walk through through creating a AR/VR ready scene using MRTK3
1212
1. Add the **MRTK XR Rig** prefab.
1313
1. Remove the **Main Camera** Game Object because **MRTK XR Rig** already contains a camera.
1414

15-
![MRTK XR rig screenshot](../../images/mrtk-xr-rig.png)
15+
![MRTK XR rig screenshot](../images/mrtk-xr-rig.png)
1616

1717
1. Add the MRTK Input Simulator prefab to your scene.
1818

1919
> [!NOTE]
2020
> This step is optional, but required by in-editor simulations.
2121
22-
![MRTK input simulator hierarchy pane](../../images/mrtk-input-simulator.png)
22+
![MRTK input simulator hierarchy pane](../images/mrtk-input-simulator.png)

docs/mrtk3-overview/getting-started/setting-up/setup-template.md renamed to docs/mrtk3-overview/getting-started/setup-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ If you work with Git using the command line, you can clone the repo while specif
1212

1313
`git clone --branch main https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity.git`
1414

15-
For information on the sample scenes included in the preview, see [Exploring MRTK3 Sample Scenes](../exploring-features/mrtk3-sample-scenes.md).
15+
For information on the sample scenes included in the preview, see [Exploring MRTK3 Sample Scenes](./mrtk3-sample-scenes.md).
1616

1717
## Next steps
1818

19-
Once you've finished setting up your Unity project, learn how to [experience your application on a device](../overview.md)
19+
Once you've finished setting up your Unity project, learn how to [experience your application on a device](./overview.md)

0 commit comments

Comments
 (0)