soulfire.bot_live_connect.BotLiveServiceSync

class soulfire.bot_live_connect.BotLiveServiceSync[source]

Bases: Protocol

Live bot remote-control service. See file header for scope and design notes.

Permissions: - READ_BOT_INFO: required for WatchBotEvents, GetBlock, FindBlocks,

ListNearbyEntities.

  • CONTROL_BOT_ACTIONS: required for chat, interactions, pathfinding, and

    exclusive control leases.

Error handling mirrors BotService: - NOT_FOUND: instance or bot does not exist. - FAILED_PRECONDITION: bot is not online, target not loaded, or the

requested action is not currently valid.

  • OUT_OF_RANGE: target is outside the bot’s reach / observation radius.

  • INTERNAL: unexpected server errors.

watch_bot_events(request: soulfire.bot_live_pb2.WatchBotEventsRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.WatchBotEventsRequest, soulfire.bot_live_pb2.BotEvent], /) → collections.abc.Iterator[soulfire.bot_live_pb2.BotEvent][source]

Subscribes to a single multiplexed event stream for one bot. The first message is always the current BotStatus. The stream remains open while the bot is stopped and follows the configured bot across reconnects. Live snapshots and filtered events begin whenever a connection becomes ready.

send_chat(request: soulfire.bot_live_pb2.SendChatRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.SendChatRequest, soulfire.bot_live_pb2.SendChatResponse], /) → soulfire.bot_live_pb2.SendChatResponse[source]

Sends a chat message (or slash command) from the bot to the connected Minecraft server. Messages prefixed with “/” are routed as commands.

get_block(request: soulfire.bot_live_pb2.GetBlockRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.GetBlockRequest, soulfire.bot_live_pb2.GetBlockResponse], /) → soulfire.bot_live_pb2.GetBlockResponse[source]

Returns the block at a world position, if the chunk is loaded.

find_blocks(request: soulfire.bot_live_pb2.FindBlocksRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.FindBlocksRequest, soulfire.bot_live_pb2.FindBlocksResponse], /) → soulfire.bot_live_pb2.FindBlocksResponse[source]

Finds blocks of the given ids within a radius of the bot. Results are sorted by ascending distance.

list_nearby_entities(request: soulfire.bot_live_pb2.ListNearbyEntitiesRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.ListNearbyEntitiesRequest, soulfire.bot_live_pb2.ListNearbyEntitiesResponse], /) → soulfire.bot_live_pb2.ListNearbyEntitiesResponse[source]

Lists entities within a radius of the bot, optionally filtered by type.

dig_block(request: soulfire.bot_live_pb2.DigBlockRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.DigBlockRequest, soulfire.bot_live_pb2.DigBlockResponse], /) → soulfire.bot_live_pb2.DigBlockResponse[source]

Starts (or stops, when cancel is set) breaking a block at a specific position. Unlike MouseClick, the target is explicit, with no raytrace from the current look direction is performed.

place_block(request: soulfire.bot_live_pb2.PlaceBlockRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.PlaceBlockRequest, soulfire.bot_live_pb2.PlaceBlockResponse], /) → soulfire.bot_live_pb2.PlaceBlockResponse[source]

Places the currently held item as a block, against a specific face of a specific block.

interact_block(request: soulfire.bot_live_pb2.InteractBlockRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.InteractBlockRequest, soulfire.bot_live_pb2.InteractBlockResponse], /) → soulfire.bot_live_pb2.InteractBlockResponse[source]

Activates a specific block face without assigning placement semantics to the operation. This covers doors, buttons, beds, redstone controls, and modded interactive blocks.

use_item(request: soulfire.bot_live_pb2.UseItemRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.UseItemRequest, soulfire.bot_live_pb2.UseItemResponse], /) → soulfire.bot_live_pb2.UseItemResponse[source]

Uses the item in the specified hand (eat, drink, throw, draw bow, etc.).

release_item(request: soulfire.bot_live_pb2.ReleaseItemRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.ReleaseItemRequest, soulfire.bot_live_pb2.ReleaseItemResponse], /) → soulfire.bot_live_pb2.ReleaseItemResponse[source]

Releases an item that is currently being used, such as firing a drawn bow or stopping eating.

attack_entity(request: soulfire.bot_live_pb2.AttackEntityRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.AttackEntityRequest, soulfire.bot_live_pb2.AttackEntityResponse], /) → soulfire.bot_live_pb2.AttackEntityResponse[source]

Attacks a specific entity by network id.

interact_entity(request: soulfire.bot_live_pb2.InteractEntityRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.InteractEntityRequest, soulfire.bot_live_pb2.InteractEntityResponse], /) → soulfire.bot_live_pb2.InteractEntityResponse[source]

Right-clicks / interacts with a specific entity by network id. Used for trading with villagers, mounting mobs, etc.

swing_arm(request: soulfire.bot_live_pb2.SwingArmRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.SwingArmRequest, soulfire.bot_live_pb2.SwingArmResponse], /) → soulfire.bot_live_pb2.SwingArmResponse[source]

Swings the specified arm without a target (visual animation only).

