diff --git a/External/ReadMeImages/MixedRealityStack-Apps.png b/External/ReadMeImages/MixedRealityStack-Apps.png new file mode 100644 index 0000000..14512be Binary files /dev/null and b/External/ReadMeImages/MixedRealityStack-Apps.png differ diff --git a/External/ReadMeImages/MixedRealityStack-Apps2.png b/External/ReadMeImages/MixedRealityStack-Apps2.png new file mode 100644 index 0000000..13899bc Binary files /dev/null and b/External/ReadMeImages/MixedRealityStack-Apps2.png differ diff --git a/External/ReadMeImages/MixedRealityStack-Apps3.png b/External/ReadMeImages/MixedRealityStack-Apps3.png new file mode 100644 index 0000000..13899bc Binary files /dev/null and b/External/ReadMeImages/MixedRealityStack-Apps3.png differ diff --git a/External/ReadMeImages/MixedRealityStack-MRTK-Unity.png b/External/ReadMeImages/MixedRealityStack-MRTK-Unity.png new file mode 100644 index 0000000..7c216d1 Binary files /dev/null and b/External/ReadMeImages/MixedRealityStack-MRTK-Unity.png differ diff --git a/External/ReadMeImages/MixedRealityStack-MRTK-Unity3.png b/External/ReadMeImages/MixedRealityStack-MRTK-Unity3.png new file mode 100644 index 0000000..ff4f7fa Binary files /dev/null and b/External/ReadMeImages/MixedRealityStack-MRTK-Unity3.png differ diff --git a/External/ReadMeImages/MixedRealityStack-MRTK.png b/External/ReadMeImages/MixedRealityStack-MRTK.png new file mode 100644 index 0000000..fdfc225 Binary files /dev/null and b/External/ReadMeImages/MixedRealityStack-MRTK.png differ diff --git a/External/ReadMeImages/MixedRealityStack-UWP.png b/External/ReadMeImages/MixedRealityStack-UWP.png new file mode 100644 index 0000000..02461b8 Binary files /dev/null and b/External/ReadMeImages/MixedRealityStack-UWP.png differ diff --git a/README.md b/README.md index 9e593a4..824d328 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ ![](External/ReadMeImages/MRDL_Logo_Rev.png) -# Mixed Reality Design Labs -This repo is where Microsoft's Windows Mixed Reality Design team publishes sample apps and experiments. If you are looking for official toolkit, please use **[Mixed Reality Toolkit](https://github.com/Microsoft/MixedRealityToolkit-Unity)** +# What is Mixed Reality Design Labs? +The Mixed Reality Design Labs (MRDL) is a collection of well-documented, open-source samples, based on the foundation of **[Mixed Reality Toolkit - Unity (MRTK)](https://github.com/Microsoft/MixedRealityToolkit-Unity)**. The goal is to inspire creators and help them build compelling, efficient Mixed Reality experiences. -**MRDL is based on [HUX](https://github.com/Microsoft/MRDesignLabs_Unity_Tools) which has an input system that is not compatible with Mixed Reality Toolkit.** +MRTK offers building-block components, and MRDL leverages them to offer more complete experiences and samples. As the name suggests, these samples are experimental/’works-in-progress’, driven by experience design, which provide creators with concrete examples of best practices for app experiences, UX, and MRTK implementation. By ‘experimental’, we mean MRDL is not officially supported/maintained by Microsoft (e.g. updated to latest versions of Unity), whereas MRTK is officially supported/maintained. + + + +# Sample apps +MRDL samples have been a successful pipeline for taking app-specific interactions and pushing them back as controls/patterns for MRTK. MRTK/MRDL have blossomed into a symbiotic relationship where iteration on each side has made the other better. This repo is where Microsoft's Windows Mixed Reality Design team publishes sample apps and experiments. If you are looking for the official toolkit, please go to **[Mixed Reality Toolkit - Unity](https://github.com/Microsoft/MixedRealityToolkit-Unity)**. | [Sample app - Lunar Module](https://github.com/Microsoft/MRDesignLabs_Unity_LunarModule) | [Sample app - Periodic Table of the Elements](https://github.com/Microsoft/MRDesignLabs_Unity_PeriodicTable) | |:---------|:--------------| @@ -11,11 +16,6 @@ This repo is where Microsoft's Windows Mixed Reality Design team publishes sampl |Lunar Module demonstrates how to extend Hololens' base gestures with two hand tracking and xbox controller input, reactive objects to surface mapping and plane finding, and simple menu systems. You can use this project's components to create your own mixed reality app experience. |Periodic Table of the Elements app demonstrates how to use Object Collection to lay out an array of objects in three-dimensional space with various surface types. You can also find the example of using Fluent Design elements such as light, depth, motion and material.| - - -# Supported Unity version: 2017.1.0f3 -The current supported version of Unity is [**Unity 2017.1.0f3**](https://unity3d.com/get-unity/download?thank-you=update&download_nid=47505&os=Win). If you are looking to have support for previous versions of Unity please check under **[Releases](https://github.com/Microsoft/MRDesignLabs_Unity/releases)**. - # Important: Requires submodule MRDesignLab As soon as you clone the repo, init and update submodule with git command: ``` @@ -31,21 +31,6 @@ git submodule foreach git pull This will add [HUX and related tools](https://github.com/Microsoft/MRDesignLabs_Unity_tools) under Assets/MRDesignLab/ folder -# Mixed Reality Design Labs(MRDL) and [Mixed Reality Toolkit(MRTK)](https://github.com/Microsoft/MixedRealityToolkit-Unity) -We are in process of migrating foundational UI controls and building blocks from MRDL to MRTK. Below you can find the list of the components that have been merged. - -## Ported UI controls and building blocks, now available on MRTK -- [Bounding Box and App Bar](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/Dev_Working_Branch/Assets/MixedRealityToolkit-Examples/UX/Readme/README_BoundingBoxGizmoExample.md) (in Dev_Working_Branch) -- [Buttons(Interactable Object)](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/master/Assets/HoloToolkit-Examples/UX/Readme/README_InteractableObjectExample.md) (in Dev_Working_Branch) -- [Interaction Receivers](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/master/Assets/HoloToolkit-Examples/UX/Readme/README_InteractableObjectExample.md) (in master & Dev_Working_Branch) -- [Object Collection](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/master/Assets/HoloToolkit-Examples/UX/Readme/README_ObjectCollection.md) (in master & Dev_Working_Branch) -- [Line creation / Rendering classes for parabolic pointers](https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/1305) (in Dev_Working_Branch) -- [Solvers](https://github.com/Microsoft/MixedRealityToolkit-Unity/tree/Dev_Working_Branch/Assets/MixedRealityToolkit/Utilities/Scripts/Solvers) (in Dev_Working_Branch) -- [Dialog](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/Dev_Working_Branch/Assets/MixedRealityToolkit-Examples/UX/Readme/README_DialogsExample.md) (in Dev_Working_Branch) -- [Progress](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/Dev_Working_Branch/Assets/MixedRealityToolkit-Examples/UX/Readme/README_ProgressExample.md) (in Dev_Working_Branch) -- [ToolTip](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/Dev_Working_Branch/Assets/MixedRealityToolkit-Examples/UX/Readme/README_TooltipExample.md) (in Dev_Working_Branch) - - # Contributing