Files
website/docs/01-get-started/02-bundled.md
Owen Zimmerman cae188d6ea Add: Terra instructions (#18)
* Add Terra instructions

* How to run telescope

* Fix typo
2024-12-29 21:34:20 -05:00

55 lines
1.4 KiB
Markdown

---
sidebar_position: 2
---
# Bundled setup
Telescope is a bundled Stardust setup that lets you 1-click run all the essentials for testing a setup out on an existing 2D computer.
## Nix
### Install Nix
For easy development and distribution this project uses the [nix package manager](https://nix.dev/).<br/>
This allows to ensure all dependency requirements are met.
If you do not have nix installed follow the instructions at https://nixos.org/download/#nix-install-linux.
:::warning
Make sure to have [flakes enabled](https://nixos.wiki/wiki/flakes).
:::
### Run Telescope
Because telescope itself is a nix flake, you simply have to run
Intel/AMD/NVK graphics:
```sh
nix run github:StardustXR/telescope
```
~~Proprietary NVIDIA graphics:~~ is broken :/
```sh
NIXPKGS_ALLOW_UNFREE=1 nix run --impure github:StardustXR/telescope#telescopeNvidia
```
## Fedora/Ultramarine
You can install Telescope, and all other core Stardust tools, through the [Terra repository](https://terra.fyralabs.com/). This repository is pre-installed on Ultramarine, manual instructions can be found on their website.
To just install Telescope:
```
dnf install telescope
```
To install all Stardust XR packages (Ultramarine 40 and later, Fedora 41 and later):
```
dnf group install stardust-xr
```
From here, just run `telescope` in your terminal of choice.
## Other
An AppImage generated from the nix flake is currently WIP. Please check back later or do a [manual build.](manual)