An open API service indexing awesome lists of open source software.

https://github.com/SZ2528/nonebot-plugin-osu

玩osu玩的
https://github.com/SZ2528/nonebot-plugin-osu

Last synced: 4 months ago
JSON representation

玩osu玩的

Awesome Lists containing this project

README

        


NoneBotPluginLogo


NoneBotPluginText


# nonebot-plugin-osu

_✨ 玩osu!玩的 ✨_


license


pypi

python

## 📖 介绍

这里是插件的详细介绍部分

~~下次一定~~

## 💿 安装

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

nb plugin install nonebot-plugin-osu

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

pip

pip install nonebot-plugin-osu

pdm

pdm add nonebot-plugin-osu

poetry

poetry add nonebot-plugin-osu

conda

conda install nonebot-plugin-osu

打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入

plugins = ["nonebot_plugin_osu"]

## ⚙️ 配置

在 nonebot2 项目的`.env`文件中添加下表中的必填配置

| 配置项 | 必填 | 默认值 | 说明 |
|:-----:|:----:|:----:|:----:|
| `osu_api_client_id` | 是 | 无 | 在帐户设置页面上注册 OAuth 应用程序 |
| `osu_api_client_secret` | 是 | 无 | 在帐户设置页面上注册 OAuth 应用程序 |

## 🎉 使用
### 指令表
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|:-----:|:----:|:----:|:----:|:----:|
| 指令1 | 主人 | 否 | 私聊 | 指令说明 |
| 指令2 | 群员 | 是 | 群聊 | 指令说明 |
### 效果图
如果有效果图的话