Files
website/docs/01-get-started/02-Quickstart.md
2025-03-07 11:12:40 -05:00

3.1 KiB

sidebar_position
sidebar_position
2

Quick Start 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. Fedora Atomic Editions will need to run the following command:

curl -fsSL https://github.com/terrapkg/subatomic-repos/raw/main/terra.repo | pkexec tee /etc/yum.repos.d/terra.repo
sudo rpm-ostree install terra-release

Other Fedora Editions can directly install terra-release:

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

On 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!

You will see a floating hexagon with the Stardust XR logo in the center, this is Hexagon Launcher.

To look around, hold down Shift and Right Click while moving the mouse.

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. Try dragging one of the apps with the Mouse 5 (Back) button. The small minus sign is Black Hole, if you click 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, running telescope while OpenXR is running should launch Stardust on your headset. If not, check further instructions for setting up OpenXR.