From cf0f3f3bc7ca7ad659af6a4c9240db109ad07a77 Mon Sep 17 00:00:00 2001
From: RF-Tar-Railt <rf_tar_railt@qq.com>
Date: Wed, 11 Dec 2024 01:35:38 +0800
Subject: [PATCH] :bug: fix version 0.10.0rc1

---
 README.md                      | 57 ++++++++++++++++++++++++++++++++++
 arclet/entari/builtins/help.py |  6 ++--
 pyproject.toml                 |  2 +-
 3 files changed, 61 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 3bab4dd..0e719c7 100644
--- a/README.md
+++ b/README.md
@@ -113,3 +113,60 @@ load_plugin("::auto_reload", {"watch_dirs": ["plugins"]})
 app.run()
 ```
 
+
+
+## 配置文件
+
+```yaml
+basic:
+  network:
+    - type: ws
+      host: "127.0.0.1"
+      port: 5140
+      path: "satori"
+  ignore_self_message: true
+  log_level: INFO
+  prefix: ["/"]
+plugins:
+  ~record_message:
+    record_send: true
+  ~commands:
+    use_config_prefix: false
+  ::auto_reload:
+    watch_dirs: ["."]
+    watch_config: false
+  ::echo: true
+  ::help:
+    page_size: null
+```
+
+- `basic`: Entari 基础配置
+  - `network`: 网络配置, 可写多个网络配置
+    - `type`: 网络类型, 可填项有 `ws`, `websocket`, `wh`, `webhook`
+    - `host`: satori 服务器地址
+    - `port`: satori 服务器端口
+    - `path`: satori 服务器路径
+  - `ignore_self_message`: 是否忽略自己发送的消息事件
+  - `log_level`: 日志等级
+  - `prefix`: 指令前缀, 可留空
+- `plugins`: 插件配置
+  - `~record_message`: 消息日志并配置
+    - `record_send`: 是否记录发送消息 (默认为 `true`)
+  - `~commands`: 指令插件配置 (适用于所有使用了 `command.on/command.command` 的插件)
+    - `need_notice_me`: 指令是否需要 @ 机器人
+    - `need_reply_me`: 指令是否需要回复机器人
+    - `use_config_prefix`: 是否使用配置文件中的前缀
+  - `::auto_reload`: 启用自动重载插件并配置
+    - `watch_dirs`: 监听目录
+    - `watch_config`: 是否监听配置文件的变化 (默认为 `true`)
+  - `::echo`: 启用回声插件
+  - `::help`: 启用帮助插件并配置
+    - `help_command`: 帮助指令, 默认为 `help`
+    - `help_alias`: 帮助指令别名, 默认为 `["帮助", "命令帮助"]`
+    - `page_size`: 每页显示的指令数量, 留空则不分页
+
+对于其他插件的配置, 有三种写法:
+
+1. `foo.bar: true` (启用插件)
+2. `foo.bar: false` (禁用插件)
+3. `foo.bar: {"key": "value"}` (启用插件并配置)
diff --git a/arclet/entari/builtins/help.py b/arclet/entari/builtins/help.py
index d993092..c066ce9 100644
--- a/arclet/entari/builtins/help.py
+++ b/arclet/entari/builtins/help.py
@@ -19,7 +19,7 @@
 from arclet.entari import Session, command, metadata, plugin_config
 
 config = plugin_config()
-help_text: str = config.get("help_text", "help")
+help_command: str = config.get("help_command", "help")
 help_alias: list[str] = config.get("help_alias", ["帮助", "命令帮助"])
 help_all_alias: list[str] = config.get("help_all_alias", ["所有帮助", "所有命令帮助"])
 page_size: Optional[int] = config.get("page_size", None)
@@ -35,7 +35,7 @@
     ns.disable_builtin_options = {"shortcut"}
 
     help_cmd = Alconna(
-        help_text,
+        help_command,
         Args[
             "query#选择某条命令的id或者名称查看具体帮助;/?",
             str,
@@ -61,7 +61,7 @@
         meta=CommandMeta(
             description="显示所有命令帮助",
             usage="可以使用 --hide 参数来显示隐藏命令，使用 -P 参数来显示命令所属插件名称",
-            example=f"${help_text} 1",
+            example=f"${help_command} 1",
         ),
     )
 
diff --git a/pyproject.toml b/pyproject.toml
index d1fa045..45a920d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "arclet-entari"
-version = "0.9.0"
+version = "0.10.0rc1"
 description = "Simple IM Framework based on satori-python"
 authors = [
     {name = "RF-Tar-Railt",email = "rf_tar_railt@qq.com"},