mirror of
https://github.com/ChenXu233/nonebot_plugin_dialectlist.git
synced 2025-09-22 20:36:23 +00:00
🔖 Version 3.0.1
This commit is contained in:
27
README.md
27
README.md
@ -7,6 +7,7 @@
|
||||
<div align="center">
|
||||
|
||||
# 📃 话痨排行榜
|
||||
|
||||
nonebot-plugin-dialectlist
|
||||
|
||||
<p align="center">
|
||||
@ -24,21 +25,25 @@ nonebot-plugin-dialectlist
|
||||
[](https://wakatime.com/badge/user/114aee90-a5f9-49aa-b441-9eca7eebfda3/project/68aaa2a1-fb8a-4b00-bb66-ee67e8a3f3b0)
|
||||
|
||||
\>💬**看看群友们这些天在群里水了多少话**💬<
|
||||
|
||||
</div>
|
||||
|
||||
## 💿 安装
|
||||
|
||||
通过`pip`或`nb`安装:
|
||||
|
||||
- 通过 pip 安装
|
||||
|
||||
```bash
|
||||
pip install nonebot-plugin-dialectlist
|
||||
```
|
||||
|
||||
- 通过 nb-cli 安装
|
||||
|
||||
```bash
|
||||
nb plugin install nonebot-plugin-dialectlist
|
||||
```
|
||||
|
||||
|
||||
### ✅ 插件依赖于
|
||||
|
||||
1. [nonebot-plugin-datastore](https://github.com/he0119/nonebot-plugin-datastore) ————本地化储存
|
||||
@ -48,13 +53,14 @@ nb plugin install nonebot-plugin-dialectlist
|
||||
5. [nonebot-plugin-chatrecorder](https://github.com/noneplugin/nonebot-plugin-chatrecorder) ————实现消息储存
|
||||
6. [nonebot-plugin-cesaa](https://github.com/MountainDash/nonebot-plugin-send-anything-anywhere) ————实现多平台
|
||||
|
||||
**⚠注意** 若先前没有安装过```nonebot-plugin-chatrecorder```或者```nonebot-plugin-orm```,则会在启动时报错,请按报错的提示安装数据库!
|
||||
**⚠ 注意** 若先前没有安装过`nonebot-plugin-chatrecorder`或者`nonebot-plugin-orm`,则会在启动时报错,请按报错的提示安装数据库!
|
||||
|
||||
## ⚙ 配置
|
||||
|
||||
需要**提前配置**本插件所**依赖的插件**!
|
||||
|
||||
在 .env 中,可以添加以下配置项
|
||||
|
||||
```python
|
||||
dialectlist__get_num: int = 5 # 获取人数数量
|
||||
dialectlist__font: str = "SimHei" # 字体格式
|
||||
@ -62,15 +68,15 @@ dialectlist__suffix: bool = True # 是否显示后缀
|
||||
dialectlist__excluded_self: bool = True # 是否排除自己
|
||||
dialectlist__visualization: bool = True # 是否可视化
|
||||
dialectlist__show_text_rank: bool = True # 是否显示文本排名
|
||||
dialectlist__counting_cache: bool = False # 计数缓存(能够提高回复速度)
|
||||
dialectlist__excluded_people: List[str] = [] # 排除的人的 QQ 号
|
||||
dialectlist__use_user_info_cache: bool = False # 是否使用用户信息缓存
|
||||
dialectlist__aggregate_transmission: bool = False # 是否聚合转发消息
|
||||
dialectlist__timezone: Optional[str] = "Asia/Shanghai" # 时区,影响统计时间
|
||||
dialectlist__string_suffix: str = "统计花费时间:{timecost}秒" # 消息格式后缀
|
||||
dialectlist__string_suffix: str = "统计花费时间:{timecost}秒" # 消息格式后缀
|
||||
dialectlist__template_path: str = "./template/rank_template.j2" # 模板路径
|
||||
dialectlist__string_format: str = "第{index}名:\n{nickname},{chatdatanum}条消息\n" # 消息格式
|
||||
dialectlist__string_format: str = "第{index}名:\n{nickname},{chatdatanum}条消息、n" # 消息格式
|
||||
```
|
||||
|
||||
💭 也可以不进行配置,这将会使插件按照默认配置运行
|
||||
|
||||
### ⚠ 注意!!
|
||||
@ -80,7 +86,8 @@ dialectlist__string_format: str = "第{index}名:\n{nickname},{chatdatanum}条
|
||||
> 由于插件依赖 chatrecord 多次引入爆炸性修改,建议在遇到问题后优先尝试降级 chatrecord 插件
|
||||
|
||||
## 🗨 命令
|
||||
__!!注意!!__
|
||||
|
||||
**!!注意!!**
|
||||
新版本指令调用方式改变,改为更易理解也更好打的 B 话榜。
|
||||
同时也可以用类似 `/今日废话榜` 的方式(只要改前面的就好了)(算是给 [盘古之白](https://github.com/vinta/pangu.js) 风格爱好者的福利吧?)
|
||||
|
||||
@ -141,7 +148,7 @@ __!!注意!!__
|
||||
## 💪 目前支持的平台
|
||||
|
||||
| 平台 | 是否经过测试 | 是否能够正常工作 | 测试环境 |
|
||||
|:-----:|:----:|:----:| :----: |
|
||||
| :---------: | :----------: | :--------------: | :---------------: |
|
||||
| Onebot | ✅ | ✅ | NapCat + Window11 |
|
||||
| 飞书 | ❌ | ❓ | 🤔 |
|
||||
| Red | ❌ | ❓ | 🤔 |
|
||||
@ -174,10 +181,9 @@ __!!注意!!__
|
||||
|
||||

|
||||
|
||||
|
||||
### 💕 感谢
|
||||
|
||||
本插件的__init__.py 中的处理函数参考了词云中的方法 ~~(其实大部分都是 Ctrl+C Ctr+V)~~
|
||||
本插件的**init**.py 中的处理函数参考了词云中的方法 ~~(其实大部分都是 Ctrl+C Ctr+V)~~
|
||||
|
||||
[nonebot-plugin-wordcloud](https://github.com/he0119/nonebot-plugin-wordcloud)
|
||||
|
||||
@ -194,7 +200,6 @@ __!!注意!!__
|
||||
- [x] 更好看的图片渲染
|
||||
|
||||
- [x] 添加一些全新的可配置项
|
||||
|
||||
- [x] 尝试利用 jinja2 模板引擎制作可视化图片
|
||||
|
||||
- [x] 私聊的查询(超级用户可以任意查询群聊的信息)一半完成
|
||||
@ -207,6 +212,6 @@ __!!注意!!__
|
||||
|
||||
待补充。.....
|
||||
|
||||
|
||||
### 👾 题外话
|
||||
|
||||
~~整个项目快被我写成屎山了~~
|
||||
|
@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "nonebot-plugin-dialectlist"
|
||||
version = "2.7.1"
|
||||
version = "3.0.1"
|
||||
description = "看看你群群友有多能说"
|
||||
authors = [{ name = "Chen_Xu233", email = "woyerpa@outlook.com" }]
|
||||
dependencies = [
|
||||
|
Reference in New Issue
Block a user