Metadata-Version: 2.1
Name: nonebot-plugin-batitle
Version: 0.2.1
Summary: BlueArchive Title Generator
Author-Email: MerCuJerry <mercujerry@gmail.com>
License: MIT License
         
         Copyright (c) 2023 MerCuJerry
         
         Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project-URL: homepage, https://github.com/MerCuJerry/nonebot-plugin-batitle
Requires-Python: <4.0,>=3.10
Requires-Dist: nonebot2>=2.5.0
Requires-Dist: nonebot_plugin_alconna>=0.54.1
Requires-Dist: pillow>=11.0.0
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-batitle

_✨ NoneBot 插件 碧蓝档案式标题生成器✨_


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

</div>

## 📖 介绍

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

## 💿 安装

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

    nb plugin install nonebot-plugin-batitle

</details>

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

<details>
<summary>pip</summary>

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

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

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

    conda install nonebot-plugin-batitle
</details>

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

    plugins = ["nonebot_plugin_batitle"]

</details>

## 配置项

> 以下配置项可在 `.env.*` 文件中设置，具体参考 [NoneBot 配置方式](https://nonebot.dev/docs/appendices/config)
### `batitle_generator_separator`
 - 类型：`str`
 - 默认：`|`
 - 说明：插件使用的分隔符

## 🎉 使用
### 指令表
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|:-----:|:----:|:----:|:----:|:----:|
| batitle (前){batitle_generator_separator}(后)| 群员 | 否 | 所有 | 使用时去掉括号 |
| ba标题 (前){batitle_generator_separator}(后) | 群员 | 否 | 所有 | 同上 |