Repository navigation
Linux
Cuebot runs natively on Linux, on Wayland or X11.
Cuebot is Wayland-first: when a Wayland compositor is running it uses its native Wayland support, otherwise X11. If Wayland cannot start, or no window appears within 20 seconds, Cuebot restarts itself once on X11 (XWayland). The log records which one is in use.
- Force one with
--backend=waylandor--backend=x11, or the environment variableCUEBOT_BACKEND=wayland|x11. - Change the 20-second wait with
CUEBOT_WAYLAND_TIMEOUT(seconds). - Wayland needs a compositor offering
xdg_wm_baseversion 3 or newer. GNOME, KDE Plasma and current sway and Hyprland do; sway 1.9 does not, and Cuebot falls back to XWayland there automatically. - In the Flatpak, X11 is only granted when no Wayland socket exists. On an older compositor run
flatpak override --user --socket=x11 io.github.cuebot.Cuebotonce, or start with--backend=x11.
The tray icon is a StatusNotifierItem, shown by KDE Plasma, waybar and most wlroots bars, XFCE, Cinnamon, and GNOME with the AppIndicator extension. Plain GNOME and some minimal sessions have no tray; Cuebot detects that and minimizes instead of hiding, so the window is never lost. Starting Cuebot again always brings its window back.
Logging out, kill, or closing the terminal Cuebot was started from (SIGTERM, SIGINT, SIGHUP) quits Cuebot cleanly,
saving everything, just like Quit in the tray. If the Wayland compositor restarts, Cuebot keeps running (streams,
timers and servers carry on) and its window comes back with the compositor.
- Sound plays through
pw-play(PipeWire),paplay(PulseAudio) oraplay(ALSA), whichever is installed. - Offline text-to-speech uses
espeak-ng(included in the Flatpak; install it from your distribution otherwise). - Voice control's speech recognition needs the GCC OpenMP runtime (
libgomp), which the AppImage includes.
-
Stream Deck without Elgato's software: install the udev rule once:
sudo cp 70-cuebot-streamdeck.rules /etc/udev/rules.d/ && sudo udevadm control --reload && sudo udevadm trigger -
Game controllers: PlayStation and Switch pads need read access to
/dev/hidraw*for rumble and lights; install your distribution'ssteam-devicesorgame-devices-udevrules. - MIDI uses the ALSA sequencer.
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