Skip to main content

Beta Software Notice

boofstream is currently in beta. You may encounter bugs and unexpected behavior. We appreciate your patience and feedback as we continue to improve the software.
If you encounter issues not covered in this documentation, please check our GitHub issues page or report a new bug.

General Troubleshooting Steps

Before diving into specific issues, try these general troubleshooting steps:
Many issues can be resolved by completely restarting the application:
  1. Close boofstream completely
  2. Wait a few seconds
  3. Relaunch the application
  4. Try reconnecting to your services (Slippi, OBS, etc.)
boofstream stores configuration in out/config.json and state in out/state.json:
  • If these files become corrupted, boofstream will automatically delete and recreate them
  • You can manually delete these files to reset to defaults
  • Location: out/config.json and out/state.json in your boofstream directory
boofstream requires network access for:
  • Local connections to Slippi (port 53742 by default)
  • Local connections to OBS WebSocket (port 4455 by default)
  • Internet access for start.gg or ParryGG integration
Make sure your firewall isn’t blocking these connections.
boofstream outputs helpful debugging information to the console:
  • Launch boofstream from a terminal to see console output
  • Look for error messages or connection failures
  • These logs can help identify the source of the problem

Reporting Bugs

If you’ve tried the troubleshooting steps and still have issues:
1

Search existing issues

Check the GitHub issues page to see if your problem has already been reported.
2

Gather information

Before reporting, collect:
  • Your operating system and version
  • boofstream version
  • Steps to reproduce the issue
  • Any error messages from the console
  • Screenshots if relevant
3

Create a new issue

If your issue hasn’t been reported, create a new issue with:
  • A clear, descriptive title
  • Detailed description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • All information gathered in step 2

Known Limitations

Some features are still in development. Check the GitHub issues for known limitations and planned features.

Getting Help

For additional support:
  • GitHub Issues: Report bugs or request features
  • Documentation: Browse the troubleshooting guides for Slippi and OBS
  • Community: Check if others have experienced similar issues on the GitHub discussions

Build docs developers (and LLMs) love