Metadata-Version: 2.4
Name: nonebot-plugin-capoo
Version: 1.0.0
Summary: 一个发送 capoo 表情包的插件
License: MIT
License-File: LICENSE
Author: HuParry
Author-email: huparry@outlook.com
Requires-Python: >=3.8
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
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: asyncio (>=3.4.3)
Requires-Dist: httpx (>=0.20.0,<1.0.0)
Requires-Dist: nonebot-adapter-onebot (>=2.1.5)
Requires-Dist: nonebot-plugin-localstore (>=0.7.2)
Requires-Dist: nonebot2 (>=2.0.0)
Project-URL: Homepage, https://github.com/HuParry/nonebot-plugin-capoo
Project-URL: Repository, https://github.com/HuParry/nonebot-plugin-capoo
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-capoo

_✨ 一个发送指令就能让你的 bot 发出可爱的 capoo 的图片的插件 ✨_


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

</div>

## 📖 介绍

capoo 实在是太可爱了，所以我收集了几百张 capoo 的表情包。这个插件用于让 bot 发送 capoo 的表情包。

该插件只能简单地从我的图源里发送表情包。如果想要更实用的插件可以移步 [nonebot-plugin-randpic
](https://github.com/HuParry/nonebot-plugin-randpic) 插件。

默认由 [nonebot-plugin-localstore](https://github.com/nonebot/plugin-localstore) 来指定图片存储路径，你也可以通过 capoo_path 参数来自定义存储路径。

插件会在设定好的路径下创建 `capoo/picture` 文件夹，之后会从图源拷贝所有图片资源到该文件夹下。

随机发送图片是用的random库。

如果你有更多可爱的、并且我未存储的，很欢迎你通过邮箱: [hu_parry@qq.com](mailto:hu_parry@qq.com) 私信我，我将很感谢你的扩充。

## 💿 安装

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

    nb plugin install nonebot-plugin-capoo

</details>

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

<details>
<summary>pip</summary>

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

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

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

    conda install nonebot-plugin-capoo
</details>

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

    plugins = ["nonebot_plugin_capoo"]

</details>

## ⚙️ 配置

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

| 配置项 | 必填 | 默认值 |                说明                 |
|:-----:|:----:|:----:|:---------------------------------:|
| capoo_path:| 否 | get_data_dir("nonebot_plugin_capoo") | 设置图片存储路径，例如我的是`data/plugin_capoo` |

图源在阿里云OSS上，是国内源，因此不需要代理就能下载。

## 🎉 使用
### 指令表
|    指令     | 权限 | 需要@ | 范围 |          说明           |
|:---------:|:--:|:---:|:--:|:---------------------:|
|  `capoo`  | 群员 |  否  | 群聊 | 随机发送一张已保存的 capoo 的表情包 |

### 效果图
#### `capoo` 指令
<img src="./docs/preview.jpg" width="375" />

## TODO
- [x] 指令触发 bot 发送图片

本插件力求精简，更复杂的功能可移步 [nonebot-plugin-randpic
](https://github.com/HuParry/nonebot-plugin-randpic) 插件。
