Farbthema

Installation & Einrichtung

Eranio

Installation & Einrichtung

Vollständige Schritt-für-Schritt-Anleitung zur Installation des Panel-Plugins und des serverseitigen Java-Mods, Konfiguration der API-Verbindung und Überprüfung der Funktionalität.


Voraussetzungen

  • Pelican Panel Version 1.0.0-rc.1+ installiert und aktiv
  • PHP 8.5 auf dem Panel-Server
  • Ein vom Panel verwalteter Hytale-Gameserver
  • Netzwerkzugriff vom Panel-Server zum Hytale-Server auf Port 5550 (Standard)
  • storage/ und bootstrap/cache/ beschreibbar (Berechtigungen 0755, Eigentümer: Webserver-Benutzer)

Schritt 1: Panel-Plugin installieren

  1. Lade die neueste Version des hytale-admin-Plugins herunter
  2. Platziere es im plugins/-Verzeichnis deines Pelican Panels:
    /var/www/pelican/plugins/hytale-admin/
    
  3. Überprüfe die Verzeichnisstruktur:
    plugins/hytale-admin/
    ├── src/
    ├── config/
    ├── resources/
    └── plugin.json
    
  4. Leere den Anwendungscache:
    php artisan cache:clear
    php artisan config:clear
    php artisan view:clear
    
  5. Überprüfe, ob das Plugin unter Admin Panel → Plugins als „Hytale Admin Panel" erscheint

Schritt 2: Egg konfigurieren

