From 740c60ab195e7936058801dfb4959161c39d4602 Mon Sep 17 00:00:00 2001 From: Chenric <91937041+ChenXu233@users.noreply.github.com> Date: Tue, 18 Jun 2024 23:20:03 +0800 Subject: [PATCH] :pencil: Update README.md --- README.md | 47 ++++++++++++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index cf12414..e152a52 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ nonebot-plugin-dialectlist -## 安装 +## 💿安装 通过`pip`或`nb`安装; @@ -25,24 +25,25 @@ nonebot-plugin-dialectlist `nb plugin install nonebot-plugin-dialectlist` -### 插件依赖于 +### ✅插件依赖于 1. [nonebot-plugin-datastore](https://github.com/he0119/nonebot-plugin-datastore) ————储存历史的消息 +2. saa 和 定时管理 (下次写个更清晰的) -## 配置 +## ⚙配置 需要**提前配置**本插件所**依赖的插件**! -在环境配置中,可以添加以下配置项 +在 .env 中,可以添加以下配置项 ```python -dialectlist_string_format = '第{index}名:\n{nickname},{chatdatanum}条消息\n' #消息格式 -dialectlist_string_suffix_format = '你们的职业是水群吗?————MYX\n计算花费时间:{timecost}秒' #消息后缀格式 -dialectlist_get_num = 10 #获取人数数量 -dialectlist_visualization = True #是否可视化 -dialectlist_visualization_type = '圆环图' #可视化方案 -dialectlist_font = 'SimHei'#字体格式 -dialectlist_excluded_people = []#排除的人的QQ号(或频道号?(未经测试)) -dialectlist_excluded_self = True #是否排除机器人自己QQ +dialectlist__string_format = '第{index}名:\n{nickname},{chatdatanum}条消息\n' #消息格式 +dialectlist__string_suffix_format = '你们的职业是水群吗?————MYX\n计算花费时间:{timecost}秒' #消息后缀格式 +dialectlist__get_num = 10 #获取人数数量 +dialectlist__visualization = True #是否可视化 +dialectlist__visualization_type = '圆环图' #可视化方案 +dialectlist__font = 'SimHei'#字体格式 +dialectlist__excluded_people = []#排除的人的QQ号(或频道号?(未经测试)) +dialectlist__excluded_self = True #是否排除机器人自己QQ ``` 💭也可以不进行配置,这将会使插件按照默认配置运行 @@ -52,7 +53,13 @@ dialectlist_excluded_self = True #是否排除机器人自己QQ 在Windows以外的环境中可能不存在插件默认的字体!请自行改为系统中拥有的字体! -## 命令 +## 🗨命令 +__!!注意!!__ +新版本指令调用方式改变,改为更易理解也更好打的B话榜。 +所以下面的调用需要把群话痨改成B话,排行榜改成榜。 +即 群话痨 -> B话 , 排行榜 -> 榜 +比如 今日群话痨排行榜 -> 今日B话榜 +以此类推。 -`/群话痨排行榜` ————看看有史以来(机器人存在以来)群友们发了多少消息! @@ -72,10 +79,8 @@ dialectlist_excluded_self = True #是否排除机器人自己QQ -`/历史群话痨排行榜` ————看看历史上(机器人存在以来)的群友发了多少消息! - -# 注意💥,在目前版本中不支持频道 -## 版本 +## 📖版本 ### V1.0 @@ -97,7 +102,11 @@ dialectlist_excluded_self = True #是否排除机器人自己QQ - 适配新版本的chatrecorder,暂时停止频道支持 -## 另外 +### V2.0 + + - 理论支持全平台!暂停图片支持。 + +## 💧另外 ### 感谢 @@ -108,9 +117,9 @@ dialectlist_excluded_self = True #是否排除机器人自己QQ ## TODO -- [ ] 私聊的查询(超级用户可以任意查询群聊的信息) +- [x] 适配全平台 -- [ ] 适配onebotV12 +- [ ] 私聊的查询(超级用户可以任意查询群聊的信息) - [ ] 关键词查询