Files
website/docs/01-get-started/02-Quickstart.md
Cyberneticmelon 9fde577aa6 Update docs/01-get-started/02-Quickstart.md
Co-authored-by: Jaiden Riordan <jade@e.email>
2025-03-06 22:14:34 -05:00

2.8 KiB

sidebar_position
sidebar_position
2

QuickStart Guide

The quickest way to get started with Stardust XR, is to try out <span style={{ color: 'yellow' }}>Telescope, this works with the device you already have, or a headset. It comes with the Stardust XR server, an app launcher called Hexagon Launcher and some helpful apps like Flatland to use your 2D apps inside Stardust, and Black Hole to quickly tuck away your objects and apps (kind of like desktop peek on Windows.)

Fedora Logo Ultramarine Logo Fedora and derivatives (except Enterprise Linux)

:::info You will need the Terra repository, unless you have Ultramarine Linux or Bazzite. You can install it using this command:

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

::: Then, install Telescope using:

sudo dnf install telescope 

Logo Arch Linux

On Arch Linux, Stardust XR is available in the Arch Linux User Repository AUR. We suggest using an AUR helper, like Paru:

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.