Jak nastavit webháky a oznámení pro váš Hytale Server

< p > HytaleCharts poskytuje několik možností integrace, které vám umožní připojit Hytale server výpis na Discord, váš herní server, a externí nástroje. Když hráč hlasuje pro váš server, můžete obdržet oznámení Discord, spouštět in- game odměny prostřednictvím Votifier, vypálit vlastní webhook na svůj vlastní backend, a udržet stav serveru up- to- date s tlukot srdce plugin. < / p > < p > Tato příručka pokrývá, jak nastavit každou integraci od nuly. Všechny tyto funkce jsou přístupné ze stránky vašeho serveru pro úpravu na HytaleCharts po přihlášení jako vlastník serveru nebo člen týmu. < / p > < h2 > Discord Vote Webháky < / h2 > < p > Discord webháky vám umožní získat oznámení v kanálu Discord pokaždé, když někdo hlasuje pro, oblíbené, nebo zanechá recenzi na vašem serveru seznamu. < / p > < h3 > Nastavení diskových webháků < / h3 > < ol > < li > < strong > Vytvořte webhook ve Vašem Discord serveru. < / strong > Přejděte na Nastavení serveru, pak Integrace, pak Webháky. Klikněte na "Nový Webhook", dejte mu jméno (např. "HytaleCharts Votes"), vyberte kanál a zkopírujte URL. < / li > < li > < strong > Přidat URL na HytaleCharts. < / strong > Přejděte na stránku pro úpravu serveru, najděte sekci Discord Webhook a vložte URL. < / li > < li > < silný > Uložit nastavení. < / silný > Hytale. Charts nyní pošle formátované vložené do vašeho Discord kanálu, kdykoliv dojde k hlasování, oblíbenému, nebo recenzi událost. < / li > < / ol > < h3 > Co dostane zasláno < / h3 > < p > Každé oznámení o webhooku je zasláno jako zástrčka Discord obsahující: < / p > < ul > < li > Typ akce (hlasování, oblíbené, recenze) < / li > < li > Uživatelské jméno hráče, který provedl akci < / li > < li > Časové razítko < / li > < li > Vaše jméno serveru a odkaz zpět na seznam HytaleCharts < / li > < / ul > < p > Doručování pomocí Webhooku využívá systém retry s 3 pokusy a 5sekundovým odstupem mezi retry. Pokud všechny pokusy selžou, selhání je zaznamenáno a HytaleCharts sleduje po sobě jdoucí selhání na server. Pokud URL webhooku trvale selže (vrací HTTP chyby nebo time out), bude nakonec označen, takže jej můžete aktualizovat nebo opravit. < / p > < img src = "https: / / cdn.hytale.com / 5e7ba23b50cbcd001176c66b _ 66 _ _ farm.jpg" alt = "A Hytale farm ukazuje druh serveru staví, které těží z komunitních nástrojů zapojení" zatížení = "líný" styl = "šířka: 100%; výška: auto; hraniční poloměr: 8px; rozpětí: 1.5rem 0;" / > < h2 > Votifier: In- Game Vote Rewards < / h2 > < p > Votifier je protokol, který posílá hlasovací oznámení přímo na váš herní server, což vám umožní odměnit hráče v rámci hry, když hlasují o HytaleCharts. Hytale. Grafy podporují tři varianty voličů. < / p > < h3 > Votifier v1 (šifrovaný RSA) < / h3 > < p > Původní Votifier protokol používá šifrování RSA. Když je hlasování obsazeno, HytaleCharts šifruje hlasovou zprávu s veřejným klíčem vašeho serveru a posílá ji přes TCP. < / p > < p > Nastavit Votifier v1: < / p > < ol > < li > Nainstalujte Votifier- kompatibilní plugin na váš Hytale server < / li > < li > Vygenerovat RSA pár klíčů (plugin to obvykle dělá automaticky při prvním spuštění) < / li > < li > Kopírujte svůj < silný > veřejný klíč < / silný > z konfigurace plugin < / li > < li > On Hytale Charts, přejděte na stránku pro úpravu serveru a nastavte typ Votifier na "v1" < / li > < li > Zadejte < silný > host < / silný > (IP adresa nebo doména), < silný > port < / silný > (odposlouchávací port Votifier, ne herní port) a vložte < silný > veřejný klíč < / silný > < / li > < li > Uložit a použít tlačítko "Test Connection" pro ověření, zda funguje < / li > < / ol > < p > Hlasová zpráva se řídí standardním formátem Votifier: < code > VOTE\ nHytaleCharts\ n {username}\ n {ip _ address}\ n {timestamp}\ n < / code >, šifrovaný PKCS # 1 v1.5 padding. < / p > < h3 > Votifier v2 (HMAC- SHA256) < / h3 > < p > Votifier v2 je modernější protokol. Místo šifrování RSA používá HMAC- SHA256 podpis se sdíleným tokem. Hand shake obsahuje řetězec výzvy ze serveru, aby se zabránilo opakování útoků. < / p > < p > Chcete-li nastavit Votifier v2: < / p > < ol > < li > Nainstalujte v2-kompatibilní Name < li > Najít < silný > token < / silný > (sdílené tajemství) v konfiguračním souboru plugin < / li > < li > On Hytale Grafy, nastavte typ Votifier na "v2" < / li > < li > Zadejte < silný > hostitel >, < silný > port < / silný > a < silný > token < / silný > < / li > < li > Uložit a otestovat spojení < / li > < / ol > < p > Protokol v2 se připojí přes TCP, přečte si pozdrav pomocí handshake s výzvou token, pak pošle binární paket obsahující užitečné zatížení JSON podepsané s HMAC- SHA256. Užitečné zatížení zahrnuje název služby ("HytaleCharts"), uživatelské jméno, IP adresu, časové razítko v milisekundách a řetězec výzvy. < / p > < h3 > HTTP Votifier < / h3 > < p > Pro Hytale- specifické pluginy, které používají HTTP místo syrového TCP, HytaleCharts podporuje HTTP koncový režim. To je nejjednodušší protokol pro implementaci pro vývojáře plugin. < / p > < p > Nastavit HTTP volič: < / p > < ol > < li > Nainstalujte plugin, který odhalí HTTP koncový bod pro příjem hlasů < / li > < li > On Hytale Grafy, nastavte typ Votifier na "HTTP" < / li > < li > Zadejte plnou < silnou > cílovou URL < / silnou > (např. < kód > https: / / your- server.com: 8080 / vote < / code >) < / li > < li > Pokud plugin vyžaduje token, zadejte jej do tokenového pole. HytaleCharts podepíše žádost podpisem HMAC- SHA256 v < kódu > X- Votifier- Podpis < / kód > hlavička. < / li > < li > Uložit a otestovat < / li > < / ol > < p > Požadavek HTTP odešle tělo JSON s < kódem > serviceName < / kód >, < kód > uživatelské jméno < / kód >, < kód > adresa < / kód > a < kód > časové razítko < / kód > pole. < / p > < h3 > Důležité poznámky pro všechny typy voličů < / h3 > < ul > < li > < silné > Uživatelské názvy jsou zkráceny na 16 znaků < / silné >, aby odpovídaly limitu uživatelského jména Hytala. HytaleCharts používá Hytale uživatelské jméno hráče, pokud je nastaveno, jinak jejich uživatelské jméno Discord. < / li > < li > < silný > Timeout připojení je 5 sekund. < / silný > Pokud váš server nereaguje do 5 sekund, je pokus považován za neúspěšný. < / li > < li > < silné > Neúspěšné pokusy se znovu zkoušejí až 3krát < / silné > s exponenciálním backoff (10s, 30s, 60s mezi pokusy). < / li > < li > Pro ověření nastavení můžete použít tlačítko < strong > Test Connection < / strong > na HytaleCharts, aniž byste potřebovali skutečný hlas. To kontroluje, zda je server dosažitelný a reaguje s očekávaným potřesením rukou. < / li > < / ul > < h2 > Generické Webháky < / h2 > < p > Pokud chcete zaslat hlasová oznámení na svůj vlastní backend service, bot, nebo aplikace, generické webové háky vám umožní definovat vlastní URL a šablonu pro ukládání. < / p > < h3 > Jak generické Webhangy pracovat < / h3 > < ol > < li > Na stránce pro úpravu serveru přejděte do konfigurační sekce webháku < / li > < li > Zadejte < silný > URL < / silný > vašeho cílového parametru < / li > < li > Nastavte šablonu < silné > užitečné zátěže < / silné > s daty, které chcete získat < / li > < li > Uložit nastavení < / li > < / ol > < p > Když dojde k volební události, HytaleCharts odešle HTTP POST požadavek na URL s nastaveným užitečným zatížením. Systém podporuje proměnné šablon, které jsou nahrazeny aktuálními hodnotami v čase odeslání (uživatelské jméno voliče, jméno serveru, časové razítko atd.). < / p > < p > Generické webháky používají stejnou logiku retry jako Discord: 3 pokusy s progresivním zálohováním (10s, pak 30s mezi retry). Pokud všechny opakování selžou, selhání je sledováno proti Vašemu serveru a přetrvávající selhání bude označeno v přístrojové desce. < / p > < img src = "https: / / cdn.hytale.com / 5e7ba02d50cbcd001176c5ff _ 30 _ _ outlander _ settlement.jpg" alt = "An Outlander settlement.jpg" alt = "An Outlander settlement in Hytale", ukazující druh komunitních serverů, které mají prospěch z integrace webháků "zatížení =" lenivý "styl =" šířka: 100%; výška: auto; hraniční poloměr: 8px; marge: 1.5rem 0; "/ > < h2 > Heartbeat Plugin: Online sledování stavu < / h2 > < p > HytaleCharts heath plugin běží na vašem herním serveru a posílá pravidelné aktualizace stavu, takže váš výpis vždy ukazuje přesný online / offline stav a počet hráčů. < / p > < h3 > Jak to funguje < / h3 > < p > Name každých 5 minut (nebo každých 20 sekund u prémiových serverů). Každý srdeční tep zahrnuje: < / p > < ul > < li > Vaše serverová < silná > srdeční tajemství < / silná > (64- znak hex token) < / li > < li > Aktuální < silný > počet hráčů < / silný > a < silný > Max hráči < / silný > < / li > < li > A < silný > hráči pole < / silný > s individuálními detaily hráče (uživatelské jméno, UUID, svět, ping) < / li > < li > metadata serveru jako < silný > název serveru < / silný >, < silný > MOTD < / silný >, < silný > uptime < / silný >, a < silný > využití paměti < / silný > < / li > < li > Seznam < silných > nainstalovaných pluginů < / silných > a < silných > světových názvů < / silných > < / li > < / ul > < h3 > Nastavení kroků < / h3 > < ol > < li > < silný > Vytvořte tajemství srdečního rytmu. < / silný > Na stránce pro úpravu serveru přejděte do sekce Heartbeat a klikněte na "Generate Secret". To vytváří unikátní znak 64- znak. < / li > < li > < silný > Nainstalujte plugin. < / silný > Umístěte modul HytaleCharts do < kódu serveru > mods / < / code > adresář. < / li > < li > < silný > Nastavit plugin. < / silný > Upravit plugin < kód > config.json < / code > soubor a nastavit tajemství: < před > < kód > { "tajné": "Your _ 64 _ CHAR _ HEARTBEAT _ SECRET," "debug": false } < / kód > < / pre > < / li > < li > < strong > Restartujte svůj server. < / strong > Plugin začne posílat tlukot srdce okamžitě. < / li > < li > < silný > Ověřte na HytaleCharts. < / silný > Zkontrolujte si editační stránku serveru, měla by ukázat poslední časové razítko tlukotu a uvést, že spojení je aktivní. < / li > < / ol > < h3 > Multi- Server Agregation < / h3 > < p > Pokud spustíte více serverových instancí (lobby, přežití, kreativní) sdílejících stejné tajemství tlukot srdce, HytaleCharts je automaticky agreguje. Identifikuje různé instance podle jejich IP adresy a jména serveru, bere nejnovější srdeční tep od každého, a sloučí hráče UUID, aby se zabránilo dvojímu počítání. Celkový počet hráčů a maximální počet hráčů uvedených na vašem seznamu odráží kombinované hodnoty ve všech případech. < / p > < h3 > Priorita on-line stavu < / h3 > < p > Hytale Grafy určují stav vašeho serveru pomocí prioritního systému: < / p > < ol > < li > < silný > Externí cíl dotazu < / silný > (je-li nakonfigurován, např., Nitrado dotaz API) < / li > < li > < silný > Heartbeat plugin < / silný > (server ukazuje jako online, pokud byl srdeční tep přijat během posledních 5 minut) < / li > < li > < silný > UDP ping < / silný > (dotaz na záložní server) < / li > < / ol > < p > Pokud se modul tlukot srdce ztichne na více než 5 minut a není nakonfigurován žádný externí dotaz, server se vrátí zpět do stavu UDP pingu. < / p > < h2 > Public Server API Tokens < / h2 > < p > HytaleCharts poskytuje veřejnou API, která vám umožní dotazovat se na voličská data, serverové statistiky a další informace programově. Chcete-li jej použít, potřebujete API token. < / p > < h3 > Získání vašeho API Token < / h3 > < ol > < li > Přejděte na stránku pro úpravu serveru na HytaleCharts < / li > < li > Přejděte do sekce API < / li > < li > Generovat API token < / li > < li > Kopírovat a ukládat bezpečně. Token ověřuje všechny požadavky na veřejný server API koncové body. < / li > < / ol > < h3 > Použití API < / h3 > < p > Zahrňte token do < kódu > Autorizace < / kód > záhlaví vašich žádostí API: < / p > < pre > < kód > GET / api / public / servery / {server _ id} / voliči Autorizace: Nositel Your _ API _ TOKEN < / kód > < / pre > < p > Veřejná API vám umožní získat nedávné voliče, statistiky serverů a další data, která můžete použít k vybudování vlastní integrace, žebříčků nebo systémů odměn na vašem serveru. < / p > < p > Pro kompletní dokumentaci API a údaje o koncích zkontrolujte < a href = "/ server- api" > Server API stránku < / a > na HytaleCharts. < / p > < h2 > Řešení problémů < / h2 > < tabulka > < hlava > < tr > < th > Vydání < / th > < th > Možné příčiny < / th > < th > Roztok < / th > < / tr > < / thead > < tbody > < tr > < td > Discord webhook neodesílá < / td > < td > Neplatný URL < / td > < td > Smazat a znovu vytvořit webhook v Discordu, pak aktualizovat URL na HytaleCharts < / td > < / tr > < tr > < td > Votifier test selže s "Bez odezvy" < / td > < td > Firewall blokující Votifier port < / td > < td > Zajistit Votifier port (ne herní port) je otevřen ve firewallu < / td > < / tr > < tr > < td > Votifier test říká "Neplatný handshake V2" < / td > < td > Server podporuje pouze v1, ale zvolili jste v2 < / td > < td > Změnit typ Votifier na v1 a poskytnout RSA veřejný klíč místo token < / td > < / tr > < tr > < td > Heartbeat neregistruje < / td > < td > Špatné tajemství v plugin config < / td > < td > Double- check that the secret in config. json odpovídá té na HytaleCharts přesně < / td > < / tr > < tr > < td > Počet hráčů ukazuje 0 < / td > < td > Plugin verze starší než 1.5.0 < / td > < td > Aktualizace Hytale Name < tr > < td > Webhook označený jako selhání < / td > < td > 100 + po sobě jdoucí selhání < / td > < td > Opravit cílovou URL a otestovat ji. Úspěšná dodávka resetuje počitadlo selhání. < / td > < / tr > < / tbody > < / tabulka > < p > Pokud narazíte na problémy, které zde nejsou pokryty, kontaktujte prostřednictvím Href = "/ about" > kontaktní formulář < / a > na HytaleCharts. Můžeme zkontrolovat webové záznamy vašeho serveru a srdeční historii, abychom pomohli diagnostikovat problémy. < / p > < p > Nastavení těchto integrací trvá několik minut, ale výrazně zlepšuje, jak váš server interaguje s HytaleCharts a vaší komunitou. Servers s aktivním hlasováním oznámení a in- game odměn důsledně vidět vyšší zapojení a návrat návštěvy voličů. < a href = "/ servery" > Projděte si jiné seznamy serverů < / a >, abyste viděli, jak špičkové servery popisují jejich integrační funkce, a ujistěte se, že váš vlastní seznam zmiňuje to, co jste nastavili. < / p >