Skip to main content

​
Overview

boofstream connects to the Slippi console relay to receive real-time game data during matches. This enables automatic character detection, score tracking, and scene switching based on game state.

​
Configuration

The Slippi connection uses a single port configuration option: 
slippi: {
  port: 53742  // Default Slippi relay port
}

​
Connection Flow

1

Configure the port

In the boofstream manager interface, navigate to the Slippi settings. The default port is 53742, which matches the standard Slippi console relay port.
Only change this port if you’ve configured your Slippi relay to use a different port.
2

Start the Slippi relay

Ensure your Slippi console relay is running and broadcasting on the configured port. The relay should be set to:
  • Host: 127.0.0.1 (localhost)
  • Port: 53742 (or your custom port)
3

Connect in boofstream

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

Verify connection

Once connected, boofstream will display the connection status. Start a game on your console to verify data is flowing correctly.

​
What Data is Captured

When connected, boofstream automatically receives:
  • Player ports: Port assignments for both players
  • Characters: Character selection and color/costume
  • Stocks remaining: Real-time stock counts during matches
  • Stage: Current stage being played
  • Game results: Match outcomes, duration, and stocks remaining
  • Character transformations: Automatic detection of Zelda/Sheik transformations

​
Connection States

​
Connected

boofstream is actively receiving data from the Slippi relay. Game state updates will flow automatically.

​
Disconnected

The connection to the Slippi relay was lost or never established. Check that:
  • The relay is running
  • The port configuration matches your relay settings
  • No firewall is blocking the connection

​
Advanced Configuration

​
Custom Port

If your Slippi relay uses a non-standard port:
  1. Open the boofstream configuration
  2. Navigate to Slippi settings
  3. Update the port number to match your relay configuration
  4. Save and reconnect

​
Multiple Setups

If you’re running multiple Slippi relays, you’ll need to:
  • Configure each boofstream instance with a unique port
  • Ensure each relay is broadcasting on its assigned port
The Slippi connection is reset when the relay disconnects. Game data from incomplete matches may be lost.

​
Troubleshooting

For connection issues, see the Slippi Connection Troubleshooting guide.

Build docs developers (and LLMs) love

Get started for freeTalk to us