nonebot-plugin-osubot 7.2.4

OSUbot in NoneBot2

nonebot-plugin-osubot

✨ NoneBot osubot ✨

📖 介绍

本项目修改自osuv2，适配了nonebot2，并且在此之上修改了命令的响应逻辑并修改了一些bug使之更易于使用

变速功能依赖ffmpeg，需要自行安装ffmpeg才能正常使用

💿 安装

使用 nb-cli 安装（推荐）

在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot-plugin-osubot

使用包管理器安装

在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

pip

pip install nonebot-plugin-osubot

pdm

pdm add nonebot-plugin-osubot

poetry

poetry add nonebot-plugin-osubot

打开 nonebot2 项目的 bot.py 文件, 在其中写入

nonebot.load_plugin('nonebot_plugin_osubot')

⚙️ 配置

你需要至OSU个人设置申请新的OAuth应用，然后将得到的客户端ID与客户端密钥填入nonebot2 项目的.env文件中

配置说明

配置项	必填	默认值	说明
OSU_CLIENT	是	无	客户端ID
OSU_KEY	是	无	客户端密钥
SQLALCHEMY_DATABASE_URL	否	sqlite+aiosqlite:///db.sqlite3	数据库地址，详见 NoneBot 数据库配置
INFO_BG	否	['https://example.com']	随机背景api地址，需要打开网页后随机获得一张图片

⚠️ 从 v6 升级到 v7

v7 将底层 ORM 从 tortoise-orm 迁移至 nonebot-plugin-orm，数据库表名和结构发生了变化，升级前需手动执行迁移脚本，否则数据将丢失。

升级步骤：

1. 停止 bot
2. 在 bot 根目录下运行迁移脚本：

# 默认 SQLite（自动从 .env 读取数据库地址）
python migrate.py

# 或手动指定数据库地址
python migrate.py sqlite:///db.sqlite3
python migrate.py postgresql://user:pass@localhost/dbname
python migrate.py mysql+pymysql://user:pass@localhost/dbname

3. 标记迁移版本：

nb orm stamp 68a04ea31d05

4. 升级插件后重启 bot

🎉 使用

指令

AI 自然语言调用（可选）

如果同一个 NoneBot 项目中安装并加载了 nonebot-plugin-ai-groupmate，本插件会自动向 ai-groupmate 注册 osu 查询工具。用户可以通过自然语言让 AI 调用 osubot 的查询能力，而不是直接输入固定命令。

没有安装或没有加载 nonebot-plugin-ai-groupmate 时，本功能会自动跳过，不影响 osubot 原有指令使用。

示例：

@bot 查我的 bp1
@bot 查我的 info
@bot 查 peppy 的 bp1
@bot 查 WhiteCat 的 bp 1-20
@bot 查 @群友 的 bp1
@bot 查我在 3783810 这张图上的成绩
@bot 查我的 pp 历史
@bot 分析我的 bp 构成
@bot 给我推荐谱面
@bot 发一下我的 osu 主页
@bot 查 match 123456789
@bot 查 match 123456789 的 rating
@bot 预览谱面 3783810
@bot 提取谱面 3783810 的背景
@bot 查成就 Non-stop Dancer

账号与模式规则：

• 用户说“我/我的/自己”或未指定玩家时，使用当前发言用户通过 /bind 绑定的 osu 账号。
• 消息里 @群友 时，优先使用被 @ 群友绑定的 osu 账号。
• 查询绑定用户时会使用绑定记录中的默认模式与 lazer/stable 设置。
• 明确指定 osu 用户名时会查询该 osu 用户名；如果需要非 std 模式，请在自然语言里说明 taiko、ctb 或 mania。

如果用户只是要求查询，AI 会调用工具发出图片后结束；如果用户同时要求评价，例如：

@bot 查我的 bp1，我打得怎么样
@bot 分析一下 @群友 的 bp1
@bot 看看我 recent 发挥如何

工具会把生成的图片回传给支持多模态的主模型，AI 可以基于图片内容给出简短评价。该分析能力依赖 ai-groupmate 当前配置的主聊天模型支持多模态输入。

💡 贡献

如果遇到任何问题，欢迎提各种issue来反馈bug 你也可以加群(228986744)来进行反馈！