Home - theweebcoders/CommercialBreaker GitHub Wiki
CommercialBreaker & Toonami Tools
Welcome to the comprehensive documentation for CommercialBreaker & Toonami Tools - the ultimate solution for recreating the authentic Toonami experience with your anime collection.
What is this project?
CommercialBreaker & Toonami Tools automate a continuous Toonami marathon by intelligently inserting commercial breaks into anime episodes and organizing them with authentic Toonami bumps. The tools slice up your anime, add nostalgic commercial breaks, and create seamless marathon experiences that feel just like those late-night Toonami sessions.
Key Features
- CommercialBreaker: Intelligently detects and creates commercial break points in anime episodes
- Cutless Mode: Preserve original files while adding virtual commercial breaks
- ComBreakDirect: Self-contained continuous MPEG-TS streaming server with beautiful WebUI - no DizqueTV or Tunarr required
- Studio β FIFO β Broadcast FFmpeg β BroadcastTower architecture for true broadcast streaming
- Truly continuous streams with seamless program transitions (Broadcast FFmpeg's
+genptsprevents freezing) - Multi-client support - watch on multiple devices simultaneously
- Toonami-themed web interface with setup instructions and copy-to-clipboard URLs
- Configurable audio track selection (defaults to English for Toonami dubs)
- HDHomeRun emulation for Plex & Jellyfin DVR integration
- Toonami Tools: Generate custom lineups with authentic bump integration
- Multiple Interfaces: GUI (TOM), Web UI (Absolution), and CLI (Clydes)
- MultiβNetwork Support: Not just Toonami β switch the active network from the Advanced settings in TOM/Absolution or at Clydes startup. Includes Networkless mode to bypass Wikipedia validation and use any custom content collection
- Platform Support: Works with DizqueTV, Tunarr, or self-hosted ComBreakDirect
- Plex Integration: Seamless integration with your existing Plex library and HDHomeRun-style discovery
Quick Start
- Installation Guide - Get up and running quickly
- User Guides - Choose your interface and start creating
- Configuration - Customize your setup
Documentation Sections
User Documentation
- Installation Guide - Step-by-step setup instructions
- User Guides - Interface-specific guides
- Cutless Mode - How to use virtual cuts instead of physical files
- ComBreakDirect - Self-hosted streaming server guide
- File Naming Conventions - Proper naming schemes
- Troubleshooting - Common issues and solutions
- FAQ - Frequently asked questions
Technical Documentation
- Architecture Overview - System design and components
- S.A.R.A. Validation System - Database validation and diagnostics
- API Reference - Technical implementation details
- Component Documentation - Individual tool descriptions
- Developer Guide - Contributing and development info
Reference Materials
- Configuration Reference - All configuration options
- Docker Setup - Container deployment
- Platform Integration - DizqueTV and Tunarr setup
Project Structure
The project is organized into several key directories, each serving a specific purpose:
CommercialBreaker/
βββ main.py # Entry point - selects which interface to run
βββ API/ # Core application logic and orchestration
βββ GUI/ # Graphical User Interfaces (TOM, Absolution)
βββ CLI/ # Command-Line Interfaces (clydes)
βββ ComBreak/ # Commercial detection and processing tools
βββ ComBreakDirect/ # Self-hosted continuous MPEG-TS streaming server
β βββ ComBreakDirectServer.py # Flask application
β βββ docks/ # Core processing modules (Loading, Factory, Unloading)
β βββ utilities/ # BroadcastTower, audio selection, pre-rendering
β βββ UI/ # WebUI with landing page
βββ ToonamiTools/ # All the tools for Toonami channel creation: Plex integration, media/bump handling, lineup scheduling, and platform deployment
βββ ExtraTools/ # Case Use tools and utilities
Getting Help
- FAQ - Check common questions first
- Troubleshooting - Solve specific issues
- Discord: Join our community
- GitHub Issues: Report bugs and request features
- ChatGPT: Give all these documents and a link to the repo to ChatGPT for assistance
Contributing
See our Developer Guide for information on contributing to the project.
"Until next time, Space Cowboy!"