Skip to main content

​
Overview

boofstream integrates with OBS Studio via the WebSocket plugin to automatically switch scenes based on game state. When a match starts, boofstream can switch to your game scene, and when it ends, switch back to your crowd cam or other scene.

​
Prerequisites

  • OBS Studio installed
  • OBS WebSocket plugin (v5.0+) installed and enabled
  • OBS running before connecting boofstream

​
Configuration Options

obs: {
  doSwitch: false,              // Enable automatic scene switching
  host: "127.0.0.1:4455",       // OBS WebSocket host and port
  password: "",                 // WebSocket password (if configured)
  noGameScene: "Crowd Cam",     // Scene to show when no game is active
  gameScene: "Melee"            // Scene to show during matches
}

​
Setup Steps

1

Enable OBS WebSocket

In OBS Studio:
  1. Go to Tools → WebSocket Server Settings
  2. Check Enable WebSocket server
  3. Note the Server Port (default is 4455)
  4. Set a password if desired (recommended for networked setups)
  5. Click OK
2

Configure boofstream

In the boofstream manager, navigate to OBS settings:Host: Enter the host and port in the format 127.0.0.1:4455
  • For local OBS: 127.0.0.1:4455
  • For networked OBS: 192.168.1.100:4455 (use your OBS computer’s IP)
Password: Enter the WebSocket password if you configured one
Leave the password field empty if you didn’t set a password in OBS.
3

Configure scene names

Set the scene names to match your OBS configuration:Game Scene: The scene to display during active matches (e.g., “Melee”, “Game”, “Gameplay”)No Game Scene: The scene to display when no match is active (e.g., “Crowd Cam”, “Waiting”, “Intermission”)
Scene names are case-sensitive and must match exactly as they appear in OBS.
4

Enable automatic switching

Check the Enable scene switching option to activate automatic scene changes.When disabled, boofstream will maintain the connection but won’t switch scenes.
5

Connect to OBS

Click Connect to OBS in the boofstream manager. The connection status will update when successfully connected.

​
Scene Switching Behavior

​
Game Start

When a Melee match begins (detected via Slippi connection):
  • boofstream switches to the configured Game Scene
  • The overlay shows live game data

​
Game End

When a match completes:
  • boofstream switches to the configured No Game Scene
  • Scores are automatically updated if auto-tracking is enabled

​
LRAS Detection

If a match is ended via LRAS (L+R+A+Start):
  • No score is recorded
  • Scene switches to the No Game Scene
  • The match is treated as cancelled

​
Connection Format

The OBS WebSocket connection uses the format: 
ws://[host]:[port]
Examples:
  • Local: ws://127.0.0.1:4455
  • Network: ws://192.168.1.100:4455
boofstream automatically adds the ws:// prefix. You only need to enter the host and port.

​
Security Considerations

​
Password Protection

For local setups, a password is optional but recommended if:
  • Multiple people have access to your network
  • You’re running OBS on a shared computer
For networked setups, always use a password to prevent unauthorized scene switching.

​
Network Access

If running boofstream and OBS on different computers:
  1. Ensure both computers are on the same network
  2. Configure your firewall to allow connections on the WebSocket port
  3. Use the OBS computer’s local IP address in the host field

​
Testing the Connection

1

Verify connection status

After clicking Connect to OBS, check that the status shows “Connected”.
2

Manual scene test

In OBS, manually switch to a different scene, then start a test game in Slippi. boofstream should automatically switch to your configured game scene.
3

End game test

End the test match. OBS should switch back to your no-game scene.
Create a dedicated scene for testing to avoid disrupting your production scenes during setup.

​
Troubleshooting

For connection issues, see the OBS Connection Troubleshooting guide.

Build docs developers (and LLMs) love

Get started for freeTalk to us