Skip to content

Commit 8f4e11a

Browse files
committed
De-dupe root readme
1 parent 5c36680 commit 8f4e11a

File tree

3 files changed

+36
-118
lines changed

3 files changed

+36
-118
lines changed

README.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,34 @@
66

77
**MRTK3** is the third generation of the Mixed Reality Toolkit for Unity. It's an open source project designed to accelerate cross-platform mixed reality development in Unity. MRTK3 is built on top of [Unity's XR Interaction Toolkit (XRI)](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) and OpenXR. This new generation of MRTK is intended to be faster, cleaner, and more modular, with an easier cross-platform development workflow enabled by OpenXR and the Unity Input System.
88

9+
[Mixed Reality Toolkit Organization](https://github.com/MixedRealityToolkit) maintains MRTK3, released MRTK3 for general availability (GA), and will announce future releases.
10+
911
## Key improvements
1012

1113
### Architecture
1214

1315
* Built on Unity XR Interaction Toolkit and the Unity Input System.
14-
* Dedicated to OpenXR, with flexibility for other XRSDK backends
15-
* Open-ended and extensible interaction paradigms across devices, platforms, and applications
16+
* Dedicated to OpenXR, with flexibility for other XRSDK backends.
17+
* Open-ended and extensible interaction paradigms across devices, platforms, and applications.
1618

1719
### Performance
1820

1921
* Rewrote and redesigned most features and systems, from UX to input to subsystems.
2022
* Zero per-frame memory allocation.
21-
* Tuned for maximum performance on HoloLens 2 and other resource-constrained mobile platforms.
23+
* Tuned for maximum performance on mixed reality devices and other resource-constrained mobile platforms.
2224

23-
### UI
25+
### User Interface
2426

2527
* New interaction models (gaze-pinch indirect manipulation).
2628
* Updated Mixed Reality Design Language.
2729
* Unity Canvas + 3D UX: production-grade dynamic auto-layout.
2830
* Unified 2D & 3D input for gamepad, mouse, and accessibility support.
2931
* Data binding for branding, theming, dynamic data, and complex lists.
3032

33+
### Long Term Support
34+
35+
* Minimum requirements: OpenXR, Unity 2022.3 LTS, Unity’s XR Interaction Toolkit 3.0.
36+
3137
## Packages
3238

3339
| Name | Package | Changelog |
@@ -56,11 +62,7 @@ The following components are considered to be in early preview.
5662

5763
It is important to note that the packages may not contain the complete feature set that is planned to be released or they may undergo major, breaking architectural changes before release.
5864

59-
We very much encourage you to provide any and all feedback to help shape the final form of these early preview features.
60-
61-
## Requirements
62-
63-
MRTK3 requires Unity 2021.3.21 or higher. In addition, you need the [Mixed Reality Feature Tool for Unity](https://aka.ms/mrfeaturetool) to find, download, and add the packages to your project.
65+
We encourage you to provide any and all feedback to help shape the final form of these early preview features.
6466

6567
## Getting started
6668

@@ -70,11 +72,29 @@ MRTK3 requires Unity 2021.3.21 or higher. In addition, you need the [Mixed Reali
7072

7173
| Platform | Supported Devices |
7274
|----------|-------------------|
73-
| OpenXR devices | Microsoft HoloLens 2 <br> Magic Leap 2 <br> Meta Quest 1/2 <br> Windows Mixed Reality (experimental) <br> SteamVR (experimental) <br> Oculus Rift on OpenXR (experimental) <br> Varjo XR-3 (experimental) <br> **If your OpenXR device already works with MRTK3, let us know!** |
75+
| OpenXR devices | [Android XR](https://www.android.com/xr/) <br> Microsoft HoloLens 2 <br> Meta Quest <br> Magic Leap 2 <br> Lenovo ThinkReality A3 (with [Qualcomm Snapdragon Spaces](https://docs.spaces.qualcomm.com/unity/samples/preview/mrtk3-setup-guide)) <br> Windows Mixed Reality (experimental) <br> SteamVR (experimental) <br> Varjo XR-3 (experimental) <br> **If your OpenXR device already works with MRTK3, let us know!** |
7476
| Windows | Traditional flat-screen desktop (experimental) |
75-
| And more coming soon! | |
7677

77-
## Versioning
78+
## UX building blocks
79+
80+
| | | |
81+
|---|---|---|
82+
| ![Button](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_Button.png) <br> **Button** <br> A volumetric button optimized for a wide range of input modalities, including poking, gaze-pinch, ray interactions, mouse click, and gamepad. | ![Bounds Control](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_BoundsControl.png) <br> **Bounds Control** <br> Intent feedback and precision manipulation affordances. | ![Object Manipulator](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_ObjectManipulator.png) <br> **Object Manipulator** <br> Move and manipulate objects with one or two hands with a wide variety of input modalities. |
83+
| ![Hand Menu](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_HandMenu.png) <br> **Hand Menu** <br> A hand-anchored collection of UX controls for easy access to quick actions. | ![Near Menu](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_NearMenu.png) <br> **Near Menu** <br> Collection of UX controls that can be manipulated, pinned, and set to follow the user. | ![Slider](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_Slider.png) <br> **Slider** <br> Adjust a value along a one-dimensional axis. |
84+
| ![Solver](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_Solver_Main.png) <br> **Solver** <br> Various object positioning behaviors such as tag-along, body-lock, constant view size and surface magnetism. | ![Dialog](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_Dialog.png) <br> **Dialog** <br> Prompt for user action. | ![Slate](./docs/mrtk3-overview/images/UXBuildingBlocks/MRTK_UX_v3_Slate.png) <br> **Slate** <br> A flat panel for displaying large-format interfaces and content. |
85+
86+
### Figma Toolkit for MRTK3 Preview
87+
88+
The [prerelease of Figma Toolkit for MRTK3](https://www.figma.com/community/file/1145959192595816999) includes UI components based on Microsoft's new Mixed Reality Design Language introduced in MRTK3. You can use the 2D representations of the components in the design process for creating UI layouts and storyboards.
89+
90+
## Session videos from Microsoft Mixed Reality Dev Days 2022
91+
92+
| | | |
93+
|---|---|---|
94+
| [![Introducing MRTK3](./docs/mrtk3-overview/images/MRDevDays/MRDD-June8-04-IntroducingMRTK3-1920x1080_w800.png)](https://youtu.be/fjQFkeF-ZOM?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL) <br> **[Introducing MRTK3 – Shaping the future of the MR Developer Experience](https://youtu.be/fjQFkeF-ZOM?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL)** | [![Getting started with your first MRTK3 project](./docs/mrtk3-overview/images/MRDevDays/MRDD-04-GettingStartedMRTK3-1920x1080_w800.png)](https://youtu.be/aVnwIq4VUcY?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL) <br> **[Getting started with your first MRTK3 project](https://youtu.be/aVnwIq4VUcY?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL)** | [![MRTK3 Interaction building blocks](./docs/mrtk3-overview/images/MRDevDays/MRDD-07-MRTK3BuildingBlocks-1920x1080_w800.png)](https://youtu.be/naVziEJ-yDg?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL) <br> **[MRTK3 Interaction building blocks](https://youtu.be/naVziEJ-yDg?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL)** |
95+
| [![Building Rich UI for MR in MRTK3](./docs/mrtk3-overview/images/MRDevDays/MRDD-10-BuildingRichUI-1920x1080_w800.png)](https://youtu.be/g2HF5HMy-2c?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL) <br> **[Building Rich UI for MR in MRTK3](https://youtu.be/g2HF5HMy-2c?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL)** | [![Working with Dynamic Data and Theming in MRTK3](./docs/mrtk3-overview/images/MRDevDays/MRDD-12-WorkingWithDynamicData-1920x1080_w800.png)](https://youtu.be/IiTpZ2ojyno?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL) <br> **[Working with Dynamic Data and Theming in MRTK3](https://youtu.be/IiTpZ2ojyno?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL)** | [![#Open - Deploy Everywhere with OpenXR and MRTK3](./docs/mrtk3-overview/images/MRDevDays/MRDD-15-HashOpenDeploy-1920x1080_w800.png)](https://youtu.be/LI6lyW9TG9o?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL) <br> **[#Open - Deploy Everywhere with OpenXR and MRTK3](https://youtu.be/LI6lyW9TG9o?list=PLlrxD0HtieHhkPlibqfQf1pGvM0vLNPpL)** |
96+
97+
### Versioning
7898

7999
In previous versions of MRTK (HoloToolkit and MRTK v2), all packages were released as a complete set, marked with the same version number (ex: 2.8.0). Starting with MRTK3 GA, each package will be individually versioned, following the [Semantic Versioning 2.0.0 specification](https://semver.org/spec/v2.0.0.html). (As a result, the '3' in MRTK3 is not a version number!)
80100

@@ -88,6 +108,10 @@ To help identify specific packages and their versions, MRTK3 provides an about d
88108

89109
![About MRTK Panel](images/AboutMRTK.png)
90110

111+
## Branch Status
112+
113+
[Mixed Reality Toolkit Organization](https://github.com/MixedRealityToolkit) maintains and updates MRTK3. We appreciate your feedback, and you can open bugs and feature request at the [Mixed Reality Toolkit for Unity](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity) GitHub project.
114+
91115
## Contributing
92116

93117
This project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the [Project's license](./LICENSE.md). You represent that if you do not own copyright in the code that you have the authority to submit it under the [Project's license](./LICENSE.md). All feedback, suggestions, or contributions are not confidential.
-515 KB
Binary file not shown.

docs/mrtk3-overview/index.md

Lines changed: 0 additions & 106 deletions
This file was deleted.

0 commit comments

Comments
 (0)