SoulFire LogoSoulFire

Commands

Learn how to use commands with SoulFire.

About commands

Commands show information or control bots through the SoulFire server.

List of commands

CommandDescription
helpShows all available commands
generate-token apiCreates an API token for the current user
generate-token webdavCreates a WebDAV token for the current user
set-email <email>Set the email of the current user
whoamiShows the current user
pluginsShow all installed plugins
stopStops the SoulFire server
sparkShows help for spark
spark <command>Runs a spark subcommand
move <entity>Makes selected bots move to an entity
move radius <radius>Moves selected bots to a random X/Z position inside the radius
move <y>Moves selected bots to the Y coordinate
move <x> <z>Moves selected bots to the X/Z coordinates
move <x> <y> <z>Moves selected bots to the X/Y/Z 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 between two positions
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 X/Y/Z coordinates
control forwardToggle walking forward for selected bots
control backwardToggle walking backward for selected bots
control leftToggle walking left for selected bots
control rightToggle walking right for selected bots
control jumpToggle jumping for selected bots
control sneakToggle sneaking for selected bots
control resetStops manual movement for selected bots
mimic <entity>Makes selected bots copy the movement of an entity
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 closeCloses the current inventory and opens the player inventory
inventory currentShows the current inventory
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-outsideLeft-clicks outside current inventory for selected bots
inventory right-click-outsideRight-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
bots startStarts every configured bot in the selected instances
bots stopStops every configured bot in the selected instances
onlineShows connected bots in the selected instances
say <message>Makes selected bots send a message in chat or execute a command
respawnRespawns selected bots
healthShows the health of selected bots
export-mapExports images of all held or framed map items
export-map <map_id>Exports an image of the map with the given ID
stop-taskStops the current task for selected bots
bot <bot_names> ...Runs a command for specific bots. Separate their names with commas
instance <instance_names> ...Runs a command for specific instances. Separate their names with commas
repeat <amount> ...Repeats a command the given 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

On this page