diff --git a/README.md b/README.md index 771de50..09ce4db 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,95 @@ -# GlobalChat +# GlobalChat 🌍 +Ein leistungsstarkes und modernes BungeeCord-Plugin für einen globalen Chat, Badword-Filter, Support-System und Server-Wechsel-Ankündigungen. Entwickelt für 1.19+ mit vollem Support für Secure Chat. + +## ✨ Features + +* **Secure Chat Support (1.19+)**: Verhindert "Invalid Signature" oder "Broken Chain" Fehler durch einen intelligenten Relay-Modus. +* **Server-Aliase & Farben**: Definieren Sie farbige Anzeigenamen für Ihre Server direkt in der `bungee.yml`. +* **Toggle-Chat Modus**: Spieler können den globalen Chat deaktivieren (`/togglechat`), um Chat-Eingaben für Plugins wie Lands oder Quests zu nutzen. +* **Badword-Filter**: Automatisches Filtern von Schimpfwörtern (konfigurierbar über `filter.yml`). +* **Support-System**: Spieler können das Team über `/support` kontaktieren. +* **Server-Wechsel**: Automatische Ankündigungen, wenn ein Spieler den Server wechselt. +* **LuckPerms Integration**: Zeigt Prefix und Suffix der Spieler an (optional). +* **Logs**: Detaillierte Chat-Logs, die ältere Einträge automatisch löschen. + +## 📦 Installation + +### Voraussetzungen + +⚠️ **Wichtig**: Dieses Plugin benötigt den **GlobalChat Suppressor** auf allen Spigot/Paper Servern! + +**Download**: [GlobalChat-Suppressor](https://git.viper.ipv64.net/M_Viper/GlobalChat-Supressor) + +### Installationsschritte + +1. **Laden Sie die Dateien herunter**: + * `GlobalChat-1.1.jar` → In den `plugins`-Ordner von **BungeeCord**. + * `GlobalChatSuppressor-1.0.0.jar` → In den `plugins`-Ordner **aller** Spigot/Paper Server. + +2. **Starten Sie die Server neu**. + +3. Die Konfigurationsdateien (`bungee.yml`, `filter.yml`, `welcome.yml`) werden automatisch erstellt. + +## ⚙️ Konfiguration + +### Server Aliase (farbige Servernamen) + +Fügen Sie ganz unten in Ihrer `plugins/bungee.yml` den Abschnitt `server-aliases` hinzu. Dies steuert, wie Server im Chat angezeigt werden. +```yaml +# plugins/bungee.yml +server-aliases: + # Format: interner-server-name: "&farbeAnzeigename" + lobby: "&aLobby" + survival: "&2Survival" + bedwars: "&cBedwars" + skyblock: "&bSkyblock" +``` + +### Badword Filter + +Bearbeiten Sie die `plugins/GlobalChat/filter.yml`: +```yaml +badwords: + - arsch + - depp + - scheiße + # Fügen Sie hier beliebig viele Wörter hinzu +``` + +### Willkommensnachrichten + +Bearbeiten Sie die `plugins/GlobalChat/welcome.yml` (Optional). + +## 🚀 Commands + +| Befehl | Beschreibung | Berechtigung | +|--------|--------------|--------------| +| `/togglechat` | Schaltet den globalen Chat für den Spieler ein/aus (wichtig für Lands/Quests). | Spieler | +| `/support ` | Sendet eine Anfrage an das gesamte Team. | Spieler | +| `/reply ` | Antwortet auf eine Support-Anfrage. | Spieler | +| `/globalmute` | Aktiviert/Deaktiviert den globalen Chat. | `globalchat.mute` | +| `/globalreload` | Lädt den Filter und Server-Aliase neu. | `globalchat.reload` | +| `/info` | Zeigt Plugin-Informationen an. | Spieler | + +## 🔧 Permissions + +| Permission | Standard | Beschreibung | +|------------|----------|--------------| +| `globalchat.reload` | OP | Erlaubt das Neuladen der Konfiguration. | +| `globalchat.mute` | OP | Erlaubt das Schalten des globalen Mutes. | +| `globalchat.bypass` | OP | Erlaubt das Schreiben trotz globalem Mute. | + +## ℹ️ Technical Info (Secure Chat Fix) + +Dieses Plugin nutzt einen sogenannten **Relay-Modus**. Um die Warnung "Chat disabled due to broken chain" bei Minecraft 1.19+ zu vermeiden, werden Chat-Nachrichten nicht direkt an die Spieler gesendet, sondern als JSON-Packet an alle Backend-Server weitergeleitet. Das Spigot-Addon (`GlobalChatSuppressor`) empfängt diese Packete und sendet sie lokal an die Spieler aus. Das garantiert eine störungsfreie Chat-Erfahrung. + +**Daher ist der GlobalChat Suppressor auf allen Spigot/Paper Servern zwingend erforderlich!** + +## 👨‍💻 Autor + +Entwickelt von **M_Viper** + +## 🔗 Links + +* [GlobalChat Suppressor Download](https://git.viper.ipv64.net/M_Viper/GlobalChat-Supressor) \ No newline at end of file