twitch-chatbot-boilerplate (Wiki)

This project is not affiliated to Twitch Interactive Inc in any way.

Uses:

• TypeScript
• tmi.js (Twitch Messaging Interface)
• express
• ESLint
• Jest
• Prettier
• .editorconfig
• dotenv

Don't like x ?

If you don't like the choices made for you by the boilerplate you can just use the core npm package by itself. It exports the initialize() function which takes care of setting up an http server and the setup process. You call it and get a tmi.js client back which is already connected to twitch.

Setup (short)

The full setup guide with screenshots is available in the wiki

1. Register a twitch app.
2. Make sure to include the /setup/callback, /add/callback and /setup/callback routes.
3. Clone or download this repository
4. Install dependencies npm install
5. Copy both the secret and your Client-ID into a .env file (cp .env.example .env first)
6. Build and start the bot: npm run build and npm run start
7. Follow further instructions
8. Write your bot (/main.ts)
9. Profit

Next Steps

Caveats

See wiki

Available Scripts

• clean - remove caches and build files,
• build - TypeScript build,
• build:watch - executes build on every file change,
• lint - run the linter,
• test - run the tests,
• test:watch - executes test on every file change

License

Licensed under the Unlicense. See the LICENSE file for details.

The following files in public/fonts are licensed under the SIL Open Font License, Version 1.1, Copyright (c) 2010-2011 by tyPoland Lukasz Dziedzic (team@latofonts.com) with Reserved Font Name "Lato": "lato-v16-latin-900.eot", "lato-v16-latin-900.svg", "lato-v16-latin-900.ttf", "lato-v16-latin-900.woff", "lato-v16-latin-900.woff2", "lato-v16-latin-regular.eot",lato-v16-latin-regular.svg", "lato-v16-latin-regular.ttf", "lato-v16-latin-regular.woff" and "lato-v16-latin-regular.woff2"

public/TwitchGlitchWhite.png: Copyright (c) Twitch Interactive, Inc