nyxx-self

April 15, 2024 ยท View on GitHub

pub documentation

The self-bot fork of nyxx, a simple, robust framework for creating discord bots for Dart language.

Disclaimer:

Self-botting is against Discord ToS. I do not encourage the use of this library and I am not held responsible for any damages or consequences inflicted upon you due to improper use of this library.

Notice:

This fork is a work-in-progress proof of concept. If you are using this fork, report issues to this repo.

Features

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

Quick example

Basic usage:

import 'package:nyxx_self/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

Notice: At this time, it is not guaranteed that these extensions will work for self-bots (ex. interactions). Proceed at your own risk if you truly know what you are doing.

  • 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