README.md aktualisiert

README.md

@@ -1,2 +1,133 @@
-# Advenskalender
+# 🎄 Minecraft Adventskalender Plugin
 
+Ein hochgradig konfigurierbares Adventskalender-Plugin für **Spigot/Paper-Server**, das dir die volle Kontrolle über Belohnungen, Sprache und Funktionen gibt.  
+Perfekt, um die Weihnachtszeit auf deinem Server zu versüßen!
+
+---
+
+## 🪟 Adventskalender GUI
+
+*(01)*
+
+---
+
+## ✨ Features
+
+- **Anpassbare Belohnungen**  
+  Definiere in der `config.yml` für jeden Tag ein eigenes Item, inklusive:
+  - Menge  
+  - Name  
+  - Lore  
+  - Verzauberungen  
+
+- **Globaler oder individueller Kalender**  
+  Entscheide, ob:
+  - jeder Spieler seinen eigenen Fortschritt hat oder  
+  - ein Türchen serverweit nur einmal geöffnet werden kann  
+
+- **Sound & Partikel**  
+  Angenehme Sound- und Partikeleffekte beim Öffnen eines Türchens.
+
+- **Mehrsprachig**  
+  Unterstützt **Deutsch** und **Englisch**.  
+  Weitere Sprachen können einfach hinzugefügt werden.
+
+- **Admin-Befehle**  
+  Konfigurationen neu laden oder Türchen gezielt für Spieler öffnen.
+
+- **Permissions-System**  
+  Feingranulare Kontrolle über Spieler- und Admin-Rechte.
+
+- **PlaceholderAPI-Unterstützung**  
+  Zeige Statistiken:
+  - auf Schildern  
+  - in der Tab-Liste  
+  - mit Hologramm-Plugins  
+
+- **Datenpersistenz**  
+  Spielerfortschritt bleibt auch nach Server-Neustarts erhalten.
+
+---
+
+## 📸 Screenshots
+
+### Placeholder auf einem Schild
+
+Ein Schild, das die Placeholder des Plugins anzeigt.
+
+*(02)*
+
+
+---
+
+## 🚀 Installation
+
+1. Lade die neueste Version des Plugins als **`.jar`-Datei** herunter.
+2. Platziere die Datei im Ordner:
+
+/plugins
+
+3. Stelle sicher, dass **PlaceholderAPI** installiert ist (Pflichtabhängigkeit).
+4. Starte oder starte den Server neu.
+5. Passe die Konfigurationsdateien an: /plugins/Adventskalender/
+
+---
+
+## ⚙️ Konfiguration
+
+Das Plugin verwendet drei Hauptdateien:
+
+- **`config.yml`**  
+- Sprache  
+- Kalender-Typ (global / individuell)  
+- Belohnungen für alle 24 Tage  
+
+- **`messages_de.yml` / `messages_en.yml`**  
+- GUI-Titel  
+- Chat-Nachrichten  
+- Systemmeldungen  
+Diese Dateien können frei angepasst oder übersetzt werden.
+
+---
+
+## 📋 Befehle & Berechtigungen
+
+### Befehle
+
+| Befehl | Alias | Beschreibung | Berechtigung |
+|------|------|-------------|--------------|
+| `/adventskalender` | `/advent`, `/kalender`, `/ak` | Öffnet den Adventskalender | `adventskalender.use` |
+| `/adventskalender admin reload` | `/ak admin reload` | Lädt Konfigurations- & Sprachdateien neu | `adventskalender.admin` |
+| `/adventskalender admin open <spieler> <tag>` | `/ak admin open ...` | Öffnet ein Türchen für einen Spieler | `adventskalender.admin` |
+
+### Berechtigungen
+
+| Berechtigung | Standard | Beschreibung |
+|-------------|----------|--------------|
+| `adventskalender.use` | `true` | Erlaubt das Öffnen des Kalenders |
+| `adventskalender.admin` | `op` | Erlaubt alle Admin-Befehle |
+
+---
+
+## 🔗 Placeholders
+
+Alle Placeholder sind **PlaceholderAPI-kompatibel** und kurz gehalten.
+
+| Placeholder | Beschreibung |
+|------------|--------------|
+| `%ak_c%` | Anzahl geöffneter Türchen |
+| `%ak_n%` | Nächstes verfügbares Türchen |
+| `%ak_d%` | Verbleibende Tage bis 25. Dezember |
+
+### Beispiel für ein Schild
+
+
+Dein Fortschritt:
+%ak_c%/24 Türchen
+
+
+---
+
+## 📜 Lizenz
+
+Dieses Projekt steht unter der **GNU General Public License v3.0 (GPL-3.0)**.