classicvalues / pictionary-bot

Simple Twitch.tv Bot for playing Pictionary, ispired by https://twitch.tv/designs

Pictionary Bot

Simple Twitch.tv Bot for playing Pictionary, ispired by https://twitch.tv/designs

Installation

Requirements

• NodeJS Version 8+
• Yarn (Optional)

Linux / MacOS

1. Install dependencies

   npm install

   or

   yarn install

2. Copy the environment file

   cp .env.example .env

3. Edit the .env file to match your settings

   To generate your Twitch.tv oAuth token you can use https://twitchapps.com/tmi/

   # Twitch Settings
   CHANNEL="channelname" # target channel name here
   USERNAME="botname" # your twitch.tv username
   PASSWORD="oauth:token" # your twitch.tv oauth token

4. Start the bot

   npm run start

   or

   yarn start

5. Write the !pictionary command in Twitch channel chat to start the bot! (Only the broadcaster can start the bot)

Commands

Channel Commands

• !pictionary Starts the bot (Only broadcaster)
• !about Shows info about the creator

Whisper Commands

• !stop Stops the bot (Only broadcaster)

TODO

• Reset scores
• Logging
• Leaderboard
• Automatic check for valid English word (Dictionary API)
• Lose if winner doesn't write the next word to the bot in time