Character status

Character status is the best starting point for a dashboard, overlay, or automation rule. It describes who is logged in, the current map, important character values, and a few pieces of client-only action state.

Reading status

curl "http://127.0.0.1:2626/clients/ZiLo/status"

The response groups the data into a lifecycle, optional character, optional map, and common observation metadata. The generated Swagger schema shows every field and exact JSON type.

Status {
    observation: ObservationMetadata,
    lifecycle: ClientLifecycle,
    character: Character?,
    map: MapLocation?,
    planned_route: PlannedRoute?,
}

The character data includes:

• Character ID, name, gender, class, hairstyle, hair color, and body sprite
• Nation, title, guild rank, display class, and guild from the latest self-look
• Level, ability level, experience, ability points, and progress toward the next level and ability level
• Strength, intelligence, wisdom, constitution, and dexterity
• Current and maximum health and mana
• Gold, weight, and maximum weight
• Armor class, damage, hit, magic resistance, attack element, and defense element
• is_hidden, is_blinded, is_casting, is_walking, and is_action_restricted
• movement_source, which identifies the active movement origin and is null while idle
• The last server-confirmed is_group_open setting and current group_members

The map data includes its ID, available name, zero-based x/y position, width, and height.

Character {
    id: u32?,
    name: string?,
    gender: CharacterGender?,
    hair_style: u16?,
    hair_color: u8?,
    body_sprite: u16?,
    class: CharacterClass,
    identity: PlayerIdentity?,
    is_hidden: bool,
    is_action_restricted: bool,
    is_blinded: bool,
    is_casting: bool,
    is_walking: bool,
    movement_source: ActionSource?,
    is_group_open: bool?,
    is_in_exchange: bool,
    group_members: Vec<GroupMember>,
    gold: u32,
    weight: u32,
    max_weight: u32,
    progression: CharacterProgression,
    stats: CharacterStats,
    vitals: CharacterVitals,
    modifiers: CharacterModifiers?,
}

MapLocation {
    id: u32,
    name: string?,
    x: i32?,
    y: i32?,
    width: i32,
    height: i32,
}

PlannedRoute {
    source: ActionSource,
    generation: u32,
    tiles: Vec<{ x: i32, y: i32 }>,
}

planned_route.tiles contains the complete native plan from the current tile through the goal. Its source identifies who built or replaced that plan. It is replaced atomically after pathfinder rebuilds and as confirmed steps are consumed. See Movement for source semantics and Movement for generation and empty-route behavior.

Hidden characters

is_hidden identifies a character that is using Hide, including a hidden character that remains visible as a translucent sprite because of a detection spell. For the local character, /status reports the client object’s hidden or translucent state. A transition emits character.hidden_changed on the SSE stream.

Nearby players report is_hidden on their player objects. A player is treated as hidden when a 0x33 player draw has either a zero body sprite or the translucent/hidden flag. The resulting player.appeared event carries the current is_hidden value. There is no player.hidden_changed event: the character.* namespace is reserved for the local character, while nearby players use the world-object events described in World.

Hidden draws are intentionally treated as sparse observations. They do not erase the local character’s last complete human appearance, or a nearby player’s last known name and profile, when those fields are omitted. Retained data is matched by entity ID. Inspecting a hidden player can still supply a profile, which is retained for later sparse observations of that same entity. Leaving the observed area still removes the player normally.

Monster form is separate from Hide. A local monster form has no human appearance, reports is_hidden: false, and changing into or out of it emits character.appearance_changed. See Hide and monster-form transitions for the exact SSE payload changes in both directions.

Client lifecycle

The lifecycle field tells you where the client is, even when no character is available yet:

The reconnect dialog takes priority over the scene behind it. A disconnected status may retain the last readable character and map, so use lifecycle rather than the presence of character to decide whether the session is live. The DLL refreshes lifecycle during client ticks. Consumers can also watch client.logged_in and client.disconnected; see Client lifecycle events.

Action flags

is_walking means the client’s native pathfinder has an active queued route. A single directional step does not set it.

is_casting means a delayed spell is in progress. Instant spells often begin and finish between two REST reads, so the spell events are the better record of those casts.

is_action_restricted represents a specific client restriction used by movement, ground drops, incoming exchange start, and inventory rearrangement. It does not mean that every action is blocked. Turning and ordinary skill or spell activation can still be available.

is_blinded follows the blind state retained from the character’s latest status update.

is_in_exchange is true while daRPC retains an open player exchange. The full offer is available from GET /exchange.

Appearance limits

Gender, hairstyle, hair color, and body sprite come from the local character’s appearance record. They are unavailable together while the character is shown through a monster-disguise image.

Readable names are used for gender, class, and elements. Raw client identifiers and memory addresses are not exposed.

stats.stat_points is the current number of unspent character stat points. The five attribute values remain strength, dexterity, intelligence, wisdom, and constitution.

Spending stat points

Use POST /clients/{client}/stats/{stat} to spend one available stats.stat_points. The request has no body. For example, this increases strength for the client named ZiLo:

curl --request POST "http://127.0.0.1:2626/clients/ZiLo/stats/strength"

Short names are accepted, so this request increases constitution:

curl --request POST "http://127.0.0.1:2626/clients/ZiLo/stats/con"

The accepted values are strength or str, dexterity or dex, intelligence or int, wisdom or wis, and constitution or con. The daemon returns HTTP 400 without sending a packet when no point is available. Wait at least 500 milliseconds between successful requests for the same character; an earlier request returns HTTP 429.

The direct Windows equivalent is:

darpc stat strength --pid 1234

Live status events

The complete payload structures and recovery route are in Character status events.

Listen on GET /clients/{client}/events. These events update status:

Status event values are absolute replacements, not amounts to add or subtract. Several events can share one revision when one game update changed several groups.

Lifecycle transitions emit client.logged_in when the title screen enters the game and client.disconnected when the client returns to its disconnected state. A closed process also closes its stream. Consumers should reread status after reconnecting.

See World for map transitions and Movement for route details.