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/DownloadingTheMRTK.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
@@ -29,7 +29,7 @@ Feedback is welcome through the [Mixed Reality GitHub site](https://github.com/M
29
29
For those who would like to contribute to the MRTK or prefer to have the latest code in their project, there is another way to get access to the latest and greatest of the Mixed Reality Toolkit, be it the Release code or the in-progress development of the project.
30
30
31
31
[Stephen Hodgson has provided a full guide](https://www.rageagainstthepixel.com/expert-import-mrtk/) for how to use Git Submodules to download and synchronize the toolkit in to your project.
32
-
Don't worry though, you still control about when and how you update your project and can even "Go back" to a previous version of the toolkit at any time.
32
+
Don't worry though, you still have control on how you update your project and can even "Go back" to a previous version of the toolkit at any time by simply checking out a specific commit or tag.
@@ -31,9 +31,12 @@ To get your first project up and running, the steps are as follows:
31
31
32
32
### 1. Create your new project (or start a new scene in your current project)
33
33
34
-
> *Note* when creating a new project with Unity 2018, Unity gives you several templates to choose from. Currently the **MRTK does not yet support the Scriptable Render Pipeline**, so the LWSRP, HDSRP and VRSRP projects are not compatible with MRTK projects.
34
+
> *Note* when creating a new project with Unity 2018, Unity gives you several templates to choose from. Currently the **MRTK does not yet support the Scriptable Render Pipeline**, so the LWSRP, HDSRP and VRSRP projects are not compatible with MRTK projects. Please stay tuned to the MRTK GitHub site for future announcements on SRP support.
35
35
36
36
### 2. [Import the Mixed Reality Toolkit asset](https://github.com/Microsoft/MixedRealityToolkit-Unity/releases)
37
+
38
+
> The Mixed Reality Toolkit is available via [multiple delivery mechanisms](/Documentation/DownloadingTheMRTK.md) and in the future will also be available via the Unity package manager once Unity makes that option available.
39
+
37
40
Get the asset and import it in to your Unity project using "Asset -> Import Package -> Custom Package" from the Unity Editor menu.
> The Examples and SDK are optional but highly recommended for new users. Once you have a feel for how the toolkit works, you can remove these safely if you are not using them.
48
+
> The SDK is optional but highly recommended for new users. Once you have a feel for how the toolkit works, you can remove these safely if you are not using them.
46
49
47
-
> The Mixed Reality Toolkit is available via [multiple delivery mechanisms](/Documentation/DownloadingTheMRTK.md) and in the future will also be available via the Unity package manager once Unity makes that option available.
50
+
> The MRTK also provides a [separate "Examples" asset](https://github.com/Microsoft/MixedRealityToolkit-Unity/releases), which currently contains demonstration scenes for current MRTK features. In the future this will also contain educational "Example" scenes to aid with learning implementation tricks with the toolkit.
@@ -76,9 +79,11 @@ Once this completes, you will see the following in your Scene hierarchy:
76
79
77
80
78
81
82
+
> The MRTK will also select the configured profile, [click here for more details on this configuration screens](#configuring)
83
+
79
84
Which contains the following:
80
85
81
-
* Mixed Reality Toolkit - The toolkit itself, providing the central configuration and activation point for the entire framework.
86
+
* Mixed Reality Toolkit - The toolkit itself, providing the central configuration entry point for the entire framework.
82
87
* MixedRealityPlayspace - The parent object for the headset, which ensures the headset / controllers and other required systems are managed correctly in the scene.
83
88
* 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
84
89
* UIRaycastCamera added as a child to the Main Camera - To enable seamless UI interactions through the toolkit
@@ -91,6 +96,8 @@ Which contains the following:
91
96
You are now ready to start building your Mixed Reality Solution, just start adding content and get building.
92
97
Switch to other platforms (ensure they have XR enabled in their player settings) and your project will still run as expected without change.
93
98
99
+
<aname="configuring"/>
100
+
94
101
## Configuring your project
95
102
96
103
The Mixed Reality Toolkit configuration is all centralized on one place and attached to the MixedRealityToolkit object in your active scene.
@@ -103,6 +110,8 @@ Clicking on this profile will show the configuration screens for the Mixed Reali
103
110
104
111
From here you can navigate to all the configuration profiles for the MRTK, including:
105
112
113
+
> The "Default" profiles provided by the Mixed Reality Toolkit are locked by default, so when you view these in the inspector they will appear greyed out. This is to ensure you always have a common default for any project. We recommend you create your own profiles (see below) when you need to customize the configuration for your project.
114
+
106
115
* Main Mixed Reality Toolkit Configuration
107
116
* Camera Settings
108
117
* Input System Settings
@@ -136,7 +145,7 @@ At each step in the configuration, you can choose to remove and create a new pro
0 commit comments