Pipe Server IPC/RPC API Reference

Overview

The pipe server provides inter-process communication via Windows Named Pipes with MessagePack-encoded JSON payloads. External processes (Java clients, tooling, scripts) connect to query game state and inject actions.

Pipe name: \\.\pipe\BotWithUs_{PID} Serialization: MessagePack (JSON model) Build flag: ENABLE_PIPE_SERVER Namespace: rpc

Wire Protocol

Message Framing

Every message (request and response) is framed as:

[4 bytes: little-endian uint32 body length] [N bytes: msgpack-encoded JSON body]

Maximum body size: 16 MB. Messages exceeding this or with zero length cause disconnection.

Request Format

{
  "method": "method_name",
  "id": 1,
  "params": { ... }
}

Field	Type	Required	Description
`method`	string	yes	RPC method name
`id`	uint32	yes	Request ID, echoed in response
`params`	object	no	Method-specific parameters

The server injects _client_id into params before dispatching. Handlers can use this for client-specific operations (e.g., event subscriptions).

Response Format

Success:

{
  "id": 1,
  "result": { ... }
}

Error:

{
  "id": 1,
  "error": "error message"
}

Event Format (server-pushed)

{
  "event": "event_name",
  "data": { ... }
}

Events are only sent to clients that have subscribed via rpc.subscribe.

Transport Details

Property	Value
Pipe type	`PIPE_TYPE_BYTE`, `PIPE_WAIT`
Buffer size	65,536 bytes per direction
Max clients	Unlimited (`PIPE_UNLIMITED_INSTANCES`)
I/O model	IOCP with 2 worker threads
Client IDs	Auto-incrementing uint32 from 1

Connection Lifecycle

Client connects to \\.\pipe\BotWithUs_{PID}
Server assigns a unique client ID
Server begins reading 4-byte header frames
Header decoded → body read → processMessage() → response sent
Loop continues until client disconnects or error occurs
On disconnect, all event subscriptions are cleaned up

RPC Methods

System

`rpc.ping`

Connectivity check.

Params: none Returns: {"pong": true}

`rpc.list_methods`

List all registered RPC method names.

Params: none Returns: ["method_name", ...]

`rpc.subscribe`

Subscribe to server-pushed events.

Params:

Field	Type	Required	Description
`event`	string	yes	Event name

Returns: {"subscribed": "event_name"}

`rpc.unsubscribe`

Unsubscribe from an event.

Params:

Field	Type	Required	Description
`event`	string	yes	Event name

Returns: {"unsubscribed": "event_name"}

`rpc.client_count`

Get number of connected clients.

Params: none Returns: {"count": 3}

`rpc.list_events`

List all available event names that can be subscribed to.

Params: none Returns: ["tick", "login_state_change", "var_change", "varbit_change", ...]

`rpc.get_subscriptions`

Get the calling client's current event subscriptions.

Params: none (uses implicit _client_id) Returns: ["tick", "var_change"]

Events

Events are server-pushed messages sent to subscribed clients. Subscribe with rpc.subscribe, unsubscribe with rpc.unsubscribe. Events have no id field — they use {"event": "name", "data": {...}} format.

`tick`

Fired each game tick when the server tick counter advances.

Data:

Field	Type	Description
`tick`	int32	Server tick counter value

`login_state_change`

Fired when the game client state changes (login screen, lobby, in-game, world hopping, etc.).

Data:

Field	Type	Description
`old_state`	int	Previous client state value
`new_state`	int	New client state value

Common states: 10 = lobby, 20 = loading, 30 = in-game.

`var_change`

Fired when a player variable (varp) changes value.

Data:

Field	Type	Description
`var_id`	int	Varp ID that changed
`old_value`	int	Previous value
`new_value`	int	New value

`varbit_change`

Fired when a varbit changes value.

Data:

Field	Type	Description
`var_id`	int	Varbit ID that changed
`old_value`	int	Previous value
`new_value`	int	New value

`key_input`

