Stream Kit Documentation
Learn how to automate your stream with actions, triggers, variables, and plugins.
Stream Kit Documentation
Stream Kit is a desktop automation app for streamers. Build actions (handler chains), fire them from triggers (chat, OBS, hotkeys, schedules), and use variables to pass data between steps.
Get Started
| Page | Description |
|---|---|
| Introduction | Core concepts: actions, triggers, variables, plugins |
| Installation | Download and first launch |
| Setup | Connect Twitch, YouTube, OBS, and the bot |
| FAQ | Common questions |
Guide
| Page | Description |
|---|---|
| Actions | Create and edit actions, handler chains, testing |
| Triggers | Add triggers, conditions, test triggers |
| Variables | Global, user, and action-scoped variables |
| Action queues | Serialize overlapping runs |
| Collections | Session and persistent key-value stores |
| Overlays | OBS browser sources and configure page |
| Dashboard | Home screen widgets |
| Logs | Action history and log levels |
Plugins
| Plugin | Description |
|---|---|
| Core | Audio, scripts, variables, collections, schedules, hotkeys |
| Bot | Chat commands, timers, moderation |
| Rankings | Points, tiers, watch time, leaderboards |
| Quotes | Save and recall chat quotes |
| Twitch | Twitch chat, subs, raids, channel points |
| YouTube | YouTube live chat and events |
| Discord | Discord messages, roles, and voice events |
| OBS | Scene and source control |
| TTS | Text-to-speech handlers |
| WebSocket | External integrations via WebSocket |
| Stream Deck | Elgato Stream Deck triggers and feedback |
| Overlay | Send events to browser overlays |
API Reference
Browse every trigger and handler with stable definition IDs, variables, and configuration:
- API catalog — counts and links for all plugins
- Twitch triggers — e.g.
twitch:twitch:chat:chat-message - Core handlers — e.g. hotkeys, variables, Run script
- OBS handlers — scenes, sources, stream/record
Developers
| Page | Description |
|---|---|
| Plugin getting started | Build your first plugin |
| Plugin API | @stream-kit/plugin reference |
| Overlay authoring | Custom overlay projects |
| Installing plugins | Official and third-party plugins |