GithubHelp home page GithubHelp logo

toiko's Introduction

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 [email protected]: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!

toiko's People

Contributors

aiden01 avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.