How locussphere/streampause works
What this project is (type + purpose)
From the README and file tree, streampause is a lightweight, static, browser-based “stream modules”/overlay toolkit. It looks like a pure front-end static site (no backend service, no server code beyond static hosting) that provides different “screens” (e.g., BRB, visualizers) as separate HTML modules.
Key indicators:
• Top-level index.html, app.js, style.css ⇒ classic static web app.
• screens/ contains multiple standalone HTML pages ⇒ each “module” is likely a self-contained screen/overlay.
• screens.json ⇒ registry/config describing available screens (names, paths, metadata).
• .github/workflows/static.yml ⇒ automated static deployment (likely GitHub Pages).
Runtime (what runs in the browser)
• Entry point UI / launcher
• index.html (top-level)
• app.js (top-level)
• style.css (top-level)
• Screens / modules
• screens/index.html (possibly a directory index or a screen gallery)
• screens/loficalm.html (example module)
• (more screens likely to be added here)
• Screen registry/config
• screens.json (source of truth for what screens exist and how to link/load them)
Delivery (how it’s published)
• Static hosting pipeline
• .github/workflows/static.yml (CI/CD)
• Hosting target
• Not explicitly in repo, but implied: GitHub Pages or another static host.
Use a “static web module platform” framing: the core architecture is Browser + Static Host + Screen Modules + Config.
User / Streamer
• Uses a browser or OBS browser source to load the site/screen.
Static Host (e.g., GitHub Pages)
• Serves index.html, app.js, style.css, screens.json, and screens/*.html.
Browser Runtime
• Loads and executes app.js
• Fetches and parses screens.json
• Renders the main UI and/or loads individual screens
Screen Modules (HTML screens)
• screens/loficalm.html, etc.
• May reference shared style.css and/or their own embedded JS/CSS.
Configuration / Registry
• screens.json as the catalog of modules
User → Browser
• “Open overlay URL” / “Load in OBS Browser Source”
Browser → Static Host
• HTTP GET index.html
• HTTP GET app.js, style.css
• HTTP GET screens.json
app.js → screens.json
• “Fetch screen registry”
Browser/app.js → Screen Module HTML
• “Navigate to / load / embed screen HTML”
• If the app uses navigation: index.html links to screens/<screen>.html
Optional (only if supported by code once inspected):
• Screen module → Web APIs
• Audio API, Canvas/WebGL, etc. (common for visualizers). If present, show as “Browser Web APIs”.
Architectural pattern worth calling out
• Static, client-only architecture
• All logic runs in-browser; hosting is a dumb file server.
• Module/plug-in style via file + registry
• A new screen by:
1) creating screens/<name>.html
2) adding/adjusting an entry in screens.json
• Shared assets
• Shared style.css (and potentially shared JS patterns in app.js) provide consistency across screens.
Technologies to label (based on evidence)
• HTML/CSS/JavaScript
• Static hosting (GitHub Pages implied by .github/workflows/static.yml)
• GitHub Actions (deployment pipeline)
Diagramming conventions (make it unambiguous and detailed)
To satisfy “be very detailed, separate into as many components as possible”:
Labels
• Use file-level labels where it helps accuracy:
• “Entry: /index.html”
• “Logic: /app.js”
• “Styles: /style.css”
• “Registry: /screens.json”
• “Module: /screens/loficalm.html”
• “HTTP GET /screens.json”
• “Loads module HTML”
• “Renders UI”
• “User selects screen”
Don’t forget deployment (it’s part of the real architecture)
• “GitHub Repo”
→ “GitHub Actions: .github/workflows/static.yml”
→ “Static Host (GitHub Pages)”
→ “Serves versioned static assets to Browser”
• Confirm how screens are loaded by reading app.js:
• navigation vs iframe vs dynamic fetch/innerHTML
• Confirm what fields exist in screens.json:
• name, path, tags, default screen, ordering, etc.
• Check whether screens share style.css or have per-screen styling.