Files
website/docs/01-get-started/02-Quickstart.md
2025-03-06 13:08:10 -05:00

2.8 KiB

sidebar_position
sidebar_position
2

QuickStart Guide

The quickest way to test Stardust XR, even if you don't have a VR setup, is to try out <span style={{ color: 'yellow' }}>Telescope, a bundled Stardust setup that runs the Stardust XR server, an app launcher called Hexagon Launcher with some pre-installed apps to try, Flatland that renders 2D Linux windows in XR, and Black Hole, a little bag of holding that can suck up all the objects & windows in it's radius (essentially a 3D version of minimizing all windows to peek at the desktop!)

Fedora Logo Ultramarine Logo Fedora/Ultramarine Linux

:::info You will need the Terra repository, unless you have Ultramarine Linux which comes pre-installed:

sudo dnf install --nogpgcheck --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' terra-release

::: In your terminal, run:

sudo dnf install telescope 

Logo Arch Linux

For Arch Linux, Stardust XR is available via the Arch Linux User Repository AUR

paru -S stardust-xr-telescope

Logo NixOS

For NixOS use the nix package manager, make sure flakes are enabled.

nix run github:StardustXR/telescope

After installation:

From here, just run telescope -f for flatscreen mode in your terminal of choice!

You will see a floating hexagon with the Stardust XR logo within it, which is the Hexagon Launcher.

To look around, hold down Shift and hold down Right Click

To move around, hold down Shift and W A S D, with Q for moving down and E for moving up

If you click on the hexagon, the launcher will open up. Try dragging out one of the apps with the Mouse 5 (Back) button. The small minus sign is Black Hole, if you click on it, it will grab any open window and store it away. Click it again and they will return to their original location.

If you are already using OpenXR within Linux, launching telescope while it's running should launch it within your headset. If not, check further instructions for setting up OpenXR, or the other installation guides.