Skip to content
forked from XRTK/com.xrtk.core

The Official Mixed Reality Framework

License

Notifications You must be signed in to change notification settings

wassx/XRTK-Core

 
 

Repository files navigation

Welcome to the Mixed Reality Toolkit

Developing Mixed Reality Applications in Unity is hard, and today we're proud to announce the formation of the XRTK (pronounced “Mixed Reality Toolkit”). This is a direct fork of the Microsoft Mixed Reality Toolkit (MRTK).

I know there are many developers who are frustrated with the current state of both game and general application development within the Mixed Reality ecosystem: a quickly developing market that encompasses the whole spectrum from Mobile Augmented Reality to high end Virtual Reality.

Compounded with the fact that developing for an emerging tech markets can be time consuming, expensive, and fraught with peril. There are many complexities with targeting multiple platforms and no single framework currently available is able to fulfil this in a true Mixed Reality approach (covering AR / XR / VR completely). This results in developers and enterprises having to build a multitude of solutions on the many SDK's provided by suppliers to fulfil the needs of the business.

To improve this situation, our vision is simple, to provide a complete cross-platform solution for AR/XR/VR development that supports three different developer skill levels:

  • Beginner No Coding Required: Perfect for artists, Hackathons, and Quick Prototyping.

  • Intermediate Customizable: The framework is flexible enough so coders can customize what they need to cover edge cases with ease.

  • Advanced Extensible: The framework is easy to extend and modify to add additional custom services to meet specific criteria and needs.

Our philosophy is to enable developers to focus on building content and structure and not have to worry about the underlying complexities for supporting multiple platforms in order to build it everywhere and on each device as required. In Short, built it once and ship it everywhere with as little effort as possible.

We’d like to invite all the major hardware vendors to help guide their platform specific implementations, from Microsoft’s Windows Mixed Reality and Magic Leap’s Lumin OS to Google’s ARCore and Apple’s ARKit. Including any upcoming Mixed Reality capable devices that would like to be included for adoption.

Chat with the community

We recently moved our main converastions regarding XRTK over to Discord, which allows us to do a lot more (and the chat / streaming there is awesome), but we keep an XRTK presence on Slack too, in order to retain links to our friends on there

Come join us!

Discord Slack
Discord Slack

Build Status

Modules Windows Build Agent
Core Build status
UPM Build status
WMR Build status
Lumin Build status
Oculus Build status
SDK Build status

Supported Platforms

By default, we support OpenVR on all platforms that support the standard, as well as Native SDK implementations for various vendors.

FAQ

How do I get started quickly?

While we are still preparing XRTK specific documentation and guidance, all the current Tutorials and Videos related to the MRTK will also work for the XRTK (which some subtle differences in screens).

Most notably:

  • Mixed Reality Toolkit Quickstart Quickstart video session demonstrating getting started with the MRTK and building your project for multiple patforms.
  • Getting Started With The XRTK (coming soon) Documented walk-through for creating your first project.
  • Mixed Reality Configuration Guide (coming soon) Screen by screen walk through of the major MRTK configuration screens (some will vary from the XRTK, but similar enough to get the picture)

What is the relationship between the XRTK and Microsoft's MRTK SDK

We work very closely with the MRTK to evolve their road-map to ensure it is the best it can be. When new features are added to the MRTK, then being a fork of the MRTK, the XRTK project can easily port those features over easily (for instance the upcoming HL2 support and hand tracking). In a lot of cases, there will be many extensions that will simply work seamlessly on both MRTK and XRTK without change, such as the Light Estimation extension released in January 2019.

It is our intention to always cooperate with the MRTK as they have similar goals, we just different aspirations to the developers adoption strategy.

How do I migrate from the MRTK to the XRTK?

All the project GUIDs have been regenerated so there will not be conflicts between assets.

To update any script references do a global find and replace for the following:

  • Microsoft.MixedReality.Toolkit -> XRTK
  • Check for any missing scripts in prefabs as e.g. Pointer Click Handler, Canvas Utility, Mixed Reality Line Data Provider,... has updated namespace

How do I migrate from the HoloToolkit to the XRTK?

Currently there isn't a direct path from the HTK to the XRTK, also Microsoft are still in the process of defining an "upgrade guide" for HTK -> MRTK upgrade. Once available we shall update that here with similar guidance.

Roadmap

About

The Official Mixed Reality Framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 96.9%
  • ShaderLab 3.1%