Files
FurnaceLevels/README.md
2025-08-23 15:12:44 +00:00

118 lines
4.7 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.

# FurnaceLevels Plugin
## Überblick
FurnaceLevels ist ein Minecraft-Plugin, das die Funktionalität von Öfen erweitert, indem Spieler ihre Öfen bis Level 5 verbessern können, um die Schmelzgeschwindigkeit zu erhöhen. Das Plugin ist für Minecraft 1.21.1 ausgelegt und benötigt ProtocolLib als Abhängigkeit, mit optionaler Unterstützung für Vault.
## Funktionen
- **Ofen-Upgrades**: Verbessere Öfen bis zu 5 Stufen, jede Stufe erhöht die Schmelzgeschwindigkeit.
- **Anpassbare Kosten**: Konfiguriere Upgrade-Kosten über eine Wirtschaft (Vault) oder benutzerdefinierte Items.
- **Konfigurierbare Schmelzgeschwindigkeit**: Stelle die Ticks-pro-Tick für jedes Level ein, um die Schmelzgeschwindigkeit zu steuern.
- **Welten-Blacklist**: Deaktiviere das Plugin in bestimmten Welten (z. B. `world_end`).
- **Debug-Befehl**: Aktiviere oder deaktiviere Debugging mit dem Befehl `/fldebug`.
- **Berechtigungssystem**: Detaillierte Berechtigungen für Upgrades und Debugging.
## Installation
1. Stelle sicher, dass **ProtocolLib** auf deinem Server installiert ist.
2. (Optional) Installiere **Vault** für Wirtschafts-basierte Upgrades.
3. Platziere die `FurnaceLevels.jar`-Datei im `plugins`-Ordner deines Servers.
4. Starte den Server neu, um die Standard-Konfigurationsdateien zu generieren.
## Konfiguration
### plugin.yml
Die `plugin.yml`-Datei definiert die Kern-Einstellungen, Befehle und Berechtigungen des Plugins.
- **Hauptklasse**: `vpd.bowandaero12.furnacelv.FurnaceLevels`
- **Version**: 2.0
- **Abhängigkeiten**: Erfordert ProtocolLib, optional Vault.
- **API-Version**: Kompatibel mit Minecraft 1.13 und höher.
- **Befehle**:
- `/fldebug`: Aktiviert oder deaktiviert Debugging.
- **Berechtigungen**:
- `furnacelevels.upgrade.<1-5>`: Erlaubt das Upgraden von Öfen auf die angegebene Stufe (Standard: true).
- `furnacelevels.debug`: Erlaubt die Nutzung des Debug-Befehls (Standard: op).
### config.yml
Die `config.yml`-Datei ermöglicht die Anpassung des Plugin-Verhaltens.
- **Wirtschafts-Nutzung**:
- Setze `use-economy: true`, um Vault für Upgrade-Kosten zu verwenden.
- Setze `use-economy: false`, um benutzerdefinierte Items (z. B. Sonnenblume) für Upgrades zu nutzen.
- **Kostenrückerstattung**:
- Bei `refund-cost: true` droppt ein zerstörter Ofen einen normalen Ofen und erstattet die gesamten Upgrade-Kosten.
- Bei `refund-cost: false` wird stattdessen das benutzerdefinierte Ofen-Item gedroppt.
- **Upgrade-Stufen**:
- Konfiguriere Kosten und Schmelzgeschwindigkeiten (`ticks-per-tick`) für jedes Level (15).
- Beispiel:
```yaml
upgrades:
level-1:
cost: 400000
ticks-per-tick: 10
level-2:
cost: 700000
ticks-per-tick: 20
... bis Level 5
### Benutzerdefiniertes Item:
Definiere das Item für Upgrades (z. B. minecraft:sunflower).
Passe den Anzeigenamen und die Beschreibung an:
```yaml
item:
material-type: 'minecraft:sunflower'
displayname: '&6&lOfen-Upgrade-Token'
lore:
- '&cEin spezieller Token, um deinen Ofen zu verbessern!'
```
## Welten-Blacklist:
Liste Welten auf, in denen das Plugin deaktiviert ist:
```yaml
world-blacklist:
- world_end
```
## Befehle
`/fldebug` - Schaltet den Debug-Modus ein oder aus (erfordert `furnacelevels.debug` -Berechtigung).
## Berechtigungen
`furnacelevels.upgrade.<1-5>` : Erlaubt das Upgraden von Öfen auf die angegebene Stufe (Standard: true).
`furnacelevels.debug` : Erlaubt den Zugriff auf den `/fldebug` -Befehl (Standard: op).
## Anforderungen
* Minecraft-Version: 1.21.1
* Abhängigkeiten:
* **ProtocolLib**: Erforderlich für die Kernfunktionalität.
* **Vault**: Optional für Wirtschaftsintegration.
**Java-Version** : Kompatibel mit der Java-Version, die von Minecraft 1.21.1 verwendet wird.
## Nutzung
1. Platziere einen Ofen und interagiere mit ihm, um ihn zu verbessern, entweder mit:
* In-Game-Währung (wenn use-economy: true).
* Einem benutzerdefinierten Item wie dem "Ofen-Upgrade-Token" (wenn use-economy: false).
Jedes Upgrade-Level erhöht die Schmelzgeschwindigkeit basierend auf den konfigurierten `ticks-per-tick`.
Nutze `/fldebug` , um Probleme zu beheben (erfordert Berechtigung).
## Hinweise
Stelle sicher, dass die `ticks-per-tick` -Werte korrekt eingestellt sind, um Probleme zu vermeiden (Öfen setzen bei 200 Ticks zurück).
Das Plugin ist in den angegebenen Welten der Blacklist (z. B. `world_end`) deaktiviert.
Für Unterstützung oder Probleme erstelle ein Ticket im GitHub-Repository.
## Mitwirken
Beiträge sind willkommen! Bitte reiche einen Pull Request ein oder erstelle ein Issue im GitHub-Repository für Fehlerberichte oder Vorschläge.
## Lizenz
Dieses Projekt ist unter der MIT-Lizenz lizenziert. Siehe die LICENSE-Datei für Details.