Metadata-Version: 2.1
Name: axtbot-plugin-feedback
Version: 1.0.0
Summary: 一个统一化的插件报错反馈系统
Author-Email: Shanshui2024 <shanshui@shanshui.site>
Requires-Python: >=3.11
Description-Content-Type: text/markdown

<div align="center">

# axtbot-plugin-feedback

_✨ 一个统一化的插件报错反馈系统 ✨_


<a href="https://pypi.python.org/pypi/axtbot-plugin-feedback">
    <img src="https://img.shields.io/pypi/v/axtbot-plugin-feedback.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.11+-blue.svg" alt="python">

</div>

## 介绍

这是一个让报错规范化输出，并让用户反馈触达开发者的插件！

## 安装方法

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

<details>
<summary>pip</summary>

    pip install axtbot-plugin-feedback
</details>
<details>
<summary>pdm</summary>

    pdm add axtbot-plugin-feedback
</details>
<details>
<summary>poetry</summary>

    poetry add axtbot-plugin-feedback
</details>
</details>

<details>
<summary>使用源码安装</summary>
在项目的插件目录下，打开命令行，输入以下内容
```bash
git clone https://github.com/Shanshui2024/axtbot-plugin-feedback
```

把src中的文件夹拷贝至插件目录下

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

    plugins = ["axtbot_plugin_feedback"]

</details>


## 配置
为使用主动推送功能，请打开机器人在指定群聊的主动消息权限，然后在 `.env` 文件中输入
```bash
FEEDBACK_GROUP_OPENID="你的群OpenID，建议从日志找"
```

## 用法
对于其他想要加入该功能的插件，可以在发送报错的时候同时发送一个键盘，大概如下：
```json
{
    "rows": [
                {
                    "buttons": [
                        {
                            "id": "xxx功能:feedback",
                            "render_data": {
                                "label": "反馈",
                                "visited_label": "已反馈",
                                "style": 3
                            },
                            "action": {
                                "type": 1,
                                "data": message,
                                "click_limit": 1,
                                "permission":{
                                    "type": 0,
                                    "specify_user_ids": [
                                        user_openid
                                    ]
                                }
                            }
                        }
                    ]
                }
            ]
}
```

请确保您的反馈按钮ID格式为 `xxxx:feedback`，传回的 `data` 可以是报错信息

这样 就可以被该插件读取并使用啦~