264 lines
5.6 KiB
Markdown
264 lines
5.6 KiB
Markdown
# A-BOT 智能助手
|
||
|
||
A-BOT是一个功能丰富的微信机器人助手，集成了多种实用功能，包括AI聊天、群智闯关、积分系统、新闻推送等。
|
||
|
||
## 📋 功能清单
|
||
|
||
### 1. 群智闯关
|
||
- 答题游戏系统
|
||
- 积分排行榜
|
||
- 任务管理
|
||
- 实时答题反馈
|
||
|
||
### 2. 积分交易系统
|
||
- 积分转账
|
||
- 积分查询
|
||
- 积分排行榜
|
||
- 打劫系统
|
||
- 保释功能
|
||
|
||
### 3. 全球快讯
|
||
- 国际政经新闻推送
|
||
- 实时新闻更新
|
||
|
||
### 4. AI聊天
|
||
- 智能对话
|
||
- 多模型支持（支持多种AI模型）
|
||
|
||
### 5. 媒体内容
|
||
- 秀人图片
|
||
- 猛男视频
|
||
- 美腿图片
|
||
- 音乐点播
|
||
- 抖音视频解析
|
||
|
||
### 6. 群管理功能
|
||
- 群自动邀请
|
||
- 插件管理系统
|
||
- 消息智能总结
|
||
|
||
### 7. 其他功能
|
||
- 每日签到系统
|
||
- 系统更新
|
||
- 视频分享
|
||
|
||
## 🚀 安装说明
|
||
|
||
### 环境要求
|
||
- Python 3.8+
|
||
- MySQL 数据库
|
||
- Redis 服务
|
||
- Git（用于系统更新）
|
||
|
||
### 依赖安装
|
||
```bash
|
||
# 克隆项目
|
||
git clone https://github.com/your-username/WeChatRobot.git
|
||
cd WeChatRobot
|
||
|
||
# 创建虚拟环境
|
||
python -m venv .venv
|
||
source .venv/bin/activate # Linux/Mac
|
||
# 或
|
||
.venv\Scripts\activate # Windows
|
||
|
||
# 安装依赖
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
### 主要依赖包
|
||
- lxml~=5.3.0
|
||
- openai>1.0.0
|
||
- pandas~=2.2.3
|
||
- pyyaml~=6.0.2
|
||
- requests~=2.32.3
|
||
- schedule~=1.2.2
|
||
- sparkdesk-api==1.3.0
|
||
- pillow~=11.0.0
|
||
- Flask~=3.1.0
|
||
- fastapi~=0.115.12
|
||
- uvicorn~=0.34.2
|
||
- 更多依赖请查看 requirements.txt
|
||
|
||
## 🔌 插件依赖说明
|
||
|
||
### 核心服务依赖
|
||
- MySQL数据库：用于存储用户数据、积分记录、群组信息等
|
||
- Redis服务：用于缓存和会话管理
|
||
- Dify服务：用于AI聊天功能（[Dify开源地址](https://docs.dify.ai/zh-hans/introduction)）
|
||
|
||
### 外部API依赖
|
||
- 天气API：用于天气查询功能
|
||
- 新闻API：用于全球快讯功能
|
||
- 音乐API：用于音乐点播功能
|
||
- 抖音解析服务：用于视频解析功能
|
||
|
||
### 系统依赖
|
||
- Python 3.8+
|
||
- Git：用于系统更新
|
||
- 文件系统存储空间：用于存储媒体文件
|
||
- 网络代理支持（可选）：用于访问特定服务
|
||
|
||
### 插件特定依赖
|
||
|
||
1. **Dify插件**
|
||
- Dify服务（自部署或云服务）
|
||
- API密钥配置
|
||
- 代理设置（可选）
|
||
|
||
2. **抖音解析插件**
|
||
- 网络请求库
|
||
- 文件系统存储
|
||
- 代理支持（可选）
|
||
|
||
3. **群智闯关插件**
|
||
- MySQL数据库
|
||
- 积分系统集成
|
||
|
||
4. **积分交易插件**
|
||
- MySQL数据库
|
||
- 用户系统集成
|
||
|
||
5. **全球快讯插件**
|
||
- 新闻API服务
|
||
- 网络请求库
|
||
|
||
6. **音乐插件**
|
||
- 音乐API服务
|
||
- 音频处理库
|
||
|
||
7. **视频插件**
|
||
- 视频处理库
|
||
- 存储系统
|
||
|
||
8. **群管理插件**
|
||
- 数据库支持
|
||
- 群管理API
|
||
|
||
## 📖 使用说明
|
||
|
||
### 基础命令
|
||
1. 群智闯关
|
||
- `/s` - 加入答题游戏
|
||
- `/t` - 获取新问题
|
||
- `/a 任务ID 答案` - 回答问题
|
||
- `/r` - 查看排行榜
|
||
- `/l` - 查看活跃问题
|
||
- `/h` - 查看未解决问题
|
||
|
||
2. 积分系统
|
||
- `积分转账 积分数 @用户` - 转账积分
|
||
- `我的积分` - 查询积分
|
||
- `积分排行` - 查看排行榜
|
||
- `打劫 @用户` - 打劫积分
|
||
- `保释 @用户` - 保释用户
|
||
|
||
3. 新闻功能
|
||
- `全球新闻` - 获取国际新闻
|
||
- 支持：`国际新闻`、`环球新闻`、`政经新闻`
|
||
|
||
4. AI聊天
|
||
- `聊天 问题` - 与AI对话
|
||
- 支持：`ai`、`dify`、`AI` 开头
|
||
|
||
5. 插件管理
|
||
- `插件 列表` - 查看插件
|
||
- `插件 启用 [插件名]` - 启用插件
|
||
- `插件 禁用 [插件名]` - 禁用插件
|
||
- `插件 信息 [插件名]` - 查看插件信息
|
||
|
||
### 媒体功能
|
||
- `图来`/`秀人` - 获取图片
|
||
- `猛男` - 获取视频
|
||
- `美腿`/`腿来` - 获取美腿图片
|
||
- `点歌 歌曲名` - 点播音乐
|
||
- 直接发送抖音链接可自动解析
|
||
|
||
### 系统功能
|
||
- `签到` - 每日签到
|
||
- `更新系统` - 系统更新（管理员）
|
||
- `#总结` - 消息总结
|
||
|
||
## ⚙️ 配置说明
|
||
|
||
1. 配置文件位于 `config.yaml`
|
||
- 数据库配置
|
||
- API密钥配置
|
||
- 插件开关设置
|
||
- 代理设置
|
||
|
||
2. 数据库配置在 `configuration.py`
|
||
- MySQL连接信息
|
||
- Redis连接信息
|
||
- 其他数据库设置
|
||
|
||
3. 日志文件：
|
||
- wx_debug.log：调试日志
|
||
- wx_info.log：信息日志
|
||
- wx_error.log：错误日志
|
||
|
||
## 🔧 开发说明
|
||
|
||
项目结构：
|
||
```
|
||
├── admin/ # 管理后台
|
||
├── base/ # 基础功能
|
||
├── event_system/ # 事件系统
|
||
├── plugins/ # 插件目录
|
||
├── utils/ # 工具函数
|
||
├── wechat_ipad/ # 微信接口
|
||
├── main.py # 主程序
|
||
└── robot.py # 机器人核心
|
||
```
|
||
|
||
### 插件开发
|
||
1. 在 `plugins` 目录下创建新的插件目录
|
||
2. 实现 `MessagePluginInterface` 接口
|
||
3. 在 `config.yaml` 中添加插件配置
|
||
4. 在插件管理器中注册插件
|
||
|
||
## 📝 注意事项
|
||
|
||
1. 首次使用需要配置相关API密钥
|
||
2. 部分功能需要管理员权限
|
||
3. 建议定期备份数据库
|
||
4. 请遵守相关法律法规使用
|
||
5. 注意API调用频率限制
|
||
6. 定期检查日志文件
|
||
7. 保持系统更新
|
||
|
||
## 🔄 更新日志
|
||
|
||
### v1.0.0
|
||
- 初始版本发布
|
||
- 基础功能实现
|
||
- 插件系统支持
|
||
|
||
## 🤝 贡献指南
|
||
|
||
1. Fork 项目
|
||
2. 创建特性分支
|
||
3. 提交更改
|
||
4. 推送到分支
|
||
5. 创建 Pull Request
|
||
|
||
### 开发规范
|
||
- 遵循PEP 8编码规范
|
||
- 添加适当的注释
|
||
- 编写单元测试
|
||
- 更新文档
|
||
|
||
## 📄 许可证
|
||
|
||
本项目采用 MIT 许可证，详见 LICENSE 文件。
|
||
|
||
## 📞 联系方式
|
||
|
||
- 项目维护者：[维护者名称]
|
||
- 邮箱：[邮箱地址]
|
||
- 项目地址：[GitHub地址]
|
||
|
||
## 🙏 致谢
|
||
|
||
感谢所有为本项目做出贡献的开发者。
|