search

Innoactive / VRTK-Windows-MR-Extension

Extension for VRTK to include Windows Mixed Reality controller visualization with GLTF
MIT License
18 stars 5 forks source link

readme

VRTK-Windows-MR-Extension

Extension for Virtual Reality Toolkit to include Windows Mixed Reality Controller visualization.

How To Use

Simply add this repository to your VRTK Unity project which includes the latest VRTK. Find a unity package and ZIP in releases or add this repository as a submodule.

Note: There are known issues when downloading this repository as a ZIP through the Clone or download button. Apparently github marks all DLLs as unsafe so they won't be recognized in Unity.

Important: When building for IL2CPP make sure to move the folder UWP and all it's content to the top level of your Unity project (next to Assets).

Example project structure:

+-- Assets
|   +-- Extensions
|   |   +-- VRTK
|   |   +-- VRTK-Windows-MR-Extension
|   +-- Folder_1
|   +-- Folder_2
|   ...
+-- UWP

NOTE: VRTK will check for a script included in this repository and adds a Scripting Predefine Symbol (_VRTK_DEFINE_WINDOWSMR_CONTROLLERVISUALIZATION) if found. If you encounter unexpected behaviour make sure the Predefine Symbol is added in the Player Settings.

If missing, add the MotionControllerVisualization component to the ControllerManager which is part of the WindowsMR SDKSetup.

NOTE: Issue #10 is fixed by PR #12.

However, because the model is loaded only if the controller is present, errors will still appear until the controller is connected. The fix for these error messages is implemented for VRTK v3 in this commit. However, currently there is no way to merge into the official repo given that v3 has stopped development.

What is included

Why is this not included in VRTK

This repository holds a lot of Windows specific code which people who want to use VRTK may not ever use, e.g. when they just want to use Oculus or SteamVR. An SDK in VRTK is always dependent on a vendor SDK package to be installed, but that's about it. For Oculus models to show up you actually need to also import Oculus Avatar, but VRTK works fine without Avatar being imported. The same is done with this repository since there is no native solution by Microsoft.