jstopchick / vrtk Goto Github PK

VRTK - Virtual Reality Toolkit

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

• Compatible SDKs
• SteamVR Plugin

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

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.

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.

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.

A collection of example scenes have been created to aid with understanding the different aspects of the toolkit. A list of the examples can be viewed within this repository in EXAMPLES.md which includes an up to date list of examples.

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.

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.