koishi-plugin-message-counter-qq 2.6.21

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "koishi-plugin-message-counter-qq",
+  "description": "Koishi 的 QQ 群消息数量统计插件。生成发言排行榜。",
+  "version": "2.6.21",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist",
+    "assets"
+  ],
+  "koishi": {
+    "service": {
+      "required": [
+        "database",
+        "cron"
+      ],
+      "optional": [
+        "markdownToImage",
+        "puppeteer",
+        "canvas"
+      ]
+    }
+  },
+  "license": "MIT OR Apache-2.0",
+  "contributors": [
+    "Nawyjx <3373167460@qq.com>",
+    "shangxueink <1919892171@qq.com>"
+  ],
+  "keywords": [
+    "chatbot",
+    "koishi",
+    "plugin",
+    "message",
+    "counter",
+    "message-counter",
+    "rank",
+    "发言排行榜",
+    "排行榜",
+    "消息",
+    "记录",
+    "发言榜"
+  ],
+  "peerDependencies": {
+    "koishi": "^4.18.9"
+  },
+  "devDependencies": {
+    "koishi-plugin-cron": "^3.1.0",
+    "koishi-plugin-markdown-to-image-service": "^1.3.6",
+    "koishi-plugin-puppeteer": "^3.9.0"
+  }
+}

package/readme.md

@@ -0,0 +1,118 @@
+koishi-plugin-message-counter-qq
+========================
+
+Koishi 的 QQ 群消息数量统计插件。发言排行榜。
+
+## 📝 注意事项
+
+- 这是 QQ 群专用版本
+- 只统计 `GROUP_MESSAGE_CREATE`，不统计 `GROUP_AT_MESSAGE_CREATE`
+- 当前群排行榜为空时，通常表示今日暂无消息，或群主未允许机器人接收全量群消息
+- 初始化需权限等级 3
+- 依赖 database 与 cron 服务
+- 生成图片时，需 puppeteer 提供 canvas 支持
+
+## 🔍 关键指令
+
+### `消息统计.查询 [指定用户]`
+
+查询指定用户的发言次数信息（次数[排名]）。若不带任何选项，则显示所有时段的数据。
+
+**选项:**
+
+| 参数 | 说明 |
+|------|------|
+| `-d, --day` | 今日发言次数[排名] |
+| `--yd, --yesterday` | 昨日发言次数[排名] |
+| `-w, --week` | 本周发言次数[排名] |
+| `-m, --month` | 本月发言次数[排名] |
+| `-y, --year` | 今年发言次数[排名] |
+| `-t, --total` | 总发言次数[排名] |
+| `--dag` | 跨群今日发言次数[排名] |
+| `--ydag` | 跨群昨日发言次数[排名] |
+| `--wag` | 跨群本周发言次数[排名] |
+| `--mag` | 跨群本月发言次数[排名] |
+| `--yag` | 跨群本年发言次数[排名] |
+| `-a, --across` | 跨群总发言次数[排名] |
+
+### `消息统计.排行榜 [显示的人数]`
+
+发言排行榜。默认为今日发言榜。
+
+**选项:**
+
+| 参数 | 说明 |
+|------|------|
+| `--yd, --yesterday` | 昨日发言排行榜 |
+| `-w` | 本周发言排行榜 |
+| `-m` | 本月发言排行榜 |
+| `-y` | 今年发言排行榜 |
+| `-t` | 总发言排行榜 |
+| `--dag` | 跨群今日发言排行榜 |
+| `--ydag` | 跨群昨日发言排行榜 |
+| `--wag` | 跨群本周发言排行榜 |
+| `--mag` | 跨群本月发言排行榜 |
+| `--yag` | 跨群今年发言排行榜 |
+| `--dragon` | 跨群总发言排行榜（圣龙王榜） |
+| `--whites` | 白名单，只显示白名单用户 |
+| `--blacks` | 黑名单，不显示黑名单用户 |
+
+### `消息统计.上传柱状条背景`
+
+- 为自己上传一张自定义的水平柱状条背景图片
+- 新图片会覆盖旧的图片。若上传失败，旧图片也会被删除
+- 使用此指令时需附带图片
+
+### `消息统计.重载资源`
+
+- 实时重载用户图标、柱状条背景和字体文件，使其更改即时生效（需要权限等级 2）
+
+### `消息统计.清理缓存`
+
+- 清理过期的头像缓存文件，以释放磁盘空间（需要权限等级 3）
+- 用户更换头像后，旧的头像缓存会变成“孤儿缓存”。此指令可以安全地移除它们。
+
+## 🚫 不支持的功能
+
+- 不支持群排行榜，因为当前拿不到稳定的群名和群头像
+- 不支持“向所有群聊推送”，请手动填写 `pushChannelIds`
+- 不支持“抓龙王”禁言
+
+## 🎨 自定义水平柱状图样式
+
+- 重载插件或使用 `消息统计.重载资源` 指令可使新增的文件立即生效。
+
+### 1. 用户图标
+
+- 在 `data/messageCounter/icons` 文件夹下添加用户图标
+- 文件名格式为 `用户ID.png`（例：`1234567890.png`）
+- 支持多图标，文件名格式为 `用户ID-1.png`, `用户ID-2.png`
+
+### 2. 柱状条背景
+
+- **推荐方式**：使用 `消息统计.上传柱状条背景` 指令
+- **手动方式**：在 `data/messageCounter/barBgImgs` 文件夹下添加背景图片
+- 支持多背景（随机选用），文件名格式为 `用户ID-1.png` 等
+- 建议尺寸 850x50 像素，文件名 `用户ID.png`
+
+### 3. 自定义字体
+
+- 插件启动时，会自动将内置字体 `HarmonyOS_Sans_Medium.ttf` 拷贝到 `data/messageCounter/fonts/` 目录下。
+- 您可以将自己喜爱的字体文件放入此文件夹，并在配置项的“字体设置”中填入该字体的文件名称（不带后缀）。
+
+<br>
+
+#### License
+
+<sup>
+Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
+2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
+</sup>
+
+<br>
+
+<sub>
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
+be dual licensed as above, without any additional terms or conditions.
+</sub>