3. DataBridge Documentation

DataBridge Documentation

Welcome to the DataBridge documentation.

DesktopXR DataBridge is an application used to send data into the DesktopXR heads up display. DataBridge is fully configured through a simple .ini file.

This guide explains how to configure the DesktopXR DataBridge.

---

Quick Start

Step 1 — Create the ini file

Launch a VR game using DesktopXR ensuring HUD is enabled

DesktopXR-DataBridge.ini will be created in %appdata%\DesktopXR

---

Step 2 — Edit the configuration file

Open:

DesktopXR-DataBridge.ini

with Notepad or any text editor.

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

If the file does not exist yet, DataBridge will create it automatically on first launch.

---

Example configuration

The file looks like this:

[DataBridge]
enabled=1
refresh_rate_hz=4

[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]
enabled=1
hotkey=CTRL+ALT+F12

---

OBS configuration

Obtain OBS websocket password

Start OBS and select Websocket Server Settings from the Tools menu

Select Show Connect Info

Copy Server Password

Paste into DesktopXR-DataBridge.ini after password= within the OBS section

Example:

password=xxxxxxxxxxxxxxxx

---

YouTube Live configuration

Create YouTube API Key

Visit https://console.cloud.google.com and login with your Google account

Select APIs and services > Library from the hamburger menu

Search for YouTube Data API v3 and then click Enable

Select Credentials > Create credentials > API key from the Manage YouTube Data API v3 page

Enter a name for the API key (eg. DesktopXR-DataBridge)

Select Create

Configure YouTube API Key Password

Select Show Key next to your API

Copy Password

Paste into DesktopXR-DataBridge.ini after apikey= within the YT section

Example:

apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Live viewers and messages

Once you have set up your youtube live stream, enter the URL in the DesktopXR-DataBridge.ini

Example:

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

Google Cloud credits

You have 10,000 free YouTube Data API v3 credits per day. Each API request for 'Live viewers' and 'Chat messages' costs 1 credit each.

The default API polling is every 4 seconds, meaning 2 credits used every 4 seconds giving you 5 hours 33 minutes 20 seconds per day.

You can change the API polling in the DesktopXR-DataBridge.ini as you see fit.

Example:

polling=8

---

Audio Switch

To make switching audio output devices easier while gaming in VR, DesktopXR lets you assign a keybind that cycles through all available Windows audio devices.

Set the keybind in DesktopXR-DataBridge.ini, then enable the Desktop toggle and make sure your game is not selected. Once that is done, press the keybind to switch between audio devices.