Skip to main content

​
Overview

boofstream integrates with both Start.gg and Parry.gg to automatically load tournament data, including player information, sets, and bracket details. This eliminates manual data entry and keeps your stream overlay synchronized with bracket updates.

​
Supported Platforms

​
Start.gg

Formerly known as smash.gg, Start.gg is the most widely used tournament platform for Super Smash Bros. events.

​
Parry.gg

A modern tournament platform with built-in streaming tools and real-time bracket updates.

​
Configuration

startgg: {
  token: "",              // Your Start.gg API token
  tournamentUrl: ""       // Tournament/event URL
}
The same configuration object is used for both Start.gg and Parry.gg. The startgg field name is maintained for backwards compatibility.

​
Start.gg Setup

1

Get your API token

  1. Go to Start.gg Developer Settings
  2. Click Create new token
  3. Give it a descriptive name (e.g., “boofstream”)
  4. Copy the generated token
Store your API token securely. It provides access to your Start.gg account and tournament data.
2

Configure boofstream

In the boofstream manager:
  1. Navigate to Tournament settings
  2. Select Start.gg as your platform
  3. Paste your API token in the Token field
  4. Save the configuration
3

Load tournament data

  1. Navigate to your tournament on Start.gg
  2. Copy the full event URL (e.g., https://start.gg/tournament/my-local-123/event/melee-singles)
  3. In boofstream, paste the URL and click Load Tournament
  4. Wait for player and set data to load
4

Select your set

Once loaded, you’ll see a list of available sets. Select the set you’re currently streaming to populate player data and match information.

​
Parry.gg Setup

1

Get your API token

  1. Log in to Parry.gg
  2. Navigate to your account settings
  3. Find the API Access section
  4. Generate or copy your API key
2

Configure boofstream

In the boofstream manager:
  1. Navigate to Tournament settings
  2. Select Parry.gg as your platform
  3. Paste your API key in the Token field
  4. Save the configuration
3

Load tournament data

  1. Navigate to your bracket on Parry.gg
  2. Copy the full bracket URL (e.g., https://parry.gg/my-tournament/melee-singles/main/bracket)
  3. In boofstream, paste the URL and click Load Tournament
  4. Wait for entrant and match data to load
Parry.gg URLs must include the full path: tournament slug, event slug, phase slug, and bracket slug.
4

Select your match

Once loaded, select the match you’re streaming to populate player data and round information.

​
Loaded Data

​
Player Information

When you load a tournament, boofstream retrieves: From Start.gg:
  • Gamer tag
  • Sponsor/prefix
  • Seed number
  • Pronouns
  • Twitter handle
  • Country and state
From Parry.gg:
  • Gamer tag
  • Seed number
  • Pronouns
  • Country and state
Parry.gg does not currently provide sponsor/prefix or Twitter data through its API.

​
Set/Match Information

  • Round text (e.g., “Winners Round 1”, “Losers Finals”)
  • Phase name (e.g., “Championship Bracket”, “Pools”)
  • Completion status
  • Player assignments

​
Tournament Details

  • Tournament name
  • Event name
  • Phase information
  • Best-of format (configurable)

​
URL Formats

​
Start.gg

Valid URL format: 
https://start.gg/tournament/[tournament-slug]/event/[event-slug]
Example: 
https://start.gg/tournament/genesis-9/event/melee-singles

​
Parry.gg

Valid URL format: 
https://parry.gg/[tournament-slug]/[event-slug]/[phase-slug]/[bracket-slug]
Example: 
https://parry.gg/my-local-weekly/melee-singles/main/bracket

​
Limitations

​
Start.gg

  • Maximum 500 entrants per event
  • Maximum 500 sets per event
  • Tournament organizer/admin accounts can be loaded as commentators
Large tournaments with over 500 entrants may not load all player data. Contact your TO if you need to stream a massive event.

​
Parry.gg

  • No built-in entrant limit
  • Requires full bracket URL (including phase and bracket slugs)
  • Limited metadata compared to Start.gg

​
Commentator Loading

​
Start.gg Only

Start.gg tournament admin accounts can be loaded as commentators. This includes:
  • Display name
  • Sponsor/prefix
  • Pronouns
  • Twitter handle
Commentators are assigned negative entrant IDs (-1, -2, etc.) to distinguish them from regular entrants.

​
Working with Sets

1

Filter sets

After loading tournament data, you can filter sets by:
  • Completion status (show/hide completed sets)
  • Phase (Pools, Championship Bracket, etc.)
  • Round (Winners/Losers)
2

Select current set

Click on the set you’re currently streaming. Player data will populate automatically, including:
  • Names and sponsors
  • Seeds
  • Countries/states
  • Social media handles
3

Update losers bracket status

If a player is coming from losers bracket, toggle their losers status. This will:
  • Optionally append [L] to their name (if configured)
  • Update overlay styling

​
Manual Overrides

After loading tournament data, you can manually edit:
  • Player names
  • Sponsors
  • Scores
  • Character selections
  • Any other displayed information
Manual changes persist until you load a new set.
Use manual overrides for crew battles, exhibitions, or other non-bracket matches while still benefiting from the tournament’s player database.

​
Best Practices

  1. Load early: Load tournament data before your stream starts to avoid delays
  2. Verify data: Always double-check player information after loading a set
  3. Refresh periodically: If bracket updates occur during your stream, reload the tournament to get the latest sets
  4. Save your token: Configure your API token once and it will persist across sessions
  5. Test beforehand: Load a test set before going live to ensure everything displays correctly

​
API Rate Limits

​
Start.gg

Start.gg imposes rate limits on API usage. For normal streaming use, you shouldn’t hit these limits, but avoid:
  • Rapidly reloading tournament data
  • Running multiple boofstream instances with the same token
  • Making excessive API calls

​
Parry.gg

Parry.gg’s rate limits are generally higher than Start.gg. Normal usage should not cause issues.

Build docs developers (and LLMs) love

Get started for freeTalk to us