xaby-simple-twitch-bot

Simple twitch bot for simple chat interactions and commands on Node.js and Tmi.js.

For more information about tmi.js follow the official website: https://tmijs.com/ .

I will add more functionallity in the future. See the Roadmap.

Built in With

This section should list any major frameworks/libraries used to bootstrap this project.

Node.js Tmi.js Dotenv fs-js Axios Express Kleur

(back to top)

Prerequisites

1. Get a free API Key at https://dev.twitch.tv/ or just using your user account by generating a password for the API https://twitchapps.com/tmi/.

2. You need to install tmi.js to run the bot and it is recommended to use dotenv.

• npm

  npm install tmi.js@latest
  npm install dotenv@latest
  npm install fs-js@latest
  npm install kleur@latest
  npm install axios@latest
  npm install express@latest

3. Before running the bot you will need to configure it.

    const options = {
    options: {
        debug: true
    },
    connection: {
        reconnect: true,
        secure: true,
        timeout: 10000,
        maxReconnectAttempts: 5
    },
    identity: {
        username: '', /* Username for the account the bot will use */
        password: '' /* oauth:{token} */
    },
    channels: [''] /* Stream channel user */
    }

       case 'test':
                client.say(target, 'This is a test.');
                break;

Runnning the bot

You can now use it and customize it as you need, use the command bellow to run the bot, You can run the bot locally or online using platforms like Heroku.

node /src/bot.js
or
npm run bot

Roadmap

---> ✔ Done. - 🛠 Working on it. - ⭕ Planned. - ❌ Will not doing that.

• [✔] Basic commands.
• [🛠] Subs, resubs, gifted subs message.
• [✔] Current song command (locally).
• [🛠-⭕-❌] Bot control-Web gui.
• [🛠] Mods commands.
• [✔] API Integrations.
• [✔] Add Chatlog.
• [✔] CLI Commands.
• [⭕] Raids notification.
• [⭕] Channel points actions.
• [⭕] Timers.
• [⭕] Database integration.
  • [⭕] Counters.
• [⭕] Discord integration.
• [🛠] Multi-language Support (Docs).
  • [✔] Spanish
  • [⭕] English

See the open issues for a full list of proposed features (and known issues).

(back to top)