Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
106 lines (80 sloc) 4.66 KB

Discord4J

Maven Central Support Server Invite

A fast, reactive Java wrapper for the official Discord Bot API.

Built with Reactor, Netty, and a focus on flexibility, Discord4J provides an effective, non-blocking interface for creating Discord bots. The reactive and asynchronous nature of the library allows for scalability through backpressure handling and the efficient use of resources. Its modularized structure gives the user the ability to tailor their experience to different levels of abstraction and pick the right tools for the job.

Installation

Gradle

repositories {
  mavenCentral()
}

dependencies {
  implementation 'com.discord4j:discord4j-core:3.0.1'
}

Maven

<dependencies>
  <dependency>
    <groupId>com.discord4j</groupId>
    <artifactId>discord4j-core</artifactId>
    <version>3.0.1</version>
  </dependency>
</dependencies>

SBT

libraryDependencies ++= Seq(
  "com.discord4j" % "discord4j-core" % "3.0.1"
)

Quick Example (Reactive and Blocking)

final DiscordClient client = new DiscordClientBuilder("token").build();

client.getEventDispatcher().on(ReadyEvent.class)
        .subscribe(ready -> System.out.println("Logged in as " + ready.getSelf().getUsername()));

client.getEventDispatcher().on(MessageCreateEvent.class)
        .map(MessageCreateEvent::getMessage)
        .filter(msg -> msg.getContent().map("!ping"::equals).orElse(false))
        .flatMap(Message::getChannel)
        .flatMap(channel -> channel.createMessage("Pong!"))
        .subscribe();

client.login().block();
final DiscordClient client = new DiscordClientBuilder("token").build();

client.getEventDispatcher().on(ReadyEvent.class)
        .subscribe(ready -> System.out.println("Logged in as " + ready.getSelf().getUsername()));

client.getEventDispatcher().on(MessageCreateEvent.class)
        .subscribe(event -> {
            Message message = event.getMessage();
            if (message.getContent().map("!ping"::equals).orElse(false)) {
                message.getChannel().block().createMessage("Pong!").block();
            }
         });

client.login().block();

Modules

Discord4J is highly oriented towards customizability. To achieve this, the project is divided into several "modules" which can be used separately depending on your use case.

Core

The core module combines the other modules to form high-level abstractions for the entire Discord Bot API. This is the module most users will want when making bots.

Rest

The rest module provides a low-level HTTP client specifically for Discord which properly handles Discord's ratelimiting system.

Gateway

The gateway module provides a low-level WebSocket client for interacting with the Discord Gateway.

Voice

The voice module provides a client to manipulate audio through Voice Connections.

Command

The command module provides a set of low-level tools for dealing with bot commands. It can be used on its own or easily serve as a basis of interoperability for higher-level command libraries.

Common

The common module contains base utilities and models useful for other modules.

Stores

Discord4J's mechanism for storing information received on the gateway is completely pluggable. This allows both the ability to customize what is stored and how. The Stores repository contains some pre-made implementations as well as the API for making your own.

Development builds

Please follow our instructions at Using Jitpack

Useful Links

You can’t perform that action at this time.