Discord Shield pub documentation

Simple, robust framework for creating discord bots for Dart language.


  • Slash commands support
    Supports and provides easy API for creating and handling slash commands
  • Buttons and dropdowns
  • Autocomplete
  • Context menus

Quick example

Slash commands:

void main() {
  final bot = NyxxFactory.createNyxxWebsocket("<TOKEN>", GatewayIntents.allUnprivileged)
    ..registerPlugin(Logging()) // Default logging plugin
    ..registerPlugin(CliIntegration()) // Cli integration for nyxx allows stopping application via SIGTERM and SIGKILl
    ..registerPlugin(IgnoreExceptions()) // Plugin that handles uncaught exceptions that may occur

    ..registerHandler("test", "This is test command", [], handler: (event) async {
      await event.reply(MessageBuilder.content("This is example message result"));

Other nyxx packages

More examples

Nyxx examples can be found here.

Example bots

Documentation, help and examples

Dartdoc documentation for latest stable version is hosted on pub

Docs and wiki

You can read docs and wiki articles for latest stable version on my website. This website also hosts docs for latest dev changes to framework (dev branch)

Official nyxx discord server

If you need assistance in developing bot using nyxx you can join official nyxx discord guild.

Discord API docs

Discord API documentation features rich descriptions about all topics that nyxx covers.

Discord API Guild

The unofficial guild for Discord Bot developers. To get help with nyxx check #dart_nyxx channel.


The dartdocs page will always have the documentation for the latest release.

Contributing to Nyxx

Read contributing document