BungeeCord

Adventure targets the latest version of BungeeCord and BungeeCord-compatible forks, such as Waterfall.

Declaring the dependency:

<dependency>
   <groupId>net.kyori</groupId>
   <artifactId>adventure-platform-bungeecord</artifactId>
   <version>4.4.0</version>
</dependency>

repositories {
    mavenCentral()
}

dependencies {
    implementation "net.kyori:adventure-platform-bungeecord:4.4.0"
}

repositories {
    mavenCentral()
}

dependencies {
    implementation("net.kyori:adventure-platform-bungeecord:4.4.0")
}

Need development/snapshot builds? Using Snapshot Builds

You should first obtain a BungeeAudiences object by using BungeeAudiences.create(plugin). This object is thread-safe and can be reused from different threads if needed. This object should also be closed when the plugin is disabled.

Note that not all functionality is available on the proxy. Sending chat messages, action bar messages, titles, and boss bars, and tab list header and footer are supported, but all other requests will fail silently.

A simple example of how to appropriately initialize this platform follows:

public class MyPlugin extends Plugin {

    private BungeeAudiences adventure;

    @NonNull
    public BungeeAudiences adventure() {
        if (this.adventure == null) {
            throw new IllegalStateException("Cannot retrieve audience provider while plugin is not enabled");
        }
        return this.adventure;
    }

    @Override
    public void onEnable() {
        this.adventure = BungeeAudiences.create(this);
    }

    @Override
    public void onDisable() {
        if (this.adventure != null) {
            this.adventure.close();
            this.adventure = null;
        }
    }
}

For functionality not already supported by Audience, the BungeeComponentSerializer allows you to convert between Adventure Components and the native BungeeCord chat component API and back.