diff --git a/README.md b/README.md index 205d765..fc61987 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,131 @@ -# Survival-Plus +# 🧩 SurvivalPlus +**Version:** 1.0.0 +**Autor:** M_Viper +**API-Version:** 1.21 +**Beschreibung:** +*SurvivalPlus* ist ein umfangreiches Minecraft-Plugin zur Verbesserung des Survival-Gameplays. Es bietet eine Vielzahl an Features, die sowohl Komfort als auch Schutzfunktionen abdecken. Alle Nachrichten sind vollständig über die `lang.yml`, und viele Funktionen über die `config.yml` konfigurierbar. + +--- + +## ✨ Features + +### 🛏 Schlaf-Mehrheitssystem +- Überspringt die Nacht, wenn ein konfigurierbarer Prozentsatz der Spieler schläft. + +### 🧍 Anti-AFK-System +- Erkennt Inaktivität durch Bewegung und Klicks. +- Kickt Spieler nach einer bestimmten Zeit automatisch. +- Ideal zur Vermeidung von AFK-Farmen. + +### 📊 Spielerstatistiken +- Befehl: `/stats` +- Zeigt Spielzeit, Tode, Kills, platzierte & abgebaut Blöcke. +- Speicherung in `stats.yml`. + +### 🏠 Home-System +- Setzen, Löschen und Verwalten von Homes. +- GUI mit `/homelist`. +- Unbegrenzte Homes mit entsprechender Permission. + +### 👥 Freundesystem +- Verwaltung über `/friend` (add, del, list, tp). +- Erlaubt Teleport zu Freunden. +- Unterstützt Locks und private Objekte. + +### 🧭 Teleportsystem +- `/tp`, `/tphere` für direkte Teleports. +- `/tpa`, `/tpaccept`, `/tpdeny` für Anfragen. +- `/back` zum letzten Todespunkt. + +### 📦 Inventar-Tools +- `/inv`, `/ec`, `/trash`, `/workbench`, `/anvil`. +- Zugriff auf eigene oder fremde Inventare (mit Rechten). + +### 🔒 Lock-System +- Kisten, Türen & Container sperren. +- Verwaltung mit `/lock` und Freundesfreigabe. + +### 🛡 Anti-Grief Spawn-Schutz +- Konfigurierbare Schutz-Zone rund um den Spawn. +- Schutz vor PvP, Blockabbau und -platzierung. +- Ideal für friedliche oder Anfängerbereiche. + +### 📋 Admin- und Komfortfunktionen +- `/clearchat`, `/clearitems`, `/closedoors`, `/setspawn`. +- Sichtbarmachen & Entfernen von Debug-Armor Stands. +- Anzeige geleinter Tiere im Chunk mit `/leashcount`. + +--- + +## ⚙ Konfiguration + +- **`config.yml`** + - Schlafsystem + - AFK-Zeit + - Teleport-Cooldowns + - Schutzzonen + +- **`lang.yml`** + - Alle Nachrichten + - Unterstützt Farb- und Formatcodes (§, &#...) + +--- + +## 🔐 Rechteverwaltung (Permissions) + +- Granulare Rechte für jedes Feature. +- Adminzugriff über `survivalplus.*`. + +Beispiel: + +```yaml +survivalplus.homes.set: true +survivalplus.stats: true +survivalplus.gamemode.others: op +``` + +## 📜 Befehle (Auszug) + +| Befehl | Beschreibung | +|---------------------------------------|---------------------------------------| +| `/home`, `/sethome`, `/delhome` | Home-System | +| `/friend` | Freundeverwaltung | +| `/tp`, `/tphere`, `/tpa`, ... | Teleport-System | +| `/back` | Zum letzten Todespunkt zurückkehren | +| `/inv`, `/ec`, `/trash`, `/workbench` | Komfort-Inventare | +| `/clearchat`, `/clearitems` | Admin-Tools | +| `/stats` | Zeigt persönliche Statistiken | +| `/lock`, `/unlock` | Kisten & Türen schützen | + +--- + +## 🔁 Plugin-Neuladen + +Mit `/sp reload` werden alle Konfigurationsdateien neu geladen. +Manager, Listener und Tasks werden korrekt aktualisiert. + +--- + +## 📂 Dateistruktur + +```plaintext +/plugins/SurvivalPlus/ +├── config.yml # Einstellungen (AFK, Schlaf, Schutz, etc.) +├── lang.yml # Nachrichten & Texte +├── stats.yml # Spielerstatistiken +├── homes.yml # Homepunkte der Spieler +└── locks.yml # Schutzdaten für Kisten/Türen +``` + +## ✅ Abhängigkeiten + +Keine externen Abhängigkeiten notwendig. +Optional kompatibel mit [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/). + +--- + +## 📬 Support + +Du hast Fragen, Ideen oder Bugs gefunden? +→ Eröffne ein [Issue](https://github.com/dein-name/SurvivalPlus/issues) oder kontaktiere mich direkt.