diff --git a/README.md b/README.md index 48ac85d..ce955c8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,75 @@ -# Minecraft-Server-Status +# Minecraft Server Status +Ein wunderschönes, modernes Minecraft-Server-Widget für deine WordPress-Website – mit Live-Update, Prefix-Rängen und einem Klick-zum-Adresse-Kopieren! + + + +## Was dieses Widget kann + +- Zeigt live an, ob dein Server **online** oder **offline** ist +- Zeigt alle **online Spieler** mit ihren Minecraft-Köpfen +- Zeigt den **Prefix direkt als Rang** an → `[Owner]`, `[Admin]`, `[VIP]`, `[Spieler]` +- Automatische Farben aus LuckPerms (§-Codes oder #Hex) +- **Ein Klick** auf die IP → Adresse wird in die Zwischenablage kopiert (mit cooler Animation) +- Komplett anpassbar: Logo, Zusatztext, Farben, Schriftgröße +- MOTD anzeigen oder ausblenden +- Funktioniert auch ohne RCON (dank api.mcsrvstat.us) – mit RCON aber noch genauer + +## Installation (super einfach) + +1. Lade die ZIP-Datei dieses Repositories herunter +2. Gehe in WordPress zu **Plugins → Installieren → Plugin hochladen** +3. Wähle die ZIP aus und klicke auf „Jetzt installieren“ +4. Aktiviere das Plugin +5. Gehe zu **Einstellungen → Minecraft Server** und trage deine Server-Daten ein + +## Einstellungen (einmal eintragen – fertig!) + +| Feld | Erklärung | +|--------------------------|---------------------------------------------------------------------------| +| Server Host | Deine IP oder Domain (z. B. `play.deinserver.de`) | +| RCON Port | Standard: `25575` | +| RCON Passwort | Das Passwort aus deiner `server.properties` (`rcon.password=…`) | +| Spieler-Port (für Kopieren) | Der Port, den Spieler wirklich nutzen (meist `25565`) – wird nur kopiert | +| Port ausblenden? | Ja → zeigt nur den Host an (schöner für Subdomains) | +| Server Logo | Hochladen oder direkte Bild-URL | +| Zusatztext | z. B. `1.21 • Survival • Whitelist aktiv • Discord` | +| IP-Adresse – Farbe/Größe | Vollständig anpassbar | +| Cache TTL | Wie oft das Widget aktualisiert wird (Standard: 15 Sekunden) | +| MOTD anzeigen? | Optional ein- oder ausblenden | + +**Tipp:** RCON aktivieren (`enable-rcon=true` in `server.properties`) → Prefixe und genaue Spielerliste! + +## Verwendung auf deiner Website + +Füge einfach diesen Shortcode ein – wo du das Widget haben möchtest: + +```[minecraft_status]``` + +## Beispiel-Ansicht + +![Beispiel Widget](https://git.viper.ipv64.net/M_Viper/Minecraft-Server-Status/raw/branch/main/assets/001.PNG) + +## Häufige Fragen (FAQ) + +**Funktioniert das mit BungeeCord?** +Ja! Solange jeder Backend-Server RCON hat und erreichbar ist. + +**Was, wenn ich kein RCON habe?** +Kein Problem – das Widget nutzt dann `api.mcsrvstat.us` als Fallback (Spielerliste ohne Prefixe). + +**Kann ich mehrere Server anzeigen?** +Diese Version zeigt einen Server. Es gibt aber bereits eine Multi-Server-Version in Arbeit! + +## Support + +Probleme oder Wünsche? +Schreib einfach ein Issue hier im Repository – ich helfe dir gern! + +## Danke! + +Vielen Dank, dass du dieses Plugin nutzt +Made with Liebe & Minecraft von **M_Viper** + +--- +*Dein Server. Deine Website. Perfekt präsentiert.* \ No newline at end of file