koishi-plugin-user-blacklist
v1.0.0
Published
一个用于管理QQ机器人黑名单的Koishi插件
Downloads
11
Maintainers
Readme
koishi-plugin-user-blacklist
一个用于管理QQ机器人黑名单的Koishi插件,可以阻止特定用户使用机器人的任何功能,并可配置回复内容。
功能特点
- 通过user_openid管理黑名单用户
- 阻止黑名单用户使用机器人的所有功能
- 可配置回复黑名单用户的文本内容
- 可配置回复黑名单用户的图片(通过URL)
- 可选择同时发送文本和图片,或仅发送其中之一
安装方法
使用 Koishi 插件市场安装(推荐)
在Koishi插件市场中搜索"user-blacklist",点击安装即可。
使用 npm 安装
npm install koishi-plugin-user-blacklist配置说明
插件提供以下配置项:
| 配置项 | 类型 | 默认值 | 说明 | |-------|------|-------|------| | enabled | 布尔值 | true | 是否启用黑名单功能 | | blacklistedUsers | 字符串数组 | [] | 黑名单用户列表(每行一个user_openid) | | replyText | 字符串 | "您已被加入黑名单,无法使用机器人功能。" | 回复黑名单用户的文本内容(留空则不发送文本) | | replyImageUrl | 字符串 | "" | 回复黑名单用户的图片URL(留空则不发送图片) | | sendBoth | 布尔值 | true | 当同时配置了文本和图片时,是否两者都发送 |
使用示例
- 安装并启用插件
- 在插件配置中添加黑名单用户的openid(每行一个)
- 配置回复内容(文本和/或图片URL)
- 保存配置
当黑名单中的用户尝试使用机器人功能时,机器人将回复配置的内容,并阻止该用户使用任何功能。
获取用户openid
在QQ平台中,用户的openid通常是用户的QQ号。在大多数情况下,您可以直接使用QQ号作为blacklistedUsers列表中的条目。
注意事项
- 图片URL必须是直接可访问的图片链接,建议使用https链接
- 黑名单功能会优先于其他所有功能执行,确保黑名单用户无法使用任何机器人功能
- 如果您不希望回复黑名单用户,可以将replyText和replyImageUrl都留空
许可证
MIT
