Tanzanite/discord-akairo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
1,672 commits 1 branch 0 tags 10 MiB
  • TypeScript 100%
Find a file
Exact
IRONM00N f666764eae
Some checks failed
Generate Docs / build_and_deploy (push) Has been skipped
Details
Checks / Lint (push) Successful in 4m0s
Details
Checks / Check Formatting (push) Successful in 3m17s
Details
Publish dev / npm publish (push) Has been cancelled
Details
npm auto deprecate / npm auto deprecate (push) Has been cancelled
Details
use git hooks instead of github actions for formatting
2023-12-25 23:37:05 -05:00
.github/workflows use git hooks instead of github actions for formatting 2023-12-25 23:37:05 -05:00
.husky use git hooks instead of github actions for formatting 2023-12-25 23:37:05 -05:00
.vscode correctly handle partial structures in check*, further abstract channel type resolvers 2023-12-25 22:13:31 -05:00
.yarn/releases correctly handle partial structures in check*, further abstract channel type resolvers 2023-12-25 22:13:31 -05:00
guide update documentation, add docs about subcommands 2023-06-19 21:36:15 -04:00
src Automatically format code 2023-12-26 03:14:39 +00:00
tests tests: switch to node:test 2023-09-10 19:01:53 -04:00
.eslintrc.json typings fixes, misc 2023-09-10 18:10:53 -04:00
.git-blame-ignore-revs made a few unit tests, experiment with swc 2022-06-23 18:44:00 -04:00
.gitattributes chore(.gitattributes): classify linguist-generated 2022-05-29 15:47:42 -04:00
.gitignore remove unneeded files from .gitignore 2022-06-28 18:30:18 -04:00
.npmignore restructure tests and switch to ts project references 2022-06-24 22:28:42 -04:00
.npmrc moved everything out of lib again 2021-11-25 22:56:30 -05:00
.prettierignore typings fixes, misc 2023-09-10 18:10:53 -04:00
.prettierrc.json switched to yarn 3.0, removed stage channels, misc improvements 2022-04-10 16:47:13 -04:00
.yarnrc.yml upgrade deps, upgrade yarn, add debug error to ClientUtils.checkUser 2023-11-20 19:21:57 -05:00
LICENSE meta: update license year 2020-03-03 11:14:47 -05:00
package.json use git hooks instead of github actions for formatting 2023-12-25 23:37:05 -05:00
README.md switch to @tanzanite/discord-akairo, update documentation 2023-06-19 17:06:34 -04:00
tsconfig.base.json 10.0.2 2023-04-03 14:31:15 -04:00
tsconfig.eslint.json make tests use esm, improve validation, bump to version 10.0.0-dev 2022-08-08 22:06:12 -04:00
tsconfig.json tests: switch to node:test 2023-09-10 19:01:53 -04:00
tsconfig.pkg.json restructure tests and switch to ts project references 2022-06-24 22:28:42 -04:00
yarn.lock use git hooks instead of github actions for formatting 2023-12-25 23:37:05 -05:00

README.md


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.