Build Status Pub documentation

Simple, robust framework for creating discord bots for Dart language. This is fork of Hackzzila's nyx.


Features

  • Commands framework included
    A fast way to create a bot with command support. Implementing the framework is simple - and everything is done automatically.
  • Cross Platform
    Nyxx works on the command line, in the browser, and on mobile devices.
  • Fine Control
    Nyxx allows you to control every outgoing HTTP request or WebSocket message.
  • Complete
    Nyxx supports nearly all Discord API endpoints.

Sample

Basic usage:

void main() {
  var bot = Nyxx(Platform.environment['DISCORD_TOKEN']);

  bot.onMessageReceived.listen((MessageEvent e) {
    if (e.message.content == "!ping") {
      e.message.channel.send(content: "Pong!");
    }
  });
}

Commands:

void main() {
  nyxx.Nyxx bot = nyxx.Nyxx(Platform.environment['DISCORD_TOKEN']);
  command.CommandsFramework('!', bot)
    ..admins = [nyxx.Snowflake("302359032612651009")]
    ..registerLibraryCommands();
}

@Command(name: "single")
Future<void> single(CommandContext context) async {
  await context.reply(content: "WORKING");
}

Documentation, help and examples

Discord API docs

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

Discord API Guild

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

Dartdocs

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

Dev docs

You can read about upcoming changes to the library on my website.

Wiki

Wiki documentation are designed to match the latest Nyxx release.

Libraries

nyxx
Nyxx Discord API wrapper for Dart [...]
nyxx.browser
nyxx.commands
Nyxx - Discord API wrapper for Dart Commands sublibrary [...]
Nyxx Discord API for Dart Lavalink sublibrary [...]
nyxx.utils
nyxx.vm