Commands
Learn how to use commands with SoulFire.
What are commands?
Commands are a way to interact with the SoulFire application server. It can either display information or control the bots.
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 | See who you are |
plugins | Show all installed plugins |
stop | Shut down the SoulFire server. |
spark | Get spark help |
spark <command> | Runs a spark subcommand |
move <entity> | Makes selected bots move to an entity |
move radius <radius> | Makes selected bots move to a random xz position within the radius |
move <y> | Makes selected bots move to the y coordinates |
move <x> <z> | Makes selected bots move to the xz coordinates |
move <x> <y> <z> | Makes selected bots move to the xyz coordinates |
collect <block> <amount> <searchRadius> | Makes selected bots collect a block by name or tag |
follow <entity> <maxRadius> | Makes selected bots follow an entity |
excavate rectangle <fromX> <fromY> <fromZ> <toX> <toY> <toZ> | Makes selected bots dig a rectangle from the from to the to coordinates |
excavate sphere <x> <y> <z> <radius> | Makes selected bots dig a sphere with the given radius |
lookat <x> <y> <z> | Makes 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> | Makes selected bots mimic the movement of other entities |
useitem <hand> | Makes selected bots use an item in the specified hand |
useitemon <blockX> <blockY> <blockZ> <face> <hand> | Makes selected bots use an item on the block at the xyz coordinates with the specified face and hand |
inventory close | Closes the current inventory for selected bots, opens the player inventory afterwards |
inventory current | Get info about the current inventory for 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> | Makes selected bots interact with an entity using a specific hand |
attack start | Makes selected instances start an attack |
attack stop | Makes selected instances stop their attack |
attack pause | Makes selected instances pause their attack |
online | Shows connected bots in attacks |
say <message> | Makes selected bots send a message in chat or execute a command |
respawn | Respawn selected bots |
health | Print the health of selected bots. |
export-map | Exports images of all map items. Can be a held item or in a item-frame. |
export-map <map_id> | Exports a image of a map item by map id. Can be a held item or in a item-frame. |
stop-task | Makes selected bots stop their current task |
bot <bot_names> ... | Instead of running a command for all possible bots, run it for a specific list of bots. Use a comma to separate the names |
instance <instance_names> ... | Instead of running a command for all possible instances, run it for a specific list of instances. Use a comma to separate the names |
repeat <amount> ... | Repeat the command for the specified amount of times |
Example usage
walkxyz 578 65 100
How to generate this list
Run the command print-docs commands in the console of the GUI, CLI or Dedicated server.
How is this guide?
Last updated on