Fired when a key is pressed while ImGui has keyboard focus (overlay active).

Data:

Field	Type	Description
`key`	int	Virtual key code (VK_*)
`is_alt`	bool	ALT modifier held
`is_ctrl`	bool	CTRL modifier held
`is_shift`	bool	SHIFT modifier held

`action_executed`

Fired after each queued bot action is executed on the game thread.

Data:

Field	Type	Description
`action_id`	int	Action type ID
`param1`	int	First param
`param2`	int	Second param
`param3`	int	Third param

`break_started`

Fired when a break begins (logout triggered by humanizer fatigue/risk or manual schedule).

Data:

Field	Type	Description
`duration_seconds`	int	Scheduled break duration
`fatigue`	double	Fatigue level at break start [0,1]
`risk`	double	Cumulative risk at break start

`break_ended`

Fired when a break countdown completes and the bot resumes.

Data: {} (empty)

Actions

`queue_action`

Queue a single game action.

Params:

Field	Type	Required	Default	Description
`action_id`	int	yes		Action type ID
`param1`	int	no	0	First param
`param2`	int	no	0	Second param
`param3`	int	no	0	Third param

Returns: {"ok": true}

`queue_actions`

Queue multiple game actions atomically.

Params:

Field	Type	Required	Description
`actions`	array	yes	Array of `{action_id, param1, param2, param3}`

Returns: {"queued": 3}

`get_action_queue_size`

Get pending action queue length.

Params: none Returns: {"size": 2}

`clear_action_queue`

Clear all pending actions.

Params: none Returns: {"ok": true}

`get_action_history`

Get recent action execution history.

Params:

Field	Type	Required	Default	Description
`max_results`	int	no	50	Max entries to return
`action_id_filter`	int	no	-1	Filter by action ID (-1=all)

Returns:

[
  {
    "action_id": 5,
    "param1": 100,
    "param2": 200,
    "param3": 0,
    "timestamp": 1709573400000,
    "delta": 600
  }
]

`get_last_action_time`

Get timestamp of last executed action.

Params: none Returns: {"timestamp": 1709573400000}

`are_actions_blocked`

Check if action execution is blocked.

Params: none Returns: {"blocked": false}

`set_actions_blocked`

Block or unblock action execution.

Params:

Field	Type	Required	Description
`blocked`	bool	yes	Whether to block actions

Returns: {"ok": true}

Entity Queries

`query_entities`

Query game entities with filters. Returns an array of entity summaries.

Params:

Field	Type	Required	Default	Description
`type`	string	no	`"npc"`	Entity type: `"npc"`, `"player"`, `"location"`, `"obj_stack"`
`type_id`	int	no	-1 (any)	Filter by type/config ID
`name_hash`	uint32	no	0 (any)	Filter by name hash
`name_pattern`	string	no		Text pattern to match entity name
`match_type`	string	no	`"contains"`	`"exact"`, `"contains"`, `"prefix"`, `"suffix"`, `"regex"`
`case_sensitive`	bool	no	false	Case-sensitive name matching
`plane`	int	no	-1 (any)	Filter by game plane
`tile_x`	int	no	0	Center X for radius query
`tile_y`	int	no	0	Center Y for radius query
`radius`	int	no	0 (disabled)	Tile radius from center
`visible_only`	bool	no	false	Only visible entities
`moving_only`	bool	no	false	Only moving entities
`stationary_only`	bool	no	false	Only stationary entities
`in_combat`	bool	no	false	Only entities in combat
`not_in_combat`	bool	no	false	Only entities not in combat
`sort_by_distance`	bool	no	false	Sort results by distance (requires `tile_x`/`tile_y`)
`max_results`	int	no	unlimited	Limit result count

Returns (NPC/Player):

[
  {
    "handle": 16777217,
    "server_index": 42,
    "type_id": 3010,
    "tile_x": 3200,
    "tile_y": 3200,
    "tile_z": 0,
    "name_hash": 123456,
    "name": "Guard",
    "is_moving": false,
    "is_hidden": false
  }
]

