Home

Awesome

Mixed Reality Extension SDK

<img width='200' height='200' src='branding/MRe-RGB.png'/>

The Mixed Reality Extension SDK lets developers and community members extend the AltspaceVR host app's worlds with multi-user games and other dynamic experiences.

Prerequisites

Get Started

The easiest way to start with the MRE SDK is to head over to the mixed-reality-extension-sdk-samples repo, and build a sample.

If you want to build the actual SDK itself, or want to build the functional test showcase MRE, jump to Build and Run section of this document

To see the APIs, jump to SDK documentation

If you have made a game or application in Unity3D, and you want it to support MREs, or you want to debug into the client runtime code itself, go to the Mixed Reality Extension Unity repository.

Other resources are on AltspaceVR's developer page

Overview

Features

The SDK enables you to create extensions that can

Current State

Developer Preview

Limitations

The MRE SDK has been in developer preview in AltspaceVR since December 2018, and while the API surface is fairly stable, internals are regularly refactored. We strive to maintain backwards compatibility when possible, but until we ship the 1.0 release, there will be occasional breaking changes, which will require MRE redeploys.

The SDK does not have a feature rich set of APIs yet. We have focused on the networking and synchronization, rather than adding more APIs. Expect this to improve over time. Our

The SDK deploys anywhere Node.js works.

Goal

We want to deliver a feature-rich set of APIs, enabling creation of high quality, rich 3d experiences. There are many features we want to add, including

However, our highest priority is reliability, predictability, and ease of use, and as a consequence we spend much more time making sure we have a solid, flexible infrastructureare than adding shiny new features.

Major known Issues

Roadmap

We are working towards 1.0 release. Please look at our project page for remaining work.

How to Build and Deploy the SDK and functional tests

From command prompt:

Testing an MRE In AltspaceVR

You should now see a functional test load up inside AltspaceVR.

Pre-deployed MREs

We have deployed the hello world and functional test MREs to servers in the cloud. The URLs are

Using Visual Studio Code

We recommend Visual Studio Code, a lightweight code editor, which is easy to use and offers full debugging capabilities for Node.js servers.

Hosting and Multi-User Testing

To learn about additional deployment options and multi-user testing in AltspaceVR, see DEPLOYING.md

Getting In Touch

To report issues and feature requests: Github issues page.

To chat with the team and other users: join the MRE SDK discord community.

Or attend the biweekly AltspaceVR developer meetups.


Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

License

Code licensed under the MIT License.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.