Installation & Einrichtung

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+ installiert und aktiv
  • PHP 8.1, 8.2 oder 8.3 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: „Java-Mod erfolgreich installiert"
  5. Hytale-Server neustarten, damit der Mod geladen wird

Integritätsprüfung

Das Plugin verwendet RSA-2048-Signaturüberprüfung und SHA-256-Hash-Vergleich zur Sicherstellung der Mod-Integrität:

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

Nach der Installation auf Integrität überprüfen klicken:

  • Erfolg: „Integritätsprüfung bestanden"
  • Fehlschlag: „SHA-256-Abweichung" — Mod neu installieren

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 die API 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 die Daemon-Datei-API. Keine manuelle Konfiguration nötig, es sei denn du möchtest Werte anpassen.

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)
    • Navigations-Tabs für alle Funktionen
  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: Admin-Einstellungen

Im Setup-Tab kannst du konfigurieren:

Einstellung Beschreibung
Gesamte Erinnerungen Anzahl entdeckbarer Erinnerungen (Standard: 240)
Spielsprache Überschreibung der Item-Übersetzungssprache (auto = folgt Panel-Sprache)
SkipModValidation Umschalter zwischen leerem String und aktuellem Server-Revisions-String

Erfolg: „Admin-Einstellungen gespeichert" Fehlschlag: „Einstellungen konnten nicht gespeichert werden"


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: „Java-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 „Bestanden" Mod bei Abweichung neu installieren