bot module

Bot state queries and basic commands.

State Queries

`position(bot_name="")`

Get bot position.

Returns: dict with keys x, y, z, or None if bot is offline

`health(bot_name="")`

Get bot health.

Returns: float or None if bot is offline

`hunger(bot_name="")`

Get bot hunger level.

Returns: int or None if bot is offline

`saturation(bot_name="")`

Get bot food saturation.

Returns: float or None if bot is offline

`air(bot_name="")`

Get bot air level.

Returns: int or None if bot is offline

`experience_level(bot_name="")`

Get bot XP level.

Returns: int or None if bot is offline

`experience_progress(bot_name="")`

Get bot XP progress to next level.

Returns: float or None if bot is offline

`selected_slot(bot_name="")`

Get currently selected hotbar slot.

Returns: int or None if bot is offline

`select_slot(slot, bot_name="")`

Select a hotbar slot.

Parameters:

slot (int) - Slot to select (0–8)
bot_name (str, optional) - Bot name, defaults to current bot

Raises: RuntimeError if bot not found or not online, or if slot is out of range

bot.select_slot(0)  # Select first hotbar slot
bot.select_slot(8)  # Select last hotbar slot

`server(bot_name="")`

Get server address.

Returns: str or None

`account(bot_name="")`

Get account username.

Returns: str or None

`uptime(bot_name="")`

Get bot uptime in seconds.

Returns: int or None

`proxy(bot_name="")`

Get proxy configuration and health state.

Returns: dict or None if no proxy is configured (host is empty)

Keys:

enabled (bool) - Whether the proxy is currently enabled
host (str) - Proxy host address
port (int) - Proxy port
type (str) - Proxy type: "SOCKS4" or "SOCKS5"
username (str) - Username (empty string if not set)
password (str) - Password (empty string if not set)
health (str) - One of: "Unknown", "Alive", "Dead"

p = bot.proxy()
if p and p["health"] == "Dead":
    utils.log("Proxy is down")

`dimension(bot_name="")`

Get current dimension.

Returns: str or None if bot is offline or dimension not available

`is_online(bot_name="")`

Check if bot is online.

Returns: bool

`status(bot_name="")`

Get bot status string.

Returns: str - One of: "Offline", "Starting", "Online", "Stopping", "Error"

Raises: RuntimeError if bot not found

`inventory(bot_name="")`

Get bot inventory.

Returns: list of item dicts, or None if bot is offline. Each dict also includes a slot field (0–40). Shulker boxes and other container items additionally have container_items (list of item dicts for the contents).

items = bot.inventory()
if items is not None:
    for item in items:
        print(f"Slot {item['slot']}: {item['count']}x {item['item_id']} ({item['display_name']})")

`resync_inventory(bot="")`

Force a full inventory resync from the server. Sends a stateId mismatch packet to trigger sendAllDataToRemote server-side, which sends back the authoritative inventory state.

Only works when no container is currently open. Raises if a container is open.

Raises: RuntimeError if bot not found, not online, or a container is open

world.close_container()
bot.resync_inventory()
time.sleep(0.2)  # wait for server response
items = bot.inventory()

Item dict

The item dict schema used by bot.inventory(), world.get_container(), and entity item fields:

Key	Type	Description
`item_id`	`str`	Item ID (e.g. `"minecraft:diamond"`)
`count`	`int`	Stack size
`damage`	`int`	Current damage (0 = undamaged)
`max_damage`	`int`	Max durability (0 for non-damageable items)
`display_name`	`str`	Display name (may include formatting)
`enchantments`	`dict[str, int]`	Map of enchantment ID to level (e.g. `{"minecraft:sharpness": 3}`)

`get_screen(bot_name="")`

Get full screen dump as a ScreenState object.

Returns: ScreenState or None if no screen is open (in-game)

ScreenState attributes:

Attribute	Type	Description
`id`	`str`	Stable screen ID - pass to `world.click_widget()`
`screen_class`	`str`	Fully qualified Java class name
`title`	`str`	Display title of the screen
`width`	`int`	Screen width in pixels
`height`	`int`	Screen height in pixels
`widgets`	`list[GuiWidget]`	All interactive widgets (buttons, edit boxes, sliders, etc.) - includes widgets nested inside list-based screens like Video Settings
`slots`	`list[GuiSlot]`	Container slots (only present for inventory-like screens)

GuiWidget attributes:

