Skip to main content

Overview

This guide will teach you how to setup a complete Stardust XR setup from scratch. This guide will assume that you already have a working OpenXR setup.

Projects & Components​

Server​

The Stardust XR reference server is the root space that all clients connect to and show up in. It must be run before any clients, but can autostart clients itself for full setups.

Clients​

  • armillary: A 3D model viewer for Stardust XR; rotate, move, and display models in your XR space
  • atmosphere: A 3D environment viewer
  • black-hole: Universal minimization of objects
  • comet: Annotate in 3D wherever you want amongst your other apps!
  • flatland: Lets your 2D apps take form as Panels in 3D space
  • gravity: Launch programs with a certain offset in 3D space
  • non-spatial-input: Provides utilities to plug raw keyboard and mouse input from various sources into Stardust XR
  • protostar: App launcher library and examples including hexagon-launcher

Rust crates​

  • core lib: Rust crates and schemas for connecting stardust server and client
  • molecules: Higher level interaction toolkit crate for Stardust
  • asteroids: Declaritive framework in Rust
  • protostar: App launcher library and examples

Other​

  • telescope: Prepackaged Stardust setup built primarily as an overlay
  • website: The location where documentation is done and the website is generated from

Currently unmaintined​