Files
website/docs/01-overview.md
6543 1f4e00b4be Documenting stardust projects and components (#10)
* Start documenting stardust projects and components

* add-more
2024-08-22 07:41:35 +00:00

2.4 KiB

sidebar_position
sidebar_position
1

Overview

Stardust XR (formerly known as Stardust) is an XR display server designed for Linux-based systems.
Unlike traditional display servers that focus on 2D screens, Stardust XR introduces new conventions to utilize unbounded 3D space in virtual or real environments.

Priorities

  • 3D Environment Focus: While supporting 2D clients through the Wayland protocol, Stardust XR primarily aims to create and manage 3D environments.

  • Standard Interfaces: Utilizes Wayland and OpenXR for 2D and XR app integration.

  • Stardust Protocol: Implements a special protocol for:

    • Creating virtual objects
    • Developing 3D UIs around 2D apps (Panel Shells)
    • Handling data as Items that can represent files, Wayland surfaces, etc.
  • Personal Device Interaction: Focuses on individual user interactions rather than collaborative 3D spaces.

  • Flexible Object Interaction: Users can choose objects that best suit their current scenario, with easy setup for default configurations.

Architecture

simplified architecture diagram

Projects & Components

  • telescope: bundle most used components to have a demo environment set up
  • server: Reverence implementation of the StardustXR server (similar to wayland's weston)
  • core lib: Rust crates and schemas for connecting stardust server and client
  • website: The location where documentation is done and the website is generated from
  • protostar: Demo application launcher (like nwg-drawer, ...)
  • black hole: Spatial storage for stardust xr
  • gravity: "Utility to launch apps and stardust clients spatially" ?!? is it an ap lancher like protostar? I could not got it to work ...
  • magnetar: Workspaces client
  • atmosphere: Environment, homespace, and setup client
  • orbit: Simple Panel Item UI ?!?
  • comet: Annotate things?!?