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

Docs updates

Browse Source
This commit is contained in:
technobaboo
2021-08-12 06:09:40 -05:00
parent cd34d3a2b8
commit db730a7f5a
5 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/getting-started/install.md
View File

@@ -6,6 +6,9 @@ sidebar_position: 2
## [libstardustxr](https://github.com/StardustXR/libstardustxr) (server, client, and fusion)
### Packages
AUR: `libstardustxr` and `libstardustxr-fusion`
### Build system
1. Meson >= 0.55.0
2. Ninja (tested on 1.10.2)
@@ -33,6 +36,9 @@ ninja install
## [stardust-xr](https://github.com/StardustXR/stardust-xr) (reference server)
### Packages
AUR: `stardust-xr`
### Build system
1. Meson >= 0.55.0
2. Ninja (tested on 1.10.2)

13
docs/getting-started/run.md
View File

@@ -5,6 +5,19 @@ sidebar_position: 3
# Use
## Server
The server has a flatscreen mode where it pops open a window for you to interact on a 2D screen and XR mode where it becomes an OpenXR client.
### Images
Flatscreen mode upon initial startup:
![A pitch black window representing Stardust in flatscreen mode](/img/docs/run/flatscreen_1.png)
XR mode when OpenXR somehow fails:
![A black void representing Stardust in XR mode with a hand skeleton in the middle](/img/docs/run/flatscreen_2.png)
Flatscreen mode when `~/.config/stardust/skytex.hdr` is [Zhengyang Gate](https://polyhaven.com/a/zhengyang_gate):
![A pitch black window representing Stardust in flatscreen mode](/img/docs/run/flatscreen_3.png)
### Help screen
```
Stardust XR