From a28d43ea3b4e2f6b5aaf63654f767f111182e0ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=99=BD=E6=B1=A0?= <98259561+whitechi73@users.noreply.github.com> Date: Tue, 31 Oct 2023 00:20:04 +0800 Subject: [PATCH] =?UTF-8?q?=E3=83=97=E3=83=AD=E3=83=95=E3=82=A1=E3=82=A4?= =?UTF-8?q?=E3=83=AB=E3=83=AD=E3=82=B8=E3=83=83=E3=82=AF=E3=81=AE=E5=A4=89?= =?UTF-8?q?=E6=9B=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/guide/configuration.md | 39 ++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 6fe0a78..21c90be 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -39,22 +39,47 @@ Shamrock 提供了一个图形化的配置界面,可进行简单的配置操 - QQ 主目录: `内部存储目录 + /Android/data/com.tencent.mobileqq` - Shamrock 主目录: `QQ主目录 + /Tencent/Shamrock` -## 事件过滤 - -当前仅支持,群聊 |私聊 黑/白名单。 +## 配置文件 将下方 JSON 文件创建在 `Shamrock 主目录 + /config.json` 请确保 JSON 格式正确。 ```json { - "group_rule": { - "black_list": [...], - "white_list": [...] - } + "rules": { + "group_rule": { + "black_list": [12345678], // 如果群号是`12345678`就跳过了哦! + "white_list": [] + }, + "private_rule": { + "black_list": [12345678], + "white_list": [] + } + }, + "default_token": null, + "active_websocket": { + "port": 5800, // 主动WS监听的端口 + "token": "aaaa1111,bbbb1111" // 同时允许两个token可使用|或,作为分割 + }, + "passive_websocket": [ + { + "address": "ws://xxxxxxxxx" // 这里是个例子,如果默认tk存在则使用默认token鉴权 + }, + { + "address": "ws://aaaaaaaaa", + "token": "aaa666" // 提供了特例化token,将不使用默认token + } + ] } ``` +| 参数名称 | 类型 | 作用 | 例子 | +|---------|------|------|-----| +| default_token | string | 默认token,**HTTP接口/主被动WS** 如果未单独定义token,则使用默认token | aaa123456 | + + +!> 记得把注释删掉哦?JSON5貌似也没有完全支持呢? + ## 数据目录 大部分 Shamrock 的数据/缓存保存在 `Shamrock 主目录`