Returns (Location):

[
  {
    "handle": 33554433,
    "type_id": 1234,
    "tile_x": 3200,
    "tile_y": 3200,
    "tile_z": 0,
    "name_hash": 789012
  }
]

Returns (ObjStack):

[
  {
    "handle": 50331649,
    "tile_x": 3200,
    "tile_y": 3200,
    "tile_z": 0
  }
]

`get_entity_info`

Get detailed info for a pathing entity (NPC or Player) by handle.

Params:

Field	Type	Required	Description
`handle`	uint32	yes	Entity handle

Returns:

{
  "handle": 16777217,
  "server_index": 42,
  "type_id": 3010,
  "tile_x": 3200,
  "tile_y": 3200,
  "tile_z": 0,
  "name": "Guard",
  "name_hash": 123456,
  "is_moving": false,
  "is_hidden": false,
  "animation_id": -1,
  "stance_id": 808,
  "health": 100,
  "max_health": 100,
  "following_index": -1,
  "overhead_text": "",
  "combat_level": 21
}

`get_entity_name`

Params: handle: uint32 Returns: {"name": "Guard"}

`get_entity_health`

Params: handle: uint32 Returns: {"health": 80, "max_health": 100}

`get_entity_position`

Params: handle: uint32 Returns: {"tile_x": 3200, "tile_y": 3200, "plane": 0}

`is_entity_valid`

Params: handle: uint32 Returns: {"valid": true}

`get_entity_hitmarks`

Get active hitmarks (damage splats) on an entity.

Params: handle: uint32 Returns:

[
  {"damage": 15, "type": 1, "cycle": 42000}
]

`get_entity_animation`

Params: handle: uint32 Returns: {"animation_id": 808}

`get_entity_overhead_text`

Get overhead text for a pathing entity (NPC or Player) by handle.

Params: handle: uint32 Returns: {"text": "Hello world"} or {"text": ""}

`get_animation_length`

Get raw animation data length from cache.

Params:

Field	Type	Required	Description
`animation_id`	int	yes	Animation config ID

Returns: {"length": 128}

`query_ground_items`

Query ground item stacks. Accepts the same entity filters as query_entities (radius, plane, etc.).

Returns:

[
  {
    "handle": 50331649,
    "tile_x": 3200,
    "tile_y": 3200,
    "tile_z": 0,
    "items": [
      {"item_id": 995, "quantity": 100},
      {"item_id": 526, "quantity": 1}
    ]
  }
]

`get_obj_stack_items`

Get items in a specific ground stack by handle.

Params: handle: uint32 Returns:

[
  {"item_id": 995, "quantity": 100}
]

`query_obj_stacks`

Query ground stacks (without inline items). Same filters as query_entities.

Returns: Array of {handle, tile_x, tile_y, tile_z}

`query_projectiles`

Query active projectiles.

Params:

Field	Type	Required	Default	Description
`projectile_id`	int	no	-1 (any)	Filter by projectile ID
`plane`	int	no	-1 (any)	Filter by plane
`max_results`	int	no	unlimited	Limit results

Returns:

[
  {
    "handle": 67108865,
    "projectile_id": 1181,
    "start_x": 3200,
    "start_y": 3200,
    "end_x": 3210,
    "end_y": 3210,
    "plane": 0,
    "target_index": 5,
    "source_index": 0,
    "start_cycle": 42000,
    "end_cycle": 42030
  }
]

`query_spot_anims`

Query active spot animations (graphics).

Params:

Field	Type	Required	Default	Description
`anim_id`	int	no	-1 (any)	Filter by animation ID
`plane`	int	no	-1 (any)	Filter by plane
`max_results`	int	no	unlimited	Limit results

Returns:

[
  {
    "handle": 83886081,
    "anim_id": 2187,
    "tile_x": 3200,
    "tile_y": 3200,
    "tile_z": 0
  }
]

`query_hint_arrows`

Query active hint arrows.

Params:

