RWR public API

The RWR API is for plugin developers. It exposes read-only snapshots and events without coupling your plugin to RWR internals, Multiverse-Core, or Worlds.

Add the dependency

Maven

<dependency>
  <groupId>io.github.tamawish</groupId>
  <artifactId>rwr-api</artifactId>
  <version>5.1.2</version>
  <scope>provided</scope>
</dependency>

Gradle

dependencies {
    compileOnly("io.github.tamawish:rwr-api:5.1.2")
}

Do not shade the API

RWR supplies these classes at runtime. Keep the API dependency as provided or compileOnly, and do not install a separate API JAR on the server.

Discover RWR

RwrApi.find(getServer()).ifPresent(api -> {
    for (ManagedWorldSnapshot world : api.managedWorlds()) {
        getLogger().info(world.id() + " -> " + world.state());
    }
});

Snapshots

Read immutable managed-world and reset-status snapshots.

Warning events

Observe scheduled warnings before a reset operation exists.

Reset events

Cancel a pre-reset event or inspect a terminal post-reset outcome.

Platform neutral

Support either RWR runtime without provider classes leaking into your API.

Keep event callbacks short and move external I/O off the server thread. Reacquire the service after plugin lifecycle changes.

Complete API contract and examples