diff --git a/readme.md b/readme.md index 98accca..54390cc 100644 --- a/readme.md +++ b/readme.md @@ -5,102 +5,181 @@ ![Author](https://img.shields.io/badge/author-M_Viper-yellow) **SurvivalPlus** ist ein Minecraft-Plugin zur Verbesserung des Survival-Erlebnisses. -Es bietet Homes, Teleportation, Inventarverwaltung, Freundeslisten, Shops, Loot-Kisten und weitere Komfortbefehle. +Es bietet Homes, Teleports, Inventar-/Enderchest-Verwaltung, Claims (Anti-Grief), Freundeslisten, Shop-System, Loot-Kisten, Tablist-Anpassungen und viele Komfort-Utilities. --- -## ⚡ Features +## ⚡ Highlights / Features -- **Homes & Warps** – Homepunkte setzen, löschen, Teleportation, persönliche Warps -- **Teleportation & Spielerinteraktion** – `/tp`, `/tphere`, `/tpa`, `/back`, `/spawn` -- **Inventar & Endertruhe** – Öffnen eigener und fremder Inventare/Endertruhen -- **Spielmodus & Zeit** – `/gm`, `/day`, `/night` -- **Freundes- und Kommunikationssystem** – `/friend`, `/block`, `/blocklist` -- **Koordinaten teilen** – `/sp share`, `/sp shareconfirm`, `/sp sharecancel` -- **Items & Werkzeuge** – `/ir`, `/workbench`, `/anvil`, `/kit` -- **Server-Management** – `/clearchat`, `/clearitems`, `/closedoors`, `/lock`, `/shop` -- **Statistiken & Reporting** – `/stats`, `/report`, `/showreport`, `/clearreport` -- **Fun & Challenges** – `/sit`, `/startchallenge`, `/trade`, `/lootchests` +- Homes & Warps (persönliche Warps, Home-Management) +- Teleportation & Anfrage-System (`/tpa`, `/tpaccept`, `/tpdeny`) +- Claim-System zur Land-Sicherung (trust/untrust, create/delete, info, list) +- Inventar- & Enderchest-Verwaltung (öffnen von Fremd-Inventaren, Admin-Tools) +- Shop-System & Lootchests (Verwaltung, Teleport zu Lootchests) +- CommandBlocker & Server-Utilities (clearchat, clearitems, closedoors, lock) +- Debug-Logging (optionale `debug-logging` in config, Debug/debug.log & Debug/console.log) +- Tablist (animiert / konfigurierbar über `tablist.yml`) +- bStats Unterstützung (Statistiken) --- -## 🛠 Commands Übersicht +## 🛠 Komplette Befehlsübersicht + +> Hinweis: In `plugin.yml` sind alle Commands definiert — hier die Übersicht gruppiert nach Kategorie. + +### Allgemein / Haupt +| Befehl | Nutzung | Permission | +|---|---:|:---| +| `/sp` | Hauptbefehl (CommandBlocker, reload, info, share, help u.v.m.) | `survivalplus.sp` | +| `/help` (alias über `/sp help`) | Hilfe / Übersicht | `survivalplus.sp` | + +### Item & Utility +| Befehl | Usage | Permission | +|---|---:|:---| +| `/ir ` | Item umbenennen (Item in Hand) | `survivalplus.itemrename` | +| `/workbench` | Öffnet Werkbank-GUI | `survivalplus.workbench` | +| `/anvil` | Öffnet Amboss-GUI | `survivalplus.anvil` | +| `/trash` | Öffnet Mülleimer | `survivalplus.trash` | +| `/showarmorstands` | Alle (debug) ArmorStands sichtbar machen | `survivalplus.showarmorstands` | +| `/cleardebugarmorstands` | Entfernt Debug-ArmorStands | `survivalplus.cleardebugarmorstands` | +| `/leashcount` | Anzahl geleinter Tiere anzeigen | `survivalplus.leashcount` | +| `/nick ` | Nickname ändern (Farben/Hex möglich) | `survivalplus.nick` | ### Teleportation -| Befehl | Nutzung | Permission | -|--------|---------|------------| -| `/tp` | Teleport zu Spieler | `survivalplus.tp` | -| `/tphere` | Spieler zu dir teleportieren | `survivalplus.tphere` | -| `/tpa` | Teleportanfrage senden | `survivalplus.tpa` | +| Befehl | Usage | Permission | +|---|---:|:---| +| `/tp ` | Teleport zu Spieler | `survivalplus.tp` | +| `/tphere ` | Teleportiert Spieler zu dir | `survivalplus.tphere` | +| `/tpa ` | Teleportanfrage senden | `survivalplus.tpa` | | `/tpaccept` | Teleportanfrage annehmen | `survivalplus.tpaccept` | | `/tpdeny` | Teleportanfrage ablehnen | `survivalplus.tpdeny` | -| `/back` | Zum letzten Todespunkt | `survivalplus.back` | -| `/spawn` | Weltspawn teleport | `survivalplus.spawn` | +| `/back` | Zum letzten Todespunkt teleportieren | `survivalplus.back` | +| `/spawn` | Teleport zum Weltspawn | `survivalplus.spawn` | +| `/setspawn` | Setzt Server-Spawn | `survivalplus.setspawn` | +| `/setworldspawn` | Setzt Weltspawn (aktuelle Welt) | `survivalplus.setworldspawn` | ### Homes & Warps -| Befehl | Nutzung | Permission | -|--------|---------|------------| -| `/sethome ` | Home setzen | `survivalplus.homes.set` | -| `/delhome ` | Home löschen | `survivalplus.homes.delete` | +| Befehl | Usage | Permission | +|---|---:|:---| +| `/sethome ` | Setzt Home | `survivalplus.homes.set` | +| `/delhome ` | Löscht Home | `survivalplus.homes.delete` | | `/home ` | Teleport zu Home | `survivalplus.homes` | -| `/homelist` | Liste aller Homes | `survivalplus.homes.list` | -| `/setwarp ` | Persönlichen Warp setzen | `survivalplus.setwarp` | +| `/homelist` | GUI mit Homes öffnen | `survivalplus.homes.list` | +| `/setwarp ` | Persönlichen Warp setzen (Item in Hand) | `survivalplus.setwarp` | | `/delwarp ` | Persönlichen Warp löschen | `survivalplus.delwarp` | | `/warps` | GUI aller Warps öffnen | `survivalplus.warps` | -### Spieler & Kommunikation -| Befehl | Nutzung | Permission | -|--------|---------|------------| -| `/friend` | Freundesliste verwalten | `survivalplus.friend` | -| `/block` | Spieler blockieren | `survivalplus.block` | -| `/unblock` | Blockierung aufheben | `survivalplus.unlock` | -| `/blocklist` | Liste blockierter Spieler | `survivalplus.blocklist` | +### Claim (Anti-Grief) +| Befehl | Usage | Permission | +|---|---:|:---| +| `/claim [unclaim | trust | untrust ]` | Claim-Management (Trust/Untrust/Unclaim) | `survivalplus.claim.use` | +| (Aliases: `cl`) | | | +| `/claim create ` (falls implementiert) | Neues Claim anlegen | `survivalplus.claim.use` | +| `/claim delete ` (falls implementiert) | Claim löschen | `survivalplus.claim.use` | +| `/claim addmember ` | Spieler zum Claim hinzufügen | `survivalplus.claim.trust` | +| `/claim removemember ` | Spieler entfernen | `survivalplus.claim.trust` | +| `/claim info` | Claim-Informationen anzeigen | `survivalplus.claim.use` | +| `/claim list` | Eigene Claims auflisten | `survivalplus.claim.use` | -### Items & Werkzeuge -| Befehl | Nutzung | Permission | -|--------|---------|------------| -| `/ir ` | Item umbenennen | `survivalplus.itemrename` | -| `/workbench` | Werkbank GUI öffnen | `survivalplus.workbench` | -| `/anvil` | Amboss GUI öffnen | `survivalplus.anvil` | -| `/kit` | Starterkit erhalten | `survivalplus.kit` | -| `/leashcount` | Anzahl geleinter Tiere | `survivalplus.leashcount` | -| `/nick ` | Nickname ändern | `survivalplus.nick` | - -### Server-Management -| Befehl | Nutzung | Permission | -|--------|---------|------------| +### CommandBlocker / Server-Management +| Befehl | Usage | Permission | +|---|---:|:---| +| `/sp cb add ` | Befehl zur Blockliste hinzufügen | `survivalplus.commandblocker.add` | +| `/sp cb remove ` | Befehl entfernen | `survivalplus.commandblocker.remove` | +| `/sp cb list` | Blockierte Befehle anzeigen | `survivalplus.commandblocker.list` | | `/clearchat` | Chat löschen | `survivalplus.clearchat` | -| `/clearitems` | Items entfernen | `survivalplus.clearitems` | -| `/closedoors ` | Türen schließen | `survivalplus.closedoors` | -| `/lock` | Container schützen | `survivalplus.lock` | -| `/shop add ` | Server-Shop verwalten | `survivalplus.shop` | +| `/clearitems` | Items aufsammeln/entfernen | `survivalplus.clearitems` | +| `/closedoors ` | Türen in Radius schließen | `survivalplus.closedoors` | +| `/splock lock|unlock|friendadd|friendremove [player]` | Kisten/Türen sperren / freigeben | `survivalplus.lock` | -### Statistiken & Reporting -| Befehl | Nutzung | Permission | -|--------|---------|------------| -| `/stats` | Spielerstatistiken | `survivalplus.stats` | -| `/report [grund]` | Spieler melden | `survivalplus.report` | -| `/showreport ` | Reports anzeigen | `survivalplus.report.show` | -| `/clearreport ` | Reports löschen | `survivalplus.report.clear` | +### Shop, Loot & Trade +| Befehl | Usage | Permission | +|---|---:|:---| +| `/shop add ` | Shop verwalten | `survivalplus.shop` | +| `/lootchests` | Listet Loot-Kisten auf (Admins teleportieren) | `survivalplus.lootchests` | +| `/tploot ` | Teleportiere zu Loot-Kiste (Admin) | `survivalplus.lootchests` | +| `/trade ` | Startet Handel | `survivalplus.trade` | +| `/tradeaccept ` | Akzeptiert Handel | `survivalplus.tradeaccept` | + +### Zeit, Gamemode & Admin +| Befehl | Usage | Permission | +|---|---:|:---| +| `/day` | Setzt Zeit auf Tag | `survivalplus.day` | +| `/night` | Setzt Zeit auf Nacht | `survivalplus.night` | +| `/gm [spieler]` (alias `gamemode`) | Spielmodus ändern | `survivalplus.gamemode` | +| `/heal [spieler]` | Heilt Spieler (oder andere) | `survivalplus.heal`, `survivalplus.heal.others` | + +### Freundes-, Block- & Report-System +| Befehl | Usage | Permission | +|---|---:|:---| +| `/friend [add|accept|deny|list|del|tp] [Spieler]` | Freundschaften verwalten | `survivalplus.friend` | +| `/block ` | Spieler blockieren | `survivalplus.block` | +| `/unblock ` | Unblock | `survivalplus.unblock` | +| `/blocklist` | Blockierte Spieler anzeigen | `survivalplus.blocklist` | +| `/report [Grund]` | Spieler melden | `survivalplus.report` | +| `/showreport ` | Reports anzeigen | `survivalplus.report.show` | +| `/clearreport ` | Reports löschen | `survivalplus.report.clear` | + +### Sonstiges +| Befehl | Usage | Permission | +|---|---:|:---| +| `/stats` | Spielerstatistiken anzeigen | `survivalplus.stats` | +| `/kit` | Starterkit erhalten | `survivalplus.kit` | +| `/startchallenge ` | Fun-Challenge starten | `survivalplus.startchallenge` | +| `/lootchests` | Übersicht über Lootkisten | `survivalplus.lootchests` | + +--- + +## 🔐 Permissions (Kurzüberblick) +Vollständige Permission-Deklaration findest du in `plugin.yml`. +Wichtige Permissions: + +- `survivalplus.*` — Vollzugriff (OP) +- `survivalplus.sp` — Zugriff auf `/sp` (Hauptbefehl) +- `survivalplus.homes.*` — Homes verwalten +- `survivalplus.claim.use` / `survivalplus.claim.trust` — Claim-Management & Trust +- `survivalplus.shop` — Shopverwaltung +- `survivalplus.lootchests` — Lootchest-Adminrechte +- `survivalplus.notify` — Admin-Benachrichtigung bei Besitz von Command/Structure-Blocks +- uvm. — siehe `plugin.yml` für die vollständige Liste --- ## ⚙ Installation -1. Lade die aktuelle `.jar` Datei herunter. -2. Kopiere sie in den `plugins`-Ordner deines Servers. -3. Starte den Server neu oder nutze `/reload`. -4. Stelle sicher, dass **LuckPerms** und **PlaceholderAPI** installiert sind. +1. Baue das Plugin (z. B. `mvn clean package`) und kopiere die erzeugte `SurvivalPlus-*.jar` nach `plugins/`. +2. Erstelle (falls nicht automatisch) den Ordner `plugins/SurvivalPlus/` und prüfe die erzeugten Configs. +3. Starte den Server neu oder lade neu mit `/reload` (Neustart empfohlen). +4. Abhängigkeiten: **LuckPerms** (empfohlen), **PlaceholderAPI** (optional, für Prefixes/Nick-Placeholders). --- -## 🔐 Permissions +## ⚙ Konfiguration / Wichtige Optionen -- **Vollzugriff:** `survivalplus.*` (OP) -- Alle Befehle können über LuckPerms angepasst werden. +- `config.yml` — Hauptkonfiguration (bei erstem Start wird `saveDefaultConfig()` verwendet). + - `version:` — wird automatisch mit der Plugin-Version aus `plugin.yml` synchronisiert. + - `debug-logging: false` — wenn `true`, werden zusätzliche Fehler in `plugins/SurvivalPlus/Debug/debug.log` geschrieben und die komplette Konsole in `plugins/SurvivalPlus/Debug/console.log` (nützlich für Bug-Reports). + +- `lang.yml` / `help.yml` / `tablist.yml` — werden beim Start geprüft und erhalten eine `version:`-Zeile oben; bestehende Inhalte bleiben erhalten (nur Version wird aktualisiert). + +--- + +## 🐞 Debug & Fehlerberichte + +- Aktiviere in `config.yml` `debug-logging: true` wenn du Probleme hast. + - `Debug/debug.log` — enthält Plugin-Fehler/Stacktraces (nur wenn aktiviert). + - `Debug/console.log` — dupliziert den Konsolenoutput (komplette Ausgabe), damit du diesen als Datei an Entwickler schicken kannst. + +--- + +## 📦 Changelog / Versionierung +Die Versionsnummer des Plugins wird aus `plugin.yml` gelesen (z. B. `version: 1.0.9`). Bei jedem Start wird diese Version in `config.yml`, `lang.yml`, `help.yml` und `tablist.yml` eingetragen bzw. aktualisiert (ganz oben). + +--- + +## 📜 Lizenz & Kontakt +Dieses Projekt ist frei für den privaten Gebrauch. Für Fragen, Bug-Reports oder Feature-Wünsche: **M_Viper** (Repo-Owner / Gitea). --- -## 📜 Lizenz -Dieses Projekt ist frei für den privaten Gebrauch. Kontakt: **M_Viper**