Field	Type	Required	Default	Description
`max_results`	int	no	unlimited	Limit results

Returns:

[
  {
    "handle": 100663297,
    "type": 1,
    "tile_x": 3200,
    "tile_y": 3200,
    "tile_z": 0,
    "target_index": 5
  }
]

`query_worlds`

Query all available game worlds.

Params:

Field	Type	Required	Default	Description
`include_activity`	bool	no	false	Include activity description

Returns:

[
  {
    "world_id": 301,
    "properties": 536870912,
    "population": 423,
    "ping": 45,
    "activity": "Mining and Smithing"
  }
]

`get_current_world`

Params: none Returns: {"world_id": 301}

`compute_name_hash`

Compute the name hash for a string (useful for filtering by name_hash).

Params:

Field	Type	Required	Description
`name`	string	yes	Name to hash

Returns: {"hash": 123456}

`update_query_context`

Force an immediate cache update of the query context.

Params: none Returns: {"ok": true}

`invalidate_query_context`

Invalidate the query context cache, forcing a rebuild on next query.

Params: none Returns: {"ok": true}

Components & Interfaces

`query_components`

Query UI components with filters.

Params:

Field	Type	Required	Default	Description
`interface_id`	int	no	-1 (any)	Filter by interface ID
`item_id`	int	no	-1 (any)	Filter by held item ID
`sprite_id`	int	no	-1 (any)	Filter by sprite ID
`type`	int	no	-1 (any)	Filter by component type
`text_pattern`	string	no		Text content pattern
`match_type`	string	no	`"contains"`	`"exact"`, `"contains"`, `"regex"`
`case_sensitive`	bool	no	false	Case-sensitive text matching
`option_pattern`	string	no		Right-click option pattern
`option_match_type`	string	no	`"contains"`	`"exact"`, `"contains"`
`visible_only`	bool	no	false	Only visible components
`max_results`	int	no	unlimited	Limit results

Returns:

[
  {
    "handle": 12345678,
    "interface_id": 1473,
    "component_id": 5,
    "sub_component_id": -1,
    "type": 5,
    "item_id": 995,
    "item_count": 100,
    "sprite_id": -1
  }
]

`is_component_valid`

Check if a component exists and is valid.

Params:

Field	Type	Required	Default	Description
`interface_id`	int	yes		Interface ID
`component_id`	int	yes		Component ID
`sub_component_id`	int	no	-1	Sub-component index

Returns: {"valid": true}

`get_component_text`

Params: interface_id: int, component_id: int Returns: {"text": "Attack"} or {"text": null}

`get_component_item`

Get the item held by a component.

Params:

Field	Type	Required	Default	Description
`interface_id`	int	yes		Interface ID
`component_id`	int	yes		Component ID
`sub_component_id`	int	no	-1	Sub-component index

Returns: {"item_id": 995, "count": 100}

`get_component_position`

Params: interface_id: int, component_id: int Returns: {"x": 100, "y": 200, "width": 32, "height": 32}

`get_component_options`

Get right-click menu options for a component.

Params: interface_id: int, component_id: int Returns: ["Use", "Drop", "Examine"]

`get_component_sprite_id`

Params: interface_id: int, component_id: int Returns: {"sprite_id": 1234}

`get_component_type`

Params: interface_id: int, component_id: int Returns: {"type": 5, "type_name": "graphic"}

`get_component_children`

Get all dynamic sub-components of a layer component.

Params: interface_id: int, component_id: int Returns:

[
  {
    "handle": 12345678,
    "interface_id": 1473,
    "component_id": 5,
    "sub_component_id": 0,
    "type": 5,
    "item_id": 995,
    "item_count": 100,
    "sprite_id": -1
  }
]

`get_component_by_hash`

Get a component handle by interface/component/sub IDs.

Params:

Field	Type	Required	Default	Description
`interface_id`	int	yes		Interface ID
`component_id`	int	yes		Component ID
`sub_component_id`	int	no	-1	Sub-component index

