/Twitch-task-overlay

A simple open-source task list twitch overlay. Allows streamer and chatters to display their tasks on the overlay.

Primary LanguageJavaScriptMIT LicenseMIT

Twitch Task List overlay

I RELEASED A NEW TASK LIST, CHECK THAT ONE OUT INSTEAD HERE

A simple task list overlay for co-working streamers on Twitch! Allows streamer and twitch chat to display their tasks on the overlay.

Why you should use this overlay:

  • Lightweight
  • Setup instructions on Youtube
  • Highly customisable
  • No third party databases required
  • Requires no servers or third-party hosting, just run OBS and you're good to go!

How to setup?

Pre-requisites

  • An IDE (recommended: Visual Studio Code, Brackets.io)
  • OBS (SLOBS, other variations)

Installation

  1. Install zip file or use git to install folder
  2. Follow instructions on Twitch Application

Twitch Application method 1

  1. Go to tmi app token generator
  2. Select "Connect"
  3. Obtain oauth token

Twitch Application method 2

  1. Go to Twitch Developers and create a twitch application
  2. Enter Name
  3. Enter http://localhost for OAuth Redirect URL
  4. Select Chat Bot for the Category

register application details

  1. Create your application.
  2. Obtain the Client ID from the application
  3. Put the Client ID into the get token link
  4. Paste the link into your browser
  5. In the URL, obtain the access_token
  6. Paste the access_token into index.js
  7. Finish setup

OBS setup

  1. Create a new Browser Source
  2. Select Local File, then select the HTML file
  3. Adjust width and height (recommended: 1280 x 720)
  4. Select OK to finish setup
  5. Test the commands in your chat

Credits

RyanPython - Creation of this project

berryspace - Introducing the concept to Ryan & testing

instafluff - Creating ComfyJS (the library the bot is built on)