Upgrade Guide

Attention!

• This release is specifically targeted for Unity Editor-2017.2.1p2
  • This release should be compatible for development for both HoloLens & immersive headsets for 2017.2+
  • Minimum Editor Compatibility for Unity 5.6 for HoloLens development ONLY.
  • Windows SDK 10.0.16299 is required for 2017.2+
  • Visual Studio 2017 is required.
  • Fall Creators Update is required.
• When upgrading to this release, delete all toolkit folders before importing the package.

Breaking Changes:

• Fixed #1800 Fixed Compiling errors by moving Sharing With UNET Completely into Examples folder. If your project requires the UNET Sharing library be sure to also download the examples package and manually import the sharing with UNET folder.

Upgrade Guide

Attention!

• This release is specifically targeted for Unity Editor-2017.2.1p2
  • This release should be compatible for development for both HoloLens & immersive headsets for 2017.2+
  • Minimum Editor Compatibility for Unity 5.6 for HoloLens development ONLY.
  • Windows SDK 10.0.16299 is required for 2017.2+
  • Visual Studio 2017 is required.
  • Fall Creators Update is required.
• When upgrading to this release, delete all toolkit folders before importing the package.

What's New

-(#1491, #1578, #1678) Added Grid layout group to Interaction Buttons and Object Collections
-(#1544) MRDL Solvers and misc helpers.
-(#1508, #1594, #1600, #1595) MRDL Bounding Boxes
-(#1471, #1585) Updated Build portal to support Building and deploying VR apps to the local machine.
-(#1456) Added Touch Screen input source implementation.
-(#1435) Added QueryTopology_FindLargestPositionsSittable() to the Spatial Understanding Features.

Release Notes

-(#1479) Updated and standardized the license headers.
-(#1521) Xbox Controller Input Handler fixes.
-(#1526) Removed the Boundary Manager from the HoloLens.
-(#1560) Fixed bug in UserNotifications example that didn't correctly check for local user.
-(#1542) Fixes for Focus Manager and uGUI interactions.
-(#1555) Teleportation logic fixes.
-(#1496) Fixed Virtual Keyboard.
-(#1563) Fixed fade plane to be transparent.
-(#1509) Removed most cross feature dependencies.
-(#1554) Updated Tile Generator.
-(#1590) Removed invalid attributes on properties.
-(#1649, #1575) Fixed UIRaycastCamera settings and references
-(#1650) Updated glTF libraries.
-(#1608) Optimized Layer Extensions.
-(#1618, #1690) Fixed and updated Dictation Manager.
-(#1670) Added signed binaries complements of Microsoft.

Known Issues

• (#1800) UNET PlayerController class does not compile correctly. Workaround: Remove Sharing with UNET folder.

Attention!

• Patch Release for 2017.2.1.0 Release
• As always, patch releases are recommended only for users affected by those bugs fixed in that patch.

Release Notes

• Fixed: Standalone build errors.
• Fixed unused field warning in BoundaryManager

Upgrade Guide

Attention!

• This release is specifically targeted for Unity Editor-2017.2.1f1
  • This release should be compatible for development for both HoloLens & immersive headsets for 2017.2+
  • Minimum Editor Compatibility for Unity 5.6 for HoloLens development ONLY.
  • Windows SDK 10.0.16299 is required for 2017.2+
  • Visual Studio 2017 is required.
  • Fall Creators Update is required.
• When upgrading to this release, delete all toolkit folders before importing the package.

What's New

• (#1197, #1294, #1305, #1332, #1364) Mixed Reality Design Labs UX features.
• (#1274) Audio Banks.
• (#1165) Interactive layout elements.
• (#1195, #1196, #1242, #1206, #1268, #1379) Added Motion Controller glTF rendering in Editor.
• (#1308) Added Windows API Contract Checker.
• (#1326) Microphone Helper.
• (#1482) Allow serialized mesh to be converted to supplied local space.

Release Notes

• (#1526) BoundaryManager will be destroyed on HoloLens because of new Unity behavior.
• (#1521) Xbox controller fixes to handle gamepad input that got broken.
• (#1182) Updated sharing scenes to use Sharing World Anchor Manager.
• (#1133) Misc Virtual Keyboard fixes.
• (#1163, #1251, #1359, #1387) Misc Build Window and Project Configuration fixes.
• (#1255) Fixes Interaction Sources not properly being registered at startup in some cases.
• (#1250) Updated Teleport logic and Floor offset in IMHDs.
• (#1259, #1338) Fixed an issue where the Mixed Reality Camera Inspector.
• (#1269, #1126) GamePad input axis fixes.
• (#1256, #1350) Fixed uGUI raycasting for HoloLens and IMHDs.
• (#1329) Properly consuming clicks in TapToPlace.cs.
• (#1361) Clicker and HandDraggable fixes for HoloLens.
• (#1298, #1464) FadeScript was renamed to FadeManager, and was updated.
  • Removed the F key input mapping that was used for testing.
• (#1419, #1427) Fixed Unity editor backwards compatibility.
• (#1290) Validation for Position and Rotation from UnityEngine.XR.WSA.InteractionSourceState.sourcePose.
• (#1469) Removed System.IO.dll that was needed to successfully build IL2CPP projects. (Unity Bug)

Breaking Changes from last release v1.2017.2.0

• (#1208) Updated Singleton with DontDestroyOnLoad and will now survive scene transitions.
• (#1349) Removed Manager.prefab. Users should use InputManager.prefab.
• Made the 16299 SDK the default when building with the Build And Deploy Window for 2017.2+
  • 15063 is still the default SDK target for all previous builds of Unity.
• Made msbuild 15.0 the default build version number.
• Now all world space canvases are required to assign the FocusManager.Instance.UIRaycastCamera (a child of the InputManager's EventSystem ) to their event camera field.
• A dialog will pop up the first time you switch to the WorldSpace render mode asking if you'd like to switch.
  
  
• Updating your existing canvases is done for you by the FocusManager if one exists in your scene.
• You can also call FocusManager.Instance.UpdateCanvasEventSystems() at runtime.
• If you're procedurally creating canvases you can also set the world/event camera to FocusManager.Instance.UIRaycastCamera.
• UAudio events are now handed by UAudioBank. To Upgrade your events:
  1. Open existing project and Inspect the UAudioManager.
  2. Use the Export button to create a bank from the existing embedded data.
  • You may need to adjust the falloff curve and distance of spatialized sounds due to changes in the underlying spatializer library.
  • You can now move the generated asset around and rename it as required. (Default asset name is ConvertedAudioBank)

Known Issues:

• Doesn't build for Window Standalone.
  • Fix: Add UNITY_WSA around broken lines.

Upgrade Guide

Attention!

• Window Mixed Reality developers use Unity Editor 2017.2.0p1 MRTP 4
  • When building for Windows Mixed Reality target 10.0.16299 SDK.
• HoloLens developers use Unity Editor 2017.1.2
  • When building for HoloLens be sure to target the 10.0.15063 SDK.
• When upgrading to this release, delete all toolkit folders before importing the package.
• Minimum Editor Compatibility for Unity 5.6 for HoloLens development ONLY.

Release Notes

• (#1101) Updated Raycasting logic
• (#1141, #1098) Ported Input Updates from Dev Branch
• (#1106) Updated Medical Example

Breaking Changes from last release v1.2017.1.2

• TryGetPosition is now TryGetPointerPosition
• TryGetOrientation is now TryGetPointerRotation
• SpeechKeywordRecognizedEventData is now SpeechEventData
• All other changes should throw Obsolete warnings with suggested updates.

Pre Release of the HoloToolkit for Unity 2017.2.0p1 MRTP 4
What's new for the Fall Creators Update

Upgrade Guide

Attention!

• When upgrading to this release, delete all toolkit folders before importing the package.
• This release is for Windows Mixed Reality HMDs only.
  • HoloLens Developers please continue to use the master branch release.
• This is the last Pre-Release for the Dev branch and is used to help mitigate the breaking changes back to master. Please use this release as a reference point before switching to the main release.

Release Notes

• (#828, #1057, #1059, #1060, #1064, #1069, #1072, #1075, #1081, #1082, #1091, #1093, #1089, #1175) Merged all changes from master branch into the development branch.
• (#1016, #1026, #1053, #1052, #1062, #1028, #1085, #1088, #1100) Synced the Input System and Utilities feature areas to make older projects forwards compatible.
• (#1122) Fixed issue with TeleportMarker
• (#1021) Added Motion Controllers Example

Breaking Changes from last pre-release v1.Dev.2017.2.0

• Moved InteractionSourceExtensions into the Input feature folder.
• fixed spelling in ICurosr.SetVisibility was SetVisiblity
• RegisterPointableCanvas is now obsolete.
• GazeManager.UpdateHitDetails(FocusDetails focusDetails, bool isRegisteredForFocus) is now UpdateHitDetails(FocusDetails focusDetails, RaycastHit hitInfo, bool isRegisteredForFocus)
• DebugInteractionSourceState public fields are now PascalCase.
• FocusManager.BorrowPointerEventData() is now GetPointerEventData()
• Removed SpecularHightlight.shader
• Marked StartAwareBehaviour obsolete.
• Marked StartAwareSingleton obsolete.

Latest Release of the HoloToolkit for Unity 2017.1.2f1

Attention!

• When upgrading to this release, delete all toolkit folders before importing the package.
• This release is not for Windows Mixed Reality HMDs. Please use the Dev branch pre-releases instead.

Release Notes

• (#1096) Updated Editor to 2017.1.2f1
• (#975) Added backwards support for Unity 5.6
• (#983) Fixed cross platform serialization issues
• (#936, #994, #1052, #1062) Xbox Controller Support
• (#981) Build and Deploy Updates
• (#998) Fixed Speech keyword editor assignment issues
• (#989) Added cursor offset to TapToPlace
• (#980) Fixed race condition for re-connection in AutoJoinSessionAndRoom
• (#985) Adds the option to download the Sharing Service executable from this repository
• (#1069) Fixed IP max character length for IPv4 addresses
• (#1075) Fixed anchor name assignment
• (#1056) Fixed WorldAnchorManager start inheritance
• (#1090) Removed MicStream from core folders until it passes WACK
• (#1059, #1079, #1072, #1085, #1091, #1093) Prep project for forward compatibility to 2017.2

Breaking Changes

• Renamed feature folders
• Merged Test and Example folders
• Removed MicStream scripts and libraries until they pass WACK

This tag is for the pre-merge of the master branch into the 2017.2 dev branch.

Latest Release of the HoloToolkit for Unity 2017.1.1f1

• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/854) Fixed UAudioManager Editor Bug and added Test Scene for UAudioManager.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/852, https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/864) CameraCache utility that replaces Camera.main.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/888, https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/929) Update Editor to 2017.1.1f1 for Security Update & VS 2017 15.3 compatibility.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/874, https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/924) Refactored TapToPlace.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/904) Fixed 3dText multi pass and single pass stereo rendering.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/887, https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/955) Updated and refactored Editor Utilities.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/930) Fixed mismatched Mic network stream.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/747) Added persistent keyword capability.
  • Removed obsolete warnings from scene loader.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/927, https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/935) Added confidence level to keywords.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/905, https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/960) Added some Enhanced 3D primitives.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/965) Fixed IL2CPP build errors.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/931, https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/967) Fixed and updated example scenes.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/962) Fixed Quality Settings regression.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/742) Update to WorldAnchorManager and added MultiLens capabilities.

Breaking Changes

• GameObjects that utilize the WorldAnchorStore need to have unique names.
  • This is important so you can spawn identical objects across the network without needing to know the anchor names ahead of time.

Latest release of the HoloToolkit for Unity 2017.1.0f3

Repository Branding Updated to MixedRealityToolkit-Unity.

• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/728) Improvements for ImportExportAnchorManager.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/492) Fixed uNet issues with the server broadcasting when building as master.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/752) SpawnManager Update.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/776) Build & Deploy tools fixed determining Visual Studio instance.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/765) Added 3d keyboard.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/717) Fixes to SpatialUnderstandingExample scene.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/733) Added a basic Application View Manager to Popup and return a value.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/764) Added medical volumetric rendering example.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/810) Replaced all project shaders with Fast Configurable Shader.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/805) Fixed Updated GazeManager uGUI raycast calculations & GazeTransform initialization.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/827) Minor Refactoring and Cleanup.
• (https://github.com/Microsoft/MixedRealityToolkit-Unity/pull/839) Fixed issue with mesh cursor light not being deactivated properly.

Updating Dev_Unity_2017.2.0 branch to final MRTP13 build
Updated feature:

• Merged glTF Crystal Key motion controller rendering code.
• No API changes or breaking changes.

Top Unity known issue:
• Gamepad input doesn't work if Holographic HMD has focus during
playmode [925608]

Current Unity Editor Project Version:
Early access 5.6.1f1-MRTP9 Not accessible broadly yet.
Eventual release target is Unity 2017.2, but we wanted some managed partners to have access to this build.

Prerequisites:
Please see ReadME.md for setup steps.

What's new for Immersive headsets in this branch?

• GamepadInput supports the Xbox controller and maps it to the input manager events. You can use the Xbox controller A to tap. Press A and hold to do hold started, canceled and completed. Press A and left joystick to trigger the navigation events. Press the Y button to teleport in your world. Press the B button to return back to your original location.

• Motion Controller support that renders a prefab where you have the Crystal Key motion controller in your hand. Refer to MotionControllerTest.unity scene for how to use the scripts.

• Teleport capability with new prefabs like MixedRealityCameraParent.prefab that help you teleport to different locations in your app using the gamepad.

• Stage folder has the scripts that support the StageRoot component that helps define the 0,0,0 for your immersive applications. Prefabs help to draw the floor for immersive headsets and also renders the stage bounds if you wish to display those in your application.

Latest release of the HoloToolkit for Unity 5.6.2f1

• (https://github.com/Microsoft/HoloToolkit-Unity/pull/677) Implementing unit tests for TransformPoint and Inverse.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/679) Added WindowsStoreApp to local .gitignore file.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/682) Updated serialized meshMaterial field.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/702, https://github.com/Microsoft/HoloToolkit-Unity/pull/727) Updated TapToPlace.cs
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/689, https://github.com/Microsoft/HoloToolkit-Unity/pull/715) Added a scene launcher for easily switching between various HoloToolkit scenes.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/533, https://github.com/Microsoft/HoloToolkit-Unity/pull/721, https://github.com/Microsoft/HoloToolkit-Unity/pull/716) Updates to Dictation, Speech, and MicStream.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/664) Added a Tile & Splashscreen generator.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/736) Updated billboard to use a target transform.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/732) Updated global listener namespace.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/740) Added Cross Platform compatibility for Android, iOS, and PC
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/750) Updated Input Manger Tests scene light settings.
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/714) Updated and fixed Build & Deploy tools.

Latest release of the HoloToolkit for Unity 5.6.1f1

Release Notes:

• (https://github.com/Microsoft/HoloToolkit-Unity/issues/557, https://github.com/Microsoft/HoloToolkit-Unity/pull/560) Updated SpatialMappingObserver
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/541) Updated Editor hand input
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/566) Increased Spatial Processing remove vertex speeds
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/549, https://github.com/Microsoft/HoloToolkit-Unity/pull/592) Updated HandDraggable
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/577, https://github.com/Microsoft/HoloToolkit-Unity/pull/609, https://github.com/Microsoft/HoloToolkit-Unity/pull/614, https://github.com/Microsoft/HoloToolkit-Unity/pull/627) Namespace changes
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/568) Added uGUI compatibility to FPS display
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/604, https://github.com/Microsoft/HoloToolkit-Unity/pull/606, https://github.com/Microsoft/HoloToolkit-Unity/pull/585, https://github.com/Microsoft/HoloToolkit-Unity/pull/637, https://github.com/Microsoft/HoloToolkit-Unity/pull/639) Cursor and Gaze Updates
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/590) Refactored test scenes and assets into their own root folder
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/594) Updated spatial mapping manager, added isDone event when scan is complete
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/547) Added HeadsetAdjustment scene
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/554, https://github.com/Microsoft/HoloToolkit-Unity/pull/619) Shader optimizations
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/631) Updated TextToSpeechManager
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/644) Fix for TapToPlace
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/602) Added confirmation dialog for EnforceEditorSettings
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/656) Updated SpatialUnderstanding DLLs
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/663) Added a way to update Spatial Mapping custom mesh material
• (https://github.com/Microsoft/HoloToolkit-Unity/pull/661) Prototype uGUI examples

Latest release of the HoloToolkit for Unity 5.5.2f1

Release Notes:

• Fixes to Sharing Services
• Updated Spatial Understanding libraries
• Moved Test scenes into their own top level folder with it's own asset package
• Updated 3d text components and shaders
• Updated Editor Input to handle manipulation and navigation events
• Fixed Spatial Mapping colliders
• Updated Spatial Mapping to use unscaled time
• Updates to World Anchor Manager
• Cursor logic fixes

Upcoming releases:

• Unity 5.6+
• Windows Mixed Reality

Release Notes:

1. Includes new Extensible Input System.
2. Master Moved to Unity Engine 5.5.0f3.
3. Updated HoloLens Project Configuration Wizard.
4. Spatial Mapping Namespace updated and assets organized.
5. Shaders now support stereo instancing and near clip fading.
6. Will also provide a release version Unity package in the External\Unitypackages folder.

Breaking Changes:

1. No Longer compatible with Unity technical preview builds.
   • Please use latest engine release from Unity.
2. All Input Systems updated to new Extensible Input System.

Release notes:

1. Creating a release off of master before taking any breaking changes.
2. Contains all the contributions since HoloToolkit first launched on 30th March 2016.
3. Release works with Unity 5.4 releases.
4. This will allow developers to sync to a known point in time.
5. It will help with a better versioning story.

Upcoming releases:

1. Merge ExtensibleInputModule breaking change branch into master.
2. Move master to Unity 5.5 builds.

Thank you for your contributions and Happy Thanksgiving :)