Returns: {"handle": 12345678}

`get_open_interfaces`

Get all currently open/visible interfaces.

Params: none Returns:

[
  {"parent_hash": 98304, "interface_id": 1473}
]

`is_interface_open`

Params: interface_id: int Returns: {"open": true}

Game Variables

`get_varp`

Read a player variable (varp).

Params: var_id: int Returns: {"value": 42}

`get_varbit`

Read a varbit (packed bit field within a varp).

Params: varbit_id: int Returns: {"value": 1}

`get_varc_int`

Read a client variable (integer).

Params: varc_id: int Returns: {"value": 100}

`get_varc_string`

Read a client variable (string).

Params: varc_id: int Returns: {"value": "some text"}

`query_varbits`

Batch-read multiple varbits.

Params:

Field	Type	Required	Description
`varbit_ids`	int[]	yes	Array of varbit IDs

Returns:

[
  {"varbit_id": 123, "value": 1},
  {"varbit_id": 456, "value": 3}
]

Script Execution

`get_script_handle`

Create a handle for a client script.

Params: script_id: int Returns: {"handle": 140234567890}

`execute_script`

Execute a client script with arguments.

Params:

Field	Type	Required	Description
`handle`	uintptr	yes	Script handle from `get_script_handle`
`int_args`	int[]	no	Integer arguments
`string_args`	string[]	no	String arguments
`returns`	string[]	no	Expected return types: `"int"`, `"long"`, `"string"`

Returns:

{
  "returns": [42, "result_text"]
}

`destroy_script_handle`

Free a script handle.

Params: handle: uintptr Returns: {"ok": true}

`fire_key_trigger`

Fire a key input trigger on a component (used for input fields, chat, etc.).

Params:

Field	Type	Required	Description
`interface_id`	int	yes	Interface ID
`component_id`	int	yes	Component ID
`input`	string	yes	Input text to send

Returns: {"ok": true}

Game State

`get_account_info`

Get account and session information for the current client.

Params: none Returns:

{
  "client_type": 0,
  "client_state": 10,
  "session_id": "abc123...",
  "ip_hash": 12345678,
  "jx_display_name": "PlayerName",
  "jx_character_id": "char-uuid-here",
  "display_name": "PlayerName",
  "is_member": true,
  "server_index": 42,
  "logged_in": true,
  "login_progress": 40,
  "login_status": 2
}

Field	Type	Description
`client_type`	int	Client platform: 0 = Jagex launcher, 1 = Steam
`client_state`	int	Overall client state (lobby, in-game, etc.)
`session_id`	string\|null	Active session ID, null if none
`ip_hash`	uint32	Hashed login identifier
`jx_display_name`	string\|null	Display name from Jagex launcher env (`JX_DISPLAY_NAME`), null if not set (e.g. Steam)
`jx_character_id`	string\|null	Character ID from launcher env (`JX_CHARACTER_ID`), null if not set
`display_name`	string\|null	In-game display name, null if not logged in
`is_member`	bool	Whether the account has membership
`server_index`	int	Player server slot index, -1 if not logged in
`logged_in`	bool	Whether a player is currently logged in
`login_progress`	int	Login handshake progress (from LoginManager)
`login_status`	int	Login status code (from LoginManager)

Notes:

jx_display_name and jx_character_id are read from environment variables set by the Jagex launcher at process start. They are available even before login completes. Steam clients will have these as null.
display_name comes from the in-game LoggedInPlayer struct and is only available once fully logged in.
client_type can be used to distinguish Steam vs Jagex launcher sessions.

`get_local_player`

Get the local player's info without querying the player list.

Params: none Returns:

{
  "server_index": 42,
  "name": "PlayerName",
  "tile_x": 3200,
  "tile_y": 3200,
  "plane": 0,
  "is_member": true,
  "is_moving": false,
  "animation_id": -1,
  "stance_id": 808,
  "health": 990,
  "max_health": 990,
  "combat_level": 138,
  "overhead_text": "",
  "target_index": -1,
  "target_type": -1
}

