diff --git a/README.md b/README.md index 771de50..fae42ff 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,65 @@ -# GlobalChat +# GlobalChat Bungee + +Ein leistungsfähiges BungeeCord-Plugin für globalen Chat, Support-Nachrichten und Staff-Kommunikation. + +--- + +## Features + +- Globaler Chat mit Badword-Zensur +- Globaler Mute für den Chat +- `/support ` – Spieler können Support-Nachrichten an das Team senden +- `/reply ` – Staff kann direkt auf Support-Nachrichten antworten +- `/info` – Anzeige von Plugin-Informationen (Name, Version, Autor) +- Einfache Konfiguration der Badwords über `filter.yml` +- Logging aller Nachrichten in `logs/` + +--- + +## Befehle + +| Befehl | Beschreibung | Berechtigung | +|--------------------------|------------------------------------------------------------------|-----------------------| +| `/globalreload` | Lädt die Badword-Liste neu | `globalchat.reload` | +| `/globalmute` | Schaltet den globalen Chat an/aus | `globalchat.mute` | +| `/support ` | Sendet eine Support-Nachricht an das Staff-Team | **Alle Spieler** | +| `/reply ` | Antwortet auf die letzte Support-Nachricht eines Spielers | Staff | +| `/info` | Zeigt Informationen über das Plugin an | **Alle Spieler** | + +--- + +## Installation + +1. Lade die **JAR-Datei** in den `plugins`-Ordner deines BungeeCord-Servers. +2. Starte den Server neu oder lade das Plugin neu. +3. Die Datei `filter.yml` wird automatisch erstellt. Bearbeite sie, um Badwords anzupassen. +4. Optional: Passe die `bungee.yml` an deine Permissions an. + +--- + +## Konfiguration + +### `filter.yml` Beispiel + +```yaml +badwords: + - arsch + - hurensohn + - scheiße + ``` + + Neue Badwords können einfach hinzugefügt werden. Das Plugin muss nach Änderungen neu geladen werden (`/globalreload`). + +--- + +## Logging + +- Alle Chat- und Support-Nachrichten werden in `plugins/GlobalChat/logs/YYYY-MM-DD.log` gespeichert. +- Logs älter als 7 Tage werden automatisch gelöscht. + +--- + +## Lizenz + +Dieses Plugin ist **proprietär** und darf nicht ohne Erlaubnis des Autors verbreitet oder verändert werden.