Notify Me Mod

NotifyMe

NotifyMe — это лёгкий серверный мод для Fabric на Minecraft 1.21.1, который следит за обычными серверными событиями и отправляет уведомления за пределами игры. Он создан для владельцев серверов, которые хотят знать, когда происходят важные вещи, не держа клиент Minecraft открытым. NotifyMe может оповещать операторов прямо в игре, отправлять письма через Postfix/sendmail, публиковать сообщения через Telegram-бота, вызывать обычный JSON-вебхук или публиковать в топик ntfy.

Возможности

• Уведомления о запуске и остановке сервера
• Уведомления о входе и выходе игроков
• Уведомления о смерти игроков с сообщением о смерти, измерением, позицией, здоровьем и метаданными урона
• Необязательные уведомления о чате, трансляции команд и игровых сообщениях
• Внутриигровые уведомления для операторов или указанных получателей
• Доставка почты через совместимый с Postfix бинарник sendmail
• Доставка через Telegram-бота
• Доставка через обычный вебхук с необязательным секретным заголовком
• Доставка в топик ntfy с необязательным bearer-токеном, приоритетом и тегами
• Фильтры игроков для отслеживаемых и игнорируемых игроков
• Фильтры по префиксу сообщений для чувствительного содержимого чата или команд
• Админ-команды во время работы для перезагрузки, тестовых уведомлений и проверки статуса

Требования

• Minecraft 1.21.1
• Fabric Loader 0.18.4 или новее
• Fabric API
• Java 21 или новее NotifyMe работает на стороне сервера. Игрокам не нужно устанавливать его на клиенты.

Установка

1. Установите Fabric Loader и Fabric API на ваш сервер Minecraft 1.21.1.
2. Поместите jar-файл NotifyMe в папку 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, добавьте его в нужный чат и настройте токен бота и id чата. Пример:

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

Для тем форума или веток супергрупп задайте messageThreadId.

Вебхук

Бэкенд вебхука отправляет JSON-полезную нагрузку с именем события, заголовком, сообщением, компактным сообщением, именем игрока, временной меткой и метаданными. Пример:

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

ntfy

NotifyMe может публиковать напрямую в URL топика ntfy. Пример:

"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 или id часового пояса Java, например Europe/Berlin или America/New_York.
• subjectPrefix добавляется к заголовкам уведомлений.

Команды

Команды NotifyMe требуют уровень разрешений 2.

/notifyme reload
/notifyme test
/notifyme status

• /notifyme reload перезагружает config/notifymemod.json.
• /notifyme test ставит в очередь тестовое уведомление через включённые каналы.
• /notifyme status показывает путь к конфигурации, включённые типы событий и готовность бэкендов.

Примечания о приватности

Внешние сервисы уведомлений могут получать имена игроков, содержимое чата (если включено), сообщения о смерти, координаты, метаданные сервера и временные метки. Проверьте свою конфигурацию перед включением доставки через чат, сообщения команд, игровые сообщения, вебхук, Telegram, ntfy или почту на публичных серверах.

Совместимость

NotifyMe использует хуки событий Fabric API и не требует миксинов. Он должен быть совместим с большинством серверных модов для Fabric, если другой мод не изменяет те же события необычным образом.

Лицензия

NotifyMe распространяется под лицензией CC0-1.0.