Skip to content

metalandcoffee/metalcoffeebot

Repository files navigation

Metalcoffeebot

Chatbot for twitch.tv/metalandcoffee_

This is a very basic Node.js application that can be used as a starting point to make your own chatbot for Twitch! ✨

This application uses tmi.js to interact with Twitch Chat & connects to the Twitch API.

It also uses TAU. (More info coming soon)

Getting started

After cloning the repository, run npm install in the root directory to install all the needed packages defined in package.json.

Create an .env file to store your tertersecrets. The following environmental variables should be defined in the file:

Variable Description
BOT_USERNAME Username of Twitch account created for chatbot
OAUTH_TOKEN OAuth Token for Twitch IRC interface (Use Twitch Chat OAuth Password Generator to generate)
CHANNEL_NAME Username of Twitch account to use chatbot for.
CLIENT_ID Twitch Client ID (for Twitch API) Register an application here to obtain.
CLIENT_SECRET Twitch Client Secret (for Twitch API) Register an application here to obtain.
SE_JWT Optional. If you have a Stream Elements account and want to use their API to receive new events (i.e. follows, subscribes, cheers, etc.)

Sample .env file

# Environment Config

BOT_USERNAME=metalcoffeebot
OAUTH_TOKEN=1234567890
CHANNEL_NAME=metalandcoffee_
CLIENT_ID=1234567890
CLIENT_SECRET=1234567890
SE_JWT=1234567890

After creating the file, run npm start to start up the chatbot. You should see an initialization message in your chat from your bot (i.e. 'Hi there' ) as confirmation that a connection has been made.

Functionality

Chatbot will automatically provide a shoutout to chatters who are listed in the vip constant in metalhead-vips.js. This functionality requires tmi.js and the Twitch API. More features coming soon...

Resources

If running on Glitch platform and are running into issues, trying running the enable-pnpm command in terminal.

If you need to quickly figure the broadcaster ID based on the username. https://jwalter-twitch.builtwithdark.com/myuserid?name=sociablesteve

tmi.js Events

https://github.com/tmijs/docs/blob/gh-pages/_posts/v1.4.2/2019-03-03-Events.md

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published