Skip to main content
The BoofConfig type contains all configuration settings for boofstream, including Slippi connection, OBS WebSocket, start.gg integration, and customization options.

Type Definition

type BoofConfig = {
    slippi: SlippiConfig,
    obs: OBSConfig,
    startgg: StartGGConfig,
    customization: CustomizationConfig,
}

Fields

slippi
SlippiConfig
required
Configuration for Slippi Desktop App connection
obs
OBSConfig
required
Configuration for OBS WebSocket connection and scene switching
startgg
StartGGConfig
required
Configuration for start.gg API integration
customization
CustomizationConfig
required
Overlay customization options including colors and display preferences

Sub-Configuration Types

SlippiConfig

type SlippiConfig = {
    port: number,
}
port
number
required
Port number for Slippi Desktop App relay connection (default: 51441)

OBSConfig

type OBSConfig = {
    doSwitch: boolean,
    host: string,
    password: string,
    noGameScene: string,
    gameScene: string,
}
doSwitch
boolean
required
Whether to automatically switch OBS scenes based on game state
host
string
required
OBS WebSocket host address (e.g., “localhost:4455”)
password
string
required
OBS WebSocket password
noGameScene
string
required
Scene name to switch to when no game is active
gameScene
string
required
Scene name to switch to when a game is in progress

StartGGConfig

type StartGGConfig = {
    token: string,
    tournamentUrl: string,
}
token
string
required
start.gg API authentication token
tournamentUrl
string
required
Full URL to the start.gg tournament (e.g., “https://start.gg/tournament/genesis-9”)

CustomizationConfig

type CustomizationConfig = {
    appendLToLosers: boolean,
    player1Color: string,
    player2Color: string,
}
appendLToLosers
boolean
required
Whether to append “L” prefix to match identifiers for players in losers bracket
player1Color
string
required
CSS color value for player 1 overlay elements
player2Color
string
required
CSS color value for player 2 overlay elements

Build docs developers (and LLMs) love