Search packages, repositories and app categories

ducafecatFlutter ecosystem guide
Package detailsv6.9.1

nyxx

A complete, robust and efficient wrapper around Discord's API for bots & applications.

AndroidiOSmacOSWindowsLinux
pub.dev API documentation Source code
30-day downloads
1.9K
Likes
109
Pub points
140

Install package

flutter pub add nyxx

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

Nyxx is a comprehensive, efficient, and robust Dart library that provides full access to Discord's API for building bots and applications. Designed with performance and reliability in mind, it supports real-time interactions, event handling, and rich functionality for managing servers, users, and messages. The package is suitable for developers aiming to create feature-rich Discord integrations across multiple platforms. Its clean API and active community support make it a strong choice for both beginners and experienced developers.

Use cases

  • Building Discord bots
  • Creating real-time chat applications
  • Integrating Discord into multi-platform apps
  • Managing server automation
  • Handling message events and reactions

Key features

  • Full Discord API coverage
  • Real-time event streaming
  • Cross-platform support
  • Efficient resource usage
  • Robust error handling
  • Modular design

Suitable for

  • Discord bot developers
  • Multi-platform application creators
  • Real-time communication projects
  • Server automation tools
  • Dart/Flutter developers targeting Discord integration

Considerations

  • Requires understanding of Discord API
  • May need additional setup for authentication
  • Dependent on stable network connectivity
  • Learning curve for advanced features
  • Not intended for user-facing Discord clients

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

nyxx

Discord pub documentation

A complete, robust and efficient wrapper around Discord's API for bots & applications.

To get started using nyxx, follow our 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:nyxx/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!',
        referencedMessage: MessageReferenceBuilder.reply(messageId: 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.

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.

Categories

Chat

Dependencies

Dependency list 9 items

Source repository

Projects using this package

No data available yet.