Error: {"error": "not_logged_in"} if no player is logged in.

`get_game_cycle`

Get the current game tick counter from the transmission manager.

Params: none Returns: {"cycle": 123456}

`get_login_state`

Get the current login/client state.

Params: none Returns:

{
  "state": 10,
  "login_progress": 40,
  "login_status": 2
}

`get_mini_menu`

Get the current right-click (mini) menu entries.

Params: none Returns:

[
  {
    "option_text": "Attack Guard (level 21)",
    "action_id": 9,
    "type_id": 2,
    "item_id": -1,
    "param1": 42,
    "param2": 0,
    "param3": 0
  }
]

`get_grand_exchange_offers`

Get all Grand Exchange offer slots (3 pages x 8 slots = 24 total).

Params: none Returns:

[
  {
    "slot": 0,
    "status": 1,
    "type": 0,
    "item_id": 314,
    "price": 100,
    "count": 50,
    "completed_count": 25,
    "completed_gold": 2500
  }
]

`get_world_to_screen`

Project a tile coordinate to screen position using the scene projection matrix.

Params:

Field	Type	Required	Description
`tile_x`	int	yes	Tile X coordinate
`tile_y`	int	yes	Tile Y coordinate

Returns: {"screen_x": 400.0, "screen_y": 300.0}

`batch_world_to_screen`

Batch-convert tile coordinates to screen positions in one call.

Params:

Field	Type	Required	Description
`tiles`	array	yes	Array of `{"x": int, "y": int}` objects

Returns:

{
  "results": [
    {"screen_x": 400.5, "screen_y": 300.2},
    {"screen_x": 410.0, "screen_y": 305.0}
  ]
}

`get_viewport_info`

Get projection matrix, view matrix, and viewport dimensions from the active scene.

Params: none Returns:

{
  "viewport_width": 1920,
  "viewport_height": 1080,
  "projection_matrix": [1.0, 0.0, "... 16 floats row-major"],
  "view_matrix": [1.0, 0.0, "... 16 floats row-major"]
}

Error: {"error": "no_active_scene"} if no scene is loaded.

`get_entity_screen_positions`

Get screen positions for multiple entities by handle in one call.

Params:

Field	Type	Required	Description
`handles`	uint32[]	yes	Array of entity handles

Returns:

{
  "results": [
    {"handle": 12345, "screen_x": 500.0, "screen_y": 300.0, "valid": true},
    {"handle": 67890, "screen_x": 0, "screen_y": 0, "valid": false}
  ]
}

`get_game_window_rect`

Get the game window position and size on screen for external overlay alignment.

Params: none Returns:

{
  "x": 100, "y": 50,
  "width": 1920, "height": 1080,
  "client_x": 100, "client_y": 80,
  "client_width": 1920, "client_height": 1040
}

Error: {"error": "no_window"} if the game window handle is not available.

`take_screenshot`

Capture a screenshot of the game framebuffer as a PNG image. The capture runs on the OpenGL thread (before overlay rendering) and returns the result to the caller. The image is resized to 1280x720.

Params: none Returns: {"data": <binary PNG>, "size": 65536} Errors:

{"error": "not_ready"} — bot context not initialized
{"error": "gl_not_ready"} — OpenGL/ImGui not initialized yet
{"error": "timeout"} — GL thread did not capture within 5 seconds

`start_stream`

Start continuous JPEG frame streaming over a dedicated one-way named pipe. The server creates a separate outbound-only pipe for frame data so the main RPC pipe remains unaffected. The caller should connect to the returned pipe_name to receive frames.

Params:

Field	Type	Required	Default	Description
`frame_skip`	int	no	2	Capture every Nth frame (1 = every frame)
`quality`	int	no	60	JPEG quality 1-100
`width`	int	no	960	Output width (clamped 160-1920)
`height`	int	no	540	Output height (clamped 90-1080)

Returns:

