Latest commit c6994c2 Apr 28, 2017 @thestonefox fix(Interaction): prevent error when exiting after haptics
There was an out of sync error when the scene was exited after
haptics had been started because the dictionary was trying to
be looped with a foreach but lost order during the shut down.

This has been fixed by simply just calling `StopAllCoroutines`
instead of stopping each one individually.
Failed to load latest commit information.
Assets fix(Interaction): prevent error when exiting after haptics Apr 28, 2017
ProjectSettings chore(Project): update base support to Unity 5.5.3 Apr 7, 2017
.editorconfig chore(Configs): add utf-8-bom to .editorconfig Jun 16, 2016
.gitignore feat(SDK): add basic support for Oculus Avatar package Dec 30, 2016
CHANGELOG.md chore(Version): bump to version 3.1.0 Feb 25, 2017
CODE_OF_CONDUCT.md docs(Templates): add new template for code of conduct and issues Jan 30, 2017
CONTRIBUTING.md chore(Structure): ensure MonoBehaviour magic methods are overridable Jan 22, 2017
DOCUMENTATION.md fix(Haptics): ensure haptics cancel correctly when called again Apr 26, 2017
EXAMPLES.md chore(Structure): ensure example scenes follow same naming pattern Mar 9, 2017
FAQ.md docs(FAQ): add more content and new development section Jan 16, 2017
GETTING_STARTED.md docs(GETTING_STARTED): advise to set Oculus tracking origin type Apr 6, 2017
ISSUE_TEMPLATE.md chore(ISSUE_TEMPLATE.md): update template to have mandatory notice Mar 27, 2017
LICENSE chore(LICENSE): update author name in copyright Aug 5, 2016
MADEWITHVRTK.md chore(MADEWITHVRTK.md): add new game to list Apr 22, 2017
README.md chore(README.md): point to new location for logo Mar 9, 2017
SteamVR_Unity_Toolkit.sln.DotSettings chore(Configs): add editor configs for VS and ReSharper Jun 14, 2016
THANK_YOU_CREDITS.md chore(THANK_YOU_CREDITS.md): update patreon credits for current cycle Apr 5, 2017
THIRD_PARTY_NOTICES feat(AdaptiveQuality): add Adaptive Quality Sep 12, 2016


vrtk logo

VRTK - Virtual Reality Toolkit

A productive VR Toolkit for rapidly building VR solutions in Unity3d.

Slack Documentation Twitter Follow YouTube Waffle


Supported SDK Download Link
VR Simulator Included
SteamVR Unity Asset SteamVR Plugin
Oculus Utilities Unity Package Oculus Utilities
*Ximmerse Unity SDK Package Ximmerse Unity SDK
*Google VR SDK for Unity Google VR SDK for Unity


Thank You

A big thank you to all those who support VRTK via Patreon.

A list of supports can be seen in THANK_YOU_CREDITS.md.


The documentation for the project can be found within this repository in DOCUMENTATION.md which includes the up to date documentation for this GitHub repository.

Alternatively, the stable versions of the documentation can be viewed online at http://docs.vrtk.io.

Frequently Asked Questions

If you have an issue or question then check the FAQ.md document to see if your query has already been answered.

Getting Started

VRTK requires a supported VR SDK to be imported into your Unity3d Project.

  • Clone this repository git clone https://github.com/thestonefox/VRTK.git.
  • Open VRTK within Unity3d.
  • Add the VRTK_SDKManager script to a GameObject in the scene.

For further information about setting up a specific SDK, check out the GETTING_STARTED.md document.

What's In The Box

VRTK is a collection of useful scripts and concepts to aid building VR solutions rapidly and easily in Unity3d 5+.

It covers a number of common solutions such as:

  • Locomotion within virtual space.
  • Interactions like touching, grabbing and using objects
  • Interacting with Unity3d UI elements through pointers or touch.
  • Body physics within virtual space.
  • 2D and 3D controls like buttons, levers, doors, drawers, etc.
  • And much more...


A collection of example scenes have been created to aid with understanding the different aspects of VRTK.

A list of the examples can be viewed in EXAMPLES.md which includes an up to date list of examples showcasing the features of VRTK.

The examples have all been built to work with the SteamVR Plugin by default, but they can be converted over to using the Oculus Utilities or Ximmerse Unity SDK by following the instructions for using the Oculus Utilities or Ximmerse Unity SDK package above.

If the examples are not working on first load, click the [VRTK] GameObject in the scene hierarchy to ensure the SDK Manager editor script successfully sets up the project and scene.

Made With VRTK

image image image image image image image image image image image image

Many games and experiences have already been made with VRTK.

Check out the MADEWITHVRTK.md document to see the full list.


I would love to get contributions from you! Follow the instructions below on how to make pull requests.

For the full contribution guidelines see the CONTRIBUTING.md document.

Pull requests

  1. Fork the project, clone your fork, and configure the remotes.
  2. Create a new topic branch (from master) to contain your feature, chore, or fix.
  3. Commit your changes in logical units.
  4. Make sure all the example scenes are still working.
  5. Push your topic branch up to your fork.
  6. Open a Pull Request with a clear title and description.


Code released under the MIT License.