ched-dev / obs-overlays

An OBS Browser Source for Twitch API actions (Follows, Subs, Cheer, Raids, Channel Rewards, etc.) and chat commands (!sounds, !brb)

OBS Overlays

This local application allows you to display overlays in OBS using a browser source.

Features

• Listen for Twitch Events (Follow, Subscribe, Channel Point Redemptions, Cheer, Hype Train, etc.)
• Listen for Twitch Chat Commands (!discord, !commands, !clap) based on chatter permissions
• Connect a Chat Bot and send messages in chat
• Common Sound clips included, or add your own
• Notification templates built in HTML/CSS
• Limit access to commands & sounds by role (moderator, vip, follower, subscriber, etc.)
• Easy customization via configuration based code
• Prebuilt Client Commands for rendering HTML/CSS templates, playing sounds, sending bot messages, etc.
• Create custom Client Commands for endless functionality (launching a game, hitting an API)

To Do:

• Command Cooldowns
• New showMedia Client Command
• !so Shoutout Command
• Hype Train Alert
• Polls and Predictions Alert
• Add Queuing to Alerts
• Turn off TAU or Chat events
• Stream Stats ending screen (# of Raids, Follows, etc.)

Documentation

• Overview for a general understanding of how this application works
• Guides
• Config Docs for customizing listeners of Event Commands and Client Commands

Praise

I have tested getting Twitch events from EventSub and PubSub with several libraries (Twurple, TwitchPS, TwitchWebhook [deprecated]) and none of them would work correctly.

TAU is the holy grail that takes the pain away. I would recommend it to all who want Twitch event notifications.

If you just want some chat integration, you could use tmi.js.

License

This project is licensed under MIT and is free for you to fork and make your own.