MayaTheShy/Starworld
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: enhance README with clearer instructions for StardustXR server requirements

Browse Source
This commit is contained in:
MayaTheShy
2025-11-09 16:59:42 -05:00
parent 902c875f78
commit 284dd9d540
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -31,9 +31,19 @@ Starworld is an [Overte](https://overte.org) client that renders virtual world e
- CMake 3.15+ - CMake 3.15+
- C++20 compiler (GCC/Clang) - C++20 compiler (GCC/Clang)
- Rust toolchain (for the bridge) - Rust toolchain (for the bridge)
- StardustXR server running - **StardustXR server running** (required!)
- Required libraries: glm, OpenSSL, zlib, libcurl - Required libraries: glm, OpenSSL, zlib, libcurl
**Important**: The application will exit if no StardustXR compositor is detected. Make sure to start the Stardust server first:
```bash
# Start StardustXR server (in a separate terminal)
stardust-xr-server
# Or as a systemd service
systemctl --user start stardust
```
### Build Everything ### Build Everything
```bash ```bash
./scripts/build_and_test.sh ./scripts/build_and_test.sh