How to configure Command

Here you can find all the information on how to configure the command.


Command Properties

All the properties you can use in the message configuration. Every property is optional.

  • Name
    enabled
    Type
    boolean
    Description

    If false, the command will be disabled.

  • Name
    aliases
    Type
    string[]
    Description

    The aliases of the command.

  • Name
    cooldown
    Type
    number
    Description

    The cooldown of the command in seconds.

  • Name
    roles
    Type
    string[]
    Description

    The roles required to use the command.

  • Name
    inherited
    Type
    boolean
    Description

    If true, member with a roles higher than the required roles can use the command.

  • Name
    permissions
    Type
    string[]
    Description

    The permissions required to use the command.

  • Name
    permission
    Type
    string
    Description

    Directly use discord permissions

  • Name
    channels
    Type
    string[]
    Description

    The channels where the command can be used.

  • Name
    users
    Type
    string[]
    Description

    The users who can use the command.

Example

plugin:
  # Configuration can be added here.
  permission: "ADMINISTRATOR" # Here for example, the command will require the administrator permission.
  description: "Manage plugins."
  subcommands:
    list:
      description: "Show the list of plugins."

Was this page helpful?