diff --git a/README.md b/README.md index 6a2c409..a5e17af 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@
-# QQ群日常分析插件 +# 群聊日常分析插件 - -[![Plugin Version](https://img.shields.io/badge/Latest_Version-v4.6.6-blue.svg?style=for-the-badge&color=76bad9)](https://github.com/SXP-Simon/astrbot-qq-group-daily-analysis) +[![Plugin Version](https://img.shields.io/badge/Latest_Version-v4.7.0-blue.svg?style=for-the-badge&color=76bad9)](https://github.com/SXP-Simon/astrbot-qq-group-daily-analysis) [![AstrBot](https://img.shields.io/badge/AstrBot-Plugin-ff69b4?style=for-the-badge)](https://github.com/AstrBotDevs/AstrBot) [![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](LICENSE) [![](https://img.shields.io/badge/五彩斑斓的Bug群-Bug反馈群&水群-white?style=for-the-badge&color=76bad9&logo=qq&logoColor=76bad9)](https://qm.qq.com/q/oTzIrdDBIc) -_✨ 一个基于AstrBot的智能群聊分析插件，能够生成精美的群聊日常分析报告。[灵感来源](https://github.com/LSTM-Kirigaya/openmcp-tutorial/tree/main/qq-group-summary)。 ✨_ +_✨ 一个基于 AstrBot 的智能群聊分析插件，支持 **QQ (OneBot)**、**Discord**，未来支持更多平台。 ✨_ count
+ ## 功能特色 ### 🎯 智能分析 @@ -28,12 +28,20 @@ _✨ 一个基于AstrBot的智能群聊分析插件，能够生成精美的群 - **PDF报告**: 生成专业的PDF格式分析报告（需配置） - **详细数据**: 包含消息统计、时间分布、关键词、金句等 +> [!warning] +> **实验性开发中**： +> - 多平台支持功能尚在开发中，当前仅支持QQ OneBot, Discord。 +> - 旧版本稳定版在[QQ 分支](https://github.com/SXP-Simon/astrbot_plugin_qq_group_daily_analysis/tree/QQ)，仅 QQ 平台支持 + + ### 🛠️ 灵活配置 -- **群组管理**: 支持指定特定群组启用功能 +- **多平台支持**: 自动识别并适配 OneBot, Discord, Telegram 等平台 +- **群组管理**: 支持指定特定群组启用功能（支持跨平台黑白名单） - **参数调节**: 可自定义分析天数、消息数量等参数 - **定时任务**: 支持设置每日自动分析时间 - **自定义LLM服务** ：支持自定义指定的LLM服务 + ## 配置选项 > [!NOTE] @@ -41,20 +49,22 @@ _✨ 一个基于AstrBot的智能群聊分析插件，能够生成精美的群 | 配置项 | 说明 | 备注 | |--------|------|--------| -| 启用自动分析 | 启用定时触发自动分析功能需要按照插件配置里面的说明填写相关的需要的字段；简略说明：打开自动分析功能，在群聊列表中添加群号或者使用 `/分析设置 enable` 启用当前群聊 | 默认关闭，需要填写机器人QQ号 | -| PDF格式的报告 | 初次使用需要使用 `/安装PDF` 命令安装依赖，首次使用命令安装，最后出现提示告诉你需要重启生效，是对的，需要重启 astrbot，而不是热重载插件。 | 输出格式需要设置为 PDF | -| 自定义LLM服务 | 插件配置中允许用户自行选取个人提供的 Astrbot 服务商列表中的大语言模型服务商 | 留空则回退到用户 Astrbot 现有服务商中第一个可用服务商 | +| 启用自动分析 | 启用定时触发自动分析功能。需要在群聊列表中添加群号或者使用 `/分析设置 enable` 启用。 | 默认关闭，建议开启 | +| PDF格式的报告 | 初次使用需要使用 `/安装PDF` 命令安装依赖。需重启 AstrBot 生效。 | 输出格式需设为 PDF | +| 自定义LLM服务 | 用户可自行选取个人提供的服务商。 | 留空则回退到默认服务商 | > [!IMPORTANT] -> **PDF 功能配置**：使用 `/安装PDF` 命令后，需要完全重启 AstrBot 才能生效，热重载插件无效！ +> **多平台配置注意**： +> - **自动发现**: 插件会自动发现已登录的 Bot 实例。 > [!TIP] -> **自定义 LLM 服务**：新版本弃用此前硬编码的 provider 提供方式，采用更符合 Astrbot 生态的更用户友好的配置方式，根据配置键选取 Provider，支持多级回退： -> 1. 尝试从配置获取指定的 provider_id（如 topic_provider_id） -> 2. 回退到主 LLM provider_id（llm_provider_id） -> 3. 回退到当前会话的 Provider（通过 umo） +> **自定义 LLM 服务回退机制**：性能优先，策略如下： +> 1. 尝试从配置获取指定的 provider_id +> 2. 回退到主 LLM provider_id +> 3. 回退到当前会话的 Provider (UMO) > 4. 回退到第一个可用的 Provider + ## 效果 ![默认模板效果图](./assets/scrapbook-demo.jpg) @@ -103,13 +113,20 @@ retro_futurism 模板效果图 - `/设置模板 [序号]`: 切换到指定序号的模板 - 例如：`/设置模板 1` 或 `/设置模板 scrapbook` -## 安装要求 +## 平台支持与要求 + +| 平台 | 适配器类型 | 特殊要求/说明 | +|------|-----------|--------------| +| **QQ** | OneBot v11 | 建议使用 NapCat/Lagrange。需注意消息分页拉取限制。 | +| **Discord** | Discord | **必须** 拥有 `Read Message History` (查看消息历史记录) 权限。 | + > [!CAUTION] -> **必需条件**： -> - 已配置 LLM 提供商（用于智能分析） -> - 平台适配器（OneBot, Discord, Telegram 等） -> - **Discord 平台特别说明**：机器人需要在频道中拥有 **“读取消息历史记录” (Read Message History)** 权限，否则分析将失败。 +> **Discord 用户重点注意**： +> 如果机器人无法获取群列表或分析报 `403 Forbidden`，请检查 Discord 开发者面板中： +> 1. **Privileged Gateway Intents**: 开启 `Message Content Intent`。 +> 2. **频道权限**: 确保机器人所在的频道，对应的角色拥有 **“查看消息历史记录”** 权限。 + ## 注意事项