Update README.md

This commit is contained in:
Skirt✿ 2022-10-03 20:32:39 +08:00 committed by GitHub
parent 95c937203d
commit 4aa2ebce29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,14 +9,27 @@
# 话痨排行榜
nonebot-plugin-dialectlist
\>📄看看群友们这些天在群里水了多少话📄<
\>💬**看看群友们这些天在群里水了多少话**💬<
</div>
## 版本
### V1.0
- 看看群里群友能有多话痨
### V1.1
- 支持频道咯!(*^_^*)
### V1.2
- 排行榜可视化
### V1.3
- 添加了一些可配置项
v1.0 支持频道咯!(*^_^*)
⚠ 适配nonebot2-2.0.0b5+
### ⚠ 适配nonebot2-2.0.0b5+
## 安装
@ -44,11 +57,16 @@ v1.0 支持频道咯!(*^_^*)
在环境配置中,可以添加以下配置项
```python
dialectlist_string_format: str = '第{index}名:\n{nickname},{chatdatanum}条消息\n' #格式
dialectlist_string_suffix_format: str = '\n你们的职业是水群吗————MYX\n计算花费时间:{timecost}秒' #后缀字符
dialectlist_get_num:int = 10 #排行榜长度
dialectlist_string_format: str = '第{index}名:\n{nickname},{chatDataNum}条消息\n' #消息格式
dialectlist_string_suffix_format: str = '你们的职业是水群吗————MYX\n计算花费时间:{timeCost}秒' #消息后缀格式
dialectlist_get_num:int = 10 #获取人数数量
dialectlist_visualization:bool = True #是否可视化
dialectlist_visualization_type:Literal['饼图','圆环图','柱状图'] = '圆环图' #可视化方案
dialectlist_font:str = 'SimHei'#字体格式
dialectlist_excluded_people:List[str] = []#排除的人的QQ号(或频道号?(未经测试))
dialectlist_excluded_self:bool = True #是否排除机器人自己QQ
```
也可以完全不配置,将会按照默认配置走
💭也可以不进行配置,这将会使插件按照默认配置运行
## 命令
@ -67,8 +85,6 @@ dialectlist_get_num:int = 10 #排行榜长度
-`/历史群话痨排行榜` ————看看历史上(机器人存在以来)的群友发了多少消息!
**注意:频道内不管任何一个都是查看有史以来的消息(储存时间的不好写(以后会写的!))**
## 另外
### 感谢
@ -81,16 +97,10 @@ dialectlist_get_num:int = 10 #排行榜长度
## TODO
1. 私聊的查询 ~~(让我先咕一会)~~
2. 可视化排行榜
3. 优化代码结构(?)(看起来非常乱了)
## 已知BUG
### 频道中同名的人会出现计数重复
- 这是因为因为chatrecorder其实不支持频道消息所有我写了一个保存在json中的版本然后频道api怎么样都通过不了user_id获取nickname于是我就放弃了
- *今后会试试~~写一个~~适配频道的chatrecorder*
1. 字体可能要自己配置(bug?)
#
**学业问题可能只有周末才能看iusse和更新插件**