Skip to content

3. DataBridge Documentation

Jump to bottom
Glen Harrison edited this page May 4, 2026 · 14 revisions

hud-1200

DataBridge Documentation

DesktopXR DataBridge is an application that sends external data into the DesktopXR heads up display.

DataBridge is configured through a simple .ini file.

This page explains where the configuration file is stored, how to edit it, and what each setting controls.

Quick Start

1. Create the configuration file

Launch a VR game with DesktopXR running and the HUD enabled.

DataBridge will create the following file automatically:

%appdata%\DesktopXR\DesktopXR-DataBridge.ini

2. Edit the configuration file

Open:

DesktopXR-DataBridge.ini

Use Notepad or any other text editor.

After saving changes, restart the DataBridge application for the new settings to take effect.

If DesktopXR-DataBridge.ini does not exist yet, DataBridge will create it automatically the first time it launches.

Example Configuration

[DataBridge]
refresh_rate_hz=4
gpu=%
cpu=%

[OBS]
enabled=1
host=127.0.0.1
port=4455
password=xxxxxxxxxxxxxxxx

[YT]
enabled=1
apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
videourl=https://youtube.com/live/xxxxxxxxxx
polling=4
livechat=1

[AudioSwitch]
hotkey=CTRL+ALT+F12

Settings Reference

DataBridge

refresh_rate_hz

Controls how often DataBridge samples and writes telemetry into shared memory.

Higher values update the HUD more frequently.

Default:

refresh_rate_hz=4

Example:

refresh_rate_hz=8

gpu

Controls how GPU performance values are displayed in the DesktopXR HUD.

Valid values:

Value Description
% Show GPU usage as a percentage.
ms Show GPU frametime-style values, where lower values indicate faster frame processing.

Default:

gpu=%

Example:

gpu=ms

cpu

Controls how CPU performance values are displayed in the DesktopXR HUD.

Valid values:

Value Description
% Show CPU usage as a percentage.
ms Show CPU frametime-style values, where lower values indicate faster frame processing.

Default:

cpu=%

Example:

cpu=ms

OBS

enabled

Enables or disables OBS integration.

Valid values:

Value Description
0 Disabled
1 Enabled

Default:

enabled=1

Example:

enabled=0

host

Sets the OBS WebSocket host address.

For OBS running on the same PC as DataBridge, use 127.0.0.1.

Default:

host=127.0.0.1

port

Sets the OBS WebSocket port.

Default:

port=4455

password

Sets the OBS WebSocket server password.

Example:

password=xxxxxxxxxxxxxxxx

Obtain the OBS WebSocket password

  1. Start OBS.

  2. Open the Tools menu.

  3. Select WebSocket Server Settings.

  4. Select Show Connect Info.

  5. Copy the server password.

  6. Paste it into DesktopXR-DataBridge.ini after password= in the [OBS] section.

Example:

[OBS]
password=xxxxxxxxxxxxxxxx

YouTube Live

enabled

Enables or disables YouTube Live integration.

Valid values:

Value Description
0 Disabled
1 Enabled

Default:

enabled=1

Example:

enabled=0

apikey

Sets the YouTube Data API v3 key used by DataBridge.

Example:

apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

videourl

Sets the YouTube Live stream URL used for live viewer and chat data.

Example:

videourl=https://youtube.com/live/xxxxxxxxxx

polling

Controls how often DataBridge polls the YouTube Data API.

The value is in seconds.

Default:

polling=4

Example:

polling=8

livechat

Enables or disables YouTube Live chat data.

Valid values:

Value Description
0 Disabled
1 Enabled

Default:

livechat=1

Example:

livechat=0

Create a YouTube API key

  1. Visit:

    https://console.cloud.google.com

  2. Sign in with your Google account.

  3. Open the hamburger menu.

  4. Select APIs and services.

  5. Select Library.

  6. Search for:

    YouTube Data API v3

  7. Select Enable.

  8. From the YouTube Data API v3 page, select Credentials.

  9. Select Create credentials.

  10. Select API key.

  11. Enter a name for the API key.

    Example:

    DesktopXR-DataBridge

  12. Select Create.

Configure the YouTube API key

  1. In Google Cloud Console, open your API key.

  2. Select Show key.

  3. Copy the API key.

  4. Paste it into DesktopXR-DataBridge.ini after apikey= in the [YT] section.

Example:

[YT]
apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Configure live viewers and chat

After setting up your YouTube Live stream, add the stream URL to DesktopXR-DataBridge.ini.

Example:

[YT]
videourl=https://youtube.com/live/xxxxxxxxxx

To enable live chat data:

[YT]
livechat=1

Google Cloud credits

YouTube Data API v3 provides 10,000 free quota units per day by default.

Each API request for live viewers and chat messages uses quota.

With the default polling interval of 4 seconds, DataBridge checks for updates every 4 seconds.

You can reduce quota usage by increasing the polling interval.

Example:

polling=8

Audio Switch

hotkey

Sets the keybind used to cycle through available Windows audio output devices.

Default:

hotkey=CTRL+ALT+F12

Example:

hotkey=CTRL+ALT+F11

Using Audio Switch

Audio Switch is designed to make changing audio output devices easier while gaming in VR.

To use it:

  1. Set the keybind in DesktopXR-DataBridge.ini.

  2. Enable the Desktop toggle in DesktopXR.

  3. Make sure your game is not selected.

  4. Press the configured hotkey to cycle through available Windows audio output devices.

Supported Keys

DataBridge supports standard keyboard keys.

Supported modifiers:

SHIFT
CTRL
ALT

Supported keys:

F1-F12
A-Z
0-9
Escape
Insert
Delete
Home
End
PageUp
PageDown

Avoid keys already used by your VR software, OpenXR runtime, simulator, game, OBS, or streaming software.

Troubleshooting

If a setting does not appear to work:

  1. Confirm the file is named exactly:

    DesktopXR-DataBridge.ini

  2. Confirm the file is located in:

    %appdata%\DesktopXR

  3. Save the file after editing.

  4. Restart the DataBridge application.

  5. Restart your OpenXR application if HUD data does not update.

  6. Reboot your PC if the setting still does not apply.

If OBS data does not appear:

  1. Confirm OBS is running.

  2. Confirm OBS WebSocket is enabled.

  3. Confirm host, port, and password are correct.

  4. Confirm the [OBS] section has:

    enabled=1

If YouTube Live data does not appear:

  1. Confirm the YouTube Data API v3 is enabled.

  2. Confirm the API key is correct.

  3. Confirm the live stream URL is correct.

  4. Confirm the [YT] section has:

    enabled=1

  5. Increase polling if you are reaching your API quota limit.

Reset to Defaults

To reset DataBridge to its default configuration, delete:

%appdata%\DesktopXR\DesktopXR-DataBridge.ini

DataBridge will recreate the file with default settings the next time it launches.

Clone this wiki locally