respawn(request: soulfire.bot_live_pb2.RespawnRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.RespawnRequest, soulfire.bot_live_pb2.RespawnResponse], /) → soulfire.bot_live_pb2.RespawnResponse[source]

Respawns a dead bot or dismisses the End credits to finish respawning.

sleep(request: soulfire.bot_live_pb2.SleepRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.SleepRequest, soulfire.bot_live_pb2.SleepResponse], /) → soulfire.bot_live_pb2.SleepResponse[source]

Uses a reachable bed and completes only after the server confirms that the bot entered the sleeping state.

wake(request: soulfire.bot_live_pb2.WakeRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.WakeRequest, soulfire.bot_live_pb2.WakeResponse], /) → soulfire.bot_live_pb2.WakeResponse[source]

Leaves the current bed.

mount_entity(request: soulfire.bot_live_pb2.MountEntityRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.MountEntityRequest, soulfire.bot_live_pb2.MountEntityResponse], /) → soulfire.bot_live_pb2.MountEntityResponse[source]
dismount(request: soulfire.bot_live_pb2.DismountRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.DismountRequest, soulfire.bot_live_pb2.DismountResponse], /) → soulfire.bot_live_pb2.DismountResponse[source]
set_vehicle_control(request: soulfire.bot_live_pb2.SetVehicleControlRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.SetVehicleControlRequest, soulfire.bot_live_pb2.SetVehicleControlResponse], /) → soulfire.bot_live_pb2.SetVehicleControlResponse[source]
update_sign(request: soulfire.bot_live_pb2.UpdateSignRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.UpdateSignRequest, soulfire.bot_live_pb2.UpdateSignResponse], /) → soulfire.bot_live_pb2.UpdateSignResponse[source]
write_book(request: soulfire.bot_live_pb2.WriteBookRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.WriteBookRequest, soulfire.bot_live_pb2.WriteBookResponse], /) → soulfire.bot_live_pb2.WriteBookResponse[source]
respond_resource_pack(request: soulfire.bot_live_pb2.RespondResourcePackRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.RespondResourcePackRequest, soulfire.bot_live_pb2.RespondResourcePackResponse], /) → soulfire.bot_live_pb2.RespondResourcePackResponse[source]
set_flying(request: soulfire.bot_live_pb2.SetFlyingRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.SetFlyingRequest, soulfire.bot_live_pb2.SetFlyingResponse], /) → soulfire.bot_live_pb2.SetFlyingResponse[source]
start_elytra_flight(request: soulfire.bot_live_pb2.StartElytraFlightRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.StartElytraFlightRequest, soulfire.bot_live_pb2.StartElytraFlightResponse], /) → soulfire.bot_live_pb2.StartElytraFlightResponse[source]

Requests survival-mode elytra flight. Minecraft validates that the bot is falling and has usable elytra equipment.

set_creative_slot(request: soulfire.bot_live_pb2.SetCreativeSlotRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.SetCreativeSlotRequest, soulfire.bot_live_pb2.SetCreativeSlotResponse], /) → soulfire.bot_live_pb2.SetCreativeSlotResponse[source]
wait_for_chunks(request: soulfire.bot_live_pb2.WaitForChunksRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.WaitForChunksRequest, soulfire.bot_live_pb2.WaitForChunksResponse], /) → soulfire.bot_live_pb2.WaitForChunksResponse[source]

Waits until every chunk in a square radius around the bot is loaded.

go_to(request: soulfire.bot_live_pb2.GoToRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.GoToRequest, soulfire.bot_live_pb2.PathfindProgress], /) → collections.abc.Iterator[soulfire.bot_live_pb2.PathfindProgress][source]

Requests the bot to pathfind to a goal. Returns a stream of progress events terminating with COMPLETED, FAILED, or CANCELLED. A new GoTo for the same bot supersedes any in-progress pathfinding; the previous stream is closed with CANCELLED.

stop_pathfinding(request: soulfire.bot_live_pb2.StopPathfindingRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.StopPathfindingRequest, soulfire.bot_live_pb2.StopPathfindingResponse], /) → soulfire.bot_live_pb2.StopPathfindingResponse[source]

Cancels any in-progress pathfinding session for this bot.

acquire_bot_control(request: soulfire.bot_live_pb2.AcquireBotControlRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.AcquireBotControlRequest, soulfire.bot_live_pb2.AcquireBotControlResponse], /) → soulfire.bot_live_pb2.AcquireBotControlResponse[source]

Acquires exclusive action control for a bot. While the lease is active, action calls must include its token in the X-SoulFire-Control-Token request header.

renew_bot_control(request: soulfire.bot_live_pb2.RenewBotControlRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.RenewBotControlRequest, soulfire.bot_live_pb2.RenewBotControlResponse], /) → soulfire.bot_live_pb2.RenewBotControlResponse[source]
release_bot_control(request: soulfire.bot_live_pb2.ReleaseBotControlRequest, ctx: connectrpc.request.RequestContext[soulfire.bot_live_pb2.ReleaseBotControlRequest, soulfire.bot_live_pb2.ReleaseBotControlResponse], /) → soulfire.bot_live_pb2.ReleaseBotControlResponse[source]