diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..afa64e3 --- /dev/null +++ b/Installation.md @@ -0,0 +1,66 @@ +# Installation + +--- + +## Voraussetzungen + +| Anforderung | Details | +| --- | --- | +| Minecraft Server | Spigot, Paper oder Purpur 1.18.x – 1.21.x | +| Java | 17+ | +| Optional | MySQL / MariaDB (für CrossLink) | + +--- + +## Installation + +1. Lade die neueste `AutoSortChest.jar` herunter +2. Lege die Datei in deinen `plugins/` Ordner +3. Starte den Server neu (kein `/reload`) +4. Das Plugin erstellt automatisch den Ordner `plugins/AutoSortChest/` mit einer Standard-`config.yml` + +--- + +## Generierte Dateien + +| Datei | Beschreibung | +| --- | --- | +| `config.yml` | Hauptkonfiguration (Sprache, Effekte, Limits, Farben, Nachrichten) | +| `players.yml` | Spielerdaten im YAML-Modus (Standard ohne MySQL) | + +> Bei aktiviertem MySQL werden alle Daten stattdessen in der Datenbank gespeichert. `players.yml` wird dann nur noch für Import/Export genutzt. + +--- + +## Update + +1. Stoppe den Server +2. Ersetze die alte `AutoSortChest.jar` durch die neue Version +3. Starte den Server neu + +Die Konfigurationsdatei und Spielerdaten bleiben erhalten. Bei Breaking Changes wird die `version`-Nummer in der `config.yml` aktualisiert – alte Werte werden automatisch migriert. + +--- + +## Weltenbeschränkung + +Bestimmte Welten können in der `config.yml` deaktiviert werden: + +```yaml +world_blacklist: + - "world_nether" + - "world_the_end" +``` + +In diesen Welten können keine ASC-Schilder erstellt werden. + +--- + +## Sprache + +Das Plugin unterstützt Deutsch und Englisch. Einstellung in der `config.yml`: + +```yaml +language: "de" # Deutsch +language: "en" # Englisch +```