diff --git a/README.md b/README.md index 6ebeed4..8a283b9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,94 @@ -# Team +# TeamPlugin +Ein Minecraft-Plugin für Teamverwaltung, inklusive Team-GUI, Settings-GUI und Backup-Funktion. + +--- + +## Installation + +1. Plugin in den `plugins`-Ordner deines Servers legen. +2. Server starten oder Plugin neu laden. +3. Die `config.yml` anpassen, falls nötig. +4. Optional: Backup-Ordner prüfen (`plugins/TeamPlugin/backups`). + +--- + +## Berechtigungen + +- `teamplugin.admin` – Zugriff auf alle Admin-Befehle und GUI. + +--- + +## Befehle + +### Allgemein für Spieler +| Befehl | Beschreibung | +|--------|-------------| +| `/team` | Öffnet die Team-Übersicht (GUI). Zeigt alle Teams und Mitglieder. | + +### Admin-Befehle +| Befehl | Beschreibung | +|--------|-------------| +| `/team add ` | Fügt einen Spieler einem Rang hinzu. Beispiel: `/team add Viper Leader` | +| `/team del ` | Entfernt einen Spieler aus allen Rängen. Beispiel: `/team del Viper` | +| `/team settings` | Öffnet das Settings-GUI: Ränge bearbeiten, Plugin neu laden, Backup erstellen. | +| `/team backup` | Erstellt ein Backup der aktuellen `data.yml`. Beispiel: `data-backup-2025-10-05T16-00-00.yml` | +| `/team restore ` | Stellt ein Backup wieder her. Beispiel: `/team restore data-backup-2025-10-05T16-00-00.yml` | +| `/team backups` | Zeigt alle Backups. Konsole: Liste im Chat. Spieler: Öffnet Backup-GUI. | + +--- + +## Features + +- Team-Übersicht mit GUI. +- Settings-GUI für Admin-Funktionen. +- Vollständig anpassbare Ränge über `config.yml`. +- Spieler-Join-Daten werden gespeichert (falls aktiviert). +- Backup- und Wiederherstellungs-Funktion mit GUI. +- Verhindert, dass Items aus den GUIs entnommen werden. + +--- + +## Konfiguration (`config.yml`) + +- `ranks`: Liste aller Team-Ränge. +- `backup.enabled`: Backup-Funktion aktivieren (true/false). +- `backup.folder`: Ordner für Backups. +- `backup.keep`: Anzahl der Backups, die behalten werden. +- `storeJoinDate`: Spieler-Beitrittsdatum speichern (true/false). +- `gui.size`: Inventargröße der Team-GUI. +- `gui.title`: Titel der Team-GUI. +- `gui.background`: Hintergrund-Material der Team-GUI. + +--- + +## Langdatei (`lang.yml`) + +- Alle Nachrichten und Tooltips sind über `lang.yml` anpassbar. +- Beispiel-Einträge: +```yaml +prefix: "§8[§bTeam§8] §7" +no_permission: "%prefix%§cDazu hast du keine Berechtigung!" +only_player: "%prefix%§cNur Spieler können diesen Befehl benutzen!" +unknown_command: "%prefix%§cUnbekannter Befehl." +player_added: "%prefix%§a%player% wurde zu %rank% hinzugefügt!" +player_removed: "%prefix%§a%player% wurde entfernt!" +team_gui_title: "%prefix%§bTeam Übersicht" +settings_gui_title: "%prefix%§cTeam Einstellungen" +backup_created: "%prefix%§aBackup erstellt: %file%" +backup_restore_success: "%prefix%§aBackup wiederhergestellt: %file%" +backup_not_found: "%prefix%§cBackup nicht gefunden: %file%" +backups_list_title: "%prefix%§bVerfügbare Backups:" +no_backups: "%prefix%§7Keine Backups vorhanden." +``` +--- + +## Hinweise + +- Backups werden automatisch sortiert und alte Backups nach `backup.keep` gelöscht. +- GUI verhindert Item-Diebstahl. +- Ränge müssen in der `config.yml` definiert sein. + +## Kontakt / Support + +Für Fragen oder Fehlerberichte erstelle ein Issue.