Files
Starworld/README.md
2025-11-08 13:39:53 -05:00

27 lines
870 B
Markdown

# Starworld (StardustXR + Overte client)
## Rust bridge (optional)
This project can load a Rust bridge shared library exposing a C ABI to the StardustXR client. Build it with:
```bash
cd bridge
cargo build
```
This produces `bridge/target/debug/libstardust_bridge.so`. The app will try to load it automatically at startup. You can also set an explicit path:
```bash
export STARWORLD_BRIDGE_PATH=./bridge/target/debug/libstardust_bridge.so
```
If the bridge is not present, the app falls back to a stub and (previously) attempted raw sockets; with the bridge present it will initialize via the official client crates.
## Overte
Overte connectivity is optional; if unreachable, the client runs in offline mode and logs a warning.
## CLI
- `--socket=/path/to.sock` (legacy attempt)
- `--abstract=name` (legacy abstract socket attempt)
Prefer using the Rust bridge.