Altspace MRE Developer Portal

Documentation #

Community Support #

Prerequisites #

  • Install Node.js 8.12 or newer, which includes NPM 6.4.1 or newer, from
  • A localhost or external server such as a VPS to host and run your MRE from in production or testing.

Developer MRE Sources & Examples #

How to Build and Run the Hello World sample #

From the command prompt:

  1. git clone
  2. cd mixed-reality-extension-sdk-samples\samples\hello-world
  3. npm install This will install all dependent packages. (and will do very little if there are no changes)
  4. npm run build This should not report any errors.
  5. npm start This should print “INF: Multi-peer Adapter listening on…”

Mixed Reality Extension (MRE) SDK #

The MRE SDK is the new SDK for building AltspaceVR extensions using Node.JS. To get started:

  1. Install AltspaceVR (from Steam or Oculus Store), create an AltspaceVR account, and familiarize yourself with the app.
  2. Install Git command line tools (install instructions)
  3. Go to the MRE SDK Samples repository, and follow the step-by-step instructions to build and run a sample

You can also:

Integrating the MRE SDK into your own app #

If you have made your own app or game in Unity3D, and want to run MREs inside your app, you should look at the MRE Unity Client Library repository.

Major known Issues #

  • Rigid body physics state syncronization is jittery.
  • Users can’t reliably directly collide with rigid body objects, except by grabbing.
  • A number of client-side errors don’t get send to the node log, which makes debugging hard. This includes glTF loading errors and using the wrong name when playing animations.

Pre-deployed MREs #

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

  • ws://
  • ws://
  • ws://
  • ws://

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.

  • Install from here: Visual Studio Code
  • You may want to add the TSLint extension to get style tips – use View->Extensions(ctrl+shift+X), search for TSLint, click Install.
  • To build: use Tasks->Run Build Task… (ctrl+shift+B), and you can select npm: Build for some or all packages.
  • To choose which MRE to launch: go to debugger sidebar: (ctrl+shift+D), and from the dropdown choose desired MRE.
  • To launch the MRE server: use Debug->Start Debugging (F5). To stop the server: user Debug->Stop Debugging (shift+F5)

Credits: This page has been made up using various useful parts of the official documentation.

Powered by BetterDocs