diff --git a/README.md b/README.md index e23b55d..dbb7c62 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,58 @@ -# Minecraft-BungeeCord-Status +# Minecraft BungeeCord Status +StatusAPI zeigt den aktuellen Status deines Minecraft-Servers direkt auf deiner Webseite an – inklusive Online/Offline, Version, Ping, Spieleranzahl und Spieler-Avatare. + +## Features + +- Zeigt Serverstatus: **Online / Offline** +- Zeigt Version und Ping +- Zeigt die Anzahl der Spieler und ihre Avatare +- Klick auf Servername kopiert die Adresse automatisch +- Spielerübersicht wird automatisch alle **2 Sekunden** aktualisiert +- Hinweise/Banner können vom Nutzer geschlossen werden +- Anpassbare Darstellung für verschiedene Layouts + +## Wichtige Hinweise + +### BungeeCord Plugin +Das Plugin **StatusAPI.jar** muss in den BungeeCord Plugin-Ordner kopiert werden, damit die API korrekt funktioniert. + +### 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. + +### 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. + +## Beispielanzeige + +**Status:** Online +**Version:** 1.8 - 1.21 +**Ping:** 1 ms +**Spieler:** 1 + +**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. + +## 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 + +## Support + +Bei Problemen überprüfe bitte: + +- Ob das Plugin **StatusAPI.jar** 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