Picture

Twitch

OBS

StreamerBot

Table of contents

  1. Description
  2. Setup
  3. URL Parameters
    1. Leaderboard Count
    2. Excluded Accounts
    3. Single User Vote
    4. Font Family
    5. Font Size
  4. Changelog

Description

An OBS overlay that displays the top words used in your chat in a dynamic leaderboard.

Picture

Duplicates within a single message count as a single word.


Setup

  1. Go into Streamerbot and head to the tab Servers/Clients -> WebSocket Server and start the websocket server. Leave the adress at 127.0.0.1 and the port at 8080. Check Auto Start as well. You can set a password, but you don’t have to. If you do, make sure Enforce for All Requests stays unchecked.

    Picture

  2. Copy the URL:
    https://tawmae.github.io/overlays/HotWords.html
    
  3. Go into your OBS, create a browser source and paste the URL in there. Preferably set the resolution to your canvas size. Also I’d recommend to check Shutdown source when not visible and Refresh browser when scene becomes active.

    Picture

    Picture

  4. Done 🥳 Once you make the source visible (and it loads), it will start tracking chat. Refreshing the source (i.e. hiding it) resets it.

To have the events in multiple scenes, don’t create an individual browser source in every scene, but instead create a new nested scene and put just a single browser source in there. Then place that scene into all your other scenes. This way you won’t have to create 20 browser sources for 20 scenes.


URL Parameters

To customize the overlay, you can add URL parameters. The first parameter gets added with a ?, every additional one with &.

Example:

https://tawmae.github.io/overlays/HotWords.html?top=8&font=Outfit&excludedusers=streamelements+tawmaebot

Leaderboard Count

Changes the count of the displayed leaderboard. Leaving it empty defauls to 5.

top=10


Excluded Accounts

Exclude accounts from having their messages count, like bot accounts. Multiple accounts are seperated by a +

excludedaccounts=streamelements

excludedaccounts=streamelements+nightbot


Single User Vote

Only count the first message of each user.

singleuservote=true


Font Family

Changes the font used for the overlay. Supports standard fonts.

font=Arial

font=Poppins


Font Size

Changes the font size.

fontsize=24


Changelog

Date Changes Version
December 06, 2024 Release 1.0.0