Firebridge #

An experimental package to use Discord with user accounts, built off of Nyxx.

Note: Using this with your user account is against TOS! Proceed at your own risk.

To get started using nyxx, follow the Nyxx getting started guide to write your first bot.

If you're already familiar with Discord's API, here's a quick example to get you started:

import 'package:firebridge/nyxx.dart';

void main() async {
  final client = await Nyxx.connectGateway('<TOKEN>', GatewayIntents.allUnprivileged);

  final botUser = await client.users.fetchCurrentUser();

  client.onMessageCreate.listen((event) async {
    if (event.mentions.contains(botUser)) {
      await event.message.channel.sendMessage(MessageBuilder(
        content: 'You mentioned me!',
        replyId: event.message.id,
      ));
    }
  });
}

Other nyxx packages #

• nyxx_commands: A command framework for handling both simple & complex commands.
• nyxx_extensions: Pagination, emoji utilities and other miscellaneous helpers for developing bots using nyxx.
• nyxx_lavalink: Lavalink support for playing audio in voice channels.

More examples #

• More examples can be found in our GitHub repository here.
• Running on Dart is a complete example of a bot written with nyxx.

Additional documentation & help #

The API documentation for the latest stable version can be found on pub.

Docs and wiki #

Tutorials and wiki articles are hosted here, as well as API documentation for development versions from GitHub.

Official nyxx Discord server #

Our Discord server is where you can get help for any nyxx packages, as well as release announcements and discussions about the library.

Discord API docs #

Discord's API documentation details what nyxx implements & provides more detailed explanations of certain topics.

Discord API Server #

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

Pub.dev docs #

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

Contributing to Nyxx #

Read the contributing document

Credits #

• Thanks to Hackzzila's for nyx, the original project nyxx was forked from.