From fb9356181528ee9578f50741e8ca842e8dab59f2 Mon Sep 17 00:00:00 2001 From: Nova Date: Mon, 4 Dec 2023 20:01:20 -0500 Subject: [PATCH] feat: moar content --- content/docs/stardust/_index.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/content/docs/stardust/_index.md b/content/docs/stardust/_index.md index ce2a29e..a1f2987 100644 --- a/content/docs/stardust/_index.md +++ b/content/docs/stardust/_index.md @@ -9,3 +9,19 @@ weight: 60 - [Github Organization](https://github.com/StardustXR/) A system UI to make using all your 2D—and eventually OpenXR—apps together intuitive, accessible, and fun by using community-made virtual objects as interfaces. + +![Panels for wayland apps and a CRT panel shell for XR UI.](https://stardustxr.org/img/carousel/panels.png) + +## Setup + +First you need to install and run the server from https://github.com/StardustXR/server. Follow the README. If you have issues getting OpenXR to work, try running https://gitlab.freedesktop.org/monado/demos/xrgears first. + +After the server is running, you'll need to run some clients. Here's a demo showing some off: +![A showcase of some different clients](https://stardustxr.org/img/docs/clients/demo_01.mp4) + +Non-exhaustive list of clients: +- [Flatland](https://github.com/StardustXR/flatland): A panel item UI (XR equivalent of a window manager) so you can interact with your apps using virtual touchscreens. To show Wayland apps, run them with the proper `WAYLAND_DISPLAY` environment variable, in the server's startup script, or use a stardust launcher such as gravity or protostar. Flatland works great in 3DoF or 6DoF with direct touch and pointer interaction. +![A flat panel containing the prism launcher](https://stardustxr.org/img/docs/clients/flatland.png) +- [Gravity](https://github.com/StardustXR/gravity): Command line tool to launch programs inside of stardust at a particular offset in space. This is nestable so you can run a script using gravity, and then gravity inside that script to make a whole composed setup out of thin air! It also ensures that everything launched through it will properly connect to the stardust server, such as wayland clients. +- [Protostar](https://github.com/StardustXR/protostar): Prototype app launcher library/examples. Grab app icons and drop them in space to launch apps where they're dropped. +- [Magnetar](https://github.com/StardustXR/magnetar): Workspaces in 3D. Any object inside the rings will move with them, so you can move a bunch of stuff out of the way temporarily when you don't need it. \ No newline at end of file