koishi-plugin-gotify-push
v1.0.2
Published
Koishi Gotify 推送插件,支持多服务器多频道,群聊/私聊消息推送到 Gotify
Maintainers
Readme
@anyul/koishi-plugin-gotify-push
Koishi Gotify 推送插件 — 将群聊/私聊消息实时推送到 Gotify 服务器。
功能特点
- 多服务器多频道:支持配置多个 Gotify 服务器,每个服务器可配置多个应用/频道
- 群聊/私聊推送:支持将群聊和私聊消息推送到指定的 Gotify 应用
- 指令控制:通过聊天指令开启/关闭推送,无需修改插件配置
- 权限管控:所有指令需要管理员权限(authority ≥ 2),删除操作需要主人权限(authority ≥ 3)
- 自定义格式:支持自定义推送标题和内容的格式模板
- 消息过滤:自动过滤机器人自身的消息,避免循环推送
配置
服务器配置
在插件设置中添加 Gotify 服务器:
| 字段 | 说明 | 示例 |
|------|------|------|
| 名称 | 唯一标识(用于命令引用) | my-gotify |
| 地址 | Gotify 服务器 URL | https://gotify.example.com |
| 默认优先级 | 消息优先级 (0-10) | 5 |
应用配置
为每个 Gotify 应用/频道添加配置:
| 字段 | 说明 | 示例 |
|------|------|------|
| 名称 | 应用名称(用于命令引用) | qq-group |
| 所属服务器 | 对应服务器列表中的名称 | my-gotify |
| 应用 Token | Gotify 管理面板中创建应用时获取 | Axxxxxxxxxxxx |
| 优先级 | 消息优先级,0 则使用服务器默认 | 0 |
消息格式
可用的格式变量:
| 变量 | 说明 |
|------|------|
| {scope} | 消息范围(群聊/私聊) |
| {channelName} | 频道名称 |
| {username} | 发送者名称 |
| {content} | 消息内容 |
| {timestamp} | 时间戳 |
| {serverName} | Gotify 服务器名 |
| {appName} | Gotify 应用名 |
命令
| 命令 | 说明 | 权限 |
|------|------|------|
| gotify开启推送 <服务器名> <应用名> | 开启当前频道推送 | 2 |
| gotify关闭推送 | 关闭当前频道推送 | 2 |
| gotify删除推送 | 删除当前频道推送配置 | 3 |
| gotify推送状态 | 查看当前频道推送状态 | 2 |
| gotify推送测试 [消息] | 测试推送功能 | 2 |
| gotify推送列表 | 查看所有推送订阅 | 3 |
| gotify服务器列表 | 查看已配置的服务器 | 2 |
使用流程
- 在插件设置中配置 Gotify 服务器和应用
- 在目标群聊中发送
gotify服务器列表查看可用配置 - 发送
gotify开启推送 my-gotify qq-group开启推送 - 发送
gotify推送测试验证推送是否正常 - 发送
gotify推送状态查看当前状态
安装
npm install @anyul/koishi-plugin-gotify-push在 Koishi 控制台中启用插件并配置服务器信息。
许可证
MIT
