harfeur / twitchalerts Goto Github PK

This bot allows you to display an alert during a Twitch live, and to update the message frequently. Messages and language are customizable.

License: MIT License

JavaScript 46.58% CSS 14.88% HTML 38.54%

twitchalerts's Introduction

Twitch Alerts

I am NOT affiliated with Twitch.

How to use ?

For the regular user, you can add the bot to your server.

I want to host the bot

You are allowed to host the bot and make changes, but you need to respect the license : You can't use the bot as a commercial purpose (you can't make money using the bot).

To host the bot, you can download all the files, run npm install, and add the following variables to the environment:

DATABASE_URL = Link to the database (I use PostgreSQL database)
DISCORD_CLIENT_ID = ID of your Discord application
DISCORD_CLIENT_SECRET = Client secret of your Discord application
DISCORD_REDIRECT_URI = Redirect URL : it is normally https://yoururl.com/connect
PORT = Port of the web server
TWITCH_BOT_CLIENT_ID = ID of your Twitch application
TWITCH_BOT_CLIENT_SECRET = Client secret of your Twitch application
TWITCHBOT = Bot secret of your Discord application
URL = URL of your server (with port if different from default)

You can then run the bot with node index.js and (optionally) the webserver with node web.js.

License

Inspired from GuideBot (see LICENSE)

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

twitchalerts's People

Contributors

Stargazers

Watchers

Forkers

oscarog dnglchlk iamdadmin kyledmoore

twitchalerts's Issues

Suggestion: Allow existing requests to be edited

Currently there exists no way to observe or edit existing requests.

Suggestion: future architecture for scale and efficiency

Hi,

Bit busy to reach out in Discord at the moment, but wanted to share my thoughts on how to scale the bot and make it more efficient.

I'd suggest using pm2 to scale the threads and breaking it up into three microservices, this diagram explains my thoughts. We'll use a sticky session technology on the web-ui workers so we don't have to do full sessions since the website isn't all that busy in comparison to the events and discord stacks. It can be scaled by adding more workers, one per vcpu.

You could possibly combine the web-ui with one of the other microservices. Logically speaking it would make sense to do that with the discord, as it'd remove the need for the internal alert api, however that's also the one likely to experience the most load/scaling issues, so possibly best to avoid that.

I've also excluded a database table for "currently live" streamers, however a simple async started when a online is received which checks the database every 15(?) minutes for changes to category or title until an offline is received would handle that.