Files
website/docs/getting-started/run.md
technobaboo db730a7f5a Docs updates
2021-08-12 06:09:40 -05:00

31 lines
969 B
Markdown

---
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
Usage: stardustxr [OPTIONS]
Options:
-h,--help Print this help message and exit
-F,--flatscreen Run Stardust in flatscreen mode
--field-debug Draw translucent meshes around fields
```