调整98堂发送的内容,先发文本
This commit is contained in:
185
README.MD
185
README.MD
@@ -1,6 +1,6 @@
|
||||
# A-BOT 智能助手
|
||||
|
||||
A-BOT是一个功能丰富的微信机器人助手,集成了多种实用功能,包括AI聊天、群智闯关、积分系统、新闻推送等。
|
||||
A-BOT是一个功能丰富的微信机器人助手,集成了多种实用功能,包括AI聊天、群智闯关、积分系统、新闻推送等。支持多种AI模型集成,提供消息自动回复、群管理等功能。
|
||||
|
||||
## 📋 功能清单
|
||||
|
||||
@@ -23,7 +23,8 @@ A-BOT是一个功能丰富的微信机器人助手,集成了多种实用功能
|
||||
|
||||
### 4. AI聊天
|
||||
- 智能对话
|
||||
- 多模型支持(支持多种AI模型)
|
||||
- 多模型支持(Claude、DeepSeek、豆包等)
|
||||
- 自定义提示词模板
|
||||
|
||||
### 5. 媒体内容
|
||||
- 秀人图片
|
||||
@@ -36,25 +37,29 @@ A-BOT是一个功能丰富的微信机器人助手,集成了多种实用功能
|
||||
- 群自动邀请
|
||||
- 插件管理系统
|
||||
- 消息智能总结
|
||||
- 数据库消息存档
|
||||
|
||||
### 7. 其他功能
|
||||
### 7. 系统功能
|
||||
- 每日签到系统
|
||||
- 系统更新
|
||||
- 视频分享
|
||||
- 邮件通知系统
|
||||
- 系统监控集成
|
||||
|
||||
## 🚀 安装说明
|
||||
|
||||
### 环境要求
|
||||
- Python 3.8+
|
||||
- Python 3.10+
|
||||
- MySQL 数据库
|
||||
- Redis 服务
|
||||
- Git(用于系统更新)
|
||||
- 支持的操作系统:Windows/Linux/MacOS
|
||||
|
||||
### 依赖安装
|
||||
```bash
|
||||
# 克隆项目
|
||||
git clone https://github.com/your-username/WeChatRobot.git
|
||||
cd WeChatRobot
|
||||
git clone https://github.com/your-username/abot.git
|
||||
cd abot
|
||||
|
||||
# 创建虚拟环境
|
||||
python -m venv .venv
|
||||
@@ -94,7 +99,7 @@ pip install -r requirements.txt
|
||||
- 抖音解析服务:用于视频解析功能
|
||||
|
||||
### 系统依赖
|
||||
- Python 3.8+
|
||||
- Python 3.10+
|
||||
- Git:用于系统更新
|
||||
- 文件系统存储空间:用于存储媒体文件
|
||||
- 网络代理支持(可选):用于访问特定服务
|
||||
@@ -181,51 +186,143 @@ pip install -r requirements.txt
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
1. 配置文件位于 `config.yaml`
|
||||
- 数据库配置
|
||||
- API密钥配置
|
||||
- 插件开关设置
|
||||
- 代理设置
|
||||
### 1. 配置文件
|
||||
配置文件位于 `config.yaml`,包含以下主要配置项:
|
||||
|
||||
2. 数据库配置在 `configuration.py`
|
||||
- MySQL连接信息
|
||||
- Redis连接信息
|
||||
- 其他数据库设置
|
||||
#### AI模型配置
|
||||
```yaml
|
||||
claude:
|
||||
key: "your-api-key"
|
||||
api: "http://127.0.0.1:8080/v1/chat/completions"
|
||||
model: "windsurf/gpt4o"
|
||||
prompt: "your-prompt-template"
|
||||
|
||||
3. 日志文件:
|
||||
- wx_debug.log:调试日志
|
||||
- wx_info.log:信息日志
|
||||
- wx_error.log:错误日志
|
||||
deepseek:
|
||||
key: "your-api-key"
|
||||
api: "https://api.deepseek.com/chat/completions"
|
||||
model: "deepseek-chat"
|
||||
prompt: "your-prompt-template"
|
||||
|
||||
doubao:
|
||||
key: "your-api-key"
|
||||
api: "https://ark.cn-beijing.volces.com/api/v3/chat/completions"
|
||||
model: "doubao-1-5-lite-32k-250115"
|
||||
prompt: "your-prompt-template"
|
||||
```
|
||||
|
||||
#### 数据库配置
|
||||
```yaml
|
||||
db_config:
|
||||
pool_name: "wechat_boot_pool"
|
||||
pool_size: 10
|
||||
host: "your-db-host"
|
||||
user: "your-db-user"
|
||||
password: "your-db-password"
|
||||
database: "message_archive"
|
||||
charset: "utf8mb4"
|
||||
```
|
||||
|
||||
#### Redis配置
|
||||
```yaml
|
||||
redis_config:
|
||||
host: "your-redis-host"
|
||||
port: 6379
|
||||
db: 0
|
||||
decode_responses: true
|
||||
```
|
||||
|
||||
### 2. 插件配置
|
||||
|
||||
#### AI聊天插件 (dify)
|
||||
```yaml
|
||||
Dify:
|
||||
enable: true
|
||||
commands: ["ai", "dify", "聊天", "AI"]
|
||||
command-tip: "聊天 请求内容"
|
||||
api-key: "your-dify-api-key"
|
||||
base-url: "your-dify-base-url"
|
||||
```
|
||||
|
||||
#### 音乐插件 (music)
|
||||
```yaml
|
||||
Music:
|
||||
enable: true
|
||||
command: ["点歌", "音乐"]
|
||||
command-format: "点歌 歌曲名"
|
||||
```
|
||||
|
||||
#### 群智闯关插件 (game_task)
|
||||
```yaml
|
||||
GameTask:
|
||||
enable: true
|
||||
command: ["/s", "/t", "/a", "/r", "/l", "/h"]
|
||||
command-format: "游戏命令格式说明"
|
||||
```
|
||||
|
||||
## 📁 项目结构
|
||||
```
|
||||
abot/
|
||||
├── admin/ # 管理后台相关代码
|
||||
├── base/ # 基础功能模块
|
||||
├── db/ # 数据库相关代码
|
||||
├── plugins/ # 插件目录
|
||||
├── resource/ # 资源文件
|
||||
├── static/ # 静态文件
|
||||
├── utils/ # 工具函数
|
||||
├── wechat_ipad/ # 微信相关核心代码
|
||||
├── config.yaml # 配置文件
|
||||
├── main.py # 主程序入口
|
||||
├── requirements.txt # 依赖列表
|
||||
└── restart.sh # 重启脚本
|
||||
```
|
||||
|
||||
## 🔧 开发说明
|
||||
|
||||
项目结构:
|
||||
```
|
||||
├── admin/ # 管理后台
|
||||
├── base/ # 基础功能
|
||||
├── event_system/ # 事件系统
|
||||
├── plugins/ # 插件目录
|
||||
├── utils/ # 工具函数
|
||||
├── wechat_ipad/ # 微信接口
|
||||
├── main.py # 主程序
|
||||
└── robot.py # 机器人核心
|
||||
```
|
||||
|
||||
### 插件开发
|
||||
1. 在 `plugins` 目录下创建新的插件目录
|
||||
2. 实现 `MessagePluginInterface` 接口
|
||||
3. 在 `config.toml` 中添加插件配置
|
||||
4. 在插件管理器中注册插件 -启动时自动注册
|
||||
4. 在插件管理器中注册插件
|
||||
|
||||
## 📝 注意事项
|
||||
### 开发规范
|
||||
- 遵循PEP 8编码规范
|
||||
- 添加适当的注释
|
||||
- 编写单元测试
|
||||
- 更新文档
|
||||
|
||||
1. 首次使用需要配置相关API密钥
|
||||
2. 部分功能需要管理员权限
|
||||
3. 建议定期备份数据库
|
||||
4. 请遵守相关法律法规使用
|
||||
5. 注意API调用频率限制
|
||||
6. 定期检查日志文件
|
||||
7. 保持系统更新
|
||||
## ⚠️ 注意事项
|
||||
|
||||
1. 确保所有API密钥配置正确
|
||||
2. 数据库和Redis服务必须正常运行
|
||||
3. 建议使用虚拟环境运行项目
|
||||
4. 定期检查日志文件(wx_debug.log, wx_info.log, wx_error.log)
|
||||
5. 部分功能需要消耗积分
|
||||
6. 部分功能需要管理员权限
|
||||
7. 建议定期备份数据库
|
||||
8. 请遵守相关法律法规使用
|
||||
9. 注意API调用频率限制
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
1. 依赖安装问题
|
||||
```bash
|
||||
python -m pip install --upgrade pip
|
||||
```
|
||||
|
||||
2. 数据库连接问题
|
||||
- 检查数据库服务是否运行
|
||||
- 验证配置信息是否正确
|
||||
- 确认数据库用户权限是否足够
|
||||
|
||||
3. Redis连接问题
|
||||
- 检查Redis服务是否运行
|
||||
- 验证配置信息是否正确
|
||||
- 检查Redis服务器防火墙设置
|
||||
|
||||
4. API调用问题
|
||||
- 确认API密钥是否正确
|
||||
- 检查API服务是否可用
|
||||
- 验证网络连接是否正常
|
||||
|
||||
## 🔄 更新日志
|
||||
|
||||
@@ -242,12 +339,6 @@ pip install -r requirements.txt
|
||||
4. 推送到分支
|
||||
5. 创建 Pull Request
|
||||
|
||||
### 开发规范
|
||||
- 遵循PEP 8编码规范
|
||||
- 添加适当的注释
|
||||
- 编写单元测试
|
||||
- 更新文档
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本项目采用 MIT 许可证,详见 LICENSE 文件。
|
||||
|
||||
Reference in New Issue
Block a user