Repository navigation
Getting Started
This walks you from a fresh install to a working chat command and an alert.
The left rail has the main sections: Home, Automation, Chat, Audio, Input, Platforms, Overlays, Apps and Settings. Each section lists its pages beside the rail. Press Ctrl+K (or click "Jump to a page..." at the top) to jump to any page by name. The top bar shows connection chips for what is connected; the status bar at the bottom shows problems and uptime.
Home > Dashboard shows what is connected, today's runs and events, and recent activity.
Open Platforms, pick Twitch, YouTube, Kick or Rumble and sign in. See Connecting Platforms for details.
In OBS open Tools > WebSocket Server Settings, tick Enable WebSocket server and click Show Connect Info. In Cuebot open Apps > Stream apps > OBS, add a connection and paste the port and password. See Stream Apps and Devices.
-
Automation > Commands: click +, name it "hello" and enter
!helloas the command. - Automation > Actions: click +, name the action "Say hello".
- On Sub-actions click + Sub-action, search "send chat message" and enter
Hello %user%, welcome in!. - On Triggers click + Trigger, choose Chat command and pick "hello".
- Type
!helloin your chat. Cuebot answers.
- Create an action "Thank followers".
- Add Set source visibility (OBS) to show an alert source, a Delay of 5 seconds, and Set source visibility again to hide it. Add Speak to have TTS read "Thanks for the follow, %user%!".
- Add a Follow trigger for your platform.
- Use Test trigger... to try it with a pretend follower.
Cuebot starts with a few example actions in the Examples group; open them to see how they are built.
- Actions and Triggers for branching, queues, timers and variables.
- Text to Speech to read chat aloud.
- Moving from Streamer.bot if you already have actions there.
Cuebot by Tech Daddy Digital · MIT license · Privacy
Cuebot Docs (the same pages, nicer to read)
- Home
- Start here
-
Guides
- Chat commands
- The mod portal
- Overlays and alerts
- Writing your own overlay widgets
- Text-to-speech
- Music and now playing
- Points, store and giveaways
- Subathons and goals
- Stream apps and devices
- VTuber apps
- Stream Deck
- The phone app
- Donations and integrations
- Discord bot
- The setup assistant and AI tools
- The assistant on your own computer
- Moving from Streamer.bot
- Cuebot's servers
- Writing code (C# and Python)
- Python in detail
- Using your own code editor
- Controlling Cuebot from other programs
- Backups and your data
- Linux
- Command-line options
- Troubleshooting
- What's experimental
- Reference