Beta Software Notice
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:Restart boofstream
Restart boofstream
Many issues can be resolved by completely restarting the application:
- Close boofstream completely
- Wait a few seconds
- Relaunch the application
- Try reconnecting to your services (Slippi, OBS, etc.)
Check your configuration files
Check your configuration files
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.jsonandout/state.jsonin your boofstream directory
Verify network connectivity
Verify network connectivity
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
Check the console logs
Check the console logs
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:Search existing issues
Check the GitHub issues page to see if your problem has already been reported.
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
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