https://github.com/jamesbroadberry/twitchpoll

A HTML Twitch Overlay that reads chat of a Twitch account and displays chat's single words as votes recorded in the last five minutes.
https://github.com/jamesbroadberry/twitchpoll

Last synced: 2 months ago
JSON representation

A HTML Twitch Overlay that reads chat of a Twitch account and displays chat's single words as votes recorded in the last five minutes.

• Host: GitHub
• URL: https://github.com/jamesbroadberry/twitchpoll
• Owner: JamesBroadberry
• Created: 2021-08-31T20:56:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-15T22:43:14.000Z (over 1 year ago)
• Last Synced: 2025-01-22T12:32:47.597Z (4 months ago)
• Language: HTML
• Size: 17.6 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TwitchPoll

A HTML Twitch Overlay that reads chat of a Twitch account and displays chat's single words as votes recorded in the last five minutes.

# Hosted on GitHub pages

https://jamesbroadberry.github.io/TwitchPoll/

# How it works

- Upon load, the page anonymously connects to the user's twitch chat

- It keeps track of each user's latest message which was just a single word (their vote)

- Every time the UI refreshes, every user's votes are grouped and then ordered from highest to lowest, discarding any which are older than 5 minutes and displayed on the page.

Doing it like this allows chatters to change their vote by sending another message of just a single word but doesn't stop them chatting by not overriding their votes when sentences appear.

# How to use

Add a browser/HTML source in your streaming software and add the URL you need and configure as necessary.

https://jamesbroadberry.github.io/TwitchPoll/?twitch={TwitchChannel}&interval={HowOftenTheUiUpdates}&show={NumberOfEntriesToShow}&fontSize={fontSizeInPixels}&fontColour={validHtmlColour}&fontStrokeColour={fontStrokeColour}&fontStrokeWidth={fontStrokeWidth}&ignore={commaSeperatedIgnoreList}

Using the URL, modify the query parameters to your needs:

- **twitch** _(required)_

  - The Twitch Channel to monitor for responses

- **interval** _(not required, defaults to 250)_

  - How often the UI refreshes **in milliseconds** - data is always constantly processed when each message is received

- **show** _(not required, defaults to 5)_

  - How many items to show in the list of responses

- **fontSize** _(not required, defaults to 48)_

  - If you need a custom font size, leave as an integer in pixels

- **fontColour** _(not required, defaults to black)_

  - Change the font colour to something that better matches your stream (if using a hex colour, you'll need to URL encode the '#' e.g. %23AAAAAA for #AAAAAA)

- **fontStrokeColour** _(not required, defaults to black)_

  - Change the font outline colour (if using a hex colour, you'll need to URL encode the '#' e.g. %23AAAAAA for #AAAAAA)

- **fontStrokeWidth** _(not required, defaults to 1px)_

  - Change the font outline width

- **ignore** _(not required, defaults to empty)_

  - Comma seperated list of words to ignore when displaying the UI

An example built URL would be:

https://jamesbroadberry.github.io/TwitchPoll/?twitch=thejrm_&fontColour=white&fontStrokeColour=black&fontStrokeWidth=1&ignore=hello,world