Creating your first Command

Having created and started your first chabot it’s time to create your first command.

Commands are created within files which are located in the commands directory defined in the paths option when creating the chatbot.

For creating a command you will have to simply create a class and export it. The class has to extend a pre-defined class called ChatCommand.

TypeScript

commands/hello.ts

import { ChatCommand } from '@twitchfy/chatbot';

export default class HelloCommand extends ChatCommand {}

JavaScript

commands/hello.js

const { ChatCommand } = require('@twitchfy/chatbot'); //using cjs

module.exports = class HelloCommand extends ChatCommand {};

Command Name

Now that be have created a command we need to set it’s name that will be used by any chatter to execute the command.

To set the name of the command we simply set the name property inside our command class to the command’s name.

Tip

Using TypeScript, you can use SetCommand decorator for setting the diffrent command properties.

TypeScript

commands/hello.ts

import { ChatCommand, SetCommand } from '@twitchfy/chatbot';

@SetCommand({
    name: 'hello'
})
export default class HelloCommand extends ChatCommand {};

JavaScript

commands/hello.js

const { ChatCommand } = require('@twitchfy/chatbot');

module.exports = class HelloCommand extends ChatCommand {
    name: 'hello'
};

Running Commands

Once you have set the name of the command it’s time to run the command logic. When an user runs a command, the package will try to execute the run method from the command with a TwitchContext.

Here is a detailed example of a simple hello world command:

TypeScript

commands/hello.ts

import { ChatCommand, SetCommand, type TwitchContext } from '@twitchfy/chatbot';

@SetCommand({
    name: 'hello'
})
export default class HelloCommand extends ChatCommand {
    async run(ctx: TwitchContext){
        return await ctx.reply(`Hello, ${ctx.author.toString()}`);
    }
};

JavaScript

commands/hello.js

const { ChatCommand } = require('@twitchfy/chatbot')

module.exports = class HelloCommand extends ChatCommand {
    name: 'hello',
    async run(ctx){
        return await ctx.reply(`Hello, ${ctx.author.toString()}`);
    }
};

Now when any user sends the command as !hello the chatbot will reply to the user’s message, mentioning the user.

Tip

You can customize the prefix of the command by setting prefix option when creating the chatbot. This option is a callback which expects an array containing the possible prefix of the command.

import { ChatBot } from '@twitchfy/chatbot'

const chatbot = new ChatBot({
    //rest of options
    ...options
    prefix: (_ctx) => ['?', '.', '/'] //in the callback you are given the context of the possible command so you can customize it in the current context.
})