Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@twurple/easy-bot

twurple1.1kMIT7.4.0TypeScript support: included

A simplified framework to get a chat bot running easily.

twitch, tmi, stream, chat, bot, events

readme

Twurple - Bot framework

GitHub license npm version PRs welcome

A simplified framework to get a chatbot running easily.

Installation

yarn add @twurple/easy-bot

or using npm:

npm install @twurple/easy-bot

Example

import { Bot, createBotCommand } from '@twurple/easy-bot';

const bot = new Bot(null, {
    authProvider,
    channel: 'satisfiedpear',
    commands: [
        createBotCommand('d20', async (params, { user, say, timeout }) => {
            const diceRoll = Math.floor(Math.random() * 20) + 1;
            if (diceRoll === 1) {
                await say(`@${user} rolled a critical failure and must be punished!`);
                await timeout(30, 'critical failure');
            } else if (diceRoll === 20) {
                await say(`Woah, critical success! @${user} deserves all the praise!`);
            } else {
                await say(`@${user} rolled a ${diceRoll}!`);
            }
        })
    ]
});