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{:bash} | Prints a list of all available commands |
generate-token api{:bash} | Generate an API JWT for the current user |
generate-token webdav{:bash} | Generate a WebDAV JWT for the current user |
set-email <email>{:bash} | Set the email of the current user |
whoami{:bash} | See who you are |
plugins{:bash} | Show all installed plugins |
stop{:bash} | Shut down the SoulFire server. |
spark{:bash} | Get spark help |
spark <command>{:bash} | Runs a spark subcommand |
move <entity>{:bash} | Makes selected bots move to an entity |
move radius <radius>{:bash} | Makes selected bots move to a random xz position within the radius |
move <y>{:bash} | Makes selected bots move to the y coordinates |
move <x> <z>{:bash} | Makes selected bots move to the xz coordinates |
move <x> <y> <z>{:bash} | Makes selected bots move to the xyz coordinates |
collect <block> <amount> <searchRadius>{:bash} | Makes selected bots collect a block by name or tag |
follow <entity> <maxRadius>{:bash} | Makes selected bots follow an entity |
excavate rectangle <fromX> <fromY> <fromZ> <toX> <toY> <toZ>{:bash} | Makes selected bots dig a rectangle from the from to the to coordinates |
excavate sphere <x> <y> <z> <radius>{:bash} | Makes selected bots dig a sphere with the given radius |
lookat <x> <y> <z>{:bash} | Makes selected bots look at the block at the xyz coordinates |
control forward{:bash} | Toggle walking forward for selected bots |
control backward{:bash} | Toggle walking backward for selected bots |
control left{:bash} | Toggle walking left for selected bots |
control right{:bash} | Toggle walking right for selected bots |
control jump{:bash} | Toggle jumping for selected bots |
control sneak{:bash} | Toggle sneaking for selected bots |
control reset{:bash} | Resets the movement of selected bots |
mimic <entity>{:bash} | Makes selected bots mimic the movement of other entities |
useitem <hand>{:bash} | Makes selected bots use an item in the specified hand |
useitemon <blockX> <blockY> <blockZ> <face> <hand>{:bash} | Makes selected bots use an item on the block at the xyz coordinates with the specified face and hand |
inventory close{:bash} | Closes the current inventory for selected bots, opens the player inventory afterwards |
inventory current{:bash} | Get info about the current inventory for selected bots |
inventory left-click <slot>{:bash} | Left-clicks the specified slot in the current inventory for selected bots |
inventory right-click <slot>{:bash} | Right-clicks the specified slot in the current inventory for selected bots |
inventory left-click-outside{:bash} | Left-clicks outside current inventory for selected bots |
inventory right-click-outside{:bash} | Right-clicks outside current inventory for selected bots |
inventory middle-click <slot>{:bash} | Middle-clicks the specified slot in the current inventory for selected bots |
inventory drop-one <slot>{:bash} | Drops one item from the specified slot in the current inventory for selected bots |
inventory drop-all <slot>{:bash} | Drops all items from the specified slot in the current inventory for selected bots |
interact <entity> <hand>{:bash} | Makes selected bots interact with an entity using a specific hand |
attack start{:bash} | Makes selected instances start an attack |
attack stop{:bash} | Makes selected instances stop their attack |
attack pause{:bash} | Makes selected instances pause their attack |
online{:bash} | Shows connected bots in attacks |
say <message>{:bash} | Makes selected bots send a message in chat or execute a command |
respawn{:bash} | Respawn selected bots |
health{:bash} | Print the health of selected bots. |
export-map{:bash} | Exports images of all map items. Can be a held item or in a item-frame. |
export-map <map_id>{:bash} | Exports a image of a map item by map id. Can be a held item or in a item-frame. |
stop-task{:bash} | Makes selected bots stop their current task |
bot <bot_names> ...{:bash} | 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> ...{:bash} | 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> ...{:bash} | 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