Commands
Learn how to use commands with SoulFire.
About commands
Commands show information or control bots through the SoulFire server.
List of commands
| Command | Description |
|---|---|
help | Prints a list of all available commands |
generate-token api | Generate an API JWT for the current user |
generate-token webdav | Generate a WebDAV JWT for the current user |
set-email <email> | Set the email of the current user |
whoami | Show your current user |
plugins | Show all installed plugins |
stop | Shut down the SoulFire server. |
spark | Show Spark help |
spark <command> | Runs a spark subcommand |
move <entity> | Move selected bots to an entity |
move radius <radius> | Move selected bots to a random XZ position within the radius |
move <y> | Move selected bots to the Y coordinate |
move <x> <z> | Move selected bots to the XZ coordinates |
move <x> <y> <z> | Move selected bots to the XYZ coordinates |
collect <block> <amount> <searchRadius> | Make selected bots collect a block by name or tag |
follow <entity> <maxRadius> | Make selected bots follow an entity |
excavate rectangle <fromX> <fromY> <fromZ> <toX> <toY> <toZ> | Make selected bots dig a rectangular area between two coordinates |
excavate sphere <x> <y> <z> <radius> | Make selected bots dig a sphere with the specified radius |
lookat <x> <y> <z> | Make selected bots look at the block at the XYZ coordinates |
control forward | Toggle walking forward for selected bots |
control backward | Toggle walking backward for selected bots |
control left | Toggle walking left for selected bots |
control right | Toggle walking right for selected bots |
control jump | Toggle jumping for selected bots |
control sneak | Toggle sneaking for selected bots |
control reset | Resets the movement of selected bots |
mimic <entity> | Make selected bots mimic the movement of other entities |
useitem <hand> | Make selected bots use an item in the specified hand |
useitemon <blockX> <blockY> <blockZ> <face> <hand> | Make selected bots use an item on a block with the specified face and hand |
inventory close | Close the current inventory of selected bots. Then open the player inventory. |
inventory current | Show the current inventory of selected bots |
inventory left-click <slot> | Left-clicks the specified slot in the current inventory for selected bots |
inventory right-click <slot> | Right-clicks the specified slot in the current inventory for selected bots |
inventory left-click-outside | Left-clicks outside current inventory for selected bots |
inventory right-click-outside | Right-clicks outside current inventory for selected bots |
inventory middle-click <slot> | Middle-clicks the specified slot in the current inventory for selected bots |
inventory drop-one <slot> | Drops one item from the specified slot in the current inventory for selected bots |
inventory drop-all <slot> | Drops all items from the specified slot in the current inventory for selected bots |
interact <entity> <hand> | Make selected bots interact with an entity using the specified hand |
click left | Simulates a left mouse button click for selected bots (attack/break) |
click right | Simulates a right mouse button click for selected bots (use/interact) |
bots start | Set every configured bot in the selected instances to running |
bots stop | Set every configured bot in the selected instances to stopped |
online | Show connected bots in the selected instances |
say <message> | Make selected bots send a chat message or run a command |
respawn | Respawn selected bots |
health | Print the health of selected bots. |
export-map | Export all loaded maps as images. |
export-map <map_id> | Export a map as an image by its map ID. |
export-basic-render | Export a basic camera image of the world that the bot sees. |
export-basic-render <width> <height> | Export an image at a custom resolution. |
export-render-debug-dump | Export a POV image, camera settings, Vulkan device, and capture timing. |
export-render-debug-dump <width> <height> | Export a debug dump at a custom resolution. |
export-render-debug-dump <width> <height> <max_distance> | Export a debug dump at a custom resolution and maximum render distance. |
stop-task | Stop the current task of selected bots |
bot <bot_names> ... | Run a command for specific bots. Separate bot names with commas. |
instance <instance_names> ... | Run a command for specific instances. Separate instance names with commas. |
repeat <amount> ... | Repeat the command the specified number of times |
Example
move 578 65 100
Generate this list
Run print-docs commands in the GUI, CLI, or dedicated server terminal.
How is this page?
Last updated on