Skip to content

A todo overlay to use in OBS while streaming

License

Notifications You must be signed in to change notification settings

negue/todo-overlay

Repository files navigation

Todo Overlay for OBS/Twitch

All Contributors

image

Import into OBS

Needed Query:

https://negue.github.io/todo-overlay/?channelName=yourName
Option Description
&command=todo The command that should react from twitch chat - Default todo
&layout=auto Switch displays between a full sized layout and an auto-sized layout - Default full - Auto auto
&scrollingInterval=5000 Time in ms, when the next scrolling to top/bottom will be triggered, this only happens when the view is smaller then entries inside.
&scrollingDuration=2000 Time in ms, how long the scroll animation should

Chat Commands

The broadcaster and mods can execute these commands

!COMMAND TEXT is a shortcut for !COMMAND add TEXT

Syntax for all other commands: !COMMAND SUBCOMMAND [ID / TEXT]

SUBCOMMAND Shortcut Description
new TITLE Resets the todo list and sets the name to TITLE
name TITLE Renames the list to TITLE
add TEXT Adds a new entry with the TEXT
edit POSITION TEXT e Changes the text of POSITION to the new TEXT
color POSITION COLOR Changes the color see Texts of NES.css or any #RRGGBB / rgb() / rgba() values of POSITION
move POSITION NEWPOSITION mv Move entry of POSITION to NEWPOSITION
remove POSITION rm Removes the entry at POSITION
toggle POSITION Toggles the entry at POSITION , it can also be a comma separated list of positions
highlight POSITION hl Changes all other than POSITION to a lower opacity
start POSITION Starts a timer at POSITION
stop [POSITION] Stops the current timer, or optionally at POSITION
reset [POSITION] Resets the current timer, or optionally at POSITION
cleanup Removes all "done" entries

Protips :

  1. (Windows only)

    Use your the same Overlay-URL in your custom OBS-Docks. Then you can it on stream and in your OBS.

  2. You can use multiple commands on separated browser sources, so if you want to have !todo (on stream) and a !later to do it after :)

    Note: You need to change the URL with &command=later accordingly

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Igor Ilic

🤔 💻

Steve Andreou

💻

Rascal_Two

💻

This project follows the all-contributors specification. Contributions of any kind welcome!