Metadata-Version: 2.1
Name: nonebot-plugin-playercheck
Version: 1.5.1
Summary: 基于 Nonebot2 的群友音游成分查询
Home-page: https://github.com/Ohdmire/nonebot-plugin-playercheck
License: MIT
Author: Ohdmire
Requires-Python: >=3.8,<4
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: nonebot-adapter-onebot (>=2.2.3)
Requires-Dist: nonebot-plugin-htmlrender (>=0.2.1)
Requires-Dist: nonebot2 (>=2.0.0-beta.1)
Project-URL: Repository, https://github.com/Ohdmire/nonebot-plugin-playercheck
Description-Content-Type: text/markdown

<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-playercheck

_✨ NoneBot 一个查询群友音游成分的插件 ✨_


<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/Ohdmire/nonebot-plugin-playercheck.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-playercheck">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-playercheck.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">

</div>

## 📖 介绍

将群友成分储存于json文件，并使用[nonebot-plugin-htmlrender](https://github.com/kexue-z/nonebot-plugin-htmlrender)渲染网页


## 💿 安装

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

    nb plugin install nonebot-plugin-playercheck

</details>

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

<details>
<summary>pip</summary>

    pip install nonebot-plugin-playercheck
</details>
<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-playercheck
</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-playercheck
</details>
<details>
<summary>conda</summary>

    conda install nonebot-plugin-playercheck
</details>

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

    plugins = ["nonebot_plugin_playercheck"]

</details>

## ⚙️ 配置

*(可选)* 可以将本项目中的`assets`文件夹内的`assets.json`拖入你机器人目录的`/data/playercheck`文件夹内这样可以 **获取游戏别名和游戏图片**

## 🎉 使用
### 指令表
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|:-----:|:----:|:----:|:----:|:----:|
| `cf.add` | 群员 | 否 | 群聊 | `cf.add osu,malody` 会替换原来的游戏列表 |
| `cf.del` | 群员 | 否 | 群聊 | 删除用户输入的所有游戏列表 |
| `cf.list` | 群员 | 否 | 群聊 | 渲染图片 |
### 效果图
> 如果没有从群内获取到该玩家的信息，则会返回None

![效果](assets/效果图.PNG)

## TODO
- [ ] 私聊页面中进行操作
- [ ] 按个人查询列表
- [ ] 更好的数据管理方案
- [ ] 资源文件本地化
- [ ] 进一步优化代码

## DONE
- [x] 优化代码结构
