Repository files navigation

This is a repository for testingVirtual Reality Toolkit (VRTK) on GearVR (see VRTK descriptionbelow, in the next section).

This is a totally separate repository and isn't representative of any work currently being carried out on VRTK.

Everything hereworks with the GearVR D-Pad only, it is designed just toenable agaze-based interaction without a gamepad or controller.If using a controller you probably don't need this: the GearVR controller can work with VRTK (see this video by @thestonefoxhttps://github.com/thestonefox [https://www.youtube.com/watch?v=ma2AetALN_k]), it is mapped onTouchpad.

Minimum Unity version is5.5.4.

Oculus package must be added installingOculusUtilities.

You can find instructionshere.

In Assets\VRTK_GearVR_Test here are 5 scenes to be tested with GearVR:

• template basic scene (000_Template_BasicScene_GearVR)
• object touching and grabbing (005_Controller_BasicObjectGrabbing_GearVR)
• interaction with Unity UI (034_Controls_InteractingWithUnityUI_GearVR)
• controlling movements with GearVR D-Pad (015_Controller_TouchpadAxisControl_GearVR)
• teleport (044_CameraRig_RestrictedTeleportZones_GearVR)

Note: Before building on your Android device, you must copy special OSIG file additions (oculussig_*)toAssets/Plugins/Android/Assets/

VRTK - Virtual Reality Toolkit

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

* experimental

The API documentation for the project can be found within thisrepository inAPI.md which includes the up to date documentationfor this GitHub repository.

Alternatively, the stable versions of the documentation can be viewedonline athttp://docs.vrtk.io.

If you have an issue or question then check theFAQ.md document tosee if your query has already been answered.

VRTK offers a VR Simulator that works without any third party SDK,but VR device support requires a supported VR SDK to be importedinto the Unity project.

• Download or clone this repository.
• Open the folder in Unity to load the project.
• Have a look at the included example scenes.

The example scenes support all the VRTK supported VR SDKs. To make useof VR devices (besides the included VR Simulator) import the neededthird party VR SDK into the project.

For further information about setting up a specific SDK and using VRTKin your own project, check out theGETTING_STARTED.md document.

VRTK is a collection of useful scripts and concepts to aid building VRsolutions 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 withunderstanding the different aspects of VRTK.

A list of the examples can be viewed inExamples/README.md which includesan up to date list of examples showcasing the features of VRTK.

The example scenes support all the VRTK supported VR SDKs. To make useof VR devices (besides the included VR Simulator) import the neededthird party VR SDK into the project.

Many games and experiences have already been made with VRTK.

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

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

For the full contribution guidelines see theCONTRIBUTING.md document.

1. Fork the project, clone your fork, and configure the remotes.
   1. If you're submitting a bug fix or refactor pull request thentarget the repositorymaster branch.
   2. If you're submitting a new feature or enhancement that changesfunctionality then target the next release branch in therepository (which is currently3.3.0-alpha).
2. Commit your changes in logical units.
3. Make sure all the example scenes are still working.
4. Push your topic branch up to your fork.
5. Open a Pull Request with a clear title and description.

Code released under theMIT License.

Any Third Party Licenses can be viewed inTHIRD_PARTY_NOTICES.md.