Skip to content

TanzaniteBot/discord-akairo

 
 

Repository files navigation


discord-akairo


NPM version NPM downloads Checks

Changes in this fork of discord-akairo

Please see this file for a list of changes in this fork vs normal akairo. If you have any questions related to this fork please contact ironm00n in the akairo server or join my bot's discord server.

Features

Completely modular commands, inhibitors, and listeners.

  • Reading files recursively from directories.
  • Adding, removing, and reloading modules.
  • Creating your own handlers and module types.

Flexible command handling and creation.

  • Command aliases.
  • Command throttling and cooldowns.
  • Client and user permission checks.
  • Running commands on edits and editing previous responses.
  • Multiple prefixes and mention prefixes.
  • Regular expression and conditional triggers.

Complex and highly customizable arguments.

  • Support for quoted arguments.
  • Arguments based on previous arguments.
  • Several ways to match arguments, such as flag arguments.
  • Casting input into certain types.
    • Simple types such as string, integer, float, url, date, etc.
    • Discord-related types such as user, member, message, etc.
    • Types that you can add yourself.
    • Asynchronous type casting.
  • Prompting for input for arguments.
    • Customizable prompts with embeds, files, etc.
    • Easily include dynamic data such as the incorrect input.
    • Infinite argument prompting.

Blocking and monitoring messages with inhibitors.

  • Run at various stages of command handling.
    • On all messages.
    • On messages that are from valid users.
    • On messages before commands.

Helpful events and modular listeners.

  • Events for handlers, such as loading modules.
  • Events for various stages of command handling.
  • Reloadable listeners to easily separate your event handling.

Useful utilities.

  • Resolvers for members, users, and others that can filter by name.
  • Shortcut methods for making embeds and collections.

Installation

Requires Node 16+ and Discord.js v14.

discord-akairo If you do not want to have to update your imports you can install the library using the following: yarn add discord-akairo@npm:@tanzanite/discord-akairo@dev
npm i discord-akairo@npm:@tanzanite/discord-akairo

Otherwise you can install the package normally, just make sure to update your imports from discord-akairo to @tanzanite/discord-akairo: yarn add @tanzanite/discord-akairo@dev
npm i @tanzanite/discord-akairo

discord.js fork
optional you can use regular discord.js instead if you want
yarn add discord.js@npm:@tanzanite/discord.js@dev
npm i discord.js@npm:@tanzanite/discord.js

Links

Contributing

Open an issue or a pull request!
Everyone is welcome to do so.
Make sure to run yarn test before committing.