/SteamVR_Unity_Toolkit

A collection of useful scripts and prefabs for building SteamVR titles in Unity 5. Phr00t's version.

Primary LanguageC#MIT LicenseMIT

[VRTK] VR Toolkit - Slack Waffle

A collection of useful scripts and prefabs for building VR titles in Unity 5.

This Toolkit requires a compatible VR SDK to be imported into your Unity Project

Games, Apps and Experiences that use this Toolkit

Game Link
QuiVR Steam Store Page
Left-Hand Path Steam Store Page
Holodaze Steam Store Page
ViveSpray Steam Store Page
VeeR Pong Steam Store Page
Emergence Fractal Universe Steam Store Page
Ocarina of Vive Itch.io Store Page
Danc<R Itch.io Store Page
Tower Island: Explore, Discover and Disassemble Steam Store Page
Virtual Warfighter Game website
VR Regatta Steam Store Page
Car Car Crash Hands Steam Store Page
MegaPolice Youtube Trailer
The Crystal Nebula Steam Store Page
Drone Training VR Youtube Trailer
Cogs and Cowboys Steam Store Page
Frantic Freighter Steam Store Page
Redswood VR Steam Store Page
Wrath Of The Fire God Steam Store Page
Coinvault Itch.io Store Page
VR Explosive Kitten Toss Itch.io Store Page
Zika VR Itch.io Store Page
Domino VR Steam Store Page
One Of The Last Game website
The Days After Game website
Quantized Steam Greenlight Page
Caketomino Steam Store Page

Quick Start for SteamVR

  • Clone this repository git clone https://github.com/thestonefox/SteamVR_Unity_Toolkit.git
  • Open SteamVR_Unity_Toolkit within Unity3d
  • Import the SteamVR Plugin from the Unity Asset Store
  • Browse the Examples scenes for example usage of the scripts

Summary

This toolkit provides many common VR functionality within Unity3d such as (but not limited to):

  • Controller button events with common aliases
  • Controller world pointers (e.g. laser pointers)
  • Player Locomotion
  • Grabbing/holding objects using the controllers
  • Interacting with objects using the controllers
  • Transforming game objects into interactive UI elements

The toolkit is heavily inspired by the SteamVR Plugin for Unity3d Github Repo.

What's In The Box

This toolkit project is split into three main sections:

  • Prefabs - VRTK/Prefabs/
  • Scripts - VRTK/Scripts/
  • Examples - VRTK/Examples/

The VRTK directory is where all of the relevant files are kept and this directory can be simply copied over to an existing project. The Examples directory contains useful scenes showing the VR Toolkit in action.

Documentation

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.

Contributing

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 Contribution 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.

License

Code released under the MIT License.