How louscmh/gts-stream works
Main Components
• Data & Configuration Layer:
• _data folder: Contains JSON files for API keys (api.json), beatmaps, match details, qualification data, seeding, stage information, and OBS scene configurations.
• This layer feeds configuration and game data that drive scene changes and interactivity.
• Shared Assets:
• _shared_assets directory: Contains design elements (animated videos, backgrounds, stingers), dependencies (JavaScript utilities like countUp.js, fetchData.js), fonts, and setup images.
• These assets are used by the overlays for visual and interactive elements.
• Overlay Scenes & Interfaces:
• overlay directory: Includes subdirectories for “match”, “schedule”, “seeding”, and “showcase”—each with its own HTML, JavaScript, CSS, and metadata files.
• Each of these serves as a distinct OBS scene that displays different phases of the event (e.g., match scene, intro scene, mappool overview, etc.).
• Main Entry / Static Landing:
• index.html at the project root might serve as an overall landing page or an access point to the overlay components.
• External Integration:
• tosu.exe: As described in the README, this external executable from a sister project (linked in the README) integrates the overlay within the streaming setup.
• osu! API: The overlay uses an API key (provided in api.json) to integrate and pull data from the osu! API.
Relationships and Interactions
• Data Flow:
• The JSON files in the _data folder feed relevant configuration, match details, and scene settings into the overlay components.
• Directional data flow should be shown from the “Data & Configuration Layer” to the “Overlay Scenes.”
• Asset Distribution:
• The _shared_assets folder supplies all design assets and dependencies to each overlay.
• External Triggers & Control:
• The control panel (described thoroughly in the README) is embedded within the interactive overlays. It manages manual scene switching, auto control toggles (for picking and scene transitions), and interactive match input.
• Connections from the “Overlay Scenes” to the “Control Panel”.
• Also, show the external integration with tosu.exe, which both prepares the static folder (with overlays) and interacts with the client (osu! client) to trigger scene changes.
• External API Interaction:
• A link from the “Overlay Application/Data Layer” to the osu! API (external service) to indicate the use of API keys and external data retrieval.
Architectural Patterns and Design Principles
• Modular Design:
• Each overlay (match, schedule, seeding, showcase) is modular, encapsulated in its own directory with dedicated HTML, JS, and CSS files. Reflect these as distinct modules/components.
• Separation of Concerns:
• Data/configuration (JSON resources) is clearly separated from presentation (HTML overlays) and asset management.
• Client-Side Execution:
• The system is largely a static, client-side application rendered in OBS and driven by JavaScript. Emphasize that no server-side processing is required.
• Dynamic Scene Transitions: