Metadata-Version: 2.1
Name: nonebot-plugin-bottle
Version: 0.2.0
Summary: Bottle post plugin in Nonebot
Home-page: https://github.com/Todysheep/nonebot_plugin_bottle
Author: Todysheep
Author-email: todysheep@163.com
License: GNU GPLv3
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENCE

# Nonebot 漂流瓶插件
* 安装
    -
    - 使用 `pip install nonebot_plugin_bottle`
    - 使用 `nb plugin install nonebot_plugin_bottle`
* 指令 (前应带指令前缀)
    - 
    - `扔漂流瓶` [文本/图片]
    - `寄漂流瓶` [文本/图片] （同`扔漂流瓶`，防止指令冲突用）
    - `捡漂流瓶` 
    - `评论漂流瓶` [漂流瓶编号] [文本]
    - `举报漂流瓶` [漂流瓶编号]
    - `查看漂流瓶` [漂流瓶编号]
    - SUPERUSER指令：
        - `清空漂流瓶`
        - `删除漂流瓶` [漂流瓶编号]
        - `漂流瓶白名单` [QQ / 群聊] [QQ号 / 群号]
        - `漂流瓶黑名单` [QQ / 群聊] [QQ号 / 群号]
        - `漂流瓶详情` [漂流瓶编号]
* 功能须知
    -
    - `扔漂流瓶`指令无字数限制，如需要可在代码中修改
    - `捡漂流瓶`若捡到的漂流瓶存在回复，则会显示最近三条(默认)，使用`查看漂流瓶`查看所有回复
    - `查看漂流瓶`为保证随机性，无评论时不展示漂流瓶内容，可在代码中修改
    - `评论漂流瓶`若机器人有被回复人好友，会发送被回复通知
    - `举报漂流瓶`五次(默认)后将自动删除，举报成功后会私聊SUPERUSER漂流瓶详情内容
    - `清空漂流瓶`无确认过程，使用需谨慎
    - `漂流瓶详情`将会发送漂流瓶发送者的QQ号和群号，回复人的QQ号
    - `漂流瓶数据库`存放在`data/bottle/data.json`中
    - `权限数据库` 存放在`data/bottle/permissionsList.json`中
* 权限控制
    -
    - 所有非SUPERUSER指令均受到权限控制
    - `冷却功能开关`：插件默认开启，可在`data/bottle/permissionsList.json`中修改`enableCooldown`bool值(True/False)
    - `功能冷却`：插件默认 30 秒冷却，可在`data/bottle/permissionsList.json`中修改`cooldownTime`值  
    - 白名单优先级高于黑名单和冷却名单

* 文字审核API配置（可选）
    - 
    - 在[百度智能云](https://cloud.baidu.com/doc/ANTIPORN/s/dkk6wyt3z)中申请`API_KEY`和`secret_key`
    - 在`config.py`中填入即可
    - 不配置该项则不进行审核操作

* 已知bug
    -
    - 第一次加载该插件时无法正常使用（重启后恢复）

* 更新日志
    - 
    - 0.2.0
        - 停止使用`black_group`
        - 增加使用CD，黑/白名单群组
        - 开始记录回复人QQ号（仅SUPERUSER使用`漂流瓶详情`可见）
    - 0.1.8
        - 增加`request`库要求
        - 丢出漂流瓶后展示漂流瓶编号
    - 0.1.7
        - 新增json项`key`，将不使用`del`删除漂流瓶，而保留原漂流瓶数据便于管理者查看
        - 新增json项`group_name`,`username`，将在API无法获取信息时使用
    - 0.1.6
        - 新增配置项`api_key`,'secret_key'，用于文本审核
        - 新增配置项`black_group`，用于屏蔽特定群聊
* 效果展示
    -
    ![image](https://user-images.githubusercontent.com/97968466/191049794-1b409436-fd70-43d9-8dcb-3575e82fd69b.png)  
    ![image](https://user-images.githubusercontent.com/97968466/191052704-1b5ec89d-7a49-40d6-a5d9-b0a0171c730e.png)  
    ![image](https://user-images.githubusercontent.com/97968466/191049649-2e8d8555-f285-470f-9f7b-f5a0994341ee.png)  
