colorbot-twitch/README.md

25 lines
721 B
Markdown
Raw Permalink Normal View History

2021-01-18 23:03:15 +00:00
# Twitch Color Bot
Setup the following environment variables:
- `TWITCH_BOT_KEY` (required)
- You can generate a key here: https://twitchapps.com/tmi/
- `TWITCH_BOT_USERNAME` (required)
- `TWITCH_BOT_COLOR_MODE`
- Currently supports `random` and `loop`
- Random will select a random color with varying hue, saturation, and lightness.
- Loop will increment the hue value through the spectrum and loop.
- `TWITCH_BOT_INTERVAL`
- Time between color changes in seconds. Default 10 seconds.
2021-01-18 23:19:54 +00:00
- `TWITCH_BOT_DEFAULT_COLOR`
- Default username color that is used initially and set on program exit. Default is #F1C40F.
2021-01-18 23:03:15 +00:00
## Running locally
Install dependencies with `yarn install`.
Run app
```bash
node index.js
```