Das Plugin verwendet das hytale-admin-Feature-Flag, um festzulegen, welche Server das Admin Panel anzeigen.

  1. Gehe zu Admin Panel → Eggs
  2. Bearbeite dein Hytale-Server-Egg (z.B. „Hytale Server")
  3. Füge hytale-admin im Feld Features hinzu:
    ["hytale-admin"]
    
    Falls das Egg bereits Features hat:
    ["steam_disk_space", "hytale-admin"]
    
  4. Klicke Speichern

Wichtig: Das Feature-Flag muss exakt hytale-admin (Kleinbuchstaben, mit Bindestrich) sein. Varianten wie HytaleAdmin oder hytale_admin funktionieren nicht.


Schritt 3: Java-Mod auf dem Server installieren

Der Java-Mod ist die serverseitige Komponente, die die REST-API bereitstellt.

  1. Navigiere zu deinem Server → Hytale Admin in der Seitenleiste
  2. Gehe zum Setup-Tab
  3. Klicke Mod installieren, das Plugin lädt die mitgelieferte JAR aus resources/mod/ in das mods/-Verzeichnis des Servers hoch
  4. Erfolgsmeldung: „Admin-Mod erfolgreich installiert“
  5. Hytale-Server neustarten, damit der Mod geladen wird

Integritätsprüfung

Das Plugin prüft die Mod mit RSA-2048-Signatur und SHA-256-Prüfsumme:

Prüfung Was überprüft wird
RSA-2048-Signatur Die JAR stammt von Eranio (öffentlicher Schlüssel fest eingebettet)
SHA-256-Prüfsumme Die installierte JAR stimmt mit der mitgelieferten überein

Die Prüfung läuft automatisch bei jedem Öffnen der Einrichtungsseite, einen Knopf dafür gibt es nicht. Die Seite zeigt „Integrität bestätigt“ oder „Integritätsprüfung FEHLGESCHLAGEN, die JAR-Datei wurde verändert!“, dann die Mod neu installieren. Schlägt sie fehl, warnt auch das Dashboard.

Neue Mod-Versionen

Neue Versionen des Java-Mods erkennt das Plugin auch dann, wenn das Plugin selbst nicht aktualisiert wurde: Es schaut stündlich (höchstens alle 6 Stunden wirklich) auf eranio.de nach, lädt eine neuere Version herunter und übernimmt sie nur, wenn Prüfsumme und Signatur stimmen. Danach erscheint auf dem Dashboard und im Setup-Tab „Update verfügbar“.

Installiert wird eine neue Version nie automatisch, sondern nur, wenn du im Setup-Tab selbst auf Mod aktualisieren klickst. Wirksam wird sie beim nächsten Neustart des Servers. Sofort nachsehen kannst du auf dem Panel-Server mit php artisan hytale-admin:update-mod. Abschalten lässt sich das Herunterladen mit HYTALE_ADMIN_MOD_AUTO_DOWNLOAD=false in der .env des Panels.


Schritt 4: API-Verbindung konfigurieren

Nach dem ersten Start des Java-Mods wird eine Konfigurationsdatei erstellt:

mods/Eranio_HytaleAdminAPI/config.json

Konfigurationsreferenz

Schlüssel Standard Beschreibung
token (auto-generiert) API-Authentifizierungstoken, im X-Admin-Token-Header verwendet
port 5550 HTTP-Server-Port für die REST-API
maxChatHistory 500 Maximale Chat-Nachrichten, die der Mod aufbewahrt
requestTimeout 10 HTTP-Request-Timeout in Sekunden
chatPollInterval 3 Chat-UI-Abfrageintervall in Sekunden
backupDir (auto) Backup-Speicherverzeichnis
worldDir (auto) Weltdaten-Verzeichnis
modsDir (auto) Mods-Verzeichnis
gameLanguage 'auto' Überschreibung der Spielsprache für Item-Übersetzungen
itemsPerPage 15 Elemente pro Seite in Tabellen

Das Plugin liest diese Konfiguration automatisch über Pelicans Datei-Schnittstelle. Von Hand muss nichts eingetragen werden, Werte lassen sich auf der Einrichtungsseite unter Einstellungen bearbeiten ändern (siehe Schritt 6).

Sicherheitshinweis: Der token wird automatisch generiert und sollte geheim gehalten werden. Bei Kompromittierung: Server stoppen, Token in config.json ändern, Server neustarten.


Schritt 5: Erster Start

  1. Stelle sicher, dass der Hytale-Server mit geladenem Java-Mod läuft
  2. Navigiere zu deinem Server → klicke auf Hytale Admin in der Seitenleiste
  3. Das Plugin verbindet sich mit der Java-Mod-API und zeigt:
    • Dashboard mit Serverstatus (Spieler, TPS, Betriebszeit)
    • Ein Menü mit allen Seiten, auf dem Handy als Leiste unten oder als Auswahlfeld
  4. Bei Verbindungsfehler: „Hytale API error" in den Logs

Verbindungs-Fehlerbehebung

Symptom Ursache Lösung
„Hytale Admin" nicht in Seitenleiste Feature-Flag fehlt hytale-admin zu Egg-Features hinzufügen
Leeres Dashboard Java-Mod läuft nicht Server neustarten, Mod-Ladung prüfen
„Hytale API config not found" config.json fehlt Server wurde nie mit Mod gestartet, oder Mod konnte nicht geladen werden
„Hytale API error: /status" API nicht erreichbar Port 5550, Firewall und Mod-Status prüfen
Verbindungs-Timeout Port blockiert Port 5550 zwischen Panel und Server freigeben

Schritt 6: Einstellungen

Die Einrichtungsseite zeigt Mod-Version, Integrität, API-Verbindung (Verbunden oder Nicht verbunden) und alle Einstellungen aus der config.json des Mods. Einstellungen bearbeiten öffnet ein Fenster und schreibt die Werte zurück in diese Datei:

Feld Grenzen Bedeutung
API-Token verdeckt, über das Augen-Symbol sichtbar Vom Mod erzeugt, für einen neuen Token config.json löschen und den Server neu starten
API-Port 1024 bis 65535 Port der REST-API des Mods
Zeitlimit für Anfragen 1 bis 120 Sekunden Wie lange das Panel auf eine Antwort wartet
Chat-Abfrage alle 1 bis 60 Sekunden Aktualisierung der Chat-Seite
Maximaler Chat-Verlauf 10 bis 10.000 Nachrichten, die der Mod im Speicher hält
Einträge pro Seite 5 bis 100 Zeilen pro Seite in Tabellen
Backup-, Welt- und Mod-Ordner Pfade Wo die Seiten Backups, Welten und Mods suchen
Spielsprache Auto oder eine von Hytales Sprachen Sprache für Namen von Gegenständen, NPCs und Orten, Auto nutzt die Sprache des Panels

Erfolg: „Einstellungen erfolgreich gespeichert“. Port und Token wirken nach einem Serverneustart.

Demo-Modus

Demo-Modus einschalten zeigt auf allen Seiten simulierte Daten, Aktionen werden nur vorgetäuscht. Er bleibt aktiv, bis er hier wieder ausgeschaltet wird. Siehe Dashboard, Abschnitt Demo-Modus.


Mod deinstallieren

  1. Gehe zum Setup-Tab → klicke auf Mod deinstallieren
  2. Die JAR wird aus dem mods/-Verzeichnis des Servers gelöscht
  3. Erfolg: „Admin-Mod deinstalliert“
  4. Server neustarten
  5. Das Panel-Plugin kann installiert bleiben, zeigt aber Verbindungsfehler ohne den Mod

Überprüfungscheckliste

Prüfung Erwartet Bei Problemen
Plugin in Admin → Plugins „Hytale Admin Panel" gelistet Falscher Pfad oder Cache nicht geleert
„Hytale Admin" in Seitenleiste Sichtbar für Server mit hytale-admin-Feature Feature-Flag fehlt beim Egg
Java-Mod auf Server mods/EranioHytaleAdminAPI-*.jar existiert Via Setup-Tab installieren
Konfigurationsdatei mods/Eranio_HytaleAdminAPI/config.json existiert Server einmal mit Mod starten
Dashboard lädt Zeigt TPS, Spieler, Betriebszeit API-Verbindung funktioniert
Integritätsprüfung „Integrität bestätigt“ Mod bei Abweichung neu installieren