Giter Club home page Giter Club logo

vrtk's Introduction

VRTK logo

VRTK v4 beta - Virtual Reality Toolkit

A productive toolkit for rapidly building spatial computing solutions in the Unity software.

Slack Documentation Videos Twitter Waffle

Introduction

VRTK aims to make building spatial computing solutions in the Unity software fast and easy for beginners as well as experienced developers.

Requires the Unity software version 2018.3.10f1 (or above).

Getting Started

Documentation

Visit the VRTK.Academy for a collection of educational content to help you get the most out of building spatial computing solutions with VRTK.

Setting up the project

  • Create a new project in the Unity software version 2018.3 (or above) using 3D Template or open an existing project.
  • Ensure Virtual Reality Supported is checked:
    • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings window.
    • Select Player from the left hand menu in the Project Settings window.
    • In the Player settings panel expand XR Settings.
    • In XR Settings ensure the Virtual Reality Supported option is checked.
  • Ensure the project Scripting Runtime Version is set to .NET 4.x Equivalent:
    • In the Unity software select Main Menu -> Edit -> Project Settings to open the Project Settings inspector.
    • Select Player from the left hand menu in the Project Settings window.
    • In the Player settings panel expand Other Settings.
    • Ensure the Scripting Runtime Version is set to .NET 4.x Equivalent.

Note: Unity 2019.1 requires additional project setup before importing VRTK.

  • Download and install the XR Legacy Input Helpers from the Unity Package Manager.
    • In the Unity software select Main Menu -> Window -> Package Manager to open the Package Manager window.
    • Select XR Legacy Input Helpers from the Packages tab in the Package Manager window.
    • Click the Install button located in the bottom right of the Package Manager window.
    • The XR Legacy Input Helpers package will now download and install into the project.

Cloning the repo

  • Navigate to the project Assets/ directory.
  • Git clone with required submodules into the Assets/ directory:
    • git clone --recurse-submodules https://github.com/ExtendRealityLtd/VRTK.git
    • change to the newly cloned directory: cd VRTK/
    • git submodule init && git submodule update
  • The Unity software will now import and compile the new files.

Running the example scene

  • Open the VRTK/Samples/Farm/Scenes/ExampleScene scene.
  • Enable Maximize On Play in the Unity Game view control bar to ensure no performance issues are caused by the Unity Editor overhead.
  • Play the scene in the Unity Editor (CTRL + P).
  • The scene should automatically play within any Unity supported XR hardware.
  • Explore the farm yard and enjoy!

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 Made With VRTK website to see the full list.

Contributing

We're not currently in a place where accepting contributions would be helpful. But as soon as we're ready we'll let you know!

License

Code released under the MIT License.

Disclaimer

These materials are not sponsored by or affiliated with Unity Technologies or its affiliates. "Unity" is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.

vrtk's People

Contributors

thestonefox avatar rwetzold avatar gpvigano avatar virror avatar mattboy64 avatar bjennings76 avatar jamre avatar burnedikt avatar dantman avatar jwnjwn avatar kristianpd avatar tmaloteaux avatar reznovvr avatar cameronoltmann avatar blueteak avatar rangerscience avatar quintesse avatar mimminito avatar omegajak avatar robinerd avatar runengamer avatar sblancodiez avatar sdouglas avatar stewmcc avatar tamirco2003 avatar tenebrous avatar torrqtb avatar tomwim avatar wildstyle007 avatar ajaxlex avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.