3.9 KiB
3.9 KiB
DotaBot 项目文档
项目概述
DotaBot 是一个 Discord 机器人,用于跟踪 Dota 2 玩家的比赛数据并在 Discord 频道中分享这些信息。它可以监控指定玩家的最近比赛,生成比赛报告图片,并通知连胜/连败等特殊事件。
项目架构
核心组件
- Discord Bot: 基于 py-cord 库实现的 Discord 机器人
- Dota 2 API 集成: 使用 OpenDota API 获取比赛数据
- 数据库: 使用 Peewee ORM 管理本地数据
- 图片生成: 使用 Playwright 和 Jinja2 生成比赛报告图片
- 图片存储: 使用 Cloudflare R2 存储生成的图片
文件结构
├── discord_bot.py # Discord 机器人主程序
├── dota.py # Dota 2 数据处理和模型定义
├── image_generator.py # 图片生成模块
├── utils.py # 工具函数
├── matches.py # 比赛数据处理
├── heroes.json # 英雄数据
├── templates/ # HTML 模板目录
│ ├── match_report.html # 比赛报告模板
│ └── recent_matches.html # 最近比赛模板
├── env.ini # 配置文件
└── dotabot.log # 日志文件
依赖关系
project-info.md
discord_bot.py
├── dota.py
│ ├── utils.py
│ └── image_generator.py
└── utils.py
image_generator.py
├── utils.py
├── templates/match_report.html
└── templates/recent_matches.html
dota.py
├── utils.py
└── image_generator.py
功能模块
1. Discord Bot (discord_bot.py)
Discord 机器人的主程序,负责与 Discord 交互,包括:
- 定时任务获取最新比赛数据
- 处理用户命令
- 发送比赛报告和通知
主要命令:
/recent_matches [name] [match_count]: 获取指定玩家的最近比赛/list_friends: 列出所有已添加的好友/add_friend [steam_id] [name]: 添加新好友/mod_friend [steam_id] [name]: 修改好友信息/activate_friend [steam_id]: 启用好友/deactivate_friend [steam_id]: 禁用好友
2. Dota 数据处理 (dota.py)
处理 Dota 2 比赛数据,定义数据模型,包括:
Match: 比赛数据模型Friend: 好友数据模型- 比赛数据序列化
- 连胜/连败检测
主要功能:
get_friends_recent_matches(): 获取所有好友的最近比赛serialize_match_for_discord(): 将比赛数据格式化为 Discord 消息check_streaks(): 检查连胜/连败情况
3. 图片生成 (image_generator.py)
使用 Playwright 和 Jinja2 生成比赛报告图片,包括:
ImageGenerator类:负责生成比赛报告和最近比赛图片- 使用 HTML 模板渲染比赛数据
- 使用 Playwright 将 HTML 转换为图片
- 上传图片到 Cloudflare R2 存储
主要方法:
generate_match_report(): 生成单场比赛报告图片generate_recent_matches_image(): 生成最近比赛汇总图片
4. 工具函数 (utils.py)
提供各种辅助功能,包括:
- 时间格式转换
- 英雄名称中英文转换
- 数字格式化
- 图片上传到 Cloudflare R2
- 日志记录
主要函数:
convert_seconds_to_hms(): 将秒数转换为时分秒get_hero_chinese_name(): 获取英雄的中文名称upload_image(): 上传图片到 Cloudflare R2get_ranking(): 获取天梯段位名称
数据流
-
定时任务流程:
- Discord Bot 定时调用
get_friends_recent_matches() - 获取所有活跃好友的最新比赛
- 对于新比赛,调用
serialize_match_for_discord()格式化数据 - 调用
ImageGenerator.generate_match_report()生成比赛报告图片 - 发送格式化的比赛数据和图片到 Discord 频道
- Discord Bot 定时调用
-
用户命令流程:
- 用户发送命令 (如
/recent_matches) - Discord Bot 处理命令并调用相应函数
- 对于
/recent_matches,调用Friend.serialize_recent_matches_for_discord() - 调用
ImageGenerator.generate_recent_matches_image()生成图片 - 发送结果到 Discord
- 用户发送命令 (如