SDK Overview¶
The vrOS SDK is for building Rust components that connect to the vrOS Director and interact with vrOS services and overlays.
What You Can Build¶
- Out-of-process extensions: ship a service + optional UI tabs (WebView) that appear in
vros-toolsand/orvros-desktop. - Native VR overlays: build a full overlay process that renders UI in VR and talks to the Director and other services.
Core Pieces (In This Repo)¶
crates/catnet-sdk: helpers for connecting + registering with the Director (VROS_BUS, defaultvros-bus).crates/vros-extensions: TOML manifest format (extension.toml) + discovery rules.crates/vros-overlay-builder: overlay framework that manages VR-thread ownership + dashboard negotiation.
Start Here¶
- Quickstart: connect to the Director
- Extensions:
extension.toml+ packaging - Native overlays with
vros-overlay-builder - SDK reference (env vars, directories)
Examples¶
- Template extension:
sdk/hello-extension/ - Reference overlay:
crates/vros-chat/