reorder: everythinggg
This commit is contained in:
37
docs/01-get-started/01-setup-openxr.md
Normal file
37
docs/01-get-started/01-setup-openxr.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
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.
|
||||
|
||||
# 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.
|
||||
30
docs/01-get-started/02-bundled.md
Normal file
30
docs/01-get-started/02-bundled.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
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
|
||||
```sh
|
||||
nix run github:StardustXR/telescope
|
||||
```
|
||||
|
||||
## Non-nix
|
||||
|
||||
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
Normal file
26
docs/01-get-started/03-manual.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
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:
|
||||

|
||||
|
||||
Non-exhaustive list of clients:
|
||||
- [**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): 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!
|
||||
4
docs/01-get-started/_category_.json
Normal file
4
docs/01-get-started/_category_.json
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Get Started",
|
||||
"position": 1
|
||||
}
|
||||
Reference in New Issue
Block a user