{
  "ok": true,
  "pipe_name": "\\\\.\\pipe\\BotWithUs_12345_stream",
  "frame_skip": 2,
  "quality": 60,
  "width": 960,
  "height": 540
}

Errors:

{"error": "not_ready"} — bot context not initialized
{"error": "gl_not_ready"} — OpenGL/ImGui not initialized yet
{"error": "pipe_create_failed"} — failed to create the stream pipe

Stream pipe protocol:

The stream pipe (\\.\pipe\BotWithUs_{PID}_stream) is a one-way outbound pipe (PIPE_ACCESS_OUTBOUND). Each frame is sent as:

[4 bytes: little-endian uint32 JPEG size] [N bytes: raw JPEG data]

The stream pipe is separate from the RPC pipe — no msgpack encoding, no event wrapping, just raw length-prefixed JPEG frames. If the previous frame write hasn't completed when a new frame is captured, the new frame is silently dropped (backpressure without blocking the GL thread). The stream automatically stops if the client disconnects from the stream pipe.

Typical usage:

Connect to the RPC pipe (\\.\pipe\BotWithUs_{PID})
Call start_stream with desired parameters
Connect to the stream pipe returned in pipe_name
Read frames in a loop: 4-byte header → JPEG body
Call stop_stream on the RPC pipe when done

`stop_stream`

Stop the frame stream and close the stream pipe.

Params: none Returns: {"ok": true}

`get_cache_file`

Read a raw file from the game cache.

Params:

Field	Type	Required	Default	Description
`index_id`	int	yes		Cache index ID
`archive_id`	int	yes		Archive ID
`file_id`	int	no	0	File within archive

Returns: {"data": <binary>, "size": 1024} Error: {"error": "file_not_found"}

`get_cache_file_count`

Get the number of files in a cache index or archive.

Params:

Field	Type	Required	Default	Description
`index_id`	int	yes		Cache index ID
`archive_id`	int	no	0	Archive ID
`shift`	int	no	0	Bit shift

Returns: {"count": 256}

`set_world`

Set the target world for login.

Params: world_id: int Returns: {"ok": true}

`change_login_state`

Change the login state machine state.

Params:

Field	Type	Required	Default	Description
`old_state`	int	no	0	Expected current state
`new_state`	int	yes		Target state

Returns: {"ok": true}

`login_to_lobby`

Trigger a login from the login screen to lobby by executing the lobby login script (CS2 15259). Only works when client state is 10 (login screen). Checks for login progress, account status, and stale game sessions before attempting.

Params: none Returns: {"ok": true}

Errors:

{"error": "not_on_login_screen", "state": <int>} — client is not on the login screen (state != 10)
{"error": "login_in_progress"} — a login attempt is already underway
{"error": "account_unavailable", "login_status": <int>} — account is disabled or locked
{"ok": true, "action": "new_game_session"} — previous session ended; a new game session was requested (caller should retry after a delay)

`get_auto_login`

Check if auto login is enabled.

Params: none Returns: {"enabled": true}

`set_auto_login`

Enable or disable auto login.

Params:

Field	Type	Required	Description
`enabled`	bool	yes	Whether to enable auto login

Returns: {"ok": true}

`get_humanization_enabled`

Check if input humanization (mouse path generation, fatigue/risk model, automatic break recommendations) is enabled. Disabled by default.

Params: none Returns: {"enabled": false}

`set_humanization_enabled`

Enable or disable input humanization. When disabled, mouse path generation is skipped (clicks are sent directly), and the fatigue/risk model will not trigger automatic break recommendations. Mouse click injection still works regardless of this setting.

Params:

Field	Type	Required	Description
`enabled`	bool	yes	Whether to enable humanization

Returns: {"ok": true}

`schedule_break`

Schedule a break (logout pause).

Params: duration: int (milliseconds) Returns: {"ok": true}

`interrupt_break`

Cancel a scheduled break.

Params: none Returns: {"ok": true}

Config Type Lookups

These methods read game config definitions from the cache by ID. Data is lazily loaded and cached after first access.