guendeli / vrtk Goto Github PK

VRTK - Virtual Reality Toolkit

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

*experimental

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.

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

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.

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.

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.

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.