No description
| css | ||
| js | ||
| json | ||
| .gitignore | ||
| auth.html | ||
| index.html | ||
| readme.md | ||
| start_server.py | ||
Twitch Overlay
This project is a custom Twitch overlay designed to display chat messages and alerts in real time. It connects to the Twitch EventSub WebSocket API (or a local proxy) to receive events such as chat messages, follows, subscriptions, raids, and more.
Features
- Real-time Chat Display: Shows incoming chat messages with sender, message, and timestamp.
- Alerts: Displays alerts for follows, subscriptions, raids, and other Twitch events.
Structure
index.html— Main overlay page.auth.html— Twitch OAuth authentication page.
Usage
- Place your Twitch API credentials in
json/config.json. - Configure a webserver to point at the root of the project.
- Run the webserver.
- Open
auth.htmlin a browser and authenticate with Twitch. - Copy the User auth token into
json/config.json. - Open
index.htmlin an OBS browser source to use the overlay.
Notes
- This overlay is intended for personal use only.
- Currently
json/config.jsonis served by the webserver. - Do not share your
config.jsonpublicly.
TODO
- (Optional) "Emote Explosion"