Files
TicketSystem/README.md
2026-02-19 22:04:21 +00:00

219 lines
7.0 KiB
Markdown
Raw 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.
<div align="center">
# 🎫 TicketSystem
### Das flexible, moderne Support- und Feedback-System für Minecraft-Server
[![Minecraft](https://img.shields.io/badge/Minecraft-1.18.x--1.21.x-brightgreen?style=for-the-badge&logo=minecraft&logoColor=white)](https://www.spigotmc.org/)
[![Java](https://img.shields.io/badge/Java-17+-orange?style=for-the-badge&logo=openjdk&logoColor=white)](https://adoptium.net/)
[![Type](https://img.shields.io/badge/Type-Support%20Plugin-blue?style=for-the-badge)](https://github.com/)
[![License](https://img.shields.io/badge/License-All%20Rights%20Reserved-red?style=for-the-badge)](LICENSE)
**⭐ Zero-Lag · Production Ready · Fully Customizable ⭐**
[Features](#-features) · [Installation](#-installation) · [Konfiguration](#-konfiguration) · [Befehle](#-befehle--permissions) · [FAQ](#-faq) · [Support](#-support)
</div>
---
## 📋 Über TicketSystem
**TicketSystem** ist die Komplettlösung für Support, Bug-Reports und Feedback auf deinem Minecraft-Server. Spieler erstellen Tickets direkt im Spiel Admins verwalten alles komfortabel per GUI oder Befehl. Optimiert für kleine und große Server, vollständig konfigurierbar und vollgepackt mit Profi-Features.
---
## ✨ Features
| Feature | Beschreibung |
|---|---|
| 🗄️ **MySQL & Datei-Speicherung** | YAML/JSON oder MySQL/MariaDB jederzeit umschaltbar, Migration & Backup inklusive |
| 🔄 **Automatische Migration** | Sicheres Wechseln zwischen Speicherarten, Datenverlust ausgeschlossen |
| 📤 **Export / Import** | Tickets einfach zwischen Servern oder Instanzen übertragen |
| 📊 **Statistiken & Archivierung** | Übersichtliche Auswertung, automatische & manuelle Archivierung nach Zeitplan |
| ✅ **Vollständige Validierung** | Fehlerhafte Tickets werden erkannt, gemeldet und übersprungen |
| 🐛 **Debug-Modus** | Ausführliche Logs für Entwickler und Admins, erkennt veraltete `config.yml` |
| 🖥️ **Dynamische GUI** | Passt sich automatisch der Ticketanzahl an bis zu 54 Tickets pro Seite mit Blättern |
| ⚡ **Performance** | Alle Operationen laufen asynchron optimiert für große Server |
| 🔧 **Komplett anpassbar** | Nachrichten, Farben, Limits, Cooldowns, Rechte alles in der `config.yml` |
| 🧪 **Unit-Tests** | Getestete Speicher-Logik für maximale Zuverlässigkeit |
---
## 📦 Installation
> **Voraussetzungen:** Paper / Spigot / Purpur `1.18.x 1.21.x` · Java `17+` · optional MySQL/MariaDB
**Schritt 1 Plugin installieren**
```
1. Lade die neueste TicketSystem.jar von den Releases herunter
2. Verschiebe die .jar in den /plugins Ordner deines Servers
3. Starte den Server neu (kein /reload verwenden!)
4. Die Konfigurationsdateien werden automatisch generiert
```
**Schritt 2 Konfiguration anpassen**
```
1. Öffne plugins/TicketSystem/config.yml
2. Passe Speicherpfade, Nachrichten, Limits und Farben an
3. Aktiviere MySQL falls gewünscht und trage Zugangsdaten ein
4. Nutze /ticket reload um Änderungen zu übernehmen
```
**Fertig!** Dein Support-System ist einsatzbereit. 🎉
---
## ⚙️ Konfiguration
<details>
<summary><b>📄 Beispiel: config.yml (klicken zum Ausklappen)</b></summary>
```yaml
# TicketSystem - Hauptkonfiguration
# © 2026 Viper Plugins
version: "2.0"
debug: false
# Speicherung
data-file: "data.yml"
archive-file: "archive.yml"
use-mysql: false
use-json: false
# MySQL (nur wenn use-mysql: true)
mysql:
host: "localhost"
port: 3306
database: "tickets"
user: "root"
password: "password"
useSSL: false
# Archivierung
auto-archive-interval-hours: 24 # 0 = deaktiviert
# Allgemein
prefix: "&8[&6Ticket&8] &r"
ticket-cooldown: 60 # Sekunden zwischen Tickets
max-description-length: 100
max-open-tickets-per-player: 2
```
</details>
---
## 💬 Befehle & Permissions
### Spieler-Befehle
| Befehl | Beschreibung | Permission |
|---|---|---|
| `/ticket` | GUI mit allen offenen Tickets öffnen | `ticket.use` |
| `/ticket create <Nachricht>` | Neues Ticket erstellen | `ticket.use` |
| `/ticket close <ID>` | Eigenes Ticket schließen | `ticket.use` |
### Admin-Befehle
| Befehl | Beschreibung | Permission |
|---|---|---|
| `/ticket claim <ID>` | Ticket übernehmen | `ticket.admin` |
| `/ticket forward <ID> <Spieler>` | Ticket weiterleiten | `ticket.admin` |
| `/ticket archive` | Tickets manuell archivieren | `ticket.admin` |
| `/ticket export <Datei>` | Tickets exportieren | `ticket.admin` |
| `/ticket import <Datei>` | Tickets importieren | `ticket.admin` |
| `/ticket migrate <tomysql\|tofile>` | Speicherart migrieren | `ticket.admin` |
| `/ticket stats` | Statistiken anzeigen | `ticket.admin` |
| `/ticket reload` | Konfiguration neu laden | `ticket.admin` |
### Permissions-Übersicht
```
ticket.use → Ticket erstellen und eigene Tickets verwalten (Standard für alle Spieler)
ticket.admin → Zugriff auf alle Admin- und Management-Funktionen
```
---
## ❓ FAQ
<details>
<summary><b>Kann ich zwischen MySQL und Datei-Speicherung wechseln?</b></summary>
Ja! Einfach per `/ticket migrate tomysql` oder `/ticket migrate tofile`. Das Plugin migriert alle Daten automatisch und sicher kein Datenverlust.
</details>
<details>
<summary><b>Wie viele Tickets passen in die GUI?</b></summary>
Bis zu 54 Tickets pro Seite. Bei mehr Tickets wird automatisch geblättert.
</details>
<details>
<summary><b>Werden automatisch Backups erstellt?</b></summary>
Ja, bei jedem Speicherwechsel und regelmäßig nach dem konfigurierten Archiv-Intervall.
</details>
<details>
<summary><b>Wie aktiviere ich den Debug-Modus?</b></summary>
Setze `debug: true` in der `config.yml` und nutze anschließend `/ticket reload`.
</details>
<details>
<summary><b>Wie exportiere/importiere ich Tickets?</b></summary>
Mit `/ticket export <Dateiname>` und `/ticket import <Dateiname>` ideal für Server-Umzüge oder Testumgebungen.
</details>
---
## 📊 Vergleich
| | **TicketSystem** | SimpleTickets | AdvancedTickets |
|---|:---:|:---:|:---:|
| Speicher-Migration | ✅ Vollständig | ⚠️ Nur manuell | ❌ |
| Automatische Backups | ✅ | ⚠️ Teilweise | ❌ |
| Dynamische GUI | ✅ Modern | ⚠️ Basic | ❌ |
| Archivierung | ✅ Auto & manuell | ⚠️ Nur manuell | ❌ |
| Export / Import | ✅ | ❌ | ❌ |
| Debug-Modus | ✅ | ❌ | ❌ |
| Update-Checker | ✅ | ❌ | ❌ |
| Unit-Tests | ✅ | ❌ | ❌ |
---
## 🆘 Support
<div align="center">
Hast du Fragen, einen Bug gefunden oder eine Feature-Idee?
[![Discord](https://img.shields.io/badge/Discord-Support%20beitreten-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/FdRs4BRd8D)
**Wir antworten in der Regel innerhalb von 24 Stunden!**
Bitte öffne für Bug-Reports ein Issue.
</div>
---
## 📜 Kompatibilität
| Plattform | Version |
|---|---|
| Paper | ✅ 1.18.x 1.21.x |
| Spigot | ✅ 1.18.x 1.21.x |
| Purpur | ✅ 1.18.x 1.21.x |
| Folia | ❌ Nicht unterstützt |
---
<div align="center">
**© 2026 Viper Plugins · TicketSystem · Alle Rechte vorbehalten**
Wenn TicketSystem deinen Server bereichert hat, freuen wir uns über eine Bewertung auf spigotmc!
</div>