CommandsPlugin class

The base plugin used to interact with nyxx_commands.

Commands can be added to nyxx_commands with the addCommand method. Once you've added the CommandsPlugin to your nyxx client, these commands will automatically become available once the client is ready.

The CommandsPlugin will automatically subscribe to all the event streams it needs. It will also bulk override all globally registered slash commands and guild commands in the guilds where commands with GuildChecks are registered.

For example, here is how you would create and register CommandsPlugin:

final commands = CommandsPlugin(
  prefix: (_) => '!',
);

final client = await Nyxx.connectGateway(
  token,
  intents,
  options: GatewayClientOptions(plugins: [commands]),
);

CommandsPlugin is also where Converters are managed and stored. New developers need not think about this as nyxx_commands comes with a set of default converters, but interested developers can take a look at addConverter and the Converter class.

You might also be interested in:

• ChatCommand, for creating commands that can be executed through Slash Commands or text messages;
• addCommand, for adding commands to your bot;
• check, for adding checks to your bot;
• MessageCommand and UserCommand, for creating Message and User Commands respectively.