\r\n It is flexible, fully object-oriented, easy to use, and makes it trivial to create your own powerful commands.\r\n Based on tmi.js.\r\n
\r\n \r\n\r\n
\r\n \r\n \r\n
\r\n\r\n## Installation\r\n\r\nwith npm:\r\n\r\n```\r\nnpm install twitch-core\r\n```\r\n\r\nor yarn:\r\n\r\n```\r\nyarn add twitch-core\r\n```\r\n\r\n## Features\r\n* Automatic command parsing\r\n* Automatic parsing of command arguments and conversion to named variables with type preservation\r\n* All commands run asynchronously\r\n* You can configure the prefix of commands\r\n* Loading configuration files\r\n* TypeScript definitions \r\n\r\n## Base settings for the client\r\n\r\n```ts\r\nimport { join } from 'path'\r\nimport { TwitchCommandClient, TwitchChatMessage } from 'twitch-core'\r\n\r\nconst client = new TwitchCommandClient({\r\n username: 'vs_code',\r\n oauth: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',\r\n channels: ['archikoff', 'le_xot'],\r\n botOwners: ['vs_code']\r\n})\r\n\r\nclient.on('connected', () => {})\r\n\r\nclient.on('join', channel => { })\r\n\r\nclient.on('error', err => { })\r\n\r\nclient.on('message', (msg: TwitchChatMessage) => { })\r\n\r\nclient.provider.set(\r\n join(__dirname, 'config/text-commands.json'),\r\n join(__dirname, 'config/commands.json')\r\n)\r\n\r\nclient.registerTextCommands()\r\n\r\nclient.registerDefaultCommands()\r\n\r\nclient.registerCommandsIn(\r\n join(__dirname, '/commands')\r\n)\r\n\r\nclient.connect()\r\n```\r\n\r\n> Client extends of `EventEmitter`, so you can easily subscribe to his events.\r\n\r\n> You can register the bot's default commands (`!commands`, `!help`, etc.), using method `registerDefaultCommands`.\r\n\r\n> Method `registerTextCommands` allows loading text commands, using `text-commands.json` config.\r\n\r\n> Create folder called `commands`, that will contain all your commands.\r\n\r\n> Don't forget to call method `registerCommandsIn`, to register your own commands.\r\n\r\n## Creating a standard command\r\n\r\n```ts\r\nimport { TwitchChatCommand, TwitchCommandClient, TwitchChatMessage, CommandOptions } from 'twitch-core'\r\n\r\nclass Example extends TwitchChatCommand {\r\n constructor(client: TwitchCommandClient, options: CommandOptions) {\r\n super(client, {\r\n name: 'example',\r\n userlevel: 'everyone',\r\n description: 'Example command',\r\n examples: [\r\n '!example',\r\n '!example '\r\n ]\r\n })\r\n }\r\n\r\n async run(msg: TwitchChatMessage, args: string[]) {\r\n msg.reply(`Args -> ${args.join(' ')}`)\r\n }\r\n}\r\n\r\nexport default Example\r\n```\r\n\r\n## Command with named arguments\r\n\r\n```ts\r\nimport { TwitchChatCommand, TwitchCommandClient, TwitchChatMessage, CommandOptions } from 'twitch-core'\r\n\r\ninterface CommandArgs {\r\n name: string\r\n age: number\r\n bool: boolean\r\n}\r\n\r\nclass ExampleArgs extends TwitchChatCommand {\r\n constructor(client: TwitchCommandClient, options: CommandOptions) {\r\n super(client, {\r\n name: 'example-args',\r\n userlevel: 'everyone',\r\n description: 'Example of command with named arguments',\r\n examples: [\r\n '!example',\r\n '!example '\r\n ],\r\n {\r\n name: 'name',\r\n type: String,\r\n defaultValue: 'Text string'\r\n },\r\n {\r\n name: 'age',\r\n type: Number,\r\n defaultValue: 22\r\n },\r\n {\r\n name: 'bool',\r\n type: Boolean,\r\n defaultValue: false\r\n }\r\n })\r\n }\r\n\r\n async run(msg: TwitchChatMessage, { name, age, bool }: CommandArgs) {\r\n msg.reply(`Args -> ${name} ${age} ${bool}`)\r\n }\r\n}\r\n\r\nexport default ExampleArgs\r\n```\r\n\r\n## Example bots\r\n\r\n* [crashmax-dev/twitch-bot](https://github.com/crashmax-dev/twitch-bot)\r\n* [crashmax-dev/twitch-bot-example](https://github.com/crashmax-dev/twitch-bot-example)\r\n\r\n> Create [issue](https://github.com/crashmax-dev/twitch-core/issues/new) to add your bot 👍\r\n\r\n## Commands params\r\n\r\n* **name**: Name of command (default alias of command)\r\n* **description**: Description of command (using at `!help `)\r\n* **userlevel**: Access level (`everyone`, `regular`, `vip`, `subscriber`, `moderator`, `broadcaster`)\r\n* **examples**?: Examples for command (using in `!help `)\r\n* **args**?: Creating named command arguments\r\n* **aliases**?: Additional command aliases\r\n* **botChannelOnly**?: Is thing command only available on the bot channel (if you have enabled `autoJoinBotChannel` in client constructor)?\r\n* **hideFromHelp**?: Do we need to hide command from `!commands` list?\r\n* **privmsgOnly**?: Answer to command only at PM?\r\n\r\n## Text command params (also implements the options above)\r\n* **text**: Message text\r\n* **messageType**?: Message send type (`reply`, `actionReply`, `say`, `actionSay`)\r\n\r\n## Default commands\r\n* **!commands**: All registered commands\r\n* **!help \\**: Help with command (detailed information)\r\n","readmeFilename":"README.md"}
![](\"docs/images/logo.png\"){kind=logo}
\r\n![\"npm\"](\"https://img.shields.io/npm/v/twitch-core\")
![\"Size\"](\"https://img.shields.io/bundlephobia/minzip/twitch-core\")