From e03ebffb647891d84fd1b0d15c0714b02ac98252 Mon Sep 17 00:00:00 2001 From: M_Viper Date: Thu, 8 Jan 2026 15:25:50 +0000 Subject: [PATCH] README.md aktualisiert --- README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 86 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dbb7c62..881492e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ StatusAPI zeigt den aktuellen Status deines Minecraft-Servers direkt auf deiner Webseite an – inklusive Online/Offline, Version, Ping, Spieleranzahl und Spieler-Avatare. +**StatusAPI Repository:** [https://git.viper.ipv64.net/M_Viper/StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI) + +--- + ## Features - Zeigt Serverstatus: **Online / Offline** @@ -12,26 +16,67 @@ StatusAPI zeigt den aktuellen Status deines Minecraft-Servers direkt auf deiner - Hinweise/Banner können vom Nutzer geschlossen werden - Anpassbare Darstellung für verschiedene Layouts +--- + ## Wichtige Hinweise -### BungeeCord Plugin +### BungeeCord Plugin (Voraussetzung) + +⚠️ **Die [StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI) MUSS auf deinem BungeeCord-Server installiert sein!** + Das Plugin **StatusAPI.jar** muss in den BungeeCord Plugin-Ordner kopiert werden, damit die API korrekt funktioniert. +```text +BungeeCord/ + ├─ plugins/ + │ └─ StatusAPI.jar ← PFLICHT + └─ config.yml +``` + +**Download:** [https://git.viper.ipv64.net/M_Viper/StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI) ### WordPress Integration + In WordPress muss der API-Port auf **9191** eingestellt sein, damit die Serverdaten korrekt abgerufen werden. Stelle sicher, dass dein Server und die Webseite auf diesen Port zugreifen können. +Die StatusAPI stellt einen HTTP-Endpunkt bereit (Standard: `http://localhost:9191`), den das WordPress-Plugin abfragt. + ### Shortcode für WordPress Um den Serverstatus auf deiner WordPress-Seite anzuzeigen, füge einfach folgenden Shortcode ein: - ```html [bungeecord_status id="Bungeecord"] ``` - Ersetze `"Bungeecord"` durch die ID deines Servers, falls mehrere Server eingebunden werden. +--- + +## Installation + +### Schritt 1: StatusAPI auf BungeeCord installieren + +1. Lade die **[StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI)** herunter +2. Kopiere die **StatusAPI.jar** in den `plugins`-Ordner deines BungeeCord-Servers +3. Starte den BungeeCord-Server neu +4. Die API läuft nun standardmäßig auf Port **9191** + +### Schritt 2: WordPress-Plugin einrichten + +1. Installiere das WordPress-Plugin für den BungeeCord-Status +2. Gehe zu den Plugin-Einstellungen +3. Trage die **StatusAPI URL** ein (z.B. `http://localhost:9191`) +4. Speichere die Einstellungen + +### Schritt 3: Shortcode einbinden + +Füge den Shortcode auf einer beliebigen WordPress-Seite ein: +```html +[bungeecord_status id="Bungeecord"] +``` + +--- + ## Beispielanzeige **Status:** Online @@ -42,17 +87,52 @@ Ersetze `"Bungeecord"` durch die ID deines Servers, falls mehrere Server eingebu **Avatare:** ![M_Viper Avatar](https://example.com/avatar/M_Viper.png) -> Der Abstand zwischen dem Text „Spieler:“ und den Avataren ist bewusst etwas größer, um die Übersichtlichkeit zu erhöhen. +> Der Abstand zwischen dem Text „Spieler:" und den Avataren ist bewusst etwas größer, um die Übersichtlichkeit zu erhöhen. + +--- ## Nutzung 1. Shortcode an der gewünschten Stelle einfügen 2. Der Serverstatus aktualisiert sich automatisch, sodass die angezeigten Spieler und der Ping immer aktuell sind +3. Alle Daten werden live von der StatusAPI bezogen + +--- + +## Technische Details + +- **API-Port:** 9191 (Standard) +- **Update-Intervall:** 2 Sekunden (automatisch) +- **Protokoll:** HTTP/JSON +- **Datenquelle:** StatusAPI auf BungeeCord + +--- ## Support Bei Problemen überprüfe bitte: -- Ob das Plugin **StatusAPI.jar** korrekt im BungeeCord Plugin-Ordner liegt +- Ob das Plugin **[StatusAPI.jar](https://git.viper.ipv64.net/M_Viper/StatusAPI)** korrekt im BungeeCord Plugin-Ordner liegt - Ob der API-Port in WordPress korrekt auf **9191** eingestellt ist -- Ob der Server erreichbar ist und Spieler online sind \ No newline at end of file +- Ob der BungeeCord-Server läuft und die StatusAPI erreichbar ist +- Ob keine Firewall den Port 9191 blockiert +- Ob die StatusAPI gültige JSON-Daten zurückliefert + +### Häufige Fehler + +❌ **"Server offline" obwohl Server läuft** +- StatusAPI ist nicht installiert oder läuft nicht +- Falscher Port in WordPress eingestellt +- Firewall blockiert Port 9191 + +❌ **Keine Spieler werden angezeigt** +- StatusAPI liefert keine Spielerdaten +- API-Verbindung fehlgeschlagen +- WordPress kann die API-URL nicht erreichen + +--- + +## Weitere Informationen + +Für detaillierte Informationen zur Installation, Konfiguration und Fehlerbehebung der StatusAPI: +**[https://git.viper.ipv64.net/M_Viper/StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI)** \ No newline at end of file