README.md aktualisiert

2026-01-06 18:47:24 +00:00
parent 496e2c4e92
commit 0aea5226ab
1 changed files with 142 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,143 @@
-# MC-Player-History---WordPress-Plugin
+# MC Player History – WordPress Plugin

+MC Player History ist ein WordPress-Plugin zur Anzeige von Minecraft-Spielern inklusive **Prefix**, **Spielername** und **Online-/Offline-Status**.  
+Die Daten werden live über eine externe **StatusAPI** aus deinem Minecraft-Netzwerk bezogen.
+
+---
+
+## 🔧 Voraussetzungen (SEHR WICHTIG)
+
+⚠️ **Ohne korrekt installierte StatusAPI funktioniert dieses Plugin NICHT.**
+
+### Pflichtvoraussetzung:
+- Ein **BungeeCord-Server**
+- Das Plugin **StatusAPI**
+- **StatusAPI MUSS im BungeeCord-Ordner `/plugins` liegen**
+
+❗ **NICHT** auf Spigot / Paper / Velocity  
+❗ **NUR** im **BungeeCord-Server unter `/plugins`**
+
+```text
+BungeeCord/
+ ├─ plugins/
+ │   └─ StatusAPI.jar   ← PFLICHT
+ └─ config.yml
+```
+
+## 🔗 StatusAPI
+
+Die **StatusAPI** stellt einen HTTP-Endpunkt bereit (z. B. `http://localhost:9191`),  
+der von diesem WordPress-Plugin **regelmäßig abgefragt** wird, um Spieler- und Online-Daten zu synchronisieren.
+
+⚠️ **WICHTIG:**  
+Die StatusAPI **MUSS** auf dem **BungeeCord-Server** installiert sein und sich im Ordner  
+`/plugins` befinden, sonst funktioniert das Plugin nicht.
+
+---
+
+## ✨ Features
+
+- Anzeige aller bekannten Spieler
+- Live-Online-Status (über StatusAPI)
+- Speicherung von:
+  - Spielername
+  - Prefix (mit Minecraft-Farbcodes)
+  - Erstes & letztes Online-Datum
+- Automatische Synchronisation (alle 2 Minuten)
+- Manueller Sync im Admin-Bereich
+- AJAX Live-Updates ohne Seitenreload
+- Shortcode-Integration
+- Responsives Grid-Layout
+
+---
+
+## 📦 Installation (WordPress)
+
+1. Plugin-Dateien hochladen nach:
+   ```text
+   wp-content/plugins/mc-player-history/
+   ```
+
+4. Plugin im WordPress-Admin aktivieren
+
+5. Unter **Einstellungen → MC Player History** die **StatusAPI URL** eintragen  
+   Beispiel:
+   ```text
+   http://localhost:9191
+   ```
+
+6. Einstellungen speichern
+
+---
+
+## 🔗 Verbindung zur StatusAPI
+
+- Die **StatusAPI** läuft auf dem **BungeeCord-Server**
+- WordPress ruft diese URL per **HTTP** ab
+- Standard-Fallback:
+  ```text
+  http://localhost:9191
+  ```
+
+❗ Stelle sicher, dass:
+
+- der konfigurierte Port erreichbar ist
+- keine Firewall den Zugriff blockiert
+- die API gültige **JSON-Daten** zurückliefert
+
+---
+
+## 🧩 Shortcode
+
+```shortcode
+[mc_player_history]
+```
+
+### Parameter
+
+| Parameter     | Beschreibung                     | Standard |
+|---------------|----------------------------------|----------|
+| limit         | Maximale Spieleranzahl           | 500      |
+| interval      | Update-Intervall (Sekunden)      | 2        |
+| only_online   | Nur Online-Spieler anzeigen      | false    |
+
+### Beispiel
+
+```shortcode
+[mc_player_history limit="50" interval="5" only_online="true"]
+```
+
+## 🎨 Anzeige-Reihenfolge (fix)
+
+Die Struktur ist **fest definiert** und kann **nicht verändert** werden:
+
+```text
+Avatar
+Prefix
+Name
+──────────
+Status (unten)
+```
+
+## 🛠 Cron & Caching
+
+- WordPress-Cron läuft alle **2 Minuten**
+- Live-Status wird zusätzlich **5 Sekunden gecacht**
+- Automatischer Fallback auf den Datenbankstatus bei API-Ausfall
+
+---
+
+## ❗ Häufige Fehler
+
+### ❌ Keine Spieler sichtbar?
+
+- StatusAPI nicht erreichbar
+- StatusAPI **nicht im `BungeeCord/plugins/`**
+- Falsche URL (z. B. `http://` vergessen)
+- Firewall blockiert den API-Port
+
+### ❌ Status immer offline?
+
+- StatusAPI liefert keine `players`
+- BungeeCord-Server nicht gestartet
+- Falscher API-Port konfiguriert