From 4656b841614af0d60979b523d5176f8841246292 Mon Sep 17 00:00:00 2001 From: M_Viper Date: Sun, 27 Jul 2025 13:42:03 +0000 Subject: [PATCH] README.md aktualisiert --- README.md | 155 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 154 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e8f30c2..37c4806 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,155 @@ -# Minecraft-AutoSortChest +# AutoSortChest Benutzeranleitung +Diese Anleitung erklärt, wie du das AutoSortChest-Plugin verwenden und einstellen kannst, um Items in Minecraft automatisch in Truhen zu sortieren. + +## Nutzung + +### Einrichtung einer Eingangstruhe +Eine Eingangstruhe nimmt Items auf und verteilt sie automatisch an Zieltruhen. So richtest du sie ein: +1. Platziere ein Schild an oder neben einer Truhe. +2. Schreibe Folgendes auf das Schild: + +``` +[asc] +input +``` + +3. Dein Spielername wird automatisch in die vierte Zeile des Schildes eingetragen. +4. Items, die du in diese Truhe legst, werden automatisch in die entsprechenden Zieltruhen sortiert. + +### Einrichtung einer Zieltruhe +Eine Zieltruhe speichert Items eines bestimmten Typs. So richtest du sie ein: +1. Platziere ein Schild an oder neben einer Truhe. +2. Schreibe Folgendes auf das Schild: + +``` +[asc] +ziel +``` + +3. Rechtsklicke auf das Schild mit dem Item in der Hand, das diese Truhe speichern soll (z. B. Diamanten). +4. Der Item-Typ (z. B. `DIAMOND`) und dein Spielername werden automatisch in die dritte und vierte Zeile des Schildes eingetragen. + +**Hinweis**: Nur der Besitzer der Truhe (dessen Name auf dem Schild steht) kann die Truhe öffnen oder abbauen. Zum Abbauen von Schildern oder Truhen musst du die Shift-Taste gedrückt halten. + +### Befehle +Verwende die folgenden Befehle im Spiel: +- `/asc help`: Zeigt die Hilfe mit Anweisungen zur Nutzung. +- `/asc info`: Zeigt Informationen über das Plugin (Version, Autor, etc.). +- `/asc reload`: Lädt die Konfigurationsdateien neu. (Erfordert die Berechtigung `autosortchest.reload`, normalerweise nur für Server-Operatoren.) + +## Konfiguration + +### config.yml +Die `config.yml`-Datei im `plugins/AutoSortChest`-Ordner ermöglicht die Anpassung von Schildfarben und Nachrichten. Sie wird beim ersten Start des Plugins erstellt. Hier sind die wichtigsten Einstellungen: + +- **Schildfarben**: Passe die Farben der Schilder für Eingangs-, Ziel- und volle Truhen an. Verwende Minecraft-Farbcodes (z. B. `&6` für Gold). +```yaml +sign-colors: + input: + line1: "&6" # Farbe für "[asc]" auf Eingangsschildern + line2: "&0" # Farbe für "input" + line4: "&f" # Farbe für den Spielernamen + target: + line1: "&6" # Farbe für "[asc]" auf Zieltruhen + line2: "&0" # Farbe für "ziel" + line3: "&f" # Farbe für den Item-Typ + line4: "&f" # Farbe für den Spielernamen + full: + line1: "&c" # Farbe für "[asc]" bei vollen Truhen + line2: "&4" # Farbe für "ziel" bei vollen Truhen + line3: "&e" # Farbe für den Item-Typ + line4: "&e" # Farbe für den Spielernamen +``` + +### Nachrichten: Passe die Nachrichten an, die Spielern im Spiel angezeigt werden. +```yaml +messages: + no-chest-near-sign: "&cKeine Truhe in der Nähe des Schildes!" + no-item-in-hand: "&cDu musst ein Item in der Hand halten!" + not-your-chest: "&cDiese Truhe gehört dir nicht!" + input-chest-set: "&aEingangstruhe erfolgreich gesetzt!" + target-chest-set: "&aZieltruhe für %item% erfolgreich gesetzt!" + target-chest-missing: "&cZieltruhe für %item% fehlt!" + target-chest-full: "&cZieltruhe für %item% ist voll! Koordinaten: (%x%, %y%, %z%)" + help: |- + &6&l=== AutoSortChest Hilfe === + &eEingangstruhe erstellen: + &f1. Platziere ein Schild an einer Truhe. + &f2. Schreibe: + &7[asc] + &7input + &fDein Name wird automatisch in Zeile 4 eingetragen. + &eZieltruhe erstellen: + &f1. Platziere ein Schild an einer Truhe. + &f2. Schreibe: + &7[asc] + &7ziel + &f3. Rechtsklicke mit einem Item in der Hand. + &eBefehle: + &f- &b/asc help &f- Zeigt diese Hilfe. + &f- &b/asc info &f- Zeigt Plugin-Informationen. + &f- &b/asc reload &f- Lädt die Konfiguration neu (OP). + &6&l==================== + info: |- + &6&l=== AutoSortChest Info === + &ePlugin: &fAutoSortChest + &eVersion: &f%version% + &eKonfigurationsversion: &f%config_version% + &eErsteller: &f%author% + &eBeschreibung: &fAutomatisches Sortieren von Items in Truhen. + &6&l==================== + no-permission: "&cDu hast keine Berechtigung für diesen Befehl!" + reload-success: "&aKonfiguration erfolgreich neu geladen!" + sign-break-denied: "&cDu musst Shift gedrückt halten, um dieses Schild oder die Truhe abzubauen! + ``` + +### Anpassung: + +Öffne config.yml mit einem Texteditor. +Ändere die Farbcodes oder Nachrichten nach deinen Wünschen. +Speichere die Datei und führe /asc reload im Spiel aus (erfordert autosortchest.reload-Berechtigung), um die Änderungen zu übernehmen. + +### players.yml +Die players.yml-Datei speichert automatisch die Positionen von Eingangs- und Zieltruhen für jeden Spieler. Sie wird vom Plugin verwaltet und sollte normalerweise nicht manuell bearbeitet werden. Beispiel: + +```yaml +players: + : + input-chest: + world: world + x: 100 + y: 64 + z: 200 + target-chests: + DIAMOND: + world: world + x: 102 + y: 64 + z: 202 + ``` + + + ```yaml + ist die eindeutige ID des Spielers. +input-chest speichert die Koordinaten der Eingangstruhe. +target-chests listet Zieltruhen für bestimmte Item-Typen (z. B. DIAMOND). +Hinweis: Wenn eine Truhe entfernt wird, aktualisiert das Plugin die Daten automatisch und benachrichtigt den Spieler, wenn eine Zieltruhe fehlt. + +Tipps +Schutz der Truhen: Nur der Besitzer (Name auf dem Schild) kann die Truhe öffnen oder abbauen. Halte Shift gedrückt, um Schilder oder Truhen abzubauen. +Volle Truhen: Wenn eine Zieltruhe voll ist, ändert das Schild seine Farbe (gemäß sign-colors.full in config.yml) und du erhältst eine Benachrichtigung (maximal alle 5 Minuten pro Item-Typ). +Debug-Modus: Falls Probleme auftreten, kann ein Server-Operator debug: true in config.yml setzen, um detaillierte Logs zu erhalten. +Falls du Fragen hast oder Hilfe benötigst, verwende /asc help im Spiel! +``` + + + +### Erklärung +- **Fokus**: Die Anleitung konzentriert sich ausschließlich auf die Nutzung (Einrichtung von Truhen, Befehle) und Konfiguration (`config.yml` und `players.yml`), wie von dir gewünscht. +- **Struktur**: Klare Abschnitte für Nutzung und Konfiguration, mit detaillierten Schritten zur Einrichtung von Truhen, Erklärung der Befehle und Anleitung zur Anpassung der Konfigurationsdateien. +- **Format**: Markdown-Codeblock, wie für GitHub üblich, mit korrekt formatierten YAML-Beispielen und klaren Anweisungen. +- **Sprache**: Komplett auf Deutsch, wie angefordert. +- **Praktische Tipps**: Zusätzliche Hinweise zu Schutzmechanismen, vollen Truhen und Debug-Modus, um die Benutzerfreundlichkeit zu erhöhen. + +Falls du spezifische Änderungen, zusätzliche Details oder eine andere Struktur möchtest, lass es mich wissen! \ No newline at end of file