Plugin Reference

RKClient

The core Rising World plugin every game server runs. Get the running instance via getPluginByName("RKClient") and cast to RKClient.

Packet registry

Method	What it does
`registerPacketHandler(Class<? extends Packet>, Consumer<Packet>)`	Register to receive a packet type sent by the backend.
`getBackendClient()`	Returns `BackendClient` — call `.sendPacket(Packet)` on it to send.

Dependencies


Private `Libs/` jars	None — RKClient has no packets of its own to ship privately.
Shared libs	Provides `SharedLibs/`, doesn't consume it — `gson-2.10.1.jar`, `RKPackets.jar`. Every other plugin's manifest resolves these for free once RKClient has loaded, no Class-Path entry needed on their side.

Event pipeline

Method	What it does
`registerEventHandler(Class<? extends RKClientEvent>, Consumer<RKClientEvent>)`	Subscribe to RKClient's own events, or any plugin's custom event type.
`getEventPipeline()`	Returns `EventPipeline` — call `.fireEvent(RKClientEvent)` on it to publish your own event.

Built-in events: PlayerVerifiedEvent (fires once a connecting player passes the wrong-server check — not raw connect), PlayerLeftEvent (fires alongside RKClient's own disconnect cleanup). Both wrap a Player.

Settings

rk.client.settings.SettingsMerger / SettingsMigrator — shared mechanism classes, call directly with your own class as the resource anchor. See Building a Plugin for the full pattern.

Player / cluster state accessors

Method	Returns
`getPlayerByUid(String uid)`	`Player`
`getOnlinePlayers()`	`HashMap<String, Player>`
`isPlayerVerified(String uid)`	`boolean`
`getServerUid()` / `getServerName()`	`String`
`getGridSize()` / `getMaxSectors()`	`int`
`isBackendConnected()`	`boolean`
`getNeighborStatus(int offsetPx, int offsetPy)`	`ServerStatus`

Package layout (source)

Package	Holds
`rk.client`	`RKClient.java` only — the plugin entry point.
`rk.client.network`	`BackendClient`, `PacketHandler`, `DataSyncManager`, `TimeSyncManager`, `TransferHandler`.
`rk.client.events`	`RKClientEvent`, `PlayerVerifiedEvent`, `PlayerLeftEvent`, `EventPipeline`.
`rk.client.settings`	`SettingsMerger`, `SettingsMigrator`, `SettingsUpdates`.
`rk.client.config`	`DebugConfig`, `NavigationConfig`.
`rk.client.spawn`	`AreaBuilder`, `NavigationController`, `SpawnSafetyManager` — border/sector-safety subsystem.
`rk.client.state`	`PlayerData`, `PlayerStateTracker`.
`rk.client.cluster`	`ClusterStateManager`.
`rk.client.util`	`FileIO`, `Logger`, `WeatherLookup`.
`rk.client.ui`	`WrongServerUI`.