README.md aktualisiert

This commit is contained in:
2026-01-26 23:01:16 +00:00
parent 0e212d8f54
commit 3bf449a8cf

186
README.md
View File

@@ -1,132 +1,118 @@
# 🎄 Minecraft Adventskalender Plugin
<div align="center">
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!
# ❄️ Minecraft Adventskalender 2.0 ❄️
*Bringe festliche Stimmung auf deinen Server mit einem hochgradig anpassbaren System*
![Version](https://img.shields.io/badge/Version-1.18.x--1.21.x-green.svg)
![Java](https://img.shields.io/badge/Java-17+-orange.svg)
![Update Checker](https://img.shields.io/badge/Update--Checker-Klickbar-blue.svg)
![Type](https://img.shields.io/badge/Type-Event-red.svg)
</div>
---
## 🖥️ Adventskalender GUI
## Über Minecraft Adventskalender
![Adventskalender GUI](https://git.viper.ipv64.net/M_Viper/Advenskalender/raw/branch/main/img/03.png)
![Adventskalender GUI](https://git.viper.ipv64.net/M_Viper/Advenskalender/raw/branch/main/img/04.png)
Das **Minecraft Adventskalender Plugin** ist die ultimative Lösung für deinen Server im Dezember! Es bietet volle Kontrolle über Belohnungen, Sprache und Funktionen. Dank des neuen klickbaren Update-Checkers und dem erweiterten Admin-Test-System war die Verwaltung eines Events noch nie so einfach. Perfekt für Community-Events, um die Spielerbindung in der Weihnachtszeit zu stärken!
---
## ✨ Features
## ✨ Exklusive 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
- Scoreboard
und vieles mehr.
- **Datenpersistenz**
Spielerfortschritt bleibt auch nach Server-Neustarts erhalten.
- **Vollständig Anpassbare Belohnungen:** Definiere für jeden Tag individuelle Items mit Menge, Name, Lore und Verzauberungen.
- **Smart Update-Checker:** Erhalte beim Joinen als Admin eine dezente, **klickbare Benachrichtigung**, falls eine neue Version verfügbar ist (erscheint verzögert nach 2 Sek.).
- **Simulations Modus (Admin-Test):** Teste alle Türchen vorab durch Datums-Simulation, ohne deine Systemzeit zu ändern. Inklusive einfachem Reset auf das Echtzeit-Datum.
- **Präzises Reset-System:** Setze einzelne Tage oder komplette Fortschritte zurück wahlweise für einzelne Spieler oder global für den ganzen Server.
- **Immersive Effekte:** Festliche Sound- und Partikeleffekte beim Öffnen eines Türchens.
- **Optimierte Tab-Completion:** Intelligente Befehlsvorschläge mit korrekter numerischer Sortierung (1, 2, 3... statt 1, 10, 11...).
---
## 📸 Screenshots
## 🎄 Adventskalender GUI
<div align="center">
<img src="https://git.viper.ipv64.net/M_Viper/Advenskalender/raw/branch/main/img/03.png" width="400" alt="Kalender GUI 1">
<img src="https://git.viper.ipv64.net/M_Viper/Advenskalender/raw/branch/main/img/04.png" width="400" alt="Kalender GUI 2">
*Die intuitive Kalender-Oberfläche mit allen 24 Türchen*
</div>
---
## ⚙️ Befehle & Permissions
### ▶ Spieler-Befehle
**`/adventskalender`** (Aliase: `/ak`, `/advent`, `/kalender`)
- **Beschreibung:** Öffnet die Kalender-Oberfläche.
- **Berechtigung:** `adventskalender.use`
### ▶ Admin-Befehle
**`/ak admin test <1-24 | reset>`**
- **Beschreibung:** Simuliert einen bestimmten Tag für Belohnungstests. Nutze `reset`, um zum echten Datum zurückzukehren.
- **Berechtigung:** `adventskalender.admin`
**`/ak admin resetday <global | Spieler> <1-24>`**
- **Beschreibung:** Setzt den Status eines spezifischen Tages für einen Spieler oder den gesamten Server zurück.
- **Berechtigung:** `adventskalender.admin`
**`/ak admin reset <global | Spieler>`**
- **Beschreibung:** Löscht den kompletten Fortschritt (alle Tage) für einen Spieler oder global.
- **Berechtigung:** `adventskalender.admin`
**`/ak admin reload`**
- **Beschreibung:** Lädt Config, Sprachdateien und Datenbank-Verbindung im laufenden Betrieb neu.
- **Berechtigung:** `adventskalender.admin`
---
## 📊 PlaceholderAPI (PAPI)
- **`%ak_c%`** - Anzahl bereits geöffneter Türchen.
- **`%ak_n%`** - Nummer des nächsten verfügbaren Türchens.
- **`%ak_d%`** - Verbleibende Tage bis zum 25. Dezember.
### Placeholder auf einem Schild
Ein Schild, das die Placeholder des Plugins anzeigt.
<div align="center">
<img src="https://git.viper.ipv64.net/M_Viper/Advenskalender/raw/branch/main/img/02.png" width="450" alt="Adventskalender Placeholder">
<img src="https://git.viper.ipv64.net/M_Viper/Advenskalender/raw/branch/main/img/02.png" alt="Placeholder Beispiel">
*Ein Schild, das die Placeholder des Plugins anzeigt.*
</div>
---
## 🚀 Installation
## 💬 Support & Community
1. Lade die neueste Version des Plugins als **`.jar`-Datei** herunter.
2. Platziere die Datei im Ordner:
Du hast Fragen oder Feedback? Tritt unserem Discord bei!
/plugins
<div align="center">
3. Stelle sicher, dass **PlaceholderAPI** installiert ist (Pflichtabhängigkeit).
4. Starte oder starte den Server neu.
5. Passe die Konfigurationsdateien an: /plugins/Adventskalender/
[![Discord Support](https://img.shields.io/badge/Discord-Support-7289DA?style=for-the-badge&logo=discord)](https://discord.com/invite/FdRs4BRd8D)
*Klicke auf den Button für direkten Support durch die Community!*
</div>
---
## ⚙️ Konfiguration
## 🔧 Technische Details
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.
- **Kompatibilität:** Paper, Spigot, Purpur (1.18.x - 1.21.x)
- **Smart Caching:** Minimale Serverlast durch asynchrone Datenbankaufrufe.
- **Join-Delay:** Update-Meldungen erscheinen erst nach 2 Sekunden, um den Chat-Spam beim Joinen zu umgehen.
---
## 📋 Befehle & Berechtigungen
<div align="center">
### Befehle
*Viper Plugins © 2026 - Effizienz und Magie für deinen Server*
| 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
---
</div>