| Name | nonebot-plugin-osubot JSON |
| Version |
6.17.0
JSON |
| download |
| home_page | None |
| Summary | OSUbot in NoneBot2 |
| upload_time | 2025-01-08 09:57:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9.8 |
| license | AGPL-3.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
<br>
<p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
</div>
<div align="center">
# nonebot-plugin-osubot
_✨ NoneBot osubot ✨_
<a href="./License">
<img src="https://img.shields.io/github/license/yaowan233/nonebot-plugin-osubot.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-osubot">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-osubot.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">
</div>
## 📖 介绍
本项目修改自[osuv2](https://github.com/Yuri-YuzuChaN/osuv2)，适配了nonebot2，并且在此之上修改了命令的响应逻辑并修改了一些bug使之更易于使用
变速功能依赖ffmpeg，需要[自行安装ffmpeg](https://docs.go-cqhttp.org/guide/quick_start.html#%E5%AE%89%E8%A3%85-ffmpeg)才能正常使用
## 💿 安装
<details>
<summary>使用 nb-cli 安装（推荐）</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-osubot
</details>
<details>
<summary>使用包管理器安装（推荐）</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
<details>
<summary>pip</summary>
pip install nonebot-plugin-osubot
</details>
<details>
<summary>pdm</summary>
pdm add nonebot-plugin-osubot
</details>
<details>
<summary>poetry</summary>
poetry add nonebot-plugin-osubot
</details>
打开 nonebot2 项目的 `bot.py` 文件, 在其中写入
nonebot.load_plugin('nonebot_plugin_osubot')
</details>
<details>
<summary>从 github 安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 输入以下命令克隆此储存库
git clone https://github.com/yaowan233/nonebot-plugin-osubot.git
修改[nonebot_plugin_osubot的__init__.py](https://github.com/yaowan233/nonebot-plugin-osubot/blob/a7c7098f39d92b8fe74dfe85c262397b81db721c/nonebot_plugin_osubot/__init__.py#L37)为
add_model('src.plugins.database.models')
打开 nonebot2 项目的 `bot.py` 文件, 在其中写入
nonebot.load_plugin('src.plugins.nonebot_plugin_osubot')
</details>
## ⚙️ 配置
你需要至[OSU个人设置](https://osu.ppy.sh/home/account/edit)申请新的OAuth应用，然后将得到的客户端ID与客户端密钥填入nonebot2 项目的`.env`文件中
配置说明
| 配置项 | 必填 | 默认值 | 说明 |
|:-----:|:----:|:----:|:----:|
| OSU_CLIENT | 是 | 无 | 客户端ID |
| OSU_KEY | 是 | 无 | 客户端密钥 |
| tortoise_orm_db_url | 否 | sqlite://db.sqlite3 | 数据库地址 |
| INFO_BG | 否 | ['https://example.com'] | 随机背景api地址，需要打开网页后随机获得一张图片 |
## 🎉 使用
### 指令
## 💡 贡献
如果遇到任何问题，欢迎提各种issue来反馈bug
你也可以加群(228986744)来进行反馈！
Raw data
{
"_id": null,
"home_page": null,
"name": "nonebot-plugin-osubot",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "yaowan233 <572473053@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/e6/61285184eebfeb2ead00e6163d3c7f3617d450b407b456a89006517d4418/nonebot-plugin-osubot-6.17.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"https://v2.nonebot.dev/store\"><img src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png\" width=\"180\" height=\"180\" alt=\"NoneBotPluginLogo\"></a>\n <br>\n <p><img src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg\" width=\"240\" alt=\"NoneBotPluginText\"></p>\n</div>\n\n<div align=\"center\">\n\n# nonebot-plugin-osubot\n\n_\u2728 NoneBot osubot \u2728_\n\n\n<a href=\"./License\">\n <img src=\"https://img.shields.io/github/license/yaowan233/nonebot-plugin-osubot.svg\" alt=\"license\">\n</a>\n<a href=\"https://pypi.python.org/pypi/nonebot-plugin-osubot\">\n <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-osubot.svg\" alt=\"pypi\">\n</a>\n<img src=\"https://img.shields.io/badge/python-3.9+-blue.svg\" alt=\"python\">\n\n</div>\n\n\n## \ud83d\udcd6 \u4ecb\u7ecd\n\n\u672c\u9879\u76ee\u4fee\u6539\u81ea[osuv2](https://github.com/Yuri-YuzuChaN/osuv2)\uff0c\u9002\u914d\u4e86nonebot2\uff0c\u5e76\u4e14\u5728\u6b64\u4e4b\u4e0a\u4fee\u6539\u4e86\u547d\u4ee4\u7684\u54cd\u5e94\u903b\u8f91\u5e76\u4fee\u6539\u4e86\u4e00\u4e9bbug\u4f7f\u4e4b\u66f4\u6613\u4e8e\u4f7f\u7528\n\n\u53d8\u901f\u529f\u80fd\u4f9d\u8d56ffmpeg\uff0c\u9700\u8981[\u81ea\u884c\u5b89\u88c5ffmpeg](https://docs.go-cqhttp.org/guide/quick_start.html#%E5%AE%89%E8%A3%85-ffmpeg)\u624d\u80fd\u6b63\u5e38\u4f7f\u7528\n\n## \ud83d\udcbf \u5b89\u88c5\n\n<details>\n<summary>\u4f7f\u7528 nb-cli \u5b89\u88c5\uff08\u63a8\u8350\uff09</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u6839\u76ee\u5f55\u4e0b\u6253\u5f00\u547d\u4ee4\u884c, \u8f93\u5165\u4ee5\u4e0b\u6307\u4ee4\u5373\u53ef\u5b89\u88c5\n\n nb plugin install nonebot-plugin-osubot\n\n</details>\n\n<details>\n<summary>\u4f7f\u7528\u5305\u7ba1\u7406\u5668\u5b89\u88c5\uff08\u63a8\u8350\uff09</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u63d2\u4ef6\u76ee\u5f55\u4e0b, \u6253\u5f00\u547d\u4ee4\u884c, \u6839\u636e\u4f60\u4f7f\u7528\u7684\u5305\u7ba1\u7406\u5668, \u8f93\u5165\u76f8\u5e94\u7684\u5b89\u88c5\u547d\u4ee4\n\n<details>\n<summary>pip</summary>\n\n pip install nonebot-plugin-osubot\n</details>\n<details>\n<summary>pdm</summary>\n\n pdm add nonebot-plugin-osubot\n</details>\n<details>\n<summary>poetry</summary>\n\n poetry add nonebot-plugin-osubot\n</details>\n\n\n\u6253\u5f00 nonebot2 \u9879\u76ee\u7684 `bot.py` \u6587\u4ef6, \u5728\u5176\u4e2d\u5199\u5165\n\n nonebot.load_plugin('nonebot_plugin_osubot')\n\n</details>\n\n<details>\n<summary>\u4ece github \u5b89\u88c5</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u63d2\u4ef6\u76ee\u5f55\u4e0b, \u6253\u5f00\u547d\u4ee4\u884c, \u8f93\u5165\u4ee5\u4e0b\u547d\u4ee4\u514b\u9686\u6b64\u50a8\u5b58\u5e93\n\n git clone https://github.com/yaowan233/nonebot-plugin-osubot.git\n\n\u4fee\u6539[nonebot_plugin_osubot\u7684__init__.py](https://github.com/yaowan233/nonebot-plugin-osubot/blob/a7c7098f39d92b8fe74dfe85c262397b81db721c/nonebot_plugin_osubot/__init__.py#L37)\u4e3a\n \n add_model('src.plugins.database.models')\n \n\u6253\u5f00 nonebot2 \u9879\u76ee\u7684 `bot.py` \u6587\u4ef6, \u5728\u5176\u4e2d\u5199\u5165\n\n nonebot.load_plugin('src.plugins.nonebot_plugin_osubot')\n\n</details>\n\n## \u2699\ufe0f \u914d\u7f6e\n\u4f60\u9700\u8981\u81f3[OSU\u4e2a\u4eba\u8bbe\u7f6e](https://osu.ppy.sh/home/account/edit)\u7533\u8bf7\u65b0\u7684OAuth\u5e94\u7528\uff0c\u7136\u540e\u5c06\u5f97\u5230\u7684\u5ba2\u6237\u7aefID\u4e0e\u5ba2\u6237\u7aef\u5bc6\u94a5\u586b\u5165nonebot2 \u9879\u76ee\u7684`.env`\u6587\u4ef6\u4e2d\n\n\u914d\u7f6e\u8bf4\u660e\n| \u914d\u7f6e\u9879 | \u5fc5\u586b | \u9ed8\u8ba4\u503c | \u8bf4\u660e |\n|:-----:|:----:|:----:|:----:|\n| OSU_CLIENT | \u662f | \u65e0 | \u5ba2\u6237\u7aefID |\n| OSU_KEY | \u662f | \u65e0 | \u5ba2\u6237\u7aef\u5bc6\u94a5 |\n| tortoise_orm_db_url | \u5426 | sqlite://db.sqlite3 | \u6570\u636e\u5e93\u5730\u5740 |\n| INFO_BG | \u5426 | ['https://example.com'] | \u968f\u673a\u80cc\u666fapi\u5730\u5740\uff0c\u9700\u8981\u6253\u5f00\u7f51\u9875\u540e\u968f\u673a\u83b7\u5f97\u4e00\u5f20\u56fe\u7247 |\n\n## \ud83c\udf89 \u4f7f\u7528\n### \u6307\u4ee4\n\n\n\n\n## \ud83d\udca1 \u8d21\u732e\n\n\u5982\u679c\u9047\u5230\u4efb\u4f55\u95ee\u9898\uff0c\u6b22\u8fce\u63d0\u5404\u79cdissue\u6765\u53cd\u9988bug\n\u4f60\u4e5f\u53ef\u4ee5\u52a0\u7fa4(228986744)\u6765\u8fdb\u884c\u53cd\u9988\uff01\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "OSUbot in NoneBot2",
"version": "6.17.0",
"project_urls": {
"Homepage": "https://github.com/yaowan233/nonebot-plugin-osubot",
"Repository": "https://github.com/yaowan233/nonebot-plugin-osubot"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ff557e3f4d7d3b17c453b36553a5924dcca92635b0d5b02e52c407673fe099a",
"md5": "32ec7ba326ba8b42926cc28bb66dd33a",
"sha256": "4df38830e578821fca9350ddb9df742a5958e04e22fff2280aad30f83c025430"
},
"downloads": -1,
"filename": "nonebot_plugin_osubot-6.17.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "32ec7ba326ba8b42926cc28bb66dd33a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9.8",
"size": 30015044,
"upload_time": "2025-01-08T09:57:46",
"upload_time_iso_8601": "2025-01-08T09:57:46.874488Z",
"url": "https://files.pythonhosted.org/packages/6f/f5/57e3f4d7d3b17c453b36553a5924dcca92635b0d5b02e52c407673fe099a/nonebot_plugin_osubot-6.17.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2be661285184eebfeb2ead00e6163d3c7f3617d450b407b456a89006517d4418",
"md5": "909a2981ee363ccab71225ee8e82dc01",
"sha256": "627223e5d69429e52c961f74ff729f88ab7dcfd83b20dd89c8fa72a7e8f6f1fa"
},
"downloads": -1,
"filename": "nonebot-plugin-osubot-6.17.0.tar.gz",
"has_sig": false,
"md5_digest": "909a2981ee363ccab71225ee8e82dc01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9.8",
"size": 29899016,
"upload_time": "2025-01-08T09:57:54",
"upload_time_iso_8601": "2025-01-08T09:57:54.853048Z",
"url": "https://files.pythonhosted.org/packages/2b/e6/61285184eebfeb2ead00e6163d3c7f3617d450b407b456a89006517d4418/nonebot-plugin-osubot-6.17.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-08 09:57:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yaowan233",
"github_project": "nonebot-plugin-osubot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nonebot-plugin-osubot"
}
