Developer
WebSocket API
Commands
Settings

Settings

SetXSOverlaySystemSetting

jsonData{ internalName, value }

Changes a global setting. internalName is a key from RequestGetSettings. value is always a string, such as "true", "0.5", or a dropdown option index like "2".

send('SetXSOverlaySystemSetting', { jsonData: { internalName: 'UseDarkTheme', value: 'false' } });

RequestGetSettings

ResponseUpdateSettings

Every global setting, keyed by its internal name. See Settings for what each one does.

on('UpdateSettings', (settings) => console.log('Dark theme:', settings.UseDarkTheme));
send('RequestGetSettings');

Percent sliders are 0 – 1, and dropdowns are the option's index:

KeyValues
DominantHand0 Right, 1 Left
InputMethod0 Touch Input, 1 Emulate Mouse
KeyboardFormat0 Compact, 1 Minimal, 2 Full
CaptureMethod0 WGC, 1 BitBlt
WindowSwitchSizePreservation0 Height, 1 Width, 2 Automatic
AimTarget0 Mixed, 1 HMD, 2 Controller
DateFormat0 DD / MM / YY, 1 MM / DD / YY, 2 YY / MM / DD
InputBlockingBehavior0 Hover, 1 Layout Mode

AccentColor is { r, g, b, a }. NotificationOffsets, WristOffsets and WristRotation are { x, y, z }. WristToolbarButtons maps each button name to true or false.

RequestThemeUpdate

ResponseUpdateTheme

Colors are RRGGBBAA hex strings without #.

on('UpdateTheme', (theme) => {
  document.body.style.background = `#${theme.Dark}`;
  document.body.style.color = `#${theme.Contrast}`;
});
send('RequestThemeUpdate');
Response
{
  ThemeType: number     // 0 None, 1 Standard, 2 Media
  UseMediaTheme: boolean
  Hi: string
  Mid: string
  Dark: string
  Contrast: string
  Error: string
  Warning: string
  Confirm: string
  Accent: string
  AccentBright: string
}

RequestUpdatedLanguageList

ResponseUpdateLanguageList

Maps each language's display name to its file path.

on('UpdateLanguageList', (languages) => console.log(Object.keys(languages)));
send('RequestUpdatedLanguageList');

RequestUpdatedLanguageMap

ResponseUpdateLanguageMap

Every UI string in the current language, keyed by translation key. Missing strings fall back to English.

on('UpdateLanguageMap', (strings) => console.log(strings.Settings));
send('RequestUpdatedLanguageMap');

OpenSteamVRBindings

Opens the SteamVR bindings page for XSOverlay.

send('OpenSteamVRBindings');