XBVR Documentation

You can sync specific filtered views from XBVR directly to the DeoVR player:

1. On the XBVR scenes page, create a filter (e.g., by cast, site, or tags) and define a sort order.
2. Create a "saved search" (using the control in the top left).
3. Check the option "use as DeoVR list".
4. The search will now appear as a list inside the DeoVR application.

After launching XBVR, access the web UI at http://127.0.0.1:9999. Follow these steps to set up your library:

1. Scrape Scene Metadata: Navigate to Options -> Scene Data and click "Run scraper". This process populates the library with titles, tags, and cast information and may take several minutes.
2. Add Video Folders: Once the scraper finishes, go to Options -> Folders and add the directories where your video files are stored.

Once configured, your media will be available in the web UI and via the built-in DLNA server for compatible VR players (e.g., Pigasus, Skybox, Mobile Station VR).

To develop on XBVR locally, ensure you have the following installed:

• Go 1.24
• Node.js 22.x
• Yarn 1.17.x
• air (Install via go install github.com/cosmtrek/air@latest outside the project directory)

Once dependencies are installed, run the following command from the project directory to launch file-watchers for live-reloading both Go and JavaScript code:

yarn dev

XBVR is available as a Docker image via the GitHub Container Registry. When running in Docker, your video files must be mounted to the /videos path inside the container. You must then configure this path in the XBVR web UI under Options -> Folders.

To run the container, use the following command. Adding the -d flag will run the container in the background (detached mode).

docker run -t --name=xbvr --net=host --restart=always \
   --mount type=bind,source=/path/to/your/videos,target=/videos \
   --mount source=xbvr-config,target=/root/.config/ \
   ghcr.io/xbapps/xbvr:latest

The XBVR system tray application is the primary entrypoint for the desktop version of the application. It manages a single instance of the process using single.New("xbvr") to prevent multiple concurrent runs. When started, it initializes a background server and provides a system tray menu for interacting with the application.

Key features provided via the tray menu:

• Open UI: Opens the web interface in the default system browser at http://localhost:<port> (where <port> is defined in the application configuration).
• Open config folder: Opens the application's data directory (common.AppDir).
• Open log file: Opens the xbvr.log file located in the application's data directory.
• Quit: Terminates the application and the background server.

go run pkg/tray/main.go

The pluginOptions.i18n object allows you to configure internationalization settings for the Vue application.

Available keys:

• locale: The default locale used by the application (e.g., 'en_GB').
• fallbackLocale: The locale to use when a translation is missing in the current locale.
• localeDir: The directory containing locale files (e.g., 'locales').
• enableInSFC: Boolean determining whether to enable i18n features within Single File Components.

pluginOptions: {
  i18n: {
    locale: 'en_GB',
    fallbackLocale: 'en_GB',
    localeDir: 'locales',
    enableInSFC: false
  }
}

Use these shortcuts to navigate the XBVR web interface efficiently.

Global

• ?: Quick Find

Details Pane

• o: Previous scene
• p: Next scene
• e: Edit scene
• w: Toggle watchlist
• f: Toggle favourite
• W: Toggle Watched status (Capital W)
• g: Toggle gallery / video window
• esc: Close details pane
• left arrow: Cycle backwards in gallery / skip backwards in video
• right arrow: Cycle forward in gallery / skip forward in video

File Match Pane

• o: Previous file
• p: Next file
• left arrow: Next page of search results
• right arrow: Previous page of search results
• esc: Close matching pane

Actor List

• o or left arrow: Previous page of actors
• p or right arrow: Next page of actors

Actor Details

• o: Previous actor
• p: Next actor
• left arrow: Cycle backwards in gallery
• esc: Close details pane

The StartServer function is the primary entrypoint for initializing and running the XBVR server. It performs several critical setup steps: loading configuration, copying data files, running database migrations (both synchronously and in the background), checking dependencies, initializing sites, and setting up the API, static file serving, image proxying, and WebSocket/WAMP routing. It also starts background tasks like the DLNA server (if enabled) and the DeoVR remote session.

// version, commit, branch, and date are build metadata strings
server.StartServer("0.4.39", "commit_hash", "main", "2026-07-03")