diff --git a/config.md b/config.md new file mode 100644 index 0000000..5d1371f --- /dev/null +++ b/config.md @@ -0,0 +1,206 @@ +# config.yml + +Die Hauptkonfiguration befindet sich unter `plugins/AutoSortChest/config.yml`. Änderungen werden nach `/asc reload` oder einem Server-Neustart übernommen. + +--- + +## Allgemein + +```yaml +version: "2.3" # Konfigurationsversion (nicht manuell ändern) +debug: false # Debug-Modus (nur für Entwicklung) +language: "de" # Sprache: 'de' oder 'en' +``` + +--- + +## MySQL + +```yaml +mysql: + enabled: false + host: "localhost" + port: 3306 + database: "autosortchest" + user: "autosortchest" + password: "autosortchest" +``` + +Details: [Datenbank & CrossLink](Datenbank) + +--- + +## CrossLink & Servername + +```yaml +server_crosslink: true # Serverübergreifende Sortierung (benötigt MySQL) +server_name: "" # Eindeutiger Name im BungeeCord-Netzwerk + # Leer = Legacy-Modus (welt-basiert) +``` + +--- + +## Welten-Blacklist + +```yaml +world_blacklist: + - "world_nether" + - "world_the_end" +``` + +In diesen Welten können keine ASC-Schilder erstellt werden. + +--- + +## Sortier-Intervall + +```yaml +sort_interval_ticks: 10 # Sortierung alle 10 Ticks (= 0,5 Sek) +rest_resort_interval_ticks: 400 # Nachsortierung aus Rest-Truhen (0 = deaktiviert) +``` + +--- + +## Mülltruhe + +```yaml +trash: + auto_clear_interval_seconds: 0 # 0 = nur beim Schließen + # 300 = alle 5 Minuten + # 3600 = stündlich +``` + +--- + +## Visuelle Effekte + +```yaml +effects: + enabled: false # Partikel-Effekte beim Sortieren? + sound: false # Sound beim Ankommen von Items? + type: "DUST" # Partikel-Typ ('DUST' = Regenbogen-Effekt) +``` + +--- + +## Schild-Stil + +```yaml +sign-style: + clean-target: false # true = sauberer Modus ohne [asc]-Tag +``` + +Details zum Clean-Modus: [Schilder & Truhen-Typen](Schilder) + +--- + +## Truhen-Limits + +```yaml +chest_limits: + enabled: true + + default: + input: 1 + rest: 1 + target: 50 + target_per_item: 1 # Max. Zieltruhen pro Item-Typ + + vip: + input: 2 + rest: 2 + target: 100 + target_per_item: 3 +``` + +Beliebig viele Gruppen möglich. Die zugehörige Permission: `autosortchest.limit.` + +--- + +## Truhen-Fenstertitel + +```yaml +chest-titles: + input: + de: "&6Eingangstruhe" + en: "&6Input Chest" + target: + de: "&6%item%" # %item% = Item-Name + en: "&6%item%" + rest: + de: "&6Rest-Truhe" + en: "&6Rest Chest" + trash: + de: "&4Mülltruhe" + en: "&4Trash Chest" +``` + +--- + +## Schildfarben + +Farben für den normalen Modus (`§`-Codes, hier mit `&`): + +```yaml +sign-colors: + input: + line1: "&6" # [asc] + line2: "&0" # input + line4: "&1" # Spielername + target: + line1: "&6" # [asc] + line2: "&0" # Item-Name + line3: "&f" # Zusatzinfo + line4: "&1" # Spielername + full: # Farben wenn Truhe voll ist + line1: "&c" + line2: "&4" + line3: "&e" + line4: "&1" + rest: + line1: "&6" + line2: "&0" + line3: "&f" + line4: "&1" + trash: + line1: "&6" + line2: "&0" + line4: "&1" +``` + +Farben für den **Clean-Modus** werden unter `sign-colors-clean` separat konfiguriert (gleiche Struktur). + +--- + +## Nachrichten + +Alle Nachrichten sind vollständig anpassbar. + +**Verfügbare Platzhalter:** + +| Platzhalter | Bedeutung | +| --- | --- | +| `%player%` | Spielername | +| `%item%` | Item-Name | +| `%x%`, `%y%`, `%z%` | Koordinaten der betroffenen Truhe | +| `%mode%` | Aktueller Modus (Öffentlich / Privat) | +| `%max%` | Maximales Limit | + +**Wichtige Nachrichten-Keys:** + +| Key | Beschreibung | +| --- | --- | +| `no-chest-near-sign` | Keine Truhe in der Nähe des Schildes | +| `no-item-in-hand` | Kein Item in der Hand beim Rechtsklick | +| `not-your-chest` | Fremde Truhe | +| `input-chest-set` | Eingangstruhe erfolgreich gesetzt | +| `target-chest-set` | Zieltruhe erfolgreich eingerichtet | +| `rest-chest-set` | Rest-Truhe gesetzt | +| `trash-chest-set` | Mülltruhe eingerichtet | +| `target-chest-full` | Zieltruhe voll (mit Koordinaten) | +| `sign-break-denied` | Schild ohne Shift abbauen versucht | +| `mode-changed` | Modus gewechselt | +| `limit-input-reached` | Limit für Eingangstruhen erreicht | +| `limit-target-reached` | Limit für Zieltruhen erreicht | +| `trash-cleared` | Mülltruhe wurde geleert | +| `reload-success` | Konfiguration neu geladen |