迪拉熊Bot - DXKuma Bot

来自启程区域的白色小熊，面向舞萌DX玩家提供一站式服务

📖 项目简介

迪拉熊Bot是一个基于NoneBot2框架开发的复合型群聊机器人，同时对接QQ官方机器人平台与OneBot V11协议，两端核心功能均可使用，且账号与群组数据可跨平台自动关联互通。

它专为舞萌DX玩家量身定制，提供了B50成绩生成、谱面信息检索、机厅排卡管理以及专属开字母小游戏等丰富的音游辅助功能，同时也具备语音合成、自定义图库、积分与排行榜等实用与娱乐功能，为你提供全面、贴心的服务体验。

📚 官方文档

有关更详细的安装步骤、配置说明、命令列表和高级用法，请参阅迪拉熊Bot的官方文档。

✨ 核心特性

• 🎮 舞萌DX玩家工具
  • B50分数查询与成绩图生成
  • 谱面信息查询、分数列表展示
  • 机厅排卡队列管理与状态监控
  • 舞萌DX版本的开字母小游戏
• 🔗 跨平台账号互通
  • OneBot与QQ官方双端身份自动关联（共睹凭证/验证码绑定二选一）
  • 群组数据跨平台共享，玩法数据不因换端而丢失
• 🛠️ 实用工具
  • 语音合成（TTS）
  • 自定义图片/视频图库，支持点赞与随机推荐
  • 用户星星积分与图库请求量排行榜
  • 群组复读机与其他辅助功能

🛠️ 技术栈

• 核心框架：NoneBot2
• 协议：QQ官方机器人平台、OneBot V11
• 数据库：PostgreSQL（nonebot-plugin-orm）
• 对象存储：S3兼容存储（如MinIO），用于图库图片的公网访问
• 包管理：uv
• 环境要求：Python >= 3.13

📦 快速开始

1. 环境要求

在开始部署之前，请确保您的系统已安装以下组件：

• Python 3.13或更高版本
• PostgreSQL数据库服务
• S3兼容对象存储（如MinIO），用于图库图片的公网访问
• uv包管理器（用于快速管理Python依赖）

2. 获取源码并安装依赖

# 克隆项目仓库
git clone <your-repo-url>/dxkuma-bot.git
cd dxkuma-bot

# 使用uv安装并同步项目依赖
uv sync

3. 配置文件

项目启动前需要进行配置。可以手动将根目录下的example.conf复制为kuma.conf（如果未手动创建，Bot在首次启动时也会自动从模板复制一份）。

cp example.conf kuma.conf

打开kuma.conf，根据实际情况修改您的环境配置。关键配置项包括：

• 数据库连接：functions.database_url（修改为您的PostgreSQL数据库连接地址）
• 对象存储：storage节点下的S3/MinIO连接信息（图库图片依赖公网可访问的URL）
• OneBot设置：nonebot.listen_port以及onebot.token（用于连接Lagrange、go-cqhttp等客户端）
• QQ官方机器人设置：qq.id、qq.token、qq.secret（在QQ开放平台申请机器人应用后获取）
• 查分器Token：prober.diving_fish_token（水鱼查分器）和prober.lxns_token（落雪查分器）
• 语音合成API：在tts节点下配置您使用的TTS服务的base_url、api_key和model

4. 运行项目

一切配置就绪后，使用以下命令启动Bot：

uv run python bot.py

说明：bot.py启动时，会自动将kuma.conf中的相关配置转写为临时.env文件，以供NoneBot框架读取并初始化。

📄 开源协议

本项目基于GNU Affero General Public License v3.0协议开源。详细信息请参阅LICENSE文件。

🐛 问题反馈

如果您遇到任何问题或有建议，请通过以下方式联系我们：

• 📧 迪拉熊开发者交流群
• 🐛 源域Code