README.md aktualisiert
This commit is contained in:
75
README.md
75
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
  
|
||||
|
||||
**TicketSystem** ist das flexible, moderne Support- und Feedback-Plugin für Minecraft-Server (Spigot/Paper 1.18.x–1.21.x, Java 17+). Es bietet flexible Speicherung, automatische Backups & Migration, Export/Import, Statistiken, dynamische GUI, Kategorie- und Prioritäten-System, Bewertungs- und Kommentar-System, **FAQ-System**, Discord-Webhook und volle BungeeCord-Unterstützung.
|
||||
**TicketSystem** ist das flexible, moderne Support- und Feedback-Plugin für Minecraft-Server (Spigot/Paper 1.18.x–1.21.x, Java 17+). Es bietet flexible Speicherung, automatische Backups & Migration, Export/Import, Statistiken, dynamische GUI, Kategorie- und Prioritäten-System, Bewertungs- und Kommentar-System, **FAQ-System mit Kategorien**, Discord-Webhook und volle BungeeCord-Unterstützung.
|
||||
|
||||
---
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
- Offline-Benachrichtigungen
|
||||
- Discord-Webhook mit Embeds & Rollen-Ping
|
||||
- Blacklist für Spieler
|
||||
- **FAQ-System** mit eigenem GUI, eigener Datei (`faqs.yml`) und vollständiger In-Game-Verwaltung durch Admins
|
||||
- **FAQ-System mit Kategorien** – eigene GUI mit Custom-Skull-Items, optionaler Kategorie-Auswahl-Screen, vollständige In-Game-Verwaltung; `faqs.yml` wird beim ersten Start automatisch mit Beispiel-Kategorien und -FAQs generiert
|
||||
- **Performance-Caching** – TTL-basierter In-Memory-Cache reduziert Datenbankabfragen spürbar
|
||||
- **Saubere Konsole** – minimale Start-Logs, kein unnötiger Spam
|
||||
- Erweiterbarkeit: viele Hooks
|
||||
@@ -35,7 +35,8 @@
|
||||
|
||||
1. TicketSystem.jar in den plugins-Ordner legen und Server starten
|
||||
2. `config.yml` anpassen (Speicherorte, Nachrichten, Limits, Farben, MySQL-Daten etc.)
|
||||
3. `/ticket`-Befehle nutzen
|
||||
3. Kopf der FAQ-Kategorie-Items optional über `gui-settings.faq.category-head-item` in der `config.yml` konfigurieren
|
||||
4. `/ticket`-Befehle nutzen
|
||||
|
||||
---
|
||||
|
||||
@@ -50,12 +51,15 @@
|
||||
| `/ticket list` | Eigene Tickets in der GUI anzeigen | Spieler |
|
||||
| `/ticket comment <ID> <Nachricht>` | Kommentar hinzufügen | Spieler, Support |
|
||||
| `/ticket rate <ID> <good\|bad>` | Support bewerten | Spieler |
|
||||
| `/ticket faq` | FAQ-GUI öffnen (häufige Fragen) | Spieler |
|
||||
| `/ticket faq` | FAQ-GUI öffnen (bei aktiven Kategorien: Auswahl zuerst)| Spieler |
|
||||
| `/ticket faq list` | FAQs im Chat auflisten | Spieler |
|
||||
| `/ticket faq add <Frage> \| <Antwort>` | Neues FAQ hinzufügen | Admin |
|
||||
| `/ticket faq add [Kategorie] <Frage> \| <Antwort>` | Neues FAQ hinzufügen (optional Kategorie angeben) | Admin |
|
||||
| `/ticket faq edit <ID> <Frage> \| <Antwort>` | Bestehendes FAQ bearbeiten | Admin |
|
||||
| `/ticket faq delete <ID>` | FAQ löschen | Admin |
|
||||
| `/ticket faq reload` | FAQs aus faqs.yml neu laden | Admin |
|
||||
| `/ticket kategorie add <n> [&Farbe] [Beschreibung]` | FAQ-Kategorie hinzufügen | Admin |
|
||||
| `/ticket kategorie delete <Schlüssel>` | FAQ-Kategorie löschen | Admin |
|
||||
| `/ticket kategorie list` | Alle FAQ-Kategorien auflisten | Admin |
|
||||
| `/ticket claim <ID>` | Ticket annehmen | Support/Admin |
|
||||
| `/ticket close <ID> [Kommentar]` | Ticket schließen | Support/Admin |
|
||||
| `/ticket forward <ID> <Spieler>` | Ticket weiterleiten | Support/Admin |
|
||||
@@ -156,44 +160,74 @@ Seit dieser Version sind auch alle **GUI-Texte** vollständig sprachabhängig
|
||||
|
||||
## FAQ-System
|
||||
|
||||
Das FAQ-System ermöglicht es Admins, häufige Fragen und Antworten direkt im Spiel zu verwalten. Spieler können die FAQs per GUI oder Befehl einsehen.
|
||||
Das FAQ-System ermöglicht es Admins, häufige Fragen und Antworten direkt im Spiel zu verwalten. Die `faqs.yml` wird beim ersten Start **automatisch generiert** – inklusive Beispiel-Kategorien und Beispiel-FAQs.
|
||||
|
||||
### Kategorien (Optional)
|
||||
|
||||
FAQs lassen sich optionalen Kategorien zuordnen. Sind Kategorien in der `faqs.yml` definiert, zeigt die GUI zunächst einen **Kategorie-Auswahl-Screen**. Ein Klick auf eine Kategorie öffnet die gefilterte FAQ-Liste mit einem Zurück-Button. Ohne Kategorien verhält sich die GUI wie gewohnt und listet alle FAQs direkt auf.
|
||||
|
||||
Das Aussehen der Kategorie-Items (Material und Custom-Head-Textur) wird **zentral** in der `config.yml` unter `gui-settings.faq.category-head-item` gesteuert. In der `faqs.yml` werden nur Name, Farbe und Beschreibung hinterlegt.
|
||||
|
||||
**Kategorien verwalten (per Befehl):**
|
||||
|
||||
```
|
||||
/ticket kategorie add Support &b Fragen zum Support-Team
|
||||
/ticket kategorie add Regeln &c Fragen zu den Server-Regeln
|
||||
/ticket kategorie delete support
|
||||
/ticket kategorie list
|
||||
```
|
||||
|
||||
**Kategorien verwalten (per GUI):**
|
||||
|
||||
Als Admin: **Shift+Klick** auf ein Kategorie-Item im Auswahl-Screen öffnet eine Aktions-GUI mit Bearbeiten und Löschen.
|
||||
|
||||
### Für Spieler
|
||||
|
||||
```
|
||||
/ticket faq – öffnet die FAQ-GUI mit Custom-Skull-Items
|
||||
/ticket faq – öffnet die FAQ-GUI (bei aktiven Kategorien: Auswahl zuerst)
|
||||
/ticket faq list – listet alle FAQs im Chat auf
|
||||
```
|
||||
|
||||
In der GUI wird für jeden FAQ-Eintrag ein **Custom-Skull-Item** mit individueller Textur angezeigt. Ein Klick auf einen Eintrag zeigt die vollständige Antwort im Chat.
|
||||
Jeder FAQ-Eintrag wird als **Custom-Skull-Item** angezeigt. Ein Klick zeigt die vollständige Antwort im Chat.
|
||||
|
||||
### Für Admins
|
||||
|
||||
```
|
||||
/ticket faq add tickets Wie melde ich einen Bug? | Nutze /ticket create bug <Beschreibung>.
|
||||
/ticket faq add Wie melde ich einen Bug? | Nutze /ticket create bug <Beschreibung>.
|
||||
/ticket faq edit 1 Neue Frage? | Neue Antwort.
|
||||
/ticket faq delete 1
|
||||
/ticket faq reload
|
||||
```
|
||||
|
||||
Alternativ können FAQs auch direkt über die **Admin-FAQ-GUI** verwaltet werden (öffnet sich automatisch wenn `ticket.admin`-Berechtigung vorhanden). Ein Klick auf einen Eintrag öffnet eine Aktions-GUI mit den Optionen **Bearbeiten** und **Löschen**. Neue FAQs lassen sich ebenfalls per Schaltfläche in der GUI hinzufügen – das Plugin führt den Admin Schritt für Schritt durch eine Chat-Eingabe.
|
||||
Der optionale Kategorie-Schlüssel als erstes Argument weist die neue FAQ direkt einer Kategorie zu. Der Tab-Completer schlägt alle vorhandenen Schlüssel vor.
|
||||
|
||||
### faqs.yml
|
||||
Alternativ über die **Admin-FAQ-GUI**: Klick auf einen Eintrag öffnet eine Aktions-GUI mit **Bearbeiten** und **Löschen**. Neue FAQs per „Neues FAQ hinzufügen"-Button hinzufügen – die FAQ wird automatisch der aktuell geöffneten Kategorie zugeordnet.
|
||||
|
||||
Alle FAQs werden in einer eigenen Datei `plugins/TicketSystem/faqs.yml` gespeichert:
|
||||
### faqs.yml (automatisch generiert)
|
||||
|
||||
```yaml
|
||||
categories:
|
||||
tickets:
|
||||
name: "Tickets"
|
||||
color: "&b"
|
||||
description: "Fragen zum Ticket-System"
|
||||
rules:
|
||||
name: "Regeln"
|
||||
color: "&c"
|
||||
description: "Fragen zu den Server-Regeln"
|
||||
|
||||
faqs:
|
||||
1:
|
||||
question: "Wie erstelle ich ein Ticket?"
|
||||
answer: "Nutze den Befehl /ticket create [Kategorie] [Beschreibung]."
|
||||
category: "tickets"
|
||||
2:
|
||||
question: "Wie lange dauert die Bearbeitung?"
|
||||
answer: "Unser Support-Team bearbeitet Tickets so schnell wie möglich."
|
||||
category: "tickets"
|
||||
```
|
||||
|
||||
Beim ersten Start werden automatisch vier Beispiel-FAQs erstellt.
|
||||
|
||||
---
|
||||
|
||||
## Performance-Caching
|
||||
@@ -280,7 +314,7 @@ TicketSystem bietet volle Unterstützung für BungeeCord-Netzwerke:
|
||||
| Rollenbasierter Archiv-Zugriff| ✔️ | ✖️ | ✖️ |
|
||||
| Kategorie-System | ✔️ | ✖️ | ✖️ |
|
||||
| Prioritäten-System | ✔️ | ✖️ | ✖️ |
|
||||
| FAQ-System | ✔️ | ✖️ | ✖️ |
|
||||
| FAQ-System mit Kategorien | ✔️ | ✖️ | ✖️ |
|
||||
| Performance-Caching | ✔️ | ✖️ | ✖️ |
|
||||
| Offline-Benachrichtigungen | ✔️ | ✖️ | ✖️ |
|
||||
| Discord-Webhook | ✔️ | ✖️ | ✖️ |
|
||||
@@ -301,7 +335,10 @@ Legende: ✔️ Vollständige Unterstützung · ⚠️ Eingeschränkt · ✖️
|
||||
> In der `config.yml` unter `categories:` – Name, Farbe, Material und Aliases frei wählbar. Änderungen mit `/ticket reload` übernehmen.
|
||||
|
||||
**Wie verwalte ich FAQs?**
|
||||
> Mit `/ticket faq` öffnest du die GUI. Als Admin kannst du über die GUI oder per `/ticket faq add|edit|delete` FAQs verwalten. Alle Daten liegen in `faqs.yml`.
|
||||
> Mit `/ticket faq` öffnest du die GUI. Als Admin kannst du über die GUI oder per `/ticket faq add|edit|delete` FAQs verwalten. Alle Daten liegen in der automatisch generierten `faqs.yml`.
|
||||
|
||||
**Wie richte ich FAQ-Kategorien ein?**
|
||||
> Die `faqs.yml` wird beim ersten Start automatisch mit vier Beispiel-Kategorien erstellt. Neue Kategorien per `/ticket kategorie add <Name> [&Farbe] [Beschreibung]` hinzufügen, löschen per `/ticket kategorie delete <Schlüssel>`. Das Aussehen der Kategorie-Items wird in `config.yml` unter `gui-settings.faq.category-head-item` gesteuert.
|
||||
|
||||
**Was passiert mit Benachrichtigungen wenn ein Spieler offline ist?**
|
||||
> Alle Benachrichtigungen werden gespeichert und beim nächsten Login angezeigt.
|
||||
@@ -334,10 +371,4 @@ Wir antworten in der Regel innerhalb von 24 Stunden!
|
||||
|
||||
**Dein Feedback zählt:**
|
||||
Wenn TicketSystem deinen Server bereichert hat, freuen wir uns über eine 5-Sterne Bewertung auf SpigotMC!
|
||||
Jede Rückmeldung hilft, das Plugin weiter zu verbessern und die Community zu stärken.
|
||||
|
||||
---
|
||||
|
||||
**Copyright © 2026 - M_Viper - Alle Rechte vorbehalten**
|
||||
|
||||
Die unbefugte Vervielfältigung, Verbreitung oder Weitergabe dieses Plugins ist strafbar und wird rechtlich verfolgt.
|
||||
Jede Rückmeldung hilft, das Plugin weiter zu verbessern und die Community zu stärken.
|
||||
Reference in New Issue
Block a user