Metadata-Version: 2.1
Name: nonebot_plugin_chikari_yinpa
Version: 1.4.0
Summary: A plugin for nonebot 2
Home-page: https://github.com/mrqx0195/nonebot_plugin_chikari_yinpa
Author: mrqx0195
Author-email: 2317249571@qq.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pillow
Requires-Dist: nonebot2 >=2.2.0
Requires-Dist: nonebot-adapter-onebot
Requires-Dist: nonebot-plugin-localstore

<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-chikari-yinpa

_✨ NoneBot 一个普通的银趴插件 ✨_


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

</div>


## 📖 介绍

### 警告：本插件包含NSFW内容！
### 由于学业问题，本项目更新放缓
这是一个基于NoneBot 2的银趴插件

## 💿 安装

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

    nb plugin install nonebot-plugin-chikari-yinpa

</details>

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

<details>
<summary>pip</summary>

    pip install nonebot-plugin-chikari-yinpa
</details>
<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-chikari-yinpa
</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-chikari-yinpa
</details>
<details>
<summary>conda</summary>

    conda install nonebot-plugin-chikari-yinpa
</details>

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

    plugins = ["nonebot_plugin_chikari_yinpa"]

</details>

## ⚙️ 配置

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

| 配置项 | 必填 | 默认值 | 说明 |
|:-----:|:----:|:----:|:----:|
| chikari_yinpa_initial_sex_value | 否 | 50 | 目前无作用 |
| chikari_yinpa_initial_penis_length | 否 | 10 | 初始长度 |
| chikari_yinpa_initial_vagina_depth | 否 | 10 | 初始深度 |
| chikari_yinpa_initial_money | 否 | 100 | 初始金钱 |
| chikari_yinpa_font | 否 | Path(__file__).parent / "resource" / "SourceHanSansSC-VF.ttf" | 绘图所用字体 |

## 🎉 使用
### 指令表
#### help指令中的提示以"/"为指令前缀，可根据实际情况自行修改
#### 部分指令存在别名，可在help指令中查询
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|:-----:|:----:|:----:|:----:|:----:|
| yinpa_control | 主人/群主/管理员 | 否 | 群聊 | 控制本群银趴的开启/关闭 |
| help | 无 | 否 | 私聊/群聊 | 查询Chikari_yinpa的帮助 |
| sign_in | 无 | 否 | 私聊/群聊 | 每日打卡，每天可使用一次，增加长度、深度、金钱 |
| yinpa_join | 无 | 否 | 私聊/群聊 | 加入银趴！ |
| yinpa_leave | 无 | 否 | 私聊/群聊 | 离开银趴！ |
| info | 无 | 否 | 私聊/群聊 | 查询自己或某人的银趴信息 |
| tou | 无 | 否 | 私聊/群聊 | 透某人 |
| zha | 无 | 否 | 私聊/群聊 | 榨某人 |
| chong | 无 | 否 | 私聊/群聊 | 冲一发，能够增加或减少一定长度 |
| kou | 无 | 否 | 私聊/群聊 | 扣一次，能够增加少量深度 |
| shop | 无 | 否 | 私聊/群聊 | 花费金钱购买商品 |
| work | 无 | 否 | 私聊/群聊 | 工作，获得金钱及其他东西 |

## 🔭 TODO

### 如果有什么好的想法，欢迎提交[issue](https://github.com/mrqx0195/nonebot_plugin_chikari_yinpa/issues)或[pr](https://github.com/mrqx0195/nonebot_plugin_chikari_yinpa/pulls)

- [ ] 将经济相关拆分为单独的插件，未来可与其他插件互通

- [ ] 排名功能（群榜，总榜）

- [ ] 誓约系统

- [ ] 成就系统

- [ ] bot随机自主出击

## 🥳 预览图

（可能过时）

![image](image/img_1.png)
