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
This is effectively part of the existing HoloToolkit, but this is the repository that will contain all Unity specific components.
3
-
The HoloToolkit is a collection of scripts and components intended to accelerate development of holographic applications targeting Windows Holographic.
The Mixed Reality Toolkit is a collection of scripts and components intended to accelerate development of applications targeting Microsoft HoloLens and Windows Mixed Reality headsets.
5
+
The project is aimed at reducing barriers to entry to create mixed reality applications and contribute back to the community as we all grow.
8
6
9
-
## Contributing to this project:
10
-
Please go over the [Contributing guidelines](CONTRIBUTING.md) to learn more about the process and thinking.
7
+
MixedRealityToolkit-Unity uses code from the base MixedRealityToolkit repository and makes it easier to consume in [Unity](https://unity3d.com/).
11
8
12
-
## Wondering how to simply get started?
13
-
Please go over the [Getting started guide](GettingStarted.md) to learn more about just getting off the ground quickly.
-**Master branch releases** will align with **major Unity releases marking a release every 3 months**. Please read the [Unity roadmap](https://unity3d.com/unity/roadmap).
17
-
- Each release will be marked as a GitHub [release tag](https://github.com/Microsoft/HoloToolkit-Unity/releases). You can consume this release by:
18
-
- Using the zip file available in the release notes
19
-
- Unity packages available in the release notes
20
-
- Syncing to the specific git tag you would like to lock on.
21
-
- Release tag name convention: v1.Unity release major number.Unity release minor number.Iteration number
22
-
- For example: For Unity version 2017.1.0 our release tag would be **v1.2017.1.0**
23
-
- If we marked another release with the same Unity version: **v1.2017.1.1**
24
-
- Unity packages for each release will be published to the Unity asset store.
25
-
- Unity packages for each feature area like Input/SpatialMapping will also be added to the release notes.
26
-
- Academy content will be updated with each major toolkit release.
11
+
Learn more about [mixed reality](https://developer.microsoft.com/en-us/windows/mixed-reality/mixed_reality).
| Scripts that leverage inputs such as gaze, gesture, voice and motion controllers. | Sharing library enables collaboration across multiple devices. | Scripts that allow applications to bring the real world into the digital using HoloLens. | Tailor experiences based on room semantics like couch, wall etc. |
| Scripts to help plug spatial audio into your application. | Building blocks for creating good UI in your application like common controls. | Common helpers and tools that you can leverage in your application. | Build and deploy automation window for Unity Editor.|
29
23
24
+
25
+
# Required Software
26
+
|[Windows 10 Creators Update](https://www.microsoft.com/software-download/windows10)|[Unity](https://unity3d.com/get-unity/download/archive?_ga=2.81762199.1436901961.1502315389-1970488254.1488922991)|[Visual Studio 2017](http://dev.windows.com/downloads)|[Hololens Emulator(optional)](https://go.microsoft.com/fwlink/?linkid=852626)|
| To develop apps for mixed reality headsets, you need Creators Update. | The Unity engine is an easy way to get started building a mixed reality app. | Visual Studio is used for code editing, deploying and building UWP app packages. | Emulator allows you test your app without the device in a simulated environment. |
29
+
30
+
# Getting started with MRTK
31
+
| Quick start | Contributing to this project |
32
+
| :--------------------- | :----------------- |
33
+
| Please go over the [Getting started guide](GettingStarted.md) to learn more about getting off the ground quickly. | Please go over the [Contributing guidelines](CONTRIBUTING.md) to learn more about the process and thinking. |
34
+
35
+
36
+
# Roadmaps
37
+
### Master branch
30
38
| Target Unity release | Release timeframe | Master release tag | Toolkit release features |
| 2017.1.0 | Early Aug 2017 | v1.2017.1.0 | - Updating to Unity's beta build. - 3D Keyboard for text entry.|
33
41
| 2017.2.0 | End Sep 2017 | v1.2017.2.0 | - Updating master with Windows Mixed Reality support (xR namespace). - RI Dev_Unity_2017.2.0 into master. - Toolkit will work on both HoloLens and immersive headsets. - Windows Mixed Reality motion controller support.|
34
42
| 2017.3.0 | End Dec 2017 | v1.2017.3.0 | - 360 video player prefabs. - Scriptable foveated rendering prefabs. |
43
+
### Dev_Unity_2017.2.0 branch
35
44
36
-
## Release cadence for development branches:
37
-
- Development branches are great for incubating features before they make their way into master.
38
-
- These branches can be feature work or experimental features.
39
-
- Development branches might not be on the same Unity versions as master.
40
-
- For being merged into Master the dev branch will have to follow the cadence laid out for master.
41
-
- Development branches might choose to mark releases on a faster cadence based on customer/project needs.
42
-
- Recommend marking a development branch tag every 2 weeks as needed to ensure stability before making up to master.
43
-
- Development branches might be deleted once merged into master. If more work is pending, it's ok to continue working in them.
44
-
45
-
## Roadmap for branch Dev_Unity_2017.2.0:
45
+
| Target Unity release | Release timeframe | Branch release tag | Branch pre-release features | Status |
| MRTP9 | End July 2017 | v1.Dev.MRTP9 | - Windows Mixed Reality support for working on both HoloLens and immersive headsets. - Gamepad support. - Windows Mixed Reality motion controller support. |[Complete: v1.Dev.MRTP9](https://github.com/Microsoft/HoloToolkit-Unity/releases/tag/v1.Dev.MRTP9)|
48
+
| MRTP13 | Early Aug 2017 | v1.Dev.MRTP13 | - Updating to MRTP13. - Windows Mixed Reality motion controller rendering with glTF format read from WU driver. |[Complete: v1.Dev.MRTP13](https://github.com/Microsoft/HoloToolkit-Unity/releases/tag/v1.Dev.MRTP13)|
49
+
| 2017.2.0 | Mid Aug 2017 | v1.Dev.2017.2.0 | - Adapting to Unity's breaking changes of xR namespace and others. | In progress |
50
+
| 2017.2.0 | End Sep 2017 | v1.Dev.2017.2.1 | - Merge branch into master. | Not started. |
46
51
47
-
| Target Unity release | Release timeframe | Branch release tag | Branch pre-release features |
| MRTP9 | End July 2017 | v1.Dev.MRTP9 | - Windows Mixed Reality support for working on both HoloLens and immersive headsets. - Gamepad support. - Windows Mixed Reality motion controller support. |
50
-
| MRTP13 | Early Aug 2017 | v1.Dev.MRTP13 | - Updating to MRTP13. - Windows Mixed Reality motion controller rendering with glTF format read from WU driver. |
51
-
| 2017.2.0 | Mid Aug 2017 | v1.Dev.2017.2.0 | - Adapting to Unity's breaking changes of xR namespace and others. |
52
-
| 2017.2.0 | End Sep 2017 | v1.Dev.2017.2.1 | - Merge branch into master. |
53
-
54
-
## Upcoming Breaking Changes:
52
+
# Upcoming Breaking Changes
55
53
56
54
-**Renaming HoloToolkit-Unity repository to MixedRealityToolkit-Unity** to align with product direction.
57
55
- Technically **all your checkins and redirect links will continue to work as-is** but we wanted to give a better heads up on this.
@@ -64,25 +62,40 @@ Please go over the [Getting started guide](GettingStarted.md) to learn more abou
64
62
| Rename repository to MixedRealityToolkit-Unity. | Mid Aug 2017 | - Recommend you do: $git remote set-url origin new_url. - Recommend reading: https://help.github.com/articles/renaming-a-repository ; https://github.com/blog/1508-repository-redirects-are-here|
65
63
| Updating toolkit namespace to MixedReality | Nov 2017 | - Update folder names, class names and namespace names post 2017.2.0 release. |
66
64
67
-
##Future work planning:
65
+
# Future work planning
68
66
- Updating landing page for the ReadMe.md to help app developers find content better.
69
67
- Updating API documentation using tools like Doxygen and not writing them manually. This is something we will work with all of you on.
70
68
- Update Wiki to host API documentation instead.
71
69
- Move reusable features from MixedReality Design Labs project into toolkit.
72
70
73
-
## HoloToolkit contains the following feature areas:
To learn more about individual HoloLens feature areas, please read the [Wiki](https://github.com/Microsoft/HoloToolkit-Unity/wiki) section.
71
+
# Release cadence
72
+
### Master branch
73
+
-**Master branch releases** will align with **major Unity releases marking a release every 3 months**. Please read the [Unity roadmap](https://unity3d.com/unity/roadmap).
74
+
- Each release will be marked as a GitHub [release tag](https://github.com/Microsoft/HoloToolkit-Unity/releases). You can consume this release by:
75
+
- Using the zip file available in the release notes
76
+
- Unity packages available in the release notes
77
+
- Syncing to the specific git tag you would like to lock on.
78
+
- Release tag name convention: v1.Unity release major number.Unity release minor number.Iteration number
79
+
- For example: For Unity version 2017.1.0 our release tag would be **v1.2017.1.0**
80
+
- If we marked another release with the same Unity version: **v1.2017.1.1**
81
+
- Unity packages for each release will be published to the Unity asset store.
82
+
- Unity packages for each feature area like Input/SpatialMapping will also be added to the release notes.
83
+
- Academy content will be updated with each major toolkit release.
84
84
85
-
To learn how to add the HoloToolkit to your project see the [Getting Started](GettingStarted.md) guide.
85
+
### Development branches
86
+
- Development branches are great for incubating features before they make their way into master.
87
+
- These branches can be feature work or experimental features.
88
+
- Development branches might not be on the same Unity versions as master.
89
+
- For being merged into Master the dev branch will have to follow the cadence laid out for master.
90
+
- Development branches might choose to mark releases on a faster cadence based on customer/project needs.
91
+
- Recommend marking a development branch tag every 2 weeks as needed to ensure stability before making up to master.
92
+
- Development branches might be deleted once merged into master. If more work is pending, it's ok to continue working in them.
86
93
87
94
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
88
95
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
96
+
97
+
98
+
# Useful resources on Microsoft Windows Dev Center
| See code examples. Do a coding tutorial. Watch guest lectures. | Get design guides. Build user interface. Learn interactions and input. | Get development guides. Learn the technology. Understand the science. | Join open source projects. Ask questions on forums. Attend events and meetups. |
0 commit comments