1.0.2 • Published 2 years ago

discord-citrus v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Installation

Requires Node 16.6.0+ and Discord.js v13.

  • discord citrus - npm i discord-citrus

  • discord.js - npm install discord.js

  • sqlite (optional) - npm install sqlite

  • sequelize (optional) - npm install sequelize

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 and database providers.

  • Resolvers for members, users, and others that can filter by name.
  • Shortcut methods for making embeds and collections.
  • Simple to use database providers.
    • Built-in support for sqlite and sequelize.
    • Works on entire table or single JSON column.
    • Caching data from databases.

License

Released under the ISC license.

Citrus (adj.) is derived from the Modern Latin genus name, from Latin citrus "citron tree", the name of an African tree with aromatic wood and lemon-like fruit (and generally bc my name is Lemon)