/twitch-chat

Twitch Chat Overlay for StreamerBot

Primary LanguageHTMLMIT LicenseMIT

twitch-chat

Twitch Chat Overlay for OBS based on streamer.bot's websocket, using pronouns from pronouns.alejo.io.

Disclaimer: This is a fork. Credits to the idea and initial version go to izzy.

Config

Supported settings are as follows. To use them just add them as URL parameters, e.g.

Example 1: file:///C:/path/to/twitch-chat/chat.html?ws_uri=ws://localhost:9090/&badges=false&pronouns=false
custom SB uri, No badges, no pronouns, vertical chat

Example 2: file:///C:/path/to/twitch-chat/chat.html?badges=false&pronouns=false&direction=horizontal&fade=12&pronoun_fontsize=small
No badges, pronouns, pronouns font size, horizontal chat, fade message after 12s

Example 3: file:///C:/path/to/twitch-chat/chat.html
full default, badges, pronouns, vertical chat

options

option default valid options description example
direction none horizontal vertical or horizontal chat layout &direction=horizontal
fade none int fade messages in horiz. chat after int seconds &fade=12
bots none string bot names in comma separated list to be excluded from chat display &bot=name1
cmdprefix none string prefix for commands to exclude from chat display &cmdprefix=!
badges true true/false enable chat badges &badges=false
fontsize large any css font declaration set font size in display &fontsize=xx-large
fontfamily sans-serif monospace/sans-serif/serif set font family for chat &fontfamily=monospace
pronouns true true/false display pronouns &pronouns=false
pronoun_fontsize none any css font declaration set font size for pronouns &pronoun_fontsize=small
timestamp false true/false enable timestamps in vert. chat box &timestamp=true
background transparent html color code without # set chat background color &background=bebebe
ws_uri ws://localhost:8080/ ws://host:port/ The Streamer Bot WebSocket Address to use. &ws_uri=ws://localhost:18080/

latest changes

  • dynamic chat badges from message
  • pronouns font size config, defaults to fontsize
  • add experimental support for redemptions
  • small css formattings

I've read this README but I still have questions/problems, where can I get help?

If you have a Github account, opening an issue is the best way to give feedback. Otherwise you can join my Discord and ask you question in #development or send me a message on Twitter.

Please note that izzy will probably not be able to help with this fork.