VRTK - Virtual Reality Toolkit

A productive toolkit for rapidly building spatial computing solutions in the Unity software.

Introduction

VRTK aims to make building spatial computing solutions in the Unity software fast and easy for beginners as well as experienced developers.

Requires the Unity software version 2018.3 (or above).

Getting Started

Setting up the project

• Create a new project in the Unity software version 2018.3 (or above) using 3D Template or open an existing project.
• Ensure Virtual Reality Supported is checked
  • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings window.
  • Select Player from the left hand menu in the Project Settings window.
  • In the Player settings panel expand XR Settings.
  • In XR Settings ensure the Virtual Reality Supported option is checked.
• Ensure the project Scripting Runtime Version is set to .NET 4.x Equivalent.
  • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings inspector.
  • Select Player from the left hand menu in the Project Settings window.
  • In the Player settings panel expand Other Settings.
  • Ensure the Scripting Runtime Version is set to .NET 4.x Equivalent.

Cloning the repo

• Navigate to the project Assets/ directory
• Git clone with required submodules into the Assets/ directory:
  • git clone --recurse-submodules https://github.com/thestonefox/VRTK.git
  • git submodule init && git submodule update

Running the tests

• Open the VRTK/Scenes/Internal/TestRunner scene
• In the Unity3 software select Main Menu -> Window -> Test Runner
• Within the Test Runner window click on the EditMode tab and the click Run All button
• If all the tests pass then installation was successful

Made With VRTK

Many games and experiences have already been made with VRTK.

Check out the Made With VRTK website to see the full list.

Contributing

We're not currently in a place where accepting contributions would be helpful. But as soon as we're ready we'll let you know!

License

Code released under the MIT License.

Disclaimer

These materials are not sponsored by or affiliated with Unity Technologies or its affiliates. "Unity" is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.