Getting Started

Things you'll need

• Git
• Node.js 16 or higher
• A Twitch account
• A Twitch token

Setting up your bot

1. Create a new JavaScript or TypeScript project

2. Install @buttercatbot/core and optionally @buttercatbot/logger

3. Create a new instance of the Bot class

   import { Bot } from '@buttercatbot/core';
    
   await new Bot({
   	channels: ['mychannel'],
   	identity: {
   		username: 'mytwitchusername',
   		password: 'mytwitchtoken',
   	},
   	logLevel: 2,
   }).initialize();

4. Run your project and see if it works

Links

• Check out the Example Bot for a working example