Getting Started

Getting Started

Get a Buttercat bot up and running

Things you'll need

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,
  4. Run your project and see if it works