通知我模组

通知我模组

NotifyMe 是一个轻量级的 Fabric 服务端模组,适用于 Minecraft 1.21.1,用于监视常见的服务器事件并在游戏外发送通知。

社交

NotifyMe

NotifyMe 是一个轻量级的 Fabric 服务端模组,适用于 Minecraft 1.21.1,用于监听常见的服务器事件并在游戏外发送通知。

它面向希望在不保持 Minecraft 客户端开启的情况下了解重要事件的服主。NotifyMe 可以在游戏内向管理员发送提醒、通过 Postfix/sendmail 发送电子邮件、发布 Telegram 机器人消息、调用通用 JSON webhook,或发布到 ntfy 主题。

功能

  • 服务器启动和服务器停止通知
  • 玩家加入和离开通知
  • 玩家死亡通知,包含死亡消息、维度、位置、生命值和伤害元数据
  • 可选的聊天、命令广播和游戏消息通知
  • 面向管理员或指定接收者的游戏内通知
  • 通过兼容 Postfix 的 sendmail 可执行文件发送电子邮件
  • Telegram 机器人投递
  • 带可选密钥请求头的通用 webhook 投递
  • ntfy 主题投递,支持可选的 bearer token、优先级和标签
  • 针对关注玩家和忽略玩家的玩家过滤器
  • 针对敏感聊天或命令内容的消息前缀过滤器
  • 运行时管理命令,用于重载、测试通知和状态检查

要求

  • Minecraft 1.21.1
  • Fabric Loader 0.18.4 或更新版本
  • Fabric API
  • Java 21 或更新版本

NotifyMe 是服务端模组。玩家无需在其客户端上安装。

安装

  1. 在你的 Minecraft 1.21.1 服务器上安装 Fabric Loader 和 Fabric API。
  2. 将 NotifyMe 的 jar 放入服务器的 mods 文件夹。
  3. 启动服务器一次。
  4. 编辑生成的配置文件 config/notifymemod.json。
  5. 运行 /notifyme reload 或重启服务器。
  6. 运行 /notifyme test 以验证你配置的通知渠道。

通知渠道

游戏内

游戏内通知默认启用。默认情况下,NotifyMe 仅向服务器管理员发送消息。

将 inGame.opsOnly 设为 false 可发送给所有在线玩家,或将 inGame.recipients 设为精确玩家名称列表。

Postfix / sendmail

NotifyMe 可以将邮件传递给本地 sendmail 命令,这与 Postfix 配合良好。

启用 postfix.enabled,配置 postfix.from,并向 postfix.to 添加一个或多个地址。

示例:

"postfix": {
  "enabled": true,
  "sendmailPath": "/usr/sbin/sendmail",
  "from": "minecraft@example.com",
  "to": ["admin@example.com"],
  "timeoutSeconds": 10
}

Postfix 必须已在服务器上配置好。NotifyMe 仅将消息交给 sendmail;它不会配置 SMTP、DNS、DKIM、SPF 或中继设置。

Telegram

使用 BotFather 创建一个机器人,将其添加到目标聊天,并配置机器人 token 和聊天 id。

示例:

"telegram": {
  "enabled": true,
  "botToken": "123456:bot-token",
  "chatId": "123456789",
  "messageThreadId": 0,
  "disableNotification": false,
  "timeoutSeconds": 10
}

对于论坛主题或超级群组主题,请设置 messageThreadId。

Webhook

webhook 后端会发送包含事件名称、标题、消息、紧凑消息、玩家名称、时间戳和元数据的 JSON 载荷。

示例:

"webhook": {
  "enabled": true,
  "url": "https://example.com/minecraft-webhook",
  "secretHeaderName": "X-NotifyMe-Secret",
  "secretHeaderValue": "change-me",
  "timeoutSeconds": 10
}

ntfy

NotifyMe 可以直接发布到 ntfy 主题 URL。

示例:

"ntfy": {
  "enabled": true,
  "topicUrl": "https://ntfy.sh/my-minecraft-topic",
  "token": "",
  "priority": "default",
  "tags": ["minecraft"],
  "timeoutSeconds": 10
}

对于受保护的 ntfy 主题,请设置 token。

配置

NotifyMe 在首次运行时创建 config/notifymemod.json。

默认事件设置:

"events": {
  "serverStarted": true,
  "serverStopping": true,
  "playerJoined": true,
  "playerLeft": true,
  "playerDied": true,
  "chatMessage": false,
  "commandMessage": false,
  "gameMessage": false,
  "test": true
}

聊天、命令和游戏消息通知默认禁用,因为它们可能很嘈杂,并且可能包含私密或敏感信息。仅当这符合你的服务器政策时才启用它们。

过滤选项:

"filters": {
  "watchedPlayers": [],
  "ignoredPlayers": [],
  "ignoreMessagesStartingWith": ["/login", "/register"]
}
  • watchedPlayers:如果非空,则仅发送这些玩家的事件。
  • ignoredPlayers:跳过这些玩家的事件。
  • ignoreMessagesStartingWith:跳过具有匹配前缀的聊天或命令消息通知。

通用选项:

"serverName": "Minecraft Server",
"timezone": "system",
"subjectPrefix": "[Minecraft]"
  • serverName 出现在通知正文中。
  • timezone 接受 system 或 Java 时区 id,例如 Europe/Berlin 或 America/New_York。
  • subjectPrefix 会添加到通知标题中。

命令

NotifyMe 命令需要权限等级 2。

/notifyme reload
/notifyme test
/notifyme status
  • /notifyme reload 重载 config/notifymemod.json。
  • /notifyme test 通过已启用的渠道排队发送一条测试通知。
  • /notifyme status 显示配置路径、已启用的事件类型和后端就绪状态。

隐私说明

外部通知服务可能会接收玩家名称、聊天内容(如果启用)、死亡消息、坐标、服务器元数据和时间戳。

在公共服务器上启用聊天、命令消息、游戏消息、webhook、Telegram、ntfy 或电子邮件投递之前,请审查你的配置。

兼容性

NotifyMe 使用 Fabric API 事件钩子,不需要 mixins。它应与大多数服务端 Fabric 模组兼容,除非另一个模组以异常方式更改了相同的事件。

许可证

NotifyMe 采用 CC0-1.0 许可证。