Skip to content

Latest commit

 

History

History
93 lines (66 loc) · 4.11 KB

README.md

File metadata and controls

93 lines (66 loc) · 4.11 KB
Raw

UltimateXR

Github

UltimateXR is a professional-grade, free, open-source framework and toolkit for Unity. UltimateXR's goal is to simplify the development of virtual reality applications; from simulators to videogames and from simple prototypes to full AAA-scale projects.

Main features:

  • Free and open-source under the MIT license.
  • Cross-device compatibility. Support for all major headsets.
  • State-of-the-art grab and manipulation mechanics.
  • Integrated hand pose editor.
  • Customizable full-body avatar representation with Inverse Kinematics.
  • Library of gender- and race-agnostic hands with special care on inclusion.
  • Support for multiple locomotion mechanics.
  • Advanced UI components including interaction and tweening.
  • Scalable architecture.
  • Clean code; fully documented using standard XML format.
  • Lots of tools, methods and extensions to make development easier.

Soon! (v1.0.0)

  • Full multiplayer support with many networking integrations.
  • Serialization.
  • New improved manipulation mechanics.

Installation

We provide the following ways to install UltimateXR:

Method 1: Using Package Manager for git users

  1. If UltimateXR was previously installed in /Assets using a .unitypackage, remove the /Assets/UltimateXR folder first

  2. Open the Package Manager using the Window menu -> Package Manager

OpenPackageManager

  1. Inside the Package Manager, click on the "+" button on the top left and select "Add package from git URL..."

AddFromGitURL

  1. Input the following URL: https://github.com/VRMADA/ultimatexr-unity.git and click Add.
  2. When the installation has completed, make sure to import the examples if it's your first time using UltimateXR.

Examples

Method 2: Downloading and installing the .unitypackage

  1. Delete the previous version from /Assets/UltimateXR first. Important! Not removing the folder before updating may result in incorrect files remaining after installation.
  2. Download the latest package (.unitypackage file) found in https://github.com/VRMADA/ultimatexr-unity/releases
  3. Double click the file to import the package to your project.

Method 3: Through the official Unity Asset Store

  1. Delete the previous version from /Assets/UltimateXR first. Important! Not removing the folder before updating may result in incorrect files remaining after installation.
  2. Go to the Asset Store and click Open in Unity to proceed with the installation.
  3. Remember to rate and review our asset if you liked it!

Learn UltimateXR

Installation and setup

Supported platforms

Main components

UltimateXR API

Unlock the full potential using the API.

Community

Join our community and get in touch with other developers.