From 284dd9d540530c8591a2cec7d183fece5b39a058 Mon Sep 17 00:00:00 2001 From: MayaTheShy Date: Sun, 9 Nov 2025 16:59:42 -0500 Subject: [PATCH] docs: enhance README with clearer instructions for StardustXR server requirements --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e9c25e..0b8fd5c 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,19 @@ Starworld is an [Overte](https://overte.org) client that renders virtual world e - CMake 3.15+ - C++20 compiler (GCC/Clang) - Rust toolchain (for the bridge) -- StardustXR server running +- **StardustXR server running** (required!) - 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 ```bash ./scripts/build_and_test.sh