Files
GlobalChat-Supressor/README.md
2026-01-08 15:23:28 +00:00

125 lines
4.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# GlobalChat Bungee
Ein leistungsfähiges BungeeCord-Plugin für globalen Chat, Support-Nachrichten und Staff-Kommunikation.
---
## ⚠️ WICHTIGER HINWEIS
**Die Kernfunktionalität des GlobalChat wurde in die [StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI) integriert.**
Dieses Plugin (**GlobalChat Suppressor**) dient ab sofort **nur noch als Schnittstelle** für die Unterserver (Spigot/Paper) und leitet die Nachrichten an die StatusAPI weiter. Die Befehle und Funktionen können wie gewohnt weiterverwendet werden.
### Was bedeutet das?
- **StatusAPI MUSS installiert sein:** Ohne die [StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI) auf deinem BungeeCord funktioniert der GlobalChat nicht mehr.
- **GlobalChat Suppressor:** Dieses Plugin bleibt auf den Unterservern aktiv und kommuniziert mit der StatusAPI.
- **Zentrale Verwaltung:** Alle Chat-Funktionen, Badword-Filter und Support-Nachrichten werden nun zentral über die StatusAPI verwaltet.
**Download StatusAPI:** [https://git.viper.ipv64.net/M_Viper/StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI)
---
## Features
- Globaler Chat mit Badword-Zensur (über StatusAPI)
- Globaler Mute für den Chat (über StatusAPI)
- `/support <Nachricht>` Spieler können Support-Nachrichten an das Team senden
- `/reply <Nachricht>` Staff kann direkt auf Support-Nachrichten antworten
- `/info` Anzeige von Plugin-Informationen (Name, Version, Autor)
- Einfache Konfiguration der Badwords über `filter.yml` in der StatusAPI
- Logging aller Nachrichten in `logs/` (StatusAPI)
---
## Befehle
| Befehl | Beschreibung | Berechtigung |
|--------------------------|------------------------------------------------------------------|-----------------------|
| `/globalreload` | Lädt die Badword-Liste neu (StatusAPI) | `globalchat.reload` |
| `/globalmute` | Schaltet den globalen Chat an/aus (StatusAPI) | `globalchat.mute` |
| `/support <Nachricht>` | Sendet eine Support-Nachricht an das Staff-Team | **Alle Spieler** |
| `/reply <Nachricht>` | Antwortet auf die letzte Support-Nachricht eines Spielers | Staff |
| `/info` | Zeigt Informationen über das Plugin an | **Alle Spieler** |
---
## Installation
### Voraussetzung: StatusAPI
⚠️ **Die [StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI) MUSS auf deinem BungeeCord-Server installiert sein!**
```text
BungeeCord/
├─ plugins/
│ ├─ StatusAPI.jar ← PFLICHT
│ └─ GlobalChat-Bungee.jar ← Optional (nur für BungeeCord)
```
### Schritt-für-Schritt
1. **Installiere die [StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI)** auf deinem BungeeCord-Server.
2. Lade die **GlobalChat Suppressor JAR-Datei** in den `plugins`-Ordner deiner **Unterserver** (Spigot/Paper).
3. Starte die Server neu oder lade die Plugins neu.
4. Die Konfiguration erfolgt nun über die **StatusAPI** im BungeeCord.
5. Die Datei `filter.yml` findest du im Ordner der StatusAPI.
---
## Konfiguration
### `filter.yml` (in der StatusAPI)
Die Badword-Liste wird nun zentral in der **StatusAPI** verwaltet:
```yaml
badwords:
- arsch
- hurensohn
- scheiße
```
Neue Badwords können einfach hinzugefügt werden. Das Plugin muss nach Änderungen neu geladen werden (`/globalreload`).
**Speicherort:** `plugins/StatusAPI/filter.yml` auf dem BungeeCord-Server
---
## Logging
- Alle Chat- und Support-Nachrichten werden in der **StatusAPI** unter `plugins/StatusAPI/logs/YYYY-MM-DD.log` gespeichert.
- Logs älter als 7 Tage werden automatisch gelöscht.
---
## Architektur
```text
BungeeCord
└─ StatusAPI (Hauptlogik, Befehle, Filter, Logs)
Unterserver (Spigot/Paper)
└─ GlobalChat Suppressor (Schnittstelle, leitet an StatusAPI weiter)
```
---
## Migration von alter Version
Wenn du eine ältere Version des GlobalChat verwendest:
1. Installiere die neue [StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI) auf BungeeCord
2. Kopiere deine `filter.yml` in den StatusAPI-Ordner
3. Ersetze das alte GlobalChat-Plugin auf den Unterservern mit dem neuen GlobalChat Suppressor
4. Starte alle Server neu
---
## Lizenz
Dieses Plugin ist **proprietär** und darf nicht ohne Erlaubnis des Autors verbreitet oder verändert werden.
---
## Support & Weitere Informationen
Für detaillierte Informationen zur StatusAPI und deren Konfiguration:
**[https://git.viper.ipv64.net/M_Viper/StatusAPI](https://git.viper.ipv64.net/M_Viper/StatusAPI)**