M_Viper/StatusAPI
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 14 Wiki Activity

README.md aktualisiert

Browse Source
This commit is contained in:
M_Viper
2026-05-21 21:18:31 +00:00
parent 9b3346c99d
commit 7fefde51fd
1 changed files with 61 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@@ -28,6 +28,7 @@ StatusAPI ist ein umfassendes BungeeCord-Plugin, das als zentrale Schaltstelle f
- [4.14 EconomyModule](#414-economymodule)
- [4.15 StatsModule](#415-statsmodule)
- [4.16 CustomCommandModule](#416-customcommandmodule)
- [4.17 HelpModule](#417-helpmodule)
5. [HTTP-API](#5-http-api)
6. [Globales Rate-Limit-Framework](#6-globales-rate-limit-framework)
7. [Update-Checker](#7-update-checker)
@@ -77,7 +78,7 @@ Alle Konfigurationsdateien befinden sich unter `/plugins/StatusAPI/` und werden
| Datei | Zuständig für |
|---|---|
| `verify.properties` | **Hauptkonfiguration** – Port, Server-Definitionen, WordPress/Forum-Anbindung, Economy-Datenbank, AutoMessage, CommandBlocker, Broadcast, BackendGuard |
| `verify.properties` | **Hauptkonfiguration** – Port, Server-Definitionen, WordPress/Forum-Anbindung, Economy-Datenbank, AutoMessage, CommandBlocker, Broadcast, BackendGuard, HelpModule |
| `chat.yml` | Alle Chat-Einstellungen: Kanäle, Filter, Private Nachrichten, Discord/Telegram-Bridge, Emoji, Rate-Limit, Mute, Reports, Join/Leave-Nachrichten, Mentions |
| `filter.yml` | Zusätzliche Wort-Blacklist für den Chat-Filter (ergänzt `chat.yml`, beide Listen werden zusammengeführt) |
| `scoreboard.properties` | Scoreboard-Layout, Zeilen, Platzhalter, Animationen, Regenbogen, News-Ticker |
@@ -841,6 +842,52 @@ Zusätzlich registriert das Modul automatisch den Befehl `/chat`, der es Spieler
---
### 4.17 HelpModule
Das HelpModule stellt eine vollständige, seitenbasierte Ingame-Hilfe bereit. Der Befehlsname ist frei konfigurierbar – normale Spieler sehen nur allgemeine Befehle, Admins und OPs erhalten zusätzlich alle Admin-Seiten.
**Konfiguration in `verify.properties`:**
```properties
# ===========================
# INGAME HILFE
# ===========================
# Befehlsname für die Ingame-Hilfe (Standard: help)
# Beispiele:
# statusapi.help=vn → /vn help
# statusapi.help=sapi → /sapi help
statusapi.help=help
# Permission, die Admin-Seiten in der Hilfe freischaltet
# (OPs sehen die Admin-Seiten automatisch)
statusapi.help.permission=statusapi.admin
```
**Verwendung:**
| Eingabe | Ergebnis |
|---|---|
| `/<befehl>` | Kurzer Hinweis auf `/<befehl> help` |
| `/<befehl> help` | Hilfe – Seite 1 |
| `/<befehl> help 2` | Hilfe – Seite 2 |
| `/<befehl> help 3` | Seite 3 (nur für Admins / OP sichtbar) |
| `/<befehl> help 4` | Seite 4 (nur für Admins / OP sichtbar) |
**Seitenaufteilung:**
| Seite | Inhalt | Sichtbar für |
|---|---|---|
| 1 | Allgemein, Chat (Teil 1) | Alle Spieler |
| 2 | Chat (Teil 2), Account-Verknüpfungen | Alle Spieler |
| 3 | Admin: StatusAPI, AntiBot, Vanish | Nur Admins / OP |
| 4 | Admin: Chat-Administration, Reports, Tools | Nur Admins / OP |
> Die Navigations-Buttons **◀** und **▶** am Ende jeder Seite sind klickbar – Spieler können direkt im Chat blättern, ohne den Befehl erneut einzugeben.
> **Hinweis:** Der Befehlsname wird nur beim Serverstart registriert. Eine Änderung von `statusapi.help` erfordert einen vollständigen Serverneustart – ein `/statusapi reload` reicht hier nicht.
---
## 5. HTTP-API
StatusAPI startet einen eigenen HTTP-Server auf dem in `verify.properties` konfigurierten Port (Standard: `9191`). Der Server läuft in einem eigenen Thread mit 4 Worker-Threads und wird automatisch neugestartet, wenn er unerwartet stoppt (Watchdog-Task alle 15 Sekunden).
@@ -963,6 +1010,14 @@ StatusAPI prüft automatisch alle 6 Stunden, ob eine neue Version verfügbar ist
| `/cb remove <befehl>` | – | `commandblocker.admin` | Befehl entsperren |
| `/cb reload` | – | `commandblocker.admin` | CommandBlocker neu laden |
### Ingame-Hilfe
| Befehl | Aliases | Permission | Beschreibung |
|---|---|---|---|
| `/<befehl> help [seite]` | – | – | Ingame-Hilfe anzeigen (Befehlsname via `statusapi.help` in `verify.properties` konfigurierbar) |
> Admin-Seiten (Seite 3 & 4) sind nur für OPs und Spieler mit der unter `statusapi.help.permission` konfigurierten Permission sichtbar.
### Chat-Befehle
| Befehl | Aliases | Permission | Beschreibung |
@@ -1213,4 +1268,8 @@ Die Anzahl der Spalten wird durch `tab-list-size` in der BungeeCord `config.yml`
**VPN/Proxy-Check blockiert zu viele legitime Spieler**
Reduziere die Scoring-Punkte für VPN/Proxy-Treffer oder erhöhe den `antibot.learning.score_threshold`. Alternativ: `antibot.vpn_check.block_hosting=false` setzen, da viele legitime Nutzer über Cloud-Anbieter spielen.
Reduziere die Scoring-Punkte für VPN/Proxy-Treffer oder erhöhe den `antibot.learning.score_threshold`. Alternativ: `antibot.vpn_check.block_hosting=false` setzen, da viele legitime Nutzer über Cloud-Anbieter spielen.
**Die Ingame-Hilfe zeigt den falschen Befehlsnamen**
Den Wert von `statusapi.help` in `verify.properties` anpassen und den Server **neu starten**. Ein `/statusapi reload` reicht nicht – Befehle werden nur beim Serverstart registriert.