Skip to main content

OSUbot in NoneBot2

Project description

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-osubot

✨ NoneBot osubot ✨

license pypi python

📖 介绍

本项目修改自osuv2,适配了nonebot2,并且在此之上修改了命令的响应逻辑并修改了一些bug使之更易于使用,可能与其他使用了tortoise-orm的插件会相冲突如harukabot

💿 安装

使用 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
conda
conda install nonebot-plugin-osubot

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

nonebot.load_plugin('nonebot_plugin_osubot')
从 github 安装 在 nonebot2 项目的插件目录下, 打开命令行, 输入以下命令克隆此储存库
git clone https://github.com/yaowan233/nonebot-plugin-osubot.git

修改nonebot_plugin_osubot的__init__.py

add_model('src.plugins.database.models')

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

nonebot.load_plugin('src.plugins.nonebot_plugin_osubot')

⚙️ 配置

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

配置说明

配置项 必填 默认值 说明
OSU_CLIENT 客户端ID
OSU_KEY 客户端密钥
DB_URL sqlite://db.sqlite3 数据库地址

🎉 使用

指令表

指令 功能 可选参数 说明
osuhelp 查看指令大全
info 查询信息 查询自己
[user] 查询TA人
:[mode] 查询自己其它模式,:为触发词
[user] :[mode] 查询TA人其它模式
bind 绑定 [user] 绑定用户名
unbind 解绑
update 更改或更新 mode [mode] 更改模式
recent(pr) 查询最近(不)包含死亡的游玩记录 查询自己最近(不)包含死亡的游玩记录
[user] 查询TA人最近(不)包含死亡的游玩记录
:[mode] 查询自己最近游玩其它模式(不)包含死亡记录
[user] :[mode] 查询TA人最近游玩其它模式(不)包含死亡记录
score 查询成绩 [mapid] 查询该地图成绩
[mapid] +[mods] 查询该地图附加mods成绩
[mapid] :[mode] 查询该地图其它模式成绩
[mapid] :[mode] +[mods] 查询该地图其它模式加mods的成绩
[user] [mapid] 查询TA人该地图成绩
[user] [mapid] :[mode] 查询TA人该地图其它模式成绩
[user] [mapid] +[mods] 查询TA人该地图加mods的成绩
[user] [mapid] :[mode] +[mods] 查询TA人该地图其它模式加mods的成绩
bp 查询bp榜成绩 [num] 查询bp成绩
[num] +[mods] 查询bp附加mods成绩
[num] :[mode] 查询其他模式的bp成绩
[num] :[mode] +[mods] 查询其他模式加mods的bp成绩
[user] [num] 查询TA人bp成绩
[user] [num] +[mods] 查询TA人bp附加mods成绩
[user] [num] :[mode] 查询TA人其他模式bp成绩
[user] [num] :[mode] +[mods] 查询TA人其他模式加mods的bp成绩
pfm 查询bp榜指定范围成绩 [min]-[max] 查询bp范围内成绩,最多10个
[min]-[max] :[mode] 查询其它模式bp范围内成绩
[min]-[max] +[mods] 查询bp范围内加mods的成绩
[min]-[max] :[mode] +[mods] 查询其它模式bp范围内加mods的成绩
[user] [min]-[max] 查询TA人bp,最多10个
[user] [min]-[max] :[mode] 查询TA人其它模式bp
[user] [min]-[max] +[mods] 查询TA人bp
[user] [min]-[max] :[mode] +[mods] 查询TA人其它模式bp范围内加mods的成绩
tbp 查询当天新增bp成绩 查询自己当天新增bp成绩
[user] 查询TA人当天新增bp成绩
:[mode] 查询自己其它模式当天新增bp成绩
[user] :[mode] 查询TA人其它模式当天新增bp成绩
map 查询地图信息 [mapid] 查询地图信息
[mapid] +[mods] 查询地图加mod的信息,仅计算PP
getbg 提取背景 [mapid] 提取地图背景
bmap 查询图组信息 [setid] 查询图组信息
-b [mapid] 使用地图id查询图组信息
osudl 下载地图上传到群 [setid] 下载地图,setid为图组id,非单图id

*[]内为需要填的参数

*mode:0-3分别为std,taiko,ctb,mania

💡 贡献

由于当前开发缺乏测试,欢迎提各种issue来反馈bug 或者你可以加群(228986744)来直接反馈! 1665504476458_temp_qrcode_share_9993

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot-plugin-osubot-0.9.5.tar.gz (30.0 MB view hashes)

Uploaded Source

Built Distribution

nonebot_plugin_osubot-0.9.5-py3-none-any.whl (30.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page