Skip to content

Commit

Permalink
docs(bot): 📝 update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AnzhiZhang committed Dec 21, 2023
1 parent c79c93a commit 868d54e
Show file tree
Hide file tree
Showing 2 changed files with 130 additions and 50 deletions.
90 changes: 65 additions & 25 deletions bot/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@

`!!bot config <name> <option> <value>` Config bot

### Workflow

```mermaid
sequenceDiagram
participant Player/Console
Expand Down Expand Up @@ -123,33 +125,71 @@ Delete saved bot

Config bot

### Full Command Tree

```mermaid
flowchart LR
start([config])
start --> bot_name(name)
bot_name --> name(name)
bot_name --> position(position)
bot_name --> facing(facing)
bot_name --> dimension(dimension)
bot_name --> comment(comment)
bot_name --> actions(actions)
bot_name --> tags(tags)
bot_name --> autoLogin(autoLogin)
bot_name --> autoRunActions(autoRunActions)
bot_name --> autoUpdate(autoUpdate)
actions --> actions_append("append &lt;action&gt;")
actions --> actions_insert("insert &lt;index&gt; &lt;action&gt;")
actions --> actions_delete("delete &lt;index&gt")
actions --> actions_edit("edit &lt;index&gt; &lt;action&gt;")
actions --> actions_clear(clear)
tags --> tags_append("append &lt;tag&gt;")
tags --> tags_insert("insert &lt;index&gt; &lt;tag&gt;")
tags --> tags_delete("delete &lt;index&gt")
tags --> tags_edit("edit &lt;index&gt; &lt;tag&gt;")
tags --> tags_clear(clear)
start(!!bot)
start --> list(list)
list --> list_index[&lt;index&gt;]
list_index --> list_index_arg["
--all
--online
--saved
"]
start --> spawn(spawn)
spawn --> spawn_name(&lt;name&gt;)
start --> kill(kill)
kill --> kill_name(&lt;name&gt;)
start --> action(action)
action --> action_name(&lt;name&gt;)
action_name --> action_name_index[&lt;index&gt;]
start --> tags(tags)
tags --> tags_tag[&lt;tag&gt;]
tags_tag --> tags_tag_spawn(spawn)
tags_tag --> tags_tag_kill(kill)
start --> info(info)
info --> info_name(&lt;name&gt;)
start --> save(save)
save --> save_name(&lt;name&gt;)
save_name --> save_name_position[&lt;position&gt;]
save_name_position --> save_name_position_facing[&lt;facing&gt;]
save_name_position_facing --> save_name_position_facing_dimension[&lt;dimension&gt;]
start --> del(del)
del --> del_name(&lt;name&gt;)
start --> config(config)
config --> config_name(&lt;name&gt;)
config_name --> config_name_name(name &lt;newName&gt;)
config_name --> config_name_position(position &lt;position&gt;)
config_name --> config_name_facing(facing &lt;facing&gt;)
config_name --> config_name_dimension(dimension &lt;dimension&gt;)
config_name --> config_name_comment(comment &lt;comment&gt;)
config_name --> config_name_actions(actions)
config_name --> config_name_tags(tags)
config_name --> config_name_autoLogin(autoLogin &lt;autoLogin&gt;)
config_name --> config_name_autoRunActions(autoRunActions &lt;autoRunActions&gt;)
config_name --> config_name_autoUpdate(autoUpdate &lt;autoUpdate&gt;)
config_name_actions --> config_name_actions_append["append &lt;action&gt;"]
config_name_actions --> config_name_actions_insert["insert &lt;index&gt; &lt;action&gt;"]
config_name_actions --> config_name_actions_delete["delete &lt;index&gt"]
config_name_actions --> config_name_actions_edit["edit &lt;index&gt; &lt;action&gt;"]
config_name_actions --> config_name_actions_clear[clear]
config_name_tags --> config_name_tags_append["append &lt;tag&gt;"]
config_name_tags --> config_name_tags_insert["insert &lt;index&gt; &lt;tag&gt;"]
config_name_tags --> config_name_tags_delete["delete &lt;index&gt"]
config_name_tags --> config_name_tags_edit["edit &lt;index&gt; &lt;tag&gt;"]
config_name_tags --> config_name_tags_clear[clear]
```

## Config
Expand Down
90 changes: 65 additions & 25 deletions bot/readme_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@

`!!bot config <name> <option> <value>` 配置假人

### 工作流

```mermaid
sequenceDiagram
participant Player/Console
Expand Down Expand Up @@ -123,33 +125,71 @@ flowchart TD

配置假人

### 完整指令树

```mermaid
flowchart LR
start([config])
start --> bot_name(name)
bot_name --> name(name)
bot_name --> position(position)
bot_name --> facing(facing)
bot_name --> dimension(dimension)
bot_name --> comment(comment)
bot_name --> actions(actions)
bot_name --> tags(tags)
bot_name --> autoLogin(autoLogin)
bot_name --> autoRunActions(autoRunActions)
bot_name --> autoUpdate(autoUpdate)
actions --> actions_append("append &lt;action&gt;")
actions --> actions_insert("insert &lt;index&gt; &lt;action&gt;")
actions --> actions_delete("delete &lt;index&gt")
actions --> actions_edit("edit &lt;index&gt; &lt;action&gt;")
actions --> actions_clear(clear)
tags --> tags_append("append &lt;tag&gt;")
tags --> tags_insert("insert &lt;index&gt; &lt;tag&gt;")
tags --> tags_delete("delete &lt;index&gt")
tags --> tags_edit("edit &lt;index&gt; &lt;tag&gt;")
tags --> tags_clear(clear)
start(!!bot)
start --> list(list)
list --> list_index[&lt;index&gt;]
list_index --> list_index_arg["
--all
--online
--saved
"]
start --> spawn(spawn)
spawn --> spawn_name(&lt;name&gt;)
start --> kill(kill)
kill --> kill_name(&lt;name&gt;)
start --> action(action)
action --> action_name(&lt;name&gt;)
action_name --> action_name_index[&lt;index&gt;]
start --> tags(tags)
tags --> tags_tag[&lt;tag&gt;]
tags_tag --> tags_tag_spawn(spawn)
tags_tag --> tags_tag_kill(kill)
start --> info(info)
info --> info_name(&lt;name&gt;)
start --> save(save)
save --> save_name(&lt;name&gt;)
save_name --> save_name_position[&lt;position&gt;]
save_name_position --> save_name_position_facing[&lt;facing&gt;]
save_name_position_facing --> save_name_position_facing_dimension[&lt;dimension&gt;]
start --> del(del)
del --> del_name(&lt;name&gt;)
start --> config(config)
config --> config_name(&lt;name&gt;)
config_name --> config_name_name(name &lt;newName&gt;)
config_name --> config_name_position(position &lt;position&gt;)
config_name --> config_name_facing(facing &lt;facing&gt;)
config_name --> config_name_dimension(dimension &lt;dimension&gt;)
config_name --> config_name_comment(comment &lt;comment&gt;)
config_name --> config_name_actions(actions)
config_name --> config_name_tags(tags)
config_name --> config_name_autoLogin(autoLogin &lt;autoLogin&gt;)
config_name --> config_name_autoRunActions(autoRunActions &lt;autoRunActions&gt;)
config_name --> config_name_autoUpdate(autoUpdate &lt;autoUpdate&gt;)
config_name_actions --> config_name_actions_append["append &lt;action&gt;"]
config_name_actions --> config_name_actions_insert["insert &lt;index&gt; &lt;action&gt;"]
config_name_actions --> config_name_actions_delete["delete &lt;index&gt"]
config_name_actions --> config_name_actions_edit["edit &lt;index&gt; &lt;action&gt;"]
config_name_actions --> config_name_actions_clear[clear]
config_name_tags --> config_name_tags_append["append &lt;tag&gt;"]
config_name_tags --> config_name_tags_insert["insert &lt;index&gt; &lt;tag&gt;"]
config_name_tags --> config_name_tags_delete["delete &lt;index&gt"]
config_name_tags --> config_name_tags_edit["edit &lt;index&gt; &lt;tag&gt;"]
config_name_tags --> config_name_tags_clear[clear]
```

## 配置
Expand Down

0 comments on commit 868d54e

Please sign in to comment.