Bot
The best carpet bot manager!
Dependencies
Usage
!!bot View help
!!bot list [--index <index>] [filters] Show bot list
!!bot spawn <name> Spawn bot
!!bot kill <name> Kill bot
!!bot action <name> [index] Execute bot action(s)
!!bot tags View available tags
!!bot tags <tag> spawn/kill Spawn/kill bot(s) with tag
!!bot info <name> View bot info
!!bot save <name> [position] [facing] [dimension] Save bot
!!bot del <name> Delete saved bot
!!bot config <name> <option> <value> Config bot
Workflow
sequenceDiagram
participant Player/Console
participant Online Bots
participant Saved Bots
Player/Console-->>Online Bots: !!bot spawn (player)
Saved Bots-->>Online Bots: !!bot spawn
Online Bots-->>Online Bots: !!bot kill
Online Bots-->>Saved Bots: !!bot save
Player/Console-->>Saved Bots: !!bot save [location]
Saved Bots-->>Saved Bots: !!bot del
list
--index <index>: Page number, e.g. --index 1, default is 0
--online: Show online bots
--saved: Show saved bots
--tag <tag>: Filter by tag
spawn
Spawn bot
flowchart TD
start([spawn])
is_saved{Saved?}
is_player{Running by Player?}
start --> is_saved
is_saved -->|Yes| spawn1(Spawn at Saved Location)
is_saved -->|No| is_player
is_player -->|Yes| spawn2(Spawn at player's Location)
is_player -->|No| error1([Not Saved Error])
kill
Kill bot
action
Execute bot action(s)
When index is specified, execute specific action(s) instead of all actions
tags
View available tags and spawn/kill bot(s) with tag
!!bot tags View available tags
!!bot tags <tag> spawn Spawn bot(s) with tag
!!bot tags <tag> kill Kill bot(s) with tag
info
View bot info
save
Save bot
flowchart TD
start([save])
with_location{Has Location?}
online{Online or Saved?}
is_player{Running by Player?}
start --> with_location
with_location -->|Yes| save3(Save at Input Location)
with_location -->|No| online
online -->|Yes| save1(Save at Bot's Location)
online -->|No| is_player
is_player -->|Yes| save2(Save at player's location)
is_player -->|No| error1([Bot Not Exists])
del
Delete saved bot
After deletion, the bot will be backed up to the botBin.json file in the data directory. If you delete it by mistake, you can use it for manual recovery.
config
Config bot
Full Command Tree
flowchart LR
start(!!bot)
start --> list(list)
list --> list_index["--index <index>"]
list --> list_online[--online]
list --> list_saved[--saved]
list --> list_tag["--tag <tag>"]
start --> spawn(spawn)
spawn --> spawn_name("<name>")
start --> kill(kill)
kill --> kill_name("<name>")
start --> action(action)
action --> action_name("<name>")
action_name --> action_name_index["<index>"]
start --> tags(tags)
tags --> tags_tag["<tag>"]
tags_tag --> tags_tag_spawn(spawn)
tags_tag --> tags_tag_kill(kill)
start --> info(info)
info --> info_name("<name>")
start --> save(save)
save --> save_name("<name>")
save_name --> save_name_position["<position>"]
save_name_position --> save_name_position_facing["<facing>"]
save_name_position_facing --> save_name_position_facing_dimension["<dimension>"]
start --> del(del)
del --> del_name("<name>")
start --> config(config)
config --> config_name("<name>")
config_name --> config_name_name("name <newName>")
config_name --> config_name_position("position <position>")
config_name --> config_name_facing("facing <facing>")
config_name --> config_name_dimension("dimension <dimension>")
config_name --> config_name_comment("comment <comment>")
config_name --> config_name_actions(actions)
config_name --> config_name_tags(tags)
config_name --> config_name_autoLogin("autoLogin <autoLogin>")
config_name --> config_name_autoRunActions("autoRunActions <autoRunActions>")
config_name --> config_name_autoUpdate("autoUpdate <autoUpdate>")
config_name_actions --> config_name_actions_append("append <action>")
config_name_actions --> config_name_actions_insert("insert <index> <action>")
config_name_actions --> config_name_actions_delete("delete <index>")
config_name_actions --> config_name_actions_edit("edit <index> <action>")
config_name_actions --> config_name_actions_clear(clear)
config_name_tags --> config_name_tags_append["append <tag>"]
config_name_tags --> config_name_tags_insert["insert <index> <tag>"]
config_name_tags --> config_name_tags_delete["delete <index>"]
config_name_tags --> config_name_tags_edit["edit <index> <tag>"]
config_name_tags --> config_name_tags_clear[clear]
Config
gamemode
Default: survival
Game mode of bot
force_gamemode
Default: false
Forcing all bots to use the game mode configured by gamemode, if false, only saved bots will use the game mode configured by gamemode.
name_prefix
Default: bot_
Prefix of bot name
name_suffix
Default: None
Suffix of bot name
post_join_delay
Default: 0
Delay time (seconds) for processing after bot joined. If you are using a non-vanilla server, you may need to adjust this value.
permissions
Minimum permission to use corresponding command
FastAPI MCDR
The plugin supports the FastAPI MCDR plugin (>=2.0.0). After installing the FastAPI MCDR plugin, the plugin will automatically register endpoints. You can view the API definition through FastAPI.
Python packages required:
pydantic>=2.0
You can use this feature to implement external control, such as a web page for managing bots:
README source: src/bot/readme.md