Skip to content

Extensions

Extensions are the supported way to add third-party functionality to vrOS. An extension is a folder containing:

  • extension.toml (manifest)
  • One or more service executables (optional)
  • Optional assets for the extension UI

Where vrOS Looks For Extensions

Search roots (in order):

  1. VROS_EXTENSIONS_DIR (path list; ; on Windows, : elsewhere)
  2. <install>/extensions, <install>/plugins
  3. <cwd>/extensions, <cwd>/plugins

Within a search root, vrOS looks for:

  • <root>/*.toml
  • <root>/<id>/extension.toml

Install An Extension

  1. Create a folder under an extension search root, for example: <install>/extensions/my-extension/
  2. Copy your extension.toml and any binaries into that folder.
  3. Restart vrOS (or refresh extensions from the UI if supported).
  4. Open Desktop Control CenterExtensions and confirm it was discovered.

Example: hello-extension

This repo includes a starter template at sdk/hello-extension/. It builds a small service and exposes a WebView tab in vros-tools and vros-desktop.