CompanionMR

Windows Mixed Reality application that showcases the Companion object recognition framework on a HoloLens device.

Demo video:

Some assets are not included into the source code because of copyright restrictions. However, you can sideload the demo app onto your device for an unrestricted experience. Please make sure to use the CompanionAPI web service to provide AR information for the artworks when the application is started for the first time. Please refer to the official documentation by Microsoft to learn how to use the Device Portal for sideloading.

Dependencies

• Companion for WinRT/UWP: CompanionWinRT
• OpenCV 3 for WinRT/UWP: opencvWinRT
• A RESTful web service that manages the data library for CompanionMR: CompanionAPI
• HoloToolkit: MixedRealityToolkit-Unity

All HoloToolkit code alterations are described in HoloToolkit_Diff.md.

Building CompanionMR

To provide AR information for the artworks, CompanionMR needs to have access to the CompanionAPI web service when the application is started for the first time. Before building the project the host IP has to be altered accordingly to your network settings. It can be changed as a parameter of the "HoloLensCamera" GameObject:

1. Simply use Unity to build CompanionMR. The currently used version is 2017.1.2p1. Make sure to switch to UWP as the target platform and to activate the Unity C# Projects option.
2. Open the generated project file CompanionMR.sln in Visual Studio.
3. Please refer to the official documentation by Microsoft to learn how to deploy the app on your HoloLens device.

License

CompanionMR is a Windows Mixed Reality example project for Companion.
Copyright (C) 2018 Dimitri Kotlovsky, Andreas Sekulski

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional licenses

Please refer to the LICENSE.md file for additional license information applicable to the HoloToolkit source code and the OpenCV binary files.