koishi-plugin-image-packer
v1.0.0
Published
一个可以打包图片并转换成 PDF 的 koishi 插件。
Maintainers
Readme
koishi-plugin-image-packer
可以将聊天中的多张图片打包成一个单一的 PDF 文件的 koishi 插件。支持私聊模式下发送 PDF 到指定群组。 *本插件仅在 Onebot 下做过测试。
✨ 功能
- 打包当前消息或所引用消息中的所有图片。
- 支持为生成的 PDF 文件设置密码。
- 支持在私聊中指定目标群聊进行发送。
- 可通过白名单限制插件在特定群聊中使用。
💿 安装
- 前往 Koishi 插件市场搜索
image-packer并安装。 - 本插件依赖
koishi-plugin-puppeteer,请确保已在你的 koishi 中正确安装并启用该插件。
📖 使用
指令列表
图片打包 [目标群聊]- 直接使用时(目标群聊参数为空时),打包当前消息中的图片,并发送到当前会话。
- 支持引用图片消息,消息中如果有其他文字会自动忽略,只打包图片。
- 在私聊中使用时,可以通过可选参数
[目标群聊]将生成的 PDF 发送到指定的、已在白名单中的群聊。目标群聊可以是群号,也可以是配置中支持的群聊序号或群名。
支持群组- 查看当前机器人被允许发送文件的群聊列表。
选项
-s, --password <密码>- 在使用
图片打包指令时附加此选项,可以为本次生成的 PDF 文件设置一个临时密码。 - 示例:
图片打包 -s 123456
- 在使用
⚙️ 配置
插件提供以下配置项:
| 配置项 | 类型 | 描述 |
| --- | --- | --- |
| supportedGroups | string[] | 机器人被允许发送文件的群组白名单。只有在此列表中的群聊,才能使用此插件的功能。 |
| defaultPassword | string | (可选)为所有生成的 PDF 文件设置一个默认密码。如果在使用指令时通过 -s 选项设置了临时密码,则临时密码会覆盖此默认密码。 |
| tempDir | string | 用于存放打包过程中产生的临时文件的目录。默认为 ./data/temp/image-packer。 |
| debug | boolean | 是否在控制台输出详细的调试日志。排查问题时建议开启。默认为 false。 |
📝 免责声明
- 本插件按“原样”提供,不提供任何形式的明示或暗示的保证。
- 使用者在使用本插件时,应自行承担所有风险。对于因使用(或无法使用)本插件而导致的任何直接或间接的数据丢失、财产损失或其他形式的损失,作者概不负责。
- 请确保您打包和传输的内容符合相关法律法规以及您所在平台的规定。对于用户使用本插件生成的任何内容,作者不承担任何责任。
📄 许可证
Released under the MIT License.
© 2025 WhiteBr1ck
