HytaleサーバーのWebhookと通知を設定する方法

HytaleCharts は、接続する複数の統合オプションを提供します。 Discord、ゲームサーバー、および外部ツールにリストするHytaleサーバー。 プレーヤーがサーバーに投票すると、Discord通知を受信し、Votifierを介してゲーム内報酬をトリガーし、独自のバックエンドにカスタムWebhookを発射し、サーバーの状態をハートビートプラグインで最新の状態に保つことができます。 このガイドでは、各インテグレーションをスクラッチからセットアップする方法について説明します。 これらのすべての機能は、サーバーの所有者またはチームメンバーとしてログインした後、HytaleChartsのサーバーの編集ページからアクセス可能です。 Discord Vote Webhooks Discord webhooks は、誰かが投票するたびに Discord チャネルで通知を受け取るようにします。, お気に入り, またはサーバーのリストでレビューを残します. Discord Webhooks の設定 Discordサーバーでwebhookを作成します。 サーバ設定、インテグレーション、Webhooks に移動します。 "New Webhook" をクリックすると、名前 (例: "HytaleCharts Votes") が、チャンネルを選択し、webhook URL をコピーします。 hytaleCharts に webhook URL を追加します。 サーバーの編集ページに移動し、Discord Webhook セクションを見つけて URL を貼り付けます。 設定を保存します。 ヒタル チャートは、投票、お気に入り、またはレビューイベントが発生したときに、Discordチャンネルに埋め込まれたフォーマットを送信します。 Sent を取得するもの Webhook通知は、以下を含むDiscordとして送信されます。 イベントの種類(投票、お気に入り、レビュー) アクションを実行したプレーヤーのユーザー名 タイムスタンプ サーバー名とリンクを HytaleCharts リストに返す Webhook デリバリーは 3 つの試みと 5 秒のバックオフのリトリート システムを使用します。 すべての試みが失敗すると、失敗が記録され、HytaleChartsはサーバーごとに連続した失敗を追跡します。 webhook URL が一貫して失敗した場合(HTTP エラーやタイムアウトを返す)、最終的にはフラグが付けられ、更新や修正ができます。 Votifier: In-Game 投票報酬 Votifier は、投票通知をゲームサーバーに直接送信するプロトコルで、HytaleCharts に投票したときにプレイヤーにゲーム内で報酬を与えることができます。 ヒタル チャートは3つのVotifier variantをサポートしています。 Votifier v1(RSA暗号化) オリジナルのVotifierプロトコルはRSA暗号化を使用します。 投票が行われると、HytaleCharts は、サーバーのパブリックキーで投票メッセージを暗号化し、TCP. 経由で送信します。 Votifier v1: を設定する Votifier互換プラグインをインストールします。 Hytale サーバー RSAキーペアを生成します(プラグインは通常最初の実行時に自動的に行います) publicキーをコピー プラグインの設定から ヒタル チャート、サーバーの編集ページに移動し、Votifierタイプを "v1" に設定します。 サーバのhost(IPアドレスまたはドメイン)、port(Votifierのリスニングポート、ゲームポートではなく)を入力し、publicキーを貼り付けます。 「テスト接続」ボタンを保存して、それを動作確認 投票メッセージは、標準のVotifier形式に従います。VOTE\nHytaleCharts\n{username}\n{ip_address}\n{timestamp}\n、PKCS#1 v1.5パディングで暗号化されます。 Votifier v2 (HMAC-SHA256) Votifier v2 は、よりモダンなプロトコルです。 RSA暗号化の代わりに、共有トークンでHMAC-SHA256署名を使用します。 handhake には、サーバーからチャレンジ文字列が含まれているため、リプレイ攻撃を防ぐことができます。 Votifier v2: の設定 v2 互換をインストール Votifierプラグイン プラグインの設定ファイルで token (共有シークレット) を修正 ヒタル チャート、Votifierタイプを"v2"に設定します。 サーバのhost、port、tokenを入力します。 接続を保存してテスト v2 プロトコルは TCP 経由で接続し、チャレンジトークンでハンドシェイクの挨拶を読んで、HMAC-SHA256 で署名された JSON ペイロードを含むバイナリパケットを送信します。 ペイロードには、サービス名(「HytaleCharts」)、ユーザー名、IPアドレス、ミリ秒単位のタイムスタンプ、チャレンジ文字列が含まれます。 HTTP の Votifier 生 TCP ではなく HTTP を使用した Hytale 固有のプラグインの場合、HytaleCharts は HTTP エンドポイントモードをサポートしています。 これは、プラグイン開発者のために実装する最も簡単なプロトコルです。 HTTP Votifierの設定: 受信用の HTTP エンドポイントを公開するプラグインをインストール ヒタル グラフは、Votifier 型を "HTTP" に設定します。 フルエンドポイント URL (例:https://your-server.com:8080/vote) プラグインがトークンを必要とする場合は、トークンフィールドに入力します。 HytaleCharts は X-Votifier-Signature ヘッダで HMAC-SHA256 署名をリクエストします。 保存とテスト HTTPリクエストは、serviceName、username、address、timestamp で JSON ボディを送信します。 フィールド。 全加圧タイプの重要な注意事項 ユーザー名は 16 文字 に切り捨てられ、Hytale のユーザ名制限にマッチします。 HytaleCharts は、プレイヤーの Hytale のユーザ名を set なら、そうしないと Discord のユーザ名を使用します。 接続タイムアウトは5秒です。 サーバが5秒以内に応答しない場合は、失敗と見なされます。 失敗した試みは、指数関数的なバックオフ(10s、30s、試み間の60s)で最大3回を再試行します。 HytaleCharts の Test Connection ボタンを使用して、実際の投票を必要としずにセットアップを検証できます。 サーバが到達可能であることを確認し、予想されるVotifierハンドシェイクで応答します。 一般的なWebhooks 独自のバックエンドサービス、ボット、またはアプリケーションに投票通知を送信したい場合は、一般的なWebhooksではカスタムURLとペイロードテンプレートを定義できます。 ジェネリックWebhooksの仕組み サーバの編集画面で、webhook 設定セクションに移動 エンドポイントの URL を入力します。 ペイロードテンプレート を受け取りたいデータに を設定 設定を保存 投票イベントが発生した場合、HytaleChartsは、設定されたペイロードでURLにHTTP POSTリクエストを送信します。 システムは、送信時に実際の値と置換されるテンプレート変数(voterのユーザー名、サーバ名、タイムスタンプなど)をサポートしています。 Generic webhooks は、Discord webhooks と同じ再試行ロジックを使用します。3 は、プログレッシブ・バックオフ (10s, その後、レトリー間の 30s) で試みます。 全てのレトリーが失敗した場合は、サーバーに対して障害が追跡され、永続的な障害がダッシュボードにフラグが付けられます。 /> Heartbeat プラグイン: オンラインステータストラッキング HytaleCharts Heartbeat プラグインは、ゲームサーバー上で実行され、定期的なステータスの更新を送信して、リストは常に正確なオンライン/オフライン状態とプレーヤーのカウントを表示します。 仕組み プラグインは、https://hytalecharts.com/api/heartbeat にハートビートを送信 毎回5分(または20秒ごとにプレミアムサーバー)。 各ハートビートには以下が含まれます: サーバーのハートビートシークレット(64文字ヘックストークン) Current player count と max のプレイヤー players array 個々のプレーヤーの詳細(ユーザー名、UUID、世界、ping) サーバ名、MOTD、uptime、、メモリー使用 インストールされたプラグインのリスト および ワールド名 セットアップステップ ハートビートの秘密を生成します。 サーバーの編集ページで、ハートビートのセクションに移動し、「シークレットを生成」をクリックします。 これは、ユニークな64文字トークンを作成します。 プラグインをインストールします。 サーバーの mods/ に HytaleCharts プラグインを配置します。 ディレクトリ。 プラグインの設定。 プラグインの config.json ファイルを編集し、シークレットを設定します。 お問い合わせ "secret": "YOUR_64_CHAR_HEARTBEAT_SECRET", "debug": false お問い合わせ サーバーを再起動します。 プラグインはすぐにハートビートを送信し始めます。 hytaleCharts.で確認する サーバの編集ページを確認してください。最後のハートビートタイムスタンプを表示し、接続がアクティブであることを示します。 マルチサーバ集計 複数のサーバーインスタンス(ロビー、サバイバル、クリエイティブ)を実行すれば、同じハートビートシークレットを共有すれば、HytaleChartsは自動的にそれらを集計します。 IP アドレスとサーバー名で異なるインスタンスを識別し、それぞれから最新のハートビートをとり、UID でプレイヤーをマージしてダブルカウントを回避します。 リストに表示されているプレイヤーの総数と最大プレイヤーは、すべてのインスタンス間でのコンバインド値を反映しています。 オンラインステータス優先 ヒタレ チャートは、サーバーのオンラインステータスを優先システムで決定します。 外部クエリエンドポイント(設定されている場合、NitradoクエリAPI) Heartbeatプラグイン (最後の5分以内にハートビートが受け取った場合、サーバーはオンラインとして表示されます) UDP ping (フォールバックサーバクエリ) ハートビートプラグインが5分以上サイレントになり、外部クエリが設定されていない場合、サーバーはUDP pingステータスに戻ります。 公開サーバーAPIトークン HytaleCharts は、投票者データ、サーバーの統計情報、その他の情報をプログラム的に照会できる公開 API を提供します。 使用するには、APIトークンが必要です。 APIトークンの取得 HytaleCharts でサーバーの編集ページに移動 API セクションに移動 APIトークンを生成する コピーして安全に保管します。 トークンは、パブリックサーバー API エンドポイントのすべてのリクエストを認証します。 API の使用 APIリクエストの Authorization ヘッダにトークンを含める: GET /api/public/servers/{server_id}/voters 認証: Bearer YOUR_API_TOKEN パブリック API では、最近の投票者、サーバー統計、その他のデータを取得して、サーバー上のカスタム統合、リーダーボード、または報酬システムを構築できます。 完全な API ドキュメントとエンドポイントの詳細については、Server API ページ を HytaleCharts で確認します。 Troubleshooting Issue 考えられる原因Solution Discord webhook が送信しないDiscord で webhook を削除して再作成し、HytaleCharts の URL を更新する Votifierテストは「応答なし」FirewallでVotifierポートをブロックするVotifierポート(ゲームポートではない)がファイアウォールで開くことを保証します Votifier のテストは "Invalid V2 handhake"Server は v1 のみサポートしますが、v2 は v1 に Votifier タイプを変更し、トークンの代わりに RSA のパブリックキーを提供します Heartbeat は、 プラグイン configDouble-check では、コンフィグのシークレットが登録されていない。 json は、HytaleCharts で示されているものを正確にマッチさせます Player カウントは 0Plugin のバージョンを 1.5.0Hytale に更新します 個々のプレイヤーデータを送信する最新バージョンにプラグインをチャート Webhook は、failing100+ 連続障害 エンドポイント URL を固定し、テストします。 渡された配達は失敗のカウンターをリセットします。 ここにカバーされていない問題に遭遇した場合は、HytaleCharts の contact フォーム からご連絡ください。 サーバーのWebhookログとハートビート履歴をチェックして、問題を診断することができます。 これらの統合の設定は数分かかりますが、サーバーがHytaleChartsとコミュニティとどのように相互作用するかを大幅に改善します。 積極的な投票通知とゲーム内報酬を持つサーバーは、一貫してより高いエンゲージメントを見て、投票者からの訪問を返す。 他のサーバーリストをブラウズ は、トップサーバーが統合機能をどのように記述するかを確認し、独自のリストングの言及を設定していることを確認してください。