StardustXR/website
1
0
Fork 0
Code Issues 3 Pull Requests 4 Actions Packages Projects Releases Wiki Activity

Updated documentation for easier onboarding of developers and users #19

Merged
cyberneticmelon merged 71 commits from main into main 2025-03-07 13:38:36 -05:00
Conversation 12 Commits 71 Files Changed 21 +483 -122
21 changed files with 483 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/01-get-started/01-What-is-Stardust.md Normal file
View File

@@ -0,0 +1,12 @@
---
nothingneko commented 2025-03-06 20:00:29 -05:00 (Migrated from github.com)
Review
Copy Link
Stardust XR is a [display server](https://itsfoss.com/display-server/) for VR and AR headsets on Linux-based systems. Stardust provides a 3D environment, where anything from 2D windows from your existing apps, to 3D apps built from objects can exist together in physical space.
```suggestion Stardust XR is a [display server](https://itsfoss.com/display-server/) for VR and AR headsets on Linux-based systems. Stardust provides a 3D environment, where anything from 2D windows from your existing apps, to 3D apps built from objects can exist together in physical space. ```
nothingneko commented 2025-03-06 20:04:04 -05:00 (Migrated from github.com)
Review
Copy Link

Remove this because we already establish these points in the previous paragraph

```suggestion ``` Remove this because we already establish these points in the previous paragraph
nothingneko commented 2025-03-06 20:05:51 -05:00 (Migrated from github.com)
Review
Copy Link
If you'd like to try Stardust XR on your existing device without a headset, head to the [Quick Start](Quickstart) guide. If you'd like to use a VR headset, Linux, check out [Set up OpenXR Runtime](setup-openxr). If you already have your headset set up, head to the [Full Stardust Installation](manual) page. If you've a beginner, and have a Meta Quest device, we've created a [full walkthrough to get you started playing with Stardust](quest-3-setup)!
```suggestion If you'd like to try Stardust XR on your existing device without a headset, head to the [Quick Start](Quickstart) guide. If you'd like to use a VR headset, Linux, check out [Set up OpenXR Runtime](setup-openxr). If you already have your headset set up, head to the [Full Stardust Installation](manual) page. If you've a beginner, and have a Meta Quest device, we've created a [full walkthrough to get you started playing with Stardust](quest-3-setup)! ```
nothingneko commented 2025-03-06 20:07:33 -05:00 (Migrated from github.com)
Review
Copy Link

You should get a contributor guide kinda like what we have on UM, see: https://wiki.ultramarine-linux.org/en/contributing/contributorguide/

You should get a contributor guide kinda like what we have on UM, see: https://wiki.ultramarine-linux.org/en/contributing/contributorguide/
Owen-sz commented 2025-03-06 22:41:40 -05:00 (Migrated from github.com)
Review
Copy Link
Stardust XR is a [display server](https://itsfoss.com/display-server/) for VR and AR headsets on Linux-based systems. Stardust provides a 3D environment, where anything from 2D windows (including your existing apps!), to 3D apps built from objects, can exist together in physical space.
```suggestion Stardust XR is a [display server](https://itsfoss.com/display-server/) for VR and AR headsets on Linux-based systems. Stardust provides a 3D environment, where anything from 2D windows (including your existing apps!), to 3D apps built from objects, can exist together in physical space. ```
Owen-sz commented 2025-03-06 22:43:12 -05:00 (Migrated from github.com)
Review
Copy Link
If you'd like to try Stardust XR on your existing device without a headset, head to the [Quick Start](Quickstart) guide. If you'd like to use a VR headset, check out [Set up OpenXR Runtime](setup-openxr). If you already have your headset set up, head to the [Full Stardust Installation](manual) page. If you've a beginner, and have a Meta Quest device, we've created a [full walkthrough to get you started playing with Stardust](quest-3-setup)!

Not sure why linux was on there?

```suggestion If you'd like to try Stardust XR on your existing device without a headset, head to the [Quick Start](Quickstart) guide. If you'd like to use a VR headset, check out [Set up OpenXR Runtime](setup-openxr). If you already have your headset set up, head to the [Full Stardust Installation](manual) page. If you've a beginner, and have a Meta Quest device, we've created a [full walkthrough to get you started playing with Stardust](quest-3-setup)! ``` Not sure why `linux` was on there?
Owen-sz commented 2025-03-06 22:44:00 -05:00 (Migrated from github.com)
Review
Copy Link
If you'd like to try Stardust XR on your existing device without a headset, head to the [Quick Start](Quickstart) guide. If you'd like to use a VR headset, Linux, check out [Set up OpenXR Runtime](setup-openxr). If you already have your headset set up, head to the [Full Stardust Installation](manual) page. If you're a beginner, and have a Meta Quest device, we've created a [full walk through to get you started playing with Stardust XR](quest-3-setup)!
```suggestion If you'd like to try Stardust XR on your existing device without a headset, head to the [Quick Start](Quickstart) guide. If you'd like to use a VR headset, Linux, check out [Set up OpenXR Runtime](setup-openxr). If you already have your headset set up, head to the [Full Stardust Installation](manual) page. If you're a beginner, and have a Meta Quest device, we've created a [full walk through to get you started playing with Stardust XR](quest-3-setup)! ```
Owen-sz commented 2025-03-06 22:45:37 -05:00 (Migrated from github.com)
Review
Copy Link
Stardust XR is acitvely looking for help with development to expand the project. You can also [become a sponsor](https://github.com/sponsors/technobaboo).
```suggestion Stardust XR is acitvely looking for help with development to expand the project. You can also [become a sponsor](https://github.com/sponsors/technobaboo). ```
nothingneko commented 2025-03-07 01:47:40 -05:00 (Migrated from github.com)
Review
Copy Link

think including from implies that there's stardust exclusive 2d apps (which i don't believe there are

think including from implies that there's stardust exclusive 2d apps (which i don't believe there are
nothingneko commented 2025-03-07 01:48:04 -05:00 (Migrated from github.com)
Review
Copy Link

mayb typo

mayb typo
nothingneko commented 2025-03-07 01:48:29 -05:00 (Migrated from github.com)
Review
Copy Link

at least hyphenate

at least hyphenate
cyberneticmelon commented 2025-03-07 10:18:23 -05:00 (Migrated from github.com)
Review
Copy Link

I don't believe there are at the moment but there certainly can and probably will be

I don't believe there are at the moment but there certainly can and probably will be
nothingneko commented 2025-03-07 12:21:39 -05:00 (Migrated from github.com)
Review
Copy Link

rm one of these empty lines

rm one of these empty lines
sidebar_position: 1
---
# What is Stardust XR?
[![Stardust XR Demo Reel](/img/docs/sizzlethumb.png)](https://www.youtube.com/watch?v=v2WblwbaLaA)
Stardust XR is a [display server](https://itsfoss.com/display-server/) for VR and AR headsets on Linux-based systems. Stardust provides a 3D environment, where anything from 2D windows (including your existing apps!), to 3D apps built from objects, can exist together in physical space.
If you'd like to try Stardust XR on your existing device without a headset, head to the [Quick Start](Quickstart) guide. If you'd like to use a VR headset, check out [Set up OpenXR Runtime](setup-openxr). If you already have your headset set up, head to the [Full Stardust Installation](manual) page. If you've a beginner, and have a Meta Quest device, we've created a [full walkthrough to get you started playing with Stardust](quest-3-setup)!
Stardust XR is acitvely looking for help with development to expand the project. You can also [become a sponsor](https://github.com/sponsors/technobaboo).

37
docs/01-get-started/01-setup-openxr.md
View File

@@ -1,37 +0,0 @@
---
sidebar_position: 1
---
# Setup OpenXR Runtime
:::info
if you want to test stardust in flatscreen mode (in a window) without a headset or other OpenXR device, you can skip this step and start with [trying out telescope](bundled).
:::
Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) to ensure your hardware and headset are compatible:
## SteamVR
You will likely want to use [Monado](#monado) instead, but if you need to the instructions are available.
:::warning
If you are on NixOS please consult https://lvra.gitlab.io/docs/distros/nixos/ before installing SteamVR.
:::
https://lvra.gitlab.io/docs/steamvr/ is a good starting point, but be aware that the stardust server cannot run as an overlay on top of other games due to SteamVR not implementing the OpenXR Overlay extension.
## Monado
If you've got a wired headset, this is generally the way to go.
### NixOS
It's generally easiest to follow the instructions at https://lvra.gitlab.io/docs/distros/nixos/ to install properly to the system.
### Other distros
[Envision](https://lvra.gitlab.io/docs/fossvr/envision/) is the XR launcher (like a minecraft launcher) of choice for open source XR and is overall better in practice than SteamVR. If you are a Fedora user, Envision is packaged, but it's reccomended to get it from the [Terra repository](https://terra.fyralabs.com/). Other distros will need to build from source.
# Test OpenXR Runtime
Try running [XRGears](https://gitlab.freedesktop.org/monado/demos/xrgears) and see if it works, you can get it from the system's package manager often.

67
docs/01-get-started/02-Quickstart.md Normal file
View File

@@ -0,0 +1,67 @@
---
nothingneko commented 2025-03-06 20:10:13 -05:00 (Migrated from github.com)
Review
Copy Link
The quickest way to get started with Stardust XR, is to try out <span style={{ color: 'yellow' }}>Telescope</span>, 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.)
```suggestion The quickest way to get started with Stardust XR, is to try out <span style={{ color: 'yellow' }}>Telescope</span>, 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.) ```
nothingneko commented 2025-03-06 20:10:49 -05:00 (Migrated from github.com)
Review
Copy Link
  Fedora and derivatives (except Enterprise Linux)
```suggestion Fedora and derivatives (except Enterprise Linux) ```
nothingneko commented 2025-03-06 20:13:51 -05:00 (Migrated from github.com)
Review
Copy Link
You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg). You can install it using this command:
```suggestion You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg). You can install it using this command: ```
nothingneko commented 2025-03-06 20:14:15 -05:00 (Migrated from github.com)
Review
Copy Link
Then, install Telescope using:
```suggestion Then, install Telescope using: ```
nothingneko commented 2025-03-06 20:17:39 -05:00 (Migrated from github.com)
Review
Copy Link
On Arch Linux, Stardust XR is available in the Arch Linux User Repository [AUR](https://aur.archlinux.org/packages/stardust-xr-telescope). We suggest using an AUR helper, like Paru:
```suggestion On Arch Linux, Stardust XR is available in the Arch Linux User Repository [AUR](https://aur.archlinux.org/packages/stardust-xr-telescope). We suggest using an AUR helper, like Paru: ```
nothingneko commented 2025-03-06 20:18:04 -05:00 (Migrated from github.com)
Review
Copy Link
On NixOS use the [Nix package manager](https://nixos.org/download/#nix-install-linux), make sure [flakes are enabled](https://nixos.wiki/wiki/flakes).
```suggestion On NixOS use the [Nix package manager](https://nixos.org/download/#nix-install-linux), make sure [flakes are enabled](https://nixos.wiki/wiki/flakes). ```
nothingneko commented 2025-03-06 20:19:17 -05:00 (Migrated from github.com)
Review
Copy Link
# After Installation
```suggestion # After Installation ```
nothingneko commented 2025-03-06 20:19:31 -05:00 (Migrated from github.com)
Review
Copy Link
# Quick Start Guide
```suggestion # Quick Start Guide ```
nothingneko commented 2025-03-06 20:19:46 -05:00 (Migrated from github.com)
Review
Copy Link
From here, just run `telescope -f` for flatscreen mode in your terminal!
```suggestion From here, just run `telescope -f` for flatscreen mode in your terminal! ```
nothingneko commented 2025-03-06 20:20:07 -05:00 (Migrated from github.com)
Review
Copy Link
You will see a floating hexagon with the Stardust XR logo in the center, this is Hexagon Launcher.
```suggestion You will see a floating hexagon with the Stardust XR logo in the center, this is Hexagon Launcher. ```
nothingneko commented 2025-03-06 20:20:33 -05:00 (Migrated from github.com)
Review
Copy Link
To look around, hold down ***Shift*** and ***Right Click*** while moving the mouse.
```suggestion To look around, hold down ***Shift*** and ***Right Click*** while moving the mouse. ```
nothingneko commented 2025-03-06 20:21:46 -05:00 (Migrated from github.com)
Review
Copy Link
To move around, hold down ***Shift*** and ***W A S D***, with ***Q*** for moving down and ***E*** for moving up.
```suggestion To move around, hold down ***Shift*** and ***W A S D***, with ***Q*** for moving down and ***E*** for moving up. ```
nothingneko commented 2025-03-06 20:22:16 -05:00 (Migrated from github.com)
Review
Copy Link
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.
```suggestion 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. ```
nothingneko commented 2025-03-06 20:23:00 -05:00 (Migrated from github.com)
Review
Copy Link
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.
```suggestion 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. ```
Owen-sz commented 2025-03-06 22:47:02 -05:00 (Migrated from github.com)
Review
Copy Link
The quickest way to get started with Stardust XR is to try out <span style={{ color: 'yellow' }}>Telescope</span>, 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).
```suggestion The quickest way to get started with Stardust XR is to try out <span style={{ color: 'yellow' }}>Telescope</span>, 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). ```
Owen-sz commented 2025-03-06 22:50:32 -05:00 (Migrated from github.com)
Review
Copy Link
You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg).
```suggestion You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg). ```
sidebar_position: 2
---
# Quick Start Guide
The quickest way to get started with Stardust XR is to try out <span style={{ color: 'yellow' }}>Telescope</span>, 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).
<h1>
<img
src="/img/docs/Fedora_logo.svg"
alt="Fedora Logo"
style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }}
/>
<img
src="/img/docs/ultramarine-logo.svg"
alt="Ultramarine Logo"
style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }}
/>
Fedora and derivatives (except Enterprise Linux)
</h1>
:::info
You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg).
[Fedora Atomic Editions](https://fedoraproject.org/atomic-desktops/) 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
```
Owen-sz commented 2025-03-06 22:53:08 -05:00 (Migrated from github.com)
Review
Copy Link

Add how to install on immutable versions of Fedora and its derivatives.

Here is what the terra docs say (make non-immutable on top though, then add back the part I removed in the previous line to encompass both ways to install):

Fedora Atomic Editions

On Immutable editions of Fedora, 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

Directly install terra-release:

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

Add how to install on immutable versions of Fedora and its derivatives. Here is what the terra docs say (make non-immutable on top though, then add back the part I removed in the previous line to encompass both ways to install): Fedora Atomic Editions On Immutable editions of Fedora, 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 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
```
<h1>
<img src="/img/docs/arch.png" alt="Logo" style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }} />
Arch Linux
</h1>
On Arch Linux, Stardust XR is available in the Arch Linux User Repository [AUR](https://aur.archlinux.org/packages/stardust-xr-telescope). We suggest using an AUR helper, like Paru:
```
paru -S stardust-xr-telescope
```
<h1>
<img src="/img/docs/nixos.svg" alt="Logo" style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }} />
NixOS
</h1>
On NixOS use the [Nix package manager](https://nixos.org/download/#nix-install-linux), make sure [flakes are enabled](https://nixos.wiki/wiki/flakes).
```
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.
nothingneko commented 2025-03-07 12:23:20 -05:00 (Migrated from github.com)
Review
Copy Link

rm one of the empty lines

rm one of the empty lines
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.

54
docs/01-get-started/02-bundled.md
View File

@@ -1,54 +0,0 @@
---
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)

26
docs/01-get-started/03-manual.md
View File

@@ -1,26 +0,0 @@
---
sidebar_position: 3
---
# Manual build/installation
Make sure all repos are cloned on the same branch (e.g. all main or all dev branch) to ensure stardust protocol compatibility.
## Server
Run and maybe install the server from https://github.com/StardustXR/server.
Follow the README.
## Clients
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](/img/docs/clients/demo_01.mp4)
Non-exhaustive list of clients:
- [**flatland**](https://github.com/StardustXR/flatland): 3D panel UI (like window manager) for intercting with all your 2D apps
![A flat panel containing the prism launcher](/img/docs/clients/flatland.png)
- [**protostar**](https://github.com/StardustXR/protostar): App launcher library and examples including futuristic hexagon launcher
- [**black hole**](https://github.com/StardustXR/black-hole): Universal minimization of Stardust objects
- [**gravity**](https://github.com/StardustXR/gravity): Launch programs with a certain offset in 3D space
- [**magnetar**](https://github.com/StardustXR/magnetar): Example workspaces client
- [**atmosphere**](https://github.com/StardustXR/atmosphere): 3D environment with natural momentum-based movement
- [**comet**](https://github.com/StardustXR/comet): Annotate in 3D wherever you want amongst your other apps!

92
docs/01-get-started/03-setup-openxr.md Normal file
View File

@@ -0,0 +1,92 @@
---
nothingneko commented 2025-03-06 20:24:49 -05:00 (Migrated from github.com)
Review
Copy Link
This guide will help you set up your VR or AR headset for use with Stardust. Although support for many headsets on Linux is still under active development, there are a number of good options available. If you already have OpenXR set up on your Linux distribution, head to the [Full Installation](manual) page to get Stardust XR installed.
```suggestion This guide will help you set up your VR or AR headset for use with Stardust. Although support for many headsets on Linux is still under active development, there are a number of good options available. If you already have OpenXR set up on your Linux distribution, head to the [Full Installation](manual) page to get Stardust XR installed. ```
nothingneko commented 2025-03-06 20:25:35 -05:00 (Migrated from github.com)
Review
Copy Link
If you want to try Stardust in a window on your existing device you can skip this step and checkout the  [Quick Start Guide](Quickstart).
```suggestion If you want to try Stardust in a window on your existing device you can skip this step and checkout the [Quick Start Guide](Quickstart). ```
nothingneko commented 2025-03-06 20:26:30 -05:00 (Migrated from github.com)
Review
Copy Link
We highly recommend using [Envision](https://lvra.gitlab.io/docs/fossvr/envision/), an easy to use GUI for utilizing [Monado](https://monado.dev/) which is what you likely use if you have a wired headset. Envision also comes with [WiVRn](https://github.com/WiVRn/WiVRn) support for connecting to headsets like the Meta Quest wirelessly.
```suggestion We highly recommend using [Envision](https://lvra.gitlab.io/docs/fossvr/envision/), an easy to use GUI for utilizing [Monado](https://monado.dev/) which is what you likely use if you have a wired headset. Envision also comes with [WiVRn](https://github.com/WiVRn/WiVRn) support for connecting to headsets like the Meta Quest wirelessly. ```
nothingneko commented 2025-03-06 20:28:39 -05:00 (Migrated from github.com)
Review
Copy Link
Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using a Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora (with RPMFusion) or Ultramarine, this command will install the driver:
```suggestion Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using a Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora (with RPMFusion) or Ultramarine, this command will install the driver: ```
nothingneko commented 2025-03-06 20:30:07 -05:00 (Migrated from github.com)
Review
Copy Link
AMD graphic cards do not require additional drivers.
```suggestion AMD graphic cards do not require additional drivers. ```
nothingneko commented 2025-03-06 20:31:01 -05:00 (Migrated from github.com)
Review
Copy Link
  Fedora and derivatives (except Enterprise Linux)
```suggestion Fedora and derivatives (except Enterprise Linux) ```
nothingneko commented 2025-03-06 20:31:08 -05:00 (Migrated from github.com)
Review
Copy Link
You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg). You can install it using this command:
```suggestion You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg). You can install it using this command: ```
nothingneko commented 2025-03-06 20:31:28 -05:00 (Migrated from github.com)
Review
Copy Link
Then, install Envision using:
```suggestion Then, install Envision using: ```
nothingneko commented 2025-03-06 20:32:03 -05:00 (Migrated from github.com)
Review
Copy Link
For Arch Linux, Envision is available via the [AUR](https://aur.archlinux.org/packages/envision-xr-git). We suggest using an AUR helper, like Paru:
```suggestion For Arch Linux, Envision is available via the [AUR](https://aur.archlinux.org/packages/envision-xr-git). We suggest using an AUR helper, like Paru: ```
nothingneko commented 2025-03-06 20:32:34 -05:00 (Migrated from github.com)
Review
Copy Link
On NixOS, it's generally easiest to follow the instructions at https://lvra.gitlab.io/docs/distros/nixos/ as Envision is currently unstable on NixOS and troubleshooting SteamVR can be tricky.
```suggestion On NixOS, it's generally easiest to follow the instructions at https://lvra.gitlab.io/docs/distros/nixos/ as Envision is currently unstable on NixOS and troubleshooting SteamVR can be tricky. ```
nothingneko commented 2025-03-06 20:34:08 -05:00 (Migrated from github.com)
Review
Copy Link
You can also download the [Envision AppImage](https://gitlab.com/gabmus/envision/-/pipelines?ref=main&status=success). Once downloaded, unzip the archive, you should find a file named Envision-x86_64.AppImage. You can do this from the properties menu in your file manager, or run `chmod +x Envision-x86_64.AppImage` in your terminal.
```suggestion You can also download the [Envision AppImage](https://gitlab.com/gabmus/envision/-/pipelines?ref=main&status=success). Once downloaded, unzip the archive, you should find a file named Envision-x86_64.AppImage. You can do this from the properties menu in your file manager, or run `chmod +x Envision-x86_64.AppImage` in your terminal. ```
nothingneko commented 2025-03-06 20:35:11 -05:00 (Migrated from github.com)
Review
Copy Link
Then double click the file to run it.
```suggestion Then double click the file to run it. ```
nothingneko commented 2025-03-06 20:39:33 -05:00 (Migrated from github.com)
Review
Copy Link
When you launch Envision, you will have to build a profile for your headset, check the [Envision website](https://lvra.gitlab.io/docs/fossvr/envision/) for instructions specific to what you have. You can take a look at [this section] of our Meta Quest setup video for an example using WiVRn.
```suggestion When you launch Envision, you will have to build a profile for your headset, check the [Envision website](https://lvra.gitlab.io/docs/fossvr/envision/) for instructions specific to what you have. You can take a look at [this section] of our Meta Quest setup video for an example using WiVRn. ```
nothingneko commented 2025-03-06 20:40:38 -05:00 (Migrated from github.com)
Review
Copy Link
Once you have one of these options installed, a quick way to test on the headset is by running `xrgears`. [xrgears](https://gitlab.freedesktop.org/monado/demos/xrgears) is a demo that comes with Monado.
```suggestion Once you have one of these options installed, a quick way to test on the headset is by running `xrgears`. [xrgears](https://gitlab.freedesktop.org/monado/demos/xrgears) is a demo that comes with Monado. ```
nothingneko commented 2025-03-06 20:41:23 -05:00 (Migrated from github.com)
Review
Copy Link
Another option is ALVR, you can check the GitHub repository for more information [https://github.com/alvr-org/ALVR](https://github.com/alvr-org/ALVR)
```suggestion Another option is ALVR, you can check the GitHub repository for more information [https://github.com/alvr-org/ALVR](https://github.com/alvr-org/ALVR) ```
nothingneko commented 2025-03-06 20:41:39 -05:00 (Migrated from github.com)
Review
Copy Link
If you'd like to use SteamVR, head over to [https://lvra.gitlab.io/docs/steamvr/](https://lvra.gitlab.io/docs/steamvr/), although it is not the recommended way to use VR within Linux due to poor support.
```suggestion If you'd like to use SteamVR, head over to [https://lvra.gitlab.io/docs/steamvr/](https://lvra.gitlab.io/docs/steamvr/), although it is not the recommended way to use VR within Linux due to poor support. ```
Owen-sz commented 2025-03-07 02:07:12 -05:00 (Migrated from github.com)
Review
Copy Link
If you want to try Stardust in a window on your existing device you can skip this step and checkout the [Quick Start Guide](Quickstart).
```suggestion If you want to try Stardust in a window on your existing device you can skip this step and checkout the [Quick Start Guide](Quickstart). ```
Owen-sz commented 2025-03-07 02:09:21 -05:00 (Migrated from github.com)
Review
Copy Link
Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using an Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora (with RPMFusion) or Ultramarine, this command will install the driver:
```suggestion Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using an Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora (with RPMFusion) or Ultramarine, this command will install the driver: ```
Owen-sz commented 2025-03-07 02:15:20 -05:00 (Migrated from github.com)
Review
Copy Link
Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using a Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora, with the RPMFusion repository, this command will install the driver:
```suggestion Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using a Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora, with the RPMFusion repository, this command will install the driver: ```
cyberneticmelon commented 2025-03-07 10:43:45 -05:00 (Migrated from github.com)
Review
Copy Link

Right, in discussion with Nova about this Telescope is a little redundant with the full installation, as the startup script essentially launches the same things if you set it up that way. I believe Nova's intention with telescope is a bit of a bundled demo. I'm going to be looking into making a submodule repo and make all of these installs more organized.

Right, in discussion with Nova about this Telescope is a little redundant with the full installation, as the startup script essentially launches the same things if you set it up that way. I believe Nova's intention with telescope is a bit of a bundled demo. I'm going to be looking into making a submodule repo and make all of these installs more organized.
sidebar_position: 3
---
# Setup OpenXR Runtime
This guide will help you set up your VR or AR headset for use with Stardust. Although support for many headsets on Linux is still under active development, there are a number of good options available. If you already have OpenXR set up on your Linux distribution, head to the [Full Installation](manual) page to get Stardust XR installed.
nothingneko commented 2025-03-07 12:24:49 -05:00 (Migrated from github.com)
Review
Copy Link

rm one empty line

rm one empty line
:::info
If you want to try Stardust in a window on your existing device you can skip this step and checkout the [Quick Start Guide](Quickstart).
:::
# Envision
:::note
![Envision](/img/docs/Envision_Monado.png)
We highly recommend using [Envision](https://lvra.gitlab.io/docs/fossvr/envision/), an easy to use GUI for utilizing [Monado](https://monado.dev/) which is what you likely use if you have a wired headset. Envision also comes with [WiVRn](https://github.com/WiVRn/WiVRn) support for connecting to headsets like the Meta Quest wirelessly.
:::
Check the [hardware table](https://lvra.gitlab.io/docs/hardware/) (for Monado/WiVRn support) to ensure your hardware and headset are compatible. If you're using an Nvidia card, you'll need to install [proprietary drivers]((https://rpmfusion.org/Howto/NVIDIA). If you're using a modern Nvidia card on Fedora (with RPMFusion) or Ultramarine, this command will install the driver:
```
sudo dnf install akmod-nvidia
nothingneko commented 2025-03-06 20:29:10 -05:00 (Migrated from github.com)
Review
Copy Link
sudo dnf install akmod-nvidia
sudo akmods
# Wait for this to finish before rebooting, this may take up to 15 minutes
```suggestion sudo dnf install akmod-nvidia sudo akmods # Wait for this to finish before rebooting, this may take up to 15 minutes ```
sudo akmods
# Wait for this to finish before rebooting, this may take up to 15 minutes
```
nothingneko commented 2025-03-06 20:29:56 -05:00 (Migrated from github.com)
Review
Copy Link

Add a note about secure boot, this is often a papercut
https://wiki.ultramarine-linux.org/en/setup/post-advanced/#set-up-secure-boot

Add a note about secure boot, this is often a papercut https://wiki.ultramarine-linux.org/en/setup/post-advanced/#set-up-secure-boot
AMD graphic cards do not require additional drivers.
<h3>
<img
src="/img/docs/Fedora_logo.svg"
alt="Fedora Logo"
style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }}
/>
<img
src="/img/docs/ultramarine-logo.svg"
alt="Ultramarine Logo"
style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }}
/>
Fedora and derivatives (except Enterprise Linux)
</h3>
:::info
You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg).
[Fedora Atomic Editions](https://fedoraproject.org/atomic-desktops/) 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 Envision using:
```
sudo dnf install envision
```
<h3>
<img src="/img/docs/arch.png" alt="Logo" style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }} />
Arch Linux
</h3>
For Arch Linux, Envision is available via the [AUR](https://aur.archlinux.org/packages/envision-xr-git). We suggest using an AUR helper, like Paru:
```
paru -S envision-xr-git
```
<h3>
<img src="/img/docs/nixos.svg" alt="Logo" style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }} />
NixOS
</h3>
nothingneko commented 2025-03-07 12:25:30 -05:00 (Migrated from github.com)
Review
Copy Link

rm one empty line

rm one empty line
On NixOS, it's generally easiest to follow the instructions at https://lvra.gitlab.io/docs/distros/nixos/ as Envision is currently unstable on NixOS and troubleshooting SteamVR can be tricky.
### Other options for installation
You can also download the [Envision AppImage](https://gitlab.com/gabmus/envision/-/pipelines?ref=main&status=success). Once downloaded, unzip the archive, you should find a file named Envision-x86_64.AppImage. You can do this from the properties menu in your file manager, or run `chmod +x Envision-x86_64.AppImage` in your terminal.
nothingneko commented 2025-03-07 12:25:39 -05:00 (Migrated from github.com)
Review
Copy Link

rm two empty lines

rm two empty lines
Then double click the file to run it.
![Envision App Image](/img/docs/envisionappimage.png)
When you launch Envision, you will have to build a profile for your headset, check the [Envision website](https://lvra.gitlab.io/docs/fossvr/envision/) for instructions specific to what you have. You can take a look at [this section] of our Meta Quest setup video for an example using WiVRn.
![Envision Build Profile](/img/docs/envisionbuildprofile.png)
Once you have one of these options installed, a quick way to test on the headset is by running `xrgears`. [xrgears](https://gitlab.freedesktop.org/monado/demos/xrgears) is a demo that comes with Monado.
:::tip
If you run into any problems during installation, the [Meta Quest Walkthrough](quest-3-setup) may contain information helpful in regards to dependencies, firewalls and drivers.
:::
# ALVR
Another option is ALVR, you can check the GitHub repository for more information [https://github.com/alvr-org/ALVR](https://github.com/alvr-org/ALVR)
# SteamVR
If you'd like to use SteamVR, head over to [https://lvra.gitlab.io/docs/steamvr/](https://lvra.gitlab.io/docs/steamvr/), although it is not the recommended way to use VR within Linux due to poor support.

89
docs/01-get-started/04-manual.md Normal file
View File

@@ -0,0 +1,89 @@
---
nothingneko commented 2025-03-06 20:44:28 -05:00 (Migrated from github.com)
Review
Copy Link
Unlike [Telescope](Quickstart) that launches the Stardust XR server and a small selection of clients, the typical way to interact with Stardust is to first run the server, which only provides a void by default, as there are no applications or clients within it. You can then launch any combination of the clients listed below, as they are all considered separate items but can run concurrently inside Stardust.
```suggestion Unlike [Telescope](Quickstart) that launches the Stardust XR server and a small selection of clients, the typical way to interact with Stardust is to first run the server, which only provides a void by default, as there are no applications or clients within it. You can then launch any combination of the clients listed below, as they are all considered separate items but can run concurrently inside Stardust. ```
nothingneko commented 2025-03-06 20:45:03 -05:00 (Migrated from github.com)
Review
Copy Link
  Fedora and derivatives (except Enterprise Linux)
```suggestion Fedora and derivatives (except Enterprise Linux) ```
nothingneko commented 2025-03-06 20:45:13 -05:00 (Migrated from github.com)
Review
Copy Link
You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg). You can install it using this command:
```suggestion You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg). You can install it using this command: ```
nothingneko commented 2025-03-06 20:45:45 -05:00 (Migrated from github.com)
Review
Copy Link
Then, run this command to install the Stardust XR group:
```suggestion Then, run this command to install the Stardust XR group: ```
nothingneko commented 2025-03-06 20:45:54 -05:00 (Migrated from github.com)
Review
Copy Link
sudo dnf group install stardust-xr
```suggestion sudo dnf group install stardust-xr ```
nothingneko commented 2025-03-06 20:46:59 -05:00 (Migrated from github.com)
Review
Copy Link
From there, you can launch the server with `stardust-xr-server`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`.
```suggestion From there, you can launch the server with `stardust-xr-server`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`. ```
nothingneko commented 2025-03-06 20:47:25 -05:00 (Migrated from github.com)
Review
Copy Link
Make sure all of the repositories that are cloned are on the same branch (e.g. all main or all dev branch) to ensure Stardust protocol compatibility
```suggestion Make sure all of the repositories that are cloned are on the same branch (e.g. all main or all dev branch) to ensure Stardust protocol compatibility ```
nothingneko commented 2025-03-06 20:47:47 -05:00 (Migrated from github.com)
Review
Copy Link
After the server is running, you'll need to run some clients. Clone any of these, `cargo build` & then `cargo run` after the server is already running, and they will load into the Stardust server!
```suggestion After the server is running, you'll need to run some clients. Clone any of these, `cargo build` & then `cargo run` after the server is already running, and they will load into the Stardust server! ```
nothingneko commented 2025-03-06 20:47:55 -05:00 (Migrated from github.com)
Review
Copy Link
Make sure to check the list of prerequisites. Run `cargo build` and `cargo run` in the cloned repo to start the server. As stated above, the Stardust server will simply load in with a black void until clients are loaded in. This behaviour can currently be modified by creating a `startup` file inside the folder `~/.config/stardust/` to automate the loading in of clients, an example of which is shown [here](https://youtu.be/c6RyEYDz2iw?si=pL1zffNVsWocZHrc&t=788), and an example of is linked [here](https://github.com/cyberneticmelon/usefulscripts/blob/main/startup)
```suggestion Make sure to check the list of prerequisites. Run `cargo build` and `cargo run` in the cloned repo to start the server. As stated above, the Stardust server will simply load in with a black void until clients are loaded in. This behaviour can currently be modified by creating a `startup` file inside the folder `~/.config/stardust/` to automate the loading in of clients, an example of which is shown [here](https://youtu.be/c6RyEYDz2iw?si=pL1zffNVsWocZHrc&t=788), and an example of is linked [here](https://github.com/cyberneticmelon/usefulscripts/blob/main/startup) ```
nothingneko commented 2025-03-06 20:48:08 -05:00 (Migrated from github.com)
Review
Copy Link
Clone the [Stardust XR Server](https://github.com/StardustXR/server) `https://github.com/StardustXR/server`
```suggestion Clone the [Stardust XR Server](https://github.com/StardustXR/server) `https://github.com/StardustXR/server` ```
sidebar_position: 4
---
# Full Installation
Unlike [Telescope](Quickstart) that launches the Stardust XR server and a small selection of clients, the typical way to interact with Stardust is to first run the server, which only provides a void by default, as there are no applications or clients within it. You can then launch any combination of the clients listed below, as they are all considered separate items but can run concurrently inside Stardust.
<h3>
<img
src="/img/docs/Fedora_logo.svg"
alt="Fedora Logo"
style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }}
/>
<img
src="/img/docs/ultramarine-logo.svg"
alt="Ultramarine Logo"
style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }}
/>
Fedora and derivatives (except Enterprise Linux)
</h3>
:::info
You will need the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg).
[Fedora Atomic Editions](https://fedoraproject.org/atomic-desktops/) 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, run this command to install the Stardust XR group:
```
sudo dnf group install stardust-xr
```
<h3>
<img src="/img/docs/arch.png" alt="Logo" style={{ verticalAlign: 'middle', height: '1em', marginRight: '0.5em' }} />
Arch Linux
</h3>
```
paru -s stardust-xr-telescope
paru -s stardust-xr-armillary
paru -s stardust-xr-atmosphere
paru -s stardust-xr-black-hole
paru -s stardust-xr-comet
paru -s stardust-xr-flatland
paru -s stardust-xr-gravity
paru -s stardust-xr-magnetar
paru -s stardust-xr-non-spatial-input
paru -s stardust-xr-protostar
paru -s stardust-xr-server
```
From there, you can launch the server with `stardust-xr-server`, then in another terminal window or tab, run any other clients you need. We recommend `flatland` and `hexagon-launcher`.
# Manual Build
:::caution
Make sure all of the repositories that are cloned are on the same branch (e.g. all main or all dev branch) to ensure Stardust protocol compatibility
:::
### Server
Clone the [Stardust XR Server](https://github.com/StardustXR/server) `https://github.com/StardustXR/server`
Make sure to check the list of prerequisites. Run `cargo build` and `cargo run` in the cloned repo to start the server. As stated above, the Stardust server will simply load in with a black void until clients are loaded in. This behaviour can currently be modified by creating a `startup` file inside the folder `~/.config/stardust/` to automate the loading in of clients, an example of which is shown [here](https://youtu.be/c6RyEYDz2iw?si=pL1zffNVsWocZHrc&t=788), and an example of is linked [here](https://github.com/cyberneticmelon/usefulscripts/blob/main/startup)
### Clients
After the server is running, you'll need to run some clients. Clone any of these, `cargo build` & then `cargo run` after the server is already running, and they will load into the Stardust server!
Non-exhaustive list of clients:
- [**flatland**](https://github.com/StardustXR/flatland): `https://github.com/StardustXR/flatland`
3D panel UI (like window manager) for intercting with all your 2D apps
- [**protostar**](https://github.com/StardustXR/protostar): `https://github.com/StardustXR/protostar`
App launcher library and examples including futuristic Hexagon Launcher
- [**black hole**](https://github.com/StardustXR/black-hole): `https://github.com/StardustXR/black-hole`
Universal minimization of Stardust objects
- [**gravity**](https://github.com/StardustXR/gravity): `https://github.com/StardustXR/gravity`
Launch programs with a certain offset in 3D space
- [**magnetar**](https://github.com/StardustXR/magnetar): `https://github.com/StardustXR/magnetar`
Example workspaces client
- [**atmosphere**](https://github.com/StardustXR/atmosphere): `https://github.com/StardustXR/atmosphere`
3D environment with natural momentum-based movement
- [**comet**](https://github.com/StardustXR/comet): `https://github.com/StardustXR/cometAnnotate`
Write in 3D wherever you want amongst your other apps!
### Installation Script
If you have all the correct dependencies, we've created a [script](https://github.com/cyberneticmelon/usefulscripts/blob/main/stardustxr_setup.sh) that will automatically `git clone` all of the necessary repositories, `cargo build` all of them, and give them a symlinks for running the server and clients from the command line. It also creates a [config](https://github.com/cyberneticmelon/usefulscripts/blob/main/startup) file that will by default install the default `atmosphere` background. Run the script with flag `-nobg` if you don't want that.

76
docs/01-get-started/05-quest-3-setup.md Normal file
View File

@@ -0,0 +1,76 @@
---
nothingneko commented 2025-03-06 20:54:24 -05:00 (Migrated from github.com)
Review
Copy Link
Do you have a Meta Quest and would like to try Stardust for yourself? Even if you don't have any experience with Linux, this full guide will get you started with Stardust! It is recommended that you install a version of Linux called [Ultramarine](https://ultramarine-linux.org/download/). We suggest Plasma Edition due to VRR and HDR support. Once you have it installed, you will mainly be using the terminal to install what you need. Linked below is a YouTube walkthrough:
```suggestion Do you have a Meta Quest and would like to try Stardust for yourself? Even if you don't have any experience with Linux, this full guide will get you started with Stardust! It is recommended that you install a version of Linux called [Ultramarine](https://ultramarine-linux.org/download/). We suggest Plasma Edition due to VRR and HDR support. Once you have it installed, you will mainly be using the terminal to install what you need. Linked below is a YouTube walkthrough: ```
nothingneko commented 2025-03-06 20:54:56 -05:00 (Migrated from github.com)
Review
Copy Link
The setup video is done with a Meta Quest 3, and with [Ultramarine](https://ultramarine-linux.org/download/), a Fedora based distribution. Ultramarine comes with the Terra repository pre-installed. You can follow [these instructions](https://wiki.ultramarine-linux.org/en/setup/getting/) to install a version of Ultramarine.
```suggestion The setup video is done with a Meta Quest 3, and with [Ultramarine](https://ultramarine-linux.org/download/), a Fedora based distribution. Ultramarine comes with the Terra repository pre-installed. You can follow [these instructions](https://wiki.ultramarine-linux.org/en/setup/getting/) to install a version of Ultramarine. ```
nothingneko commented 2025-03-06 20:55:26 -05:00 (Migrated from github.com)
Review
Copy Link
AMD Graphics cards do not require additional drivers, but Nvidia graphics cards will need to install drivers [provided by RPMFusion](https://rpmfusion.org/Howto/NVIDIA), which can be installed with:
```suggestion AMD Graphics cards do not require additional drivers, but Nvidia graphics cards will need to install drivers [provided by RPMFusion](https://rpmfusion.org/Howto/NVIDIA), which can be installed with: ```
Owen-sz commented 2025-03-07 12:27:22 -05:00 (Migrated from github.com)
Review
Copy Link

Sometimes the guide says in, sometimes the guide says install. Should say install everywhere to be consistent.

Sometimes the guide says in, sometimes the guide says install. Should say install everywhere to be consistent.
sidebar_position: 5
---
# Meta Quest Walkthrough
Do you have a Meta Quest and would like to try Stardust for yourself? Even if you don't have any experience with Linux, this full guide will get you started with Stardust! It is recommended that you install a version of Linux called [Ultramarine](https://ultramarine-linux.org/download/). We suggest Plasma Edition due to VRR and HDR support. Once you have it installed, you will mainly be using the terminal to install what you need. Linked below is a YouTube walkthrough:
[![Youtube Tutorial](/img/docs/youtubethumb.png)](https://www.youtube.com/watch?v=Rgj9-9UwA2g)
:::info
Applies to Quest, Quest 2, Quest 3, and Quest Pro. These instructions should work on all Fedora derivatives (excluding Enterprise Linux) but you will need to download the [Terra repository](https://terra.fyralabs.com/), unless you have [Ultramarine Linux](https://ultramarine-linux.org) or [Bazzite](https://bazzite.gg).
[Fedora Atomic Editions](https://fedoraproject.org/atomic-desktops/) 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
```
The setup video is done with a Meta Quest 3, and with [Ultramarine](https://ultramarine-linux.org/download/), a Fedora based distribution. Ultramarine comes with the Terra repository pre-installed. You can follow [these instructions](https://wiki.ultramarine-linux.org/en/setup/getting/) to install a version of Ultramarine.
:::
nothingneko commented 2025-03-07 12:27:35 -05:00 (Migrated from github.com)
Review
Copy Link

rm one empty line

rm one empty line
# Nvidia & AMD
AMD Graphics cards do not require additional drivers, but Nvidia graphics cards will need to install drivers [provided by RPMFusion](https://rpmfusion.org/Howto/NVIDIA), which can be installed with:
```
sudo dnf install akmod-nvidia
```
# Envision
The next step is to install [Envision](https://lvra.gitlab.io/docs/fossvr/envision/). Envision is a GUI that makes it easier to connect and run the Quest 3 (among other headsets) with [Monado](https://monado.dev/), an open source OpenXR implementation, and [WiVRn](https://github.com/WiVRn/WiVRn), a wireless streaming implementation that also works with the Quest 3. Envision comes pre-packaged with WiVRn. Envision can be installed via:
```
sudo dnf install akmod-nvidia
```
# Vulkan Layers
If you have an Nvidia graphics card, it is possible that you will need to install [Vulkan Layers](https://gitlab.freedesktop.org/monado/utilities/vulkan-layers) for Monado, although this may not be necessary depending on the driver version:
```
sudo dnf install -y monado-vulkan-layers
```
Next, Launch Envision, and in the drop down menu on the bottom, select the **WiVRn profile** and click **Build Profile**. It'll give you a list of dependencies to install, so copy the command and run it. After they are installed, there's one extra dependency to add manually.
```
sudo dnf install libnotify-devel
```
:::note
Note that [Developer Mode](https://developers.meta.com/horizon/documentation/native/android/mobile-device-setup/) must be enabled on your Quest 3. The most streamlined way to do this is through the Meta Horizons app on [Android](https://play.google.com/store/apps/details?id=com.oculus.twilight&hl=en_US) or [iPhone](https://apps.apple.com/us/app/meta-horizon/id1366478176)
:::
# Installing WiVRn
Once that is complete, you're ready to click Build Profile within Envision. Once it's done building, you're ready to install WiVRn on the headset. Connect your headset to your computer via the Quest 3 Link cable or another compatable USB-C cable. Now that Developer Mode is enabled, you should see "Allow USB debugging", click *allow* within the headset.
With debugging enabled and the headset connected, click **Install WiVRn** within Envision to install the android apk onto the headset.
# Firewalls
Once it's installed, you'll need avahi-daemon running:
```
systemctl enable --now avahi-daemon
```
And it's possible that your firewall could prevent connection, so use the following commands to open up the ports required and reload the firewall:
```
sudo firewall-cmd --zone=public --add-port=5353/udp --permanent
sudo firewall-cmd --zone=public --add-port=9757/udp --permanent
sudo firewall-cmd --zone=public --add-port=9757/tcp --permanent
sudo firewall-cmd --reload
```
# Stardust XR
Now that we've set up the Quest 3 to be able to connect to your linux distribution via Envision/WiVRn, we can install Stardust XR!
```
sudo dnf group install stardust-xr
```
Once installed, you'll have to launch WiVRN within the headset. On the bottom right of the Quest 3 menu, go to Library > Unknown Sources, and you'll see the WiVRn app. Once you're loaded up, click the Start button at the top of Envision on your computer, and you'll be greeted with a PIN for firs time setup. Back in the Quest 3, tap Connect, and enter the PIN, and you should see "Connection ready, Start a VR application on Ultramarine"
For the quickest way to test Stardust XR, run the command
```
telescope
```
Which will launch Stardust XR along with the Hexagon App Launcher and some pre-loaded applications!

2
docusaurus.config.js
View File

@@ -4,7 +4,7 @@ const darkCodeTheme = require("prism-react-renderer/themes/vsDark");
/** @type {import('@docusaurus/types').DocusaurusConfig} */ /** @type {import('@docusaurus/types').DocusaurusConfig} */
nothingneko commented 2025-03-06 21:03:44 -05:00 (Migrated from github.com)
Review
Copy Link
	tagline: "Stardust... : \nWe Fight For the Users!",
```suggestion tagline: "Stardust... : \nWe Fight For the Users!", ```
module.exports = { module.exports = {
title: "Stardust XR", title: "Stardust XR",
tagline: "We Fight for the Users!", tagline: "Stardust... : \nWe Fight For the Users!",
url: "https://stardustxr.org", url: "https://stardustxr.org",
baseUrl: "/", baseUrl: "/",
trailingSlash: false, trailingSlash: false,

2
src/pages/index.js
View File

@@ -19,7 +19,7 @@ function HomepageHeader() {
<div className={styles.buttons}> <div className={styles.buttons}>
<Link <Link
className="button button--secondary button--lg" className="button button--secondary button--lg"
to="/docs/get-started/setup-openxr" to="/docs/get-started/What-is-Stardust"
> >
Get Started Get Started
</Link> </Link>

BIN
static/img/docs/Envision_Monado.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

10
static/img/docs/Fedora_logo.svg Normal file
View File

@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0" width="267" height="267" id="svg2">
<defs id="defs5"/>
<path d="M 266.62575,133.50613 C 266.62575,59.98128 207.02222,0.37583 133.49792,0.37583 C 60.00668,0.37583 0.42639,59.93123 0.37425,133.41225 L 0.37425,236.4333 C 0.4138,253.11763 13.94545,266.62417 30.64027,266.62417 L 133.55192,266.62417 C 207.05167,266.59532 266.62575,207.01142 266.62575,133.50613" id="voice" style="fill:#294172"/>
<path d="M 77.126289,142.09756 C 77.126289,142.09756 124.97104,142.09756 124.97104,142.09756 C 124.97104,142.09756 124.97104,189.94234 124.97104,189.94234 C 124.97104,216.35263 103.53659,237.78707 77.126289,237.78707 C 50.715979,237.78707 29.28153,216.35263 29.28153,189.94234 C 29.28153,163.53203 50.715979,142.09756 77.126289,142.09756 z" id="in" style="fill:none;stroke:#3c6eb4;stroke-width:29.21"/>
<use transform="matrix(-1,0,0,-1,249.71151,284.2882)" id="finity" xlink:href="#in"/>
<path d="M 139.6074,127.52923 L 139.6074,189.87541 C 139.6074,224.37943 111.63203,252.35541 77.12679,252.35541 C 71.89185,252.35541 68.1703,251.7644 63.32444,250.49771 C 56.25849,248.64859 50.48398,242.85518 50.48158,236.1166 C 50.48158,227.97147 56.39394,222.0467 65.23187,222.0467 C 69.43824,222.0467 70.96454,222.85435 77.12679,222.85435 C 95.3184,222.85435 110.07443,208.11916 110.10634,189.92756 L 110.10634,161.27099 C 110.10634,158.70324 108.01971,156.62274 105.44767,156.62274 L 83.78246,156.61846 C 75.71034,156.61846 69.18845,150.18003 69.18845,142.0858 C 69.18414,133.94124 75.77725,127.52923 83.93653,127.52923" id="free" style="fill:#ffffff"/>
<use transform="matrix(-1,0,0,-1,249.71152,284.28821)" id="dom" xlink:href="#free"/>
<path d="M 243.65456,243.58425 C 243.65456,243.58425 243.6546,238.05286 243.6546,238.05286 L 241.12607,243.85062 C 241.12607,243.85062 238.66466,238.05286 238.66466,238.05286 L 238.66513,243.58425 L 237.24683,243.58425 L 237.24683,234.84933 L 238.73387,234.84933 C 238.73387,234.84933 241.16784,240.42984 241.16784,240.42984 L 243.56495,234.84933 L 245.07039,234.84933 L 245.07039,243.58425 L 243.65456,243.58425 z M 233.32154,236.31241 L 233.32154,243.58425 L 231.83941,243.58425 L 231.83941,236.31241 L 229.35453,236.31241 L 229.35453,234.84933 L 235.80399,234.84933 L 235.80399,236.31241" id="TM" style="fill:#3c6eb4"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
static/img/docs/arch.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.5 KiB

BIN
static/img/docs/clients/demo_01.mp4
View File

Binary file not shown.

BIN
static/img/docs/envisionappimage.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 KiB

BIN
static/img/docs/envisionbuildprofile.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 100 KiB

120
static/img/docs/nixos.svg Normal file
View File

@@ -0,0 +1,120 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="41.759441mm"
height="36.219036mm"
viewBox="0 0 41.759441 36.219036"
version="1.1"
id="svg1"
xml:space="preserve"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg"><defs
id="defs1"><linearGradient
id="linearGradient5960"><stop
id="stop5962"
offset="0"
style="stop-color:#637ddf;stop-opacity:1" /><stop
style="stop-color:#649afa;stop-opacity:1"
offset="0.23168644"
id="stop5964" /><stop
id="stop5966"
offset="1"
style="stop-color:#719efa;stop-opacity:1" /></linearGradient><linearGradient
y2="515.97058"
x2="282.26105"
y1="338.62445"
x1="213.95642"
gradientTransform="translate(983.36076,601.38885)"
gradientUnits="userSpaceOnUse"
id="linearGradient5855"
xlink:href="#linearGradient5960" /></defs><g
id="layer1"
transform="translate(-58.258978,-103.52501)"><g
id="g1"
transform="matrix(0.08323529,0,0,0.08323529,25.787204,112.98814)"><g
id="layer6"
style="display:none"
transform="translate(-132.5822,958.04022)"><rect
y="-958.02759"
x="132.65129"
height="484.30399"
width="550.41602"
id="rect5379"
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5c201e;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" /><rect
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#c24a46;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
id="rect5372"
width="501.94415"
height="434.30405"
x="156.12303"
y="-933.02759" /><rect
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#d98d8a;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
id="rect5381"
width="24.939611"
height="24.939611"
x="658.02826"
y="-958.04022" /></g><g
id="layer1-7"
style="display:inline"
transform="translate(233.78153,819.49931)"><path
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5277c3;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
d="m 309.40365,-710.2521 122.19683,211.6751 -56.15706,0.5268 -32.6236,-56.8692 -32.85645,56.5653 -27.90237,-0.011 -14.29086,-24.6896 46.81047,-80.4902 -33.22946,-57.8256 z"
id="path4861" /><path
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#7ebae4;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
d="m 353.50926,-797.4433 -122.21756,211.6631 -28.53477,-48.37 32.93839,-56.6875 -65.41521,-0.1719 -13.9414,-24.1698 14.23637,-24.721 93.11177,0.2939 33.46371,-57.6903 z"
id="use4863" /><path
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#7ebae4;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
d="m 362.88537,-628.243 244.41439,0.012 -27.62229,48.8968 -65.56199,-0.1817 32.55876,56.7371 -13.96098,24.1585 -28.52722,0.032 -46.3013,-80.7841 -66.69317,-0.1353 z"
id="use4865" /><path
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#7ebae4;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
d="m 505.14318,-720.9886 -122.19683,-211.6751 56.15706,-0.5268 32.6236,56.8692 32.85645,-56.5653 27.90237,0.011 14.29086,24.6896 -46.81047,80.4902 33.22946,57.8256 z"
id="use4867" /><path
id="path4873"
d="m 309.40365,-710.2521 122.19683,211.6751 -56.15706,0.5268 -32.6236,-56.8692 -32.85645,56.5653 -27.90237,-0.011 -14.29086,-24.6896 46.81047,-80.4902 -33.22946,-57.8256 z"
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5277c3;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" /><path
id="use4875"
d="m 451.3364,-803.53264 -244.4144,-0.012 27.62229,-48.89685 65.56199,0.18175 -32.55875,-56.73717 13.96097,-24.15851 28.52722,-0.0315 46.3013,80.78414 66.69317,0.13524 z"
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5277c3;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" /><path
id="use4877"
d="m 460.87178,-633.8425 122.21757,-211.66304 28.53477,48.37003 -32.93839,56.68751 65.4152,0.1718 13.9414,24.1698 -14.23636,24.7211 -93.11177,-0.294 -33.46371,57.6904 z"
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#5277c3;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" /><g
id="layer2"
style="display:none"
transform="translate(72.039038,-1799.4476)"><path
d="M 460.60629,594.72881 209.74183,594.7288 84.309616,377.4738 209.74185,160.21882 l 250.86446,1e-5 125.43222,217.255 z"
id="path6032"
style="color:#000000;display:inline;overflow:visible;visibility:visible;opacity:0.236;fill:#4e4d52;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;enable-background:accumulate" /><path
transform="translate(0,-308.26772)"
style="color:#000000;display:inline;overflow:visible;visibility:visible;opacity:1;fill:#4e4d52;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;enable-background:accumulate"
id="path5875"
d="m 385.59154,773.06721 -100.83495,0 -50.41747,-87.32564 50.41748,-87.32563 100.83495,10e-6 50.41748,87.32563 z" /><path
transform="translate(0,-308.26772)"
id="path5851"
d="m 1216.5591,938.53395 123.0545,228.14035 -42.6807,-1.2616 -43.4823,-79.7725 -39.6506,80.3267 -32.6875,-19.7984 53.4737,-100.2848 -37.1157,-73.88955 z"
style="fill:url(#linearGradient5855);fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /><rect
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:0.415;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#c53a3a;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
id="rect5884"
width="48.834862"
height="226.22897"
x="-34.74221"
y="446.17056"
transform="rotate(-30)" /><path
transform="translate(0,-308.26772)"
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:0.509;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:3;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
id="path3428"
d="m 251.98568,878.63831 -14.02447,24.29109 h -28.04894 l -14.02447,-24.29109 14.02447,-24.2911 h 28.04894 z" /><use
x="0"
y="0"
xlink:href="#rect5884"
id="use4252"
transform="rotate(60,268.29786,489.4515)"
width="100%"
height="100%" /><rect
style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#000000;fill-opacity:0.650794;fill-rule:evenodd;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
id="rect4254"
width="5.3947482"
height="115.12564"
x="545.71014"
y="467.07007"
transform="rotate(30,575.23539,-154.13386)" /></g></g></g></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
static/img/docs/sizzlethumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 146 KiB

12
static/img/docs/ultramarine-logo.svg Normal file
View File

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<svg id="svg5" version="1.1" viewBox="0 0 224 224" xmlns="http://www.w3.org/2000/svg">
<defs id="defs1">
<style id="style1">.cls-1{fill:#00078f;fill-rule:evenodd;}.cls-2{fill:#fdfdff;}</style>
</defs>
<g id="layer1">
<g id="surface85753">
<path id="path1984" class="cls-1" transform="translate(0)" d="M112,0A112,112,0,1,1,0,112,112,112,0,0,1,112,0"/>
<path id="path1986" class="cls-2" transform="translate(0)" d="m206.49 147.8c-16.67-3.84-33-9.53-44.13-16-30.51-17.8-41.07-56.65-84.1-42.2 34 39.65-23 52-61.64 55.76a101 101 0 0 0 189.87 2.44"/>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 616 B

BIN
static/img/docs/youtubethumb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 121 KiB

6
yarn.lock
View File

@@ -3004,9 +3004,9 @@ caniuse-api@^3.0.0:
lodash.uniq "^4.5.0" lodash.uniq "^4.5.0"
caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001646: caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001646:
version "1.0.30001651" version "1.0.30001701"
resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001651.tgz#52de59529e8b02b1aedcaaf5c05d9e23c0c28138" resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001701.tgz"
integrity sha512-9Cf+Xv1jJNe1xPZLGuUXLNkE1BoDkqRqYyFJ9TDYSqhduqA4hu4oR9HluGoWYQC/aj8WHjsGVV+bwkh0+tegRg== integrity sha512-faRs/AW3jA9nTwmJBSO1PQ6L/EOgsB5HMQQq4iCu5zhPgVVgO/pZRHlmatwijZKetFw8/Pr4q6dEN8sJuq8qTw==
ccount@^1.0.0: ccount@^1.0.0:
version "1.1.0" version "1.1.0"