Aiden01 / toiko

A multi-purpose Discord bot that helps you manage your server 🤖

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Toiko

A multi-purpose Discord bot that helps you manage your server

avatar

Adding Toiko to your server

If you want to add Toiko to your server, you can use this link

Development

1. Clone the repository

git glone git@github.com:Aiden01/toiko.git

2. Install the dependencies

# npm
npm install
# yarn
yarn install

3. Rename config.example.json to config.json and replace the values with your actual credentials

4. Start the bot

yarn dev

Formatting

Run yarn format to make prettier format your code.

Building for production

  • Run the build script
# npm
npm run build
# yarn
yarn build
  • Docker
docker-compose up --build -d

Adding custom commands (Macro)

Toiko allows you to add custom commands, aka macro. It can be done with $addmacro.

$addmacro <category> <name> <response>

For example, this will add a macro named hello in the category fun and the bot will respond with Hello, world!.

$addmacro fun hello Hello, world!
$hello 
> Hello, world!

You can get a list of all available macros in your server using $listmacros.

They can also be edited and removed with $editmacro and $removemacro.

Relevant links

Feel free to submit PRs if you see any issues or you want to improve the bot!

About

A multi-purpose Discord bot that helps you manage your server 🤖


Languages

Language:TypeScript 99.0%Language:Dockerfile 1.0%