📖 介绍
本插件基于 MsgRankCard 项目改写,是一个 NoneBot2 插件,用于记录群聊消息并生成精美的每日水群排行榜图片。
功能特点:
- 📝 自动记录群聊消息数量和在线时长
- 🎨 生成精美的排行榜图片,支持自定义背景、边框和字体
- 🖼️ 自动获取用户 QQ 头像
- 🏆 支持查看今日水群排行榜
- 🔔 支持 Superuser 开启排名变动提醒,名次变化后自动重发榜单
- 🧹 支持自动清理过期数据
💿 安装
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行,输入以下指令即可安装
nb plugin install nonebot-plugin-msg-rank-card
使用包管理器安装
在 nonebot2 项目的插件目录下,打开命令行,根据你使用的包管理器,输入相应的安装命令
pip
pip install nonebot-plugin-msg-rank-card
poetry
poetry add nonebot-plugin-msg-rank-card
打开 nonebot2 项目根目录下的 pyproject.toml 文件,在 [tool.nonebot] 部分追加写入
plugins = ["nonebot_plugin_msg_rank_card"]
⚙️ 配置
在 nonebot2 项目的 .env 文件中添加下表中的配置
| 配置项 | 必填 | 默认值 | 说明 |
|---|---|---|---|
| msg_rank_data_path | 否 | data/msg_rank | 数据存储路径 |
| msg_rank_resource_path | 否 | 插件目录/resources | 资源文件路径(背景图、边框、字体) |
| msg_rank_max_count | 否 | 10 | 排行榜最大显示人数 |
| msg_rank_auto_clean | 否 | true | 是否自动清理过期数据 |
| msg_rank_title | 否 | 今日水群排行榜 | 排行榜标题 |
🎉 使用
指令表
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|---|---|---|---|---|
| 水群榜 / msgrank | 群员 | 否 | 群聊 | 查看今日水群排行榜 |
| 排名变动提醒 开启|关闭|状态 | Superuser | 否 | 群聊 | 管理本群排名变动提醒 |
| 清理水群数据 / clean_msgrank | 群主/管理员 | 否 | 群聊 | 清理过期数据 |
排名变动提醒默认关闭,开关按群保存。开启后,只有榜单成员或名次顺序发生变化时才会提醒;消息数增加但名次不变时不会重复发送。
效果图
插件会自动记录群聊消息,发送 /水群榜 即可生成精美排行榜图片。
自定义资源
你可以替换插件目录下 resources 文件夹中的资源文件:
bg/- 背景图片(随机选择)frame/- 排名边框装饰ttf/- 自定义字体(第一个 ttf 文件会被使用)
📄 许可证
本项目基于 MsgRankCard 改写,采用 MIT 许可证。
Metadata
Release files for nonebot-plugin-msg-rank-card 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nonebot_plugin_msg_rank_card-0.1.3.tar.gz | 9.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nonebot_plugin_msg_rank_card-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.0 MB
Release files / nonebot_plugin_msg_rank_card-0.1.3.tar.gz
| Download URL | nonebot_plugin_msg_rank_card-0.1.3.tar.gz |
|---|---|
| Size | 9.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
51cc12fa2432b4e2229eefe0dbfcba56bfbabee1390ab4519eb0add24900f3d4
|
|
BLAKE2b-256 checksum How to use checksums |
f8e1543957c441d0995c5141fd2abfb84d5471d424e5fdf98f51a75e4d98a1ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.9
|
Release files / nonebot_plugin_msg_rank_card-0.1.3-py3-none-any.whl
| Download URL | nonebot_plugin_msg_rank_card-0.1.3-py3-none-any.whl |
|---|---|
| Size | 9.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
561f0e25d8cc0b0439dfc5820f58547b47dd5dcfa49ee9320d780fb0aebdbaf6
|
|
BLAKE2b-256 checksum How to use checksums |
43c2413517f92fab4405ab974ff40587022a6c1c8ba16651d2875dfc648799f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.9
|