From b823901337894dd3f311eb36cef57c75a730108f Mon Sep 17 00:00:00 2001 From: M_Viper Date: Sat, 26 Jul 2025 19:48:47 +0000 Subject: [PATCH] README.md aktualisiert --- README.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 92 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 881d4e7..b1b9eb7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,93 @@ -# Minecraft-TpPlugin +# TpPlugin +Ein einfaches Minecraft Bukkit/Spigot Plugin zum Verwalten von Teleport-Punkten (TPs) per Befehl und GUI. + +--- + +## Übersicht + +TpPlugin ermöglicht es Spielern, sich an vordefinierte Orte zu teleportieren, die von Administratoren gesetzt werden können. Es unterstützt eine konfigurierbare GUI, die Anzeige von Teleportpunkten sowie das Speichern der TPs in einer YAML-Datei. + +--- + +## Funktionen + +- Setzen, Löschen und Teleportieren zu Teleportpunkten via Befehle +- GUI für die Teleportauswahl +- Speicherung von TP-Standorten und zugehörigen Items in `tps.yml` +- Konfigurierbare Standard-Items und Nachrichten in `config.yml` +- Farbige und mehrsprachige Nachrichten +- Rechte-System für Nutzer- und Adminbefehle + +--- + +## Befehle + +| Befehl | Beschreibung | Berechtigung | +|-----------------|------------------------------------|----------------------| +| `/tp` | Öffnet die GUI oder teleportiert | `tpplugin.use` | +| `/tp ` | Teleportiert zu einem TP | `tpplugin.use` | +| `/settp ` | Setzt einen neuen TP am aktuellen Standort | `tpplugin.admin` | +| `/deltp ` | Löscht einen bestehenden TP | `tpplugin.admin` | + +--- + +## Installation + +1. Lade die neueste Version der `TpPlugin.jar` herunter. +2. Kopiere die `.jar`-Datei in den `plugins`-Ordner deines Spigot- oder Bukkit-Servers. +3. Starte den Server neu oder lade das Plugin mit `/reload`. +4. Die `config.yml` und `tps.yml` werden automatisch erstellt. +5. Konfiguriere ggf. `config.yml` nach deinen Wünschen. + +--- + +## Konfiguration (`config.yml`) + +```yaml +version: 1.3.3 +prefix: '&7[&bTpPlugin&7] ' +default-item: OAK_SIGN +sign: + line1-color: '&1' + line2-color: '&6' + line3-text: 'Teleport' + line4-text: 'Klick mich!' +messages: + player-only: '&cDieser Befehl ist nur für Spieler!' + no-permission-use: '&cDu hast keine Berechtigung, diesen Befehl zu benutzen!' + no-permission-admin: '&cDu hast keine Berechtigung für diesen Befehl!' + teleport-success: '&aDu wurdest zu %tp% teleportiert!' + tp-not-found: '&cDer Teleportpunkt %tp% wurde nicht gefunden!' + settp-success: '&aTeleportpunkt %tp% wurde gesetzt!' + deltp-success: '&aTeleportpunkt %tp% wurde gelöscht!' + config-error: '&cEin Fehler ist in der Konfiguration aufgetreten!' + +## Berechtigungen + +| Berechtigung | Beschreibung | +|------------------|------------------------------------| +| `tpplugin.use` | Nutzung der Teleportbefehle | +| `tpplugin.admin` | Setzen und Löschen von Teleportpunkten | + +--- + +## Support + +Für Fehlerberichte, Feature-Anfragen oder Fragen erstelle bitte ein Issue auf GitHub. + +--- + +## Lizenz + +Dieses Plugin ist unter der MIT-Lizenz lizenziert. Details siehe LICENSE-Datei. + +--- + +## Autor + +M_Viper + +--- + +**Viel Spaß beim Teleportieren!**