Attribute	Type	Description
`index`	`int`	Widget index - pass to `world.click_widget()`
`type`	`str`	`"Button"`, `"EditBox"`, `"Checkbox"`, `"ListEntry"`, `"SignLine"`, or simple class name for others
`class_name`	`str`	Fully qualified class name
`x`, `y`	`int`	Screen pixel coordinates
`width`, `height`	`int`	Widget dimensions
`active`	`bool`	Whether the widget can be interacted with
`visible`	`bool`	Whether the widget is rendered
`text`	`str`	Button label or widget text
`edit_value`	`str`	Current text (EditBox only)
`edit_editable`	`bool`	Whether the EditBox can be edited
`selected`	`bool`	Whether this widget is currently focused/selected (e.g. selected entry in the multiplayer or world list)

GuiSlot attributes:

Attribute	Type	Description
`index`	`int`	Slot index - pass to `world.click_slot()`
`x`, `y`	`int`	Screen pixel coordinates
`active`	`bool`	Whether the slot is active
`item_id`	`str`	Item ID (e.g. `"minecraft:diamond"`, `"minecraft:air"` if empty)
`count`	`int`	Stack count
`display_name`	`str`	Display name
`damage`	`int`	Current durability damage
`max_damage`	`int`	Max durability (0 if not damageable)
`enchantments`	`dict[str, int]`	Enchantment ID to level
`repair_cost`	`int`	Anvil repair cost

# Click a button by label on any screen
screen = bot.get_screen()
if screen is not None:
    for w in screen.widgets:
        if w.text == "Multiplayer" and w.active:
            world.click_widget(screen.id, w.index)
            break

# Auction house: slots act as buttons, items describe what they do
screen = bot.get_screen()
if screen is not None:
    for slot in screen.slots:
        if "Buy" in slot.display_name:
            world.click_slot(slot.index)
            break

`open_game_menu(bot_name="")`

Open the game/pause menu, equivalent to pressing ESC while in-game.

Parameters:

bot_name (str, optional) - Bot name, defaults to current bot

Raises: RuntimeError if bot not found or not online

Note: The client performs additional checks before opening the menu (screen already open, not in a world) and will send a failure response if these conditions aren't met.

bot.open_game_menu()

`network_stats(bot_name="")`

Get network statistics.

Returns: dict with network information

`list_all()`

List all bots with their status.

Returns: list[dict] where each dict has:

name (str) - Bot name
status (str) - Bot status ("Offline", "Starting", "Online", "Stopping", "Error")

bots = bot.list_all()
for b in bots:
    print(f"{b['name']}: {b['status']}")

Bot Control

`start(bot_name="")`

Start the bot.

Parameters:

bot_name (str, optional) - Bot name, defaults to current bot

Raises: RuntimeError if bot not found

bot.start()  # Start current bot
bot.start("bot2")  # Start specific bot

`stop(reason="", bot_name="")`

Stop the bot gracefully.

Parameters:

reason (str, optional) - Reason for stopping (shown in logs)
bot_name (str, optional) - Bot name, defaults to current bot

Raises: RuntimeError if bot not found

bot.stop()  # Stop with default reason
bot.stop("Task completed")  # Stop with custom reason

`restart(reason="", bot_name="")`

Restart the bot.

Parameters:

reason (str, optional) - Reason for restarting (shown in logs)
bot_name (str, optional) - Bot name, defaults to current bot

Raises: RuntimeError if bot not found

bot.restart()  # Restart with default reason
bot.restart("Updating configuration")  # Restart with custom reason

Commands

`chat(message, bot_name="")`

Send chat message. Supports / commands and # for baritone.

Parameters:

message (str) - Message to send
bot_name (str, optional) - Bot name, defaults to current bot

Raises: RuntimeError if bot not found or not online

bot.chat("Hello world!")
bot.chat("/tp 0 64 0")  # Slash commands work
bot.chat("#goto 100 64 100")  # Baritone commands work
bot.chat("Hello from bot2!", "bot2")  # Send from specific bot

`manager_command(command, bot_name="")`

Send raw manager protocol command (advanced).

Parameters:

command (str) - Manager command to execute
bot_name (str, optional) - Bot name, defaults to current bot

Raises: RuntimeError if bot not found or not online

# Advanced usage - prefer using bot.chat() or specific APIs
bot.manager_command("chat Hello")
bot.manager_command("baritone goto 100 64 100")
bot.manager_command("chat Hello", "bot2")  # Send to specific bot