Skip to content

Commit b8f2244

Browse files
authored
Merge pull request #4012 from julenka/gettingstarted-2
Update GettingStartedWithTheMRTK.md
2 parents 700ca80 + 746a834 commit b8f2244

File tree

1 file changed

+17
-23
lines changed

1 file changed

+17
-23
lines changed

Documentation/GettingStartedWithTheMRTK.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting started with the Mixed Reality Toolkit
1+
# Getting Started with MRTK
22

33
![](../Documentation/Images/MRTK_Logo_Rev.png)
44

@@ -17,29 +17,28 @@ To get started with the Mixed Reality Toolkit you will need:
1717
## Get the latest MRTK Unity packages
1818
1. Go to the [MRTK release page](https://github.com/Microsoft/MixedRealityToolkit-Unity/releases).
1919
2. Under Assets, download both `Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage` and `Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage`
20-
> The Mixed Reality Toolkit is available via [multiple delivery mechanisms](DownloadingTheMRTK.md) and in the future will be available via the Unity package manager.
2120

22-
## Import MRTK packages into your Unity project
23-
1. Create a new Unity project, or open an existing project. When creating a project, make sure to select "3D" as the template type.
21+
The Mixed Reality Toolkit is available via [multiple delivery mechanisms](DownloadingTheMRTK.md) and in the future will be available via the Unity package manager.
2422

25-
> We used 2018.3.9f1 for this tutorial, though any Unity 2018.3.x release should work.
23+
## Import MRTK packages into your Unity project
24+
1. Create a new Unity project, or open an existing project. When creating a project, make sure to select "3D" as the template type. We used 2018.3.9f1 for this tutorial, though any Unity 2018.3.x release should work.
2625

2726
2. Import the `Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage` you downloaded by going into "Asset -> Import Package -> Custom Package", selecting the .unitypackage file, ensure all items to import are checked, and then selecting "Import".
2827

2928
3. Import `Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage` following the same steps as above. The examples package is optional but contains useful demonstration scenes for current MRTK features.
3029

31-
> After importing the Foundation package, you may see a setup prompt like the following:
32-
>
33-
> ![](../Documentation/Images/MRTK_UnitySetupPrompt.png)
34-
>
35-
> MRTK is attempting to set up your project for building Mixed Reality solutions by doing the following:
36-
> * Enable XR Settings for your current platform (enabling the XR checkbox).
37-
> * Force Text Serialization / Visible Meta files (recommended for Unity projects using source control).
38-
>
39-
> Accepting these options is completely optional, but recommended.
30+
After importing the Foundation package, you may see a setup prompt like the following:
31+
32+
![](../Documentation/Images/MRTK_UnitySetupPrompt.png)
33+
34+
MRTK is attempting to set up your project for building Mixed Reality solutions by doing the following:
35+
* Enable XR Settings for your current platform (enabling the XR checkbox).
36+
* Force Text Serialization / Visible Meta files (recommended for Unity projects using source control).
37+
38+
Accepting these options is completely optional, but recommended.
4039

4140

42-
> Some prefabs and assets require TextMesh Pro, meaning you have to have the TextMesh Pro package installed and the assets in your project (Window -> TextMeshPro -> Import TMP Essential Resources). **After you import TMP Essentials Resources, you need to restart Unity to see changes**.
41+
Some prefabs and assets require TextMesh Pro, meaning you have to have the TextMesh Pro package installed and the assets in your project (Window -> TextMeshPro -> Import TMP Essential Resources). **After you import TMP Essentials Resources, you need to restart Unity to see changes**.
4342

4443

4544
## Open and run the HandInteractionExamples scene in editor
@@ -90,12 +89,7 @@ Click "OK".
9089

9190
![](../Documentation/Images/MRTK_SelectConfigurationDialog.png)
9291

93-
> **Note** Note that the other configuration profiles in this picker are from other scenes in the examples
94-
package. If you did not install the examples package, you would not have been prompted to
95-
choose a specific profile (as the foundation package only contains a single
96-
MixedRealityToolkitConfigurationProfile - the default one). The other profiles are part of their
97-
respective example scenes (for example, the HandInteractionAllExampleMixedRealityToolkitConfigurationProfile)
98-
is part of the [HandInteractionExamples scene](README_HandInteractionExamples.md).
92+
> **NOTE**: Note that the other configuration profiles in this picker are from other scenes in the examples package. If you did not install the examples package, you would not have been prompted to choose a specific profile (as the foundation package only contains a single MixedRealityToolkitConfigurationProfile - the default one). The other profiles are part of their respective example scenes (for example, the HandInteractionAllExampleMixedRealityToolkitConfigurationProfile) is part of the [HandInteractionExamples scene](README_HandInteractionExamples.md).
9993
10094
You will then see the following in your Scene hierarchy:
10195

@@ -107,8 +101,8 @@ Which contains the following:
107101
* MixedRealityPlayspace - The parent object for the headset, which ensures the headset / controllers and other required systems are managed correctly in the scene.
108102
* The Main Camera is moved as a child to the Playspace - Which allows the playspace to manage the camera in conjunction with the SDK's
109103

110-
> **Note** While working in your scene, **DO NOT move the Main Camera** (or the playspace) from the scene origin (0,0,0). This is controlled by the MRTK and the active SDK.
111-
> If you need to move the players start point, then **move the scene content and NOT the camera**!
104+
**Note** While working in your scene, **DO NOT move the Main Camera** (or the playspace) from the scene origin (0,0,0). This is controlled by the MRTK and the active SDK.
105+
If you need to move the players start point, then **move the scene content and NOT the camera**!
112106

113107
6. Hit play and test out hand simulation by pressing spacebar.
114108

0 commit comments

Comments
 (0)