Уведомления о событиях Hytale Плагин

А. Плагин сервера Hytale, который отправляет уведомления в реальном времени внешним службам, когда происходят события на сервере. Получите уведомление через ntfy (телефон, рабочий стол или веб), Discord, Slack или пользовательские веб-хуки, когда игроки присоединяются, сервер запускается / останавливается и многое другое.

Поддерживаемые службы уведомлений

• ntfy - Бесплатные push-уведомления с открытым исходным кодом (рекомендуется)
• раздор Уведомления Webhook с богатыми вставками
• Слак Уведомления Webhook с вложениями
• Вебхуки Общие веб-хуки HTTP для пользовательских интеграций

установка

1. Скачать последнюю Уведомления о событии. банку из выпусков
2. Поместите JAR в сервер Hytale мод папка
3. Запустите сервер один раз, чтобы создать конфигурацию по умолчанию
4. Редактировать config.json Чтобы настроить ваши цели уведомлений
5. Перезагрузить сервер

Быстрый старт (ntfy)

Самый быстрый способ получения уведомлений:

1. Давай! ntfy: установить мобильное приложение, настольное приложение или использовать веб-приложение
2. В приложении подпишитесь на тему (например, мой-хиталь-сервер)
3. в config.jsonустановленный «Включено»: истинно на высшем уровне
4. Установите мишень ntfy «Включено»: истинно Обновление URL для https://ntfy.sh/my-hytale-server
5. Перезагрузите сервер - теперь вы будете получать уведомления!

конфигурация

Конфигурационный файл находится в mods/Valhal_EventУведомления/config.json.

Важно: Высший уровень "включено" должны быть установлены истинный плагин для отправки любых уведомлений. По умолчанию это ложный.

Для полного примера со всеми вариантами см. example-config.json.

Основная структура

{
"Включено": правда,
"цели": {
"ntfy": {...},
"раздор": {...},
"слабый": {...},
"вебхук": {...}
?
? 

Настройка ntfy

ntfy Это бесплатный сервис push-уведомлений. Вы можете использовать публичный сервер или самохостинг.

"НТФИ": {
"тип": "ntfy",
"Включено": правда,
"урл":"rel="noopener nofollow" target="_blank">https://ntfy.sh/your-topicname",
"События": {
Сервер Старт: {
"Включено": правда,
"титул": "{сервер} - Онлайн",
"Послание": "Сервер теперь онлайн!",
"приоритет": "высокий",
"tags": "green_circle"
?
?
? 

Настройка диссонанса

1. Создайте веб-хук в своем канале Discord (Настройки каналов > Интеграции > Веб-хуки)
2. Скопировать webhook URL

"раздор": {
"тип": "разлад",
"Включено": правда,
"урл":"rel="noopener nofollow" target="_blank">https://discord.com/api/webhooks/YOUR_ID/YOUR_TOKEN",
"discordUsername": "Hytale Server",
"discordUseEmbeds": правда,
"События": {
"Игрок присоединяется": {
"Включено": правда,
Оригинальное название: Player Joined
"сообщение": "**{player}** присоединился к серверу",
"цвет": "#5865F2"
?
?
? 

Настройка Slack

1. Создайте приложение Slack в api.slack.com/apps
2. Включите «Входящие веб-хуки» и создайте веб-хук для своего канала
3. Скопировать webhook URL

"Слак": {
"тип": "слабый",
"Включено": правда,
"урл":"rel="noopener nofollow" target="_blank">https://hooks.slack.com/services/YOUR/WEBHOOK/URL",
"slackUseAttachments": правда,
"События": {
"Игрок присоединяется": {
"Включено": правда,
Оригинальное название: Player Joined
"сообщение": "*{player}* присоединился к серверу",
"цвет": "#5865F2"
?
?
? 

Настройка Webhook

Для пользовательской интеграции с любой конечной точкой HTTP:

"вебхук": {
"тип": "вебхук",
"Включено": правда,
"урл":"rel="noopener nofollow" target="_blank">https://your-server.com/webhook",
"contentType": "application/json",
"События": {
Сервер Старт: {
"Включено": правда,
«Заголовок»: «Сервер Онлайн»,
«Сообщение»: «Сервер запущен»
?
?
? 

аутентификация

Все цели поддерживают дополнительную аутентификацию. Добавьте эти поля в любую целевую конфигурацию.

Токен-носитель

Для сервисов, использующих токены на основе auth (например, ntfy с токенами доступа (опционально)):

"bearerToken": "tk_your_token_here" 

Это посылает Разрешение: Bearer tk_your_token_here Заголовок с каждым запросом.

Основной аут

Для служб, использующих аутентификацию имени пользователя / пароля:

"имя пользователя": "ваш_имя пользователя",
«пароль»: «your_password» 

Это посылает Разрешение: Базовый <base64> Заголовок с каждым запросом.

Пользовательские заголовки

Для веб-хуков, которым нужны пользовательские заголовки аутентификации:

"заголовки": {
"X-API-Key": "your-api-key",
"X-Custom-Header": "ценность"
? 

Поддерживаемые события

Примечание: Уведомления в чате по умолчанию отключены, чтобы избежать спама на загруженных серверах. допускать игрок Чат Если вы хотите получать сообщения в чате.

Варианты конфигурации событий

Каждое мероприятие поддерживает эти варианты:

Опции целевой конфигурации

ntfy варианты

Диссонные варианты

Опции Slack

Варианты Webhook

Обычный шаблон тела

Использовать телосложение для отправки пользовательской полезной нагрузки JSON вместо формата по умолчанию:

"вебхук": {
"тип": "вебхук",
"Включено": правда,
"урл":"rel="noopener nofollow" target="_blank">https://your-server.com/webhook",
"bodyTemplate": "{\"event\": \"{eventType}\", \"text\": \"{message:json}\"},
"События": {...}
? 

Доступные шаблонные заполнители: {Тип события}, {титул}, {сообщение}, Приоритет, {теги}, а также все конкретные места проведения мероприятия. Использовать Джейсон суффикс для значений, избегающих JSON (например, {сообщение:json}).

Несколько целей

Вы можете использовать несколько целей одновременно. Каждая цель имеет независимые настройки событий, поэтому вы можете отправлять различные события в разные службы:

{
"цели": {
"ntfy": {
"Включено": правда,
"События": {
"ServerStart": { "включено": истинно},
"playerChat": {"enabled": false }
?
?
"раздор": {
"Включено": правда,
"События": {
"ServerStart": { "включено": истинно},
"playerChat": {"enabled": true }
?
?
?
? 

устранение неполадок

Уведомления не отправляются?

• Убедитесь, что цель Разрешено: истинно
• Проверьте, является ли событие Разрешено: истинно в пределах этой цели
• Убедитесь, что URL правильный и доступен с вашего сервера.
• Проверьте журналы сервера на наличие сообщений об ошибках

Разногласия не показываются?

• Убедись. раздор Использование Embeds это истинный
• Убедитесь, что URL веб-хука является полным и действительным.

Признания

Этот проект был построен с использованием Проект Hytale-Example как шаблон.

Заметки

Примечание: Этот плагин не связан с ntfy. рубить

Лицензия

МТИ Лицензия