Skip to content

OpenBonfire/firebridge

 
 

Repository files navigation

Firebridge

Firebridge has moved! We are now operating at https://github.com/OpenBonfire/bonfire, for the sake of development. I may end up using this repository in the future as the project scales.

documentation

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/firebridge.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

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.

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

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

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

Contributing to Firebridge

Read the contributing document

Credits

  • Thanks to Hackzzila's for nyx, the original project nyxx was forked from, as well as Nyxx, the project that firebridge is forked from.

About

Wrapper around Discord user API for Dart

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 99.9%
  • Makefile 0.1%