Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.39 KB

README.md

File metadata and controls

73 lines (51 loc) · 2.39 KB
Raw

Twitch Team Shoutout Bot

A bot that detects when a team member has entered the chat and sends a shout out message.

Prerequisites

  • Node.js version 12.0.0 or higher is required. This bot was tested against Node.js version 14.0.0

Setup

Install dependencies:

npm i

Environment Config

Copy the .env.sample file into a file named .env and update the variables accordingly.

cp .env.sample .env
Variable Description
BOT_USERNAME The twitch username of the bot that will be used to send the messages.
TWITCH_OAUTH_TOKEN Twitch OAuth token for the given BOT_USERNAME - can be obtained here: https://twitchtokengenerator.com/ (requires the chat:read and chat:edit permissions)
TWITCH_CLIENT_ID Twitch Client ID used to generate the above token, if using the above service to generate a token, use this Client ID: gp762nuuoqcoxypju8c569th9wz7q5
CHANNEL_NAME The twitch channel name to send the messages in.
CHANNEL_ID The channel ID of the above CHANNEL_NAME, used to prevent shouting out yourself.

Messaging Config

The src/config.js file contains some values that can be updated to your liking:

  • The timeout in milliseconds to wait between shoutouts for the same team member
  • An object teams where you can list any number of teams to shout out. The value of each key will be the team name display in the chat message.
  • A getMessage function that is used to format the message to be sent when a team member is detected.

Running

After installing dependencies, creating the .env file and updating the src/config.js file, run the bot:

npm start

Running with Docker

You can create the .env file first to include it in the built image, or you can omit the .env file and specify environment variables when you run the image.

docker build -t twitch-team-shoutout-bot .

This assumes the .env was built into the image:

docker run twitch-team-shoutout-bot

Run with environment variables (no .env in the image):

docker run \
  -e TWITCH_OAUTH_TOKEN=your-token-here \
  -e TWITCH_CLIENT_ID=your-client-id-here \
  -e BOT_USERNAME=your-bot-username-here \
  -e CHANNEL_NAME=your-channel-name-here \
  -e CHANNEL_ID=your-channel-id-here \
  twitch-team-shoutout-bot