From 859a46c1d86aa321b2f1bec83d1e55e3407eefaa Mon Sep 17 00:00:00 2001 From: M_Viper Date: Thu, 7 Aug 2025 17:01:53 +0000 Subject: [PATCH] README.md aktualisiert --- README.md | 154 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 154 insertions(+) diff --git a/README.md b/README.md index 883ade3..2002fe0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,156 @@ # RealTimeWeather +Ein Minecraft-Plugin, das Echtzeit-Wetter und -Zeit in deine Welten bringt! **RealTimeWeather** synchronisiert das In-Game-Wetter und die Tageszeit mit Daten von OpenWeatherMap und bietet eine benutzerfreundliche GUI, Wettervorhersagen und anpassbare Anzeigeoptionen. Entwickelt für Minecraft 1.21.1. + +## Funktionen + +- **Echtzeit-Wetter**: Synchronisiert Regen, Gewitter oder klares Wetter mit realen Wetterdaten eines konfigurierbaren Orts. +- **Echtzeit-Zeit**: Passt die Minecraft-Tageszeit an die aktuelle Uhrzeit an (deaktiviert den Tageszyklus). +- **Actionbar-Anzeige**: Zeigt Datum, Uhrzeit, Wetter-Symbol (z. B. 🌧️) und Temperatur in der Actionbar an, mit Optionen für Position (oben links/rechts) und Symbolanzeige. +- **Wettervorhersage**: 5-Tage-Wettervorhersage über den Befehl `/weatherforecast`. +- **GUI**: Intuitive Benutzeroberfläche zum Festlegen von Orten, Umschalten der Anzeige und Abrufen von Informationen. +- **Mehrsprachenunterstützung**: Unterstützt Deutsch (`de`) und Englisch (`en`) über `lang.yml`, mit einfacher Erweiterung für weitere Sprachen. +- **Weltspezifische Konfiguration**: Unterschiedliche Einstellungen für jede Welt in `config.yml`. +- **Spielerindividuelle Orte**: Spieler können ihren eigenen Ort mit `/wetter setlocation` festlegen. +- **Berechtigungen**: Admin-Befehle sind durch Berechtigungen geschützt. + +## Installation + +1. **Download**: Lade die `RealTimeWeather.jar` aus den [Releases](https://github.com/M_Viper/RealTimeWeather/releases) herunter. +2. **Plugin-Ordner**: Kopiere die JAR-Datei in den `plugins`-Ordner deines Minecraft-Servers. +3. **API-Schlüssel**: Registriere dich bei [OpenWeatherMap](https://openweathermap.org/) für einen kostenlosen API-Schlüssel. +4. **Konfiguration**: Bearbeite die `config.yml` im Ordner `plugins/RealTimeWeather/` und füge deinen API-Schlüssel ein. +5. **Server starten**: Starte deinen Server, um das Plugin zu laden. Die `lang.yml` wird automatisch generiert. + +## Konfiguration + +Die Konfigurationsdateien befinden sich im Ordner `plugins/RealTimeWeather/`. + +### config.yml + +```yaml +api-key: "DEIN_API_KEY_HIER" +update-interval: 60 # Sekunden +defaults: + enabled: true # Plugin für Welten ohne spezifische Konfiguration aktivieren + location: "Berlin,de" # Stadt,Ländercode + units: "metric" # metric = Celsius, imperial = Fahrenheit + time-format: "24h" # "24h" oder "12h" + display-actionbar: true + display-weather-icon: true + display-position: "top-right" # top-left oder top-right + padding-right: 100 # Anzahl der Leerzeichen für top-right +worlds: + world: + enabled: true + location: "London,uk" + units: "imperial" + time-format: "12h" + display-actionbar: true + display-weather-icon: true + display-position: "top-left" + padding-right: 50 + world_nether: + enabled: false + location: "Tokyo,jp" + units: "metric" + time-format: "24h" + display-actionbar: true + display-weather-icon: false + display-position: "top-right" + padding-right: 150 + ``` +# RealTimeWeather + +Ein Minecraft-Plugin, das Echtzeit-Wetter und -Zeit in deine Welten bringt. Synchronisiert Wetter und Tageszeit mit OpenWeatherMap-Daten. Entwickelt für Minecraft 1.21.1. + +## Konfiguration + +### lang.yml + +Enthält Übersetzungen für Deutsch (`de`) und Englisch (`en`). Beispiel für Deutsch: + +```yaml +languages: + de: + help_header: "RealTimeWeather-Befehle" + help_help: "Diese Hilfenachricht anzeigen" + help_reload: "Die Plugin-Konfiguration neu laden (Berechtigung: realtimeweather.reload)" + help_setlocation: "Eigenen Wetterort für den Spieler festlegen (z.B. Berlin,de)" + help_query: "Aktuelles Wetter für den Spielerort oder die Welt anzeigen" + help_info: "Plugin-Informationen anzeigen" + help_gui: "GUI für Wettersteuerung öffnen" + help_weatherforecast: "Wettervorhersage für 5 Tage anzeigen" + help_toggleweather: "Wetteranzeige in der Actionbar ein-/ausschalten" + usage: "Verwendung: /wetter reload | setlocation | query | info | gui | help" + usage_setlocation: "Verwendung: /wetter setlocation " + no_permission: "Du hast keine Berechtigung für diesen Befehl!" + reload_success: "Konfiguration erfolgreich neu geladen!" + only_players: "Dieser Befehl ist nur für Spieler!" + plugin_disabled: "Plugin ist für die Welt {world} deaktiviert!" + location_set: "Ort auf {location} gesetzt!" + invalid_location: "Ungültiger Ort: {location}" + forecast_error: "Fehler beim Abrufen der Wetterdaten für {location}: {error}" + gui_title: "Wettersteuerung" + gui_setlocation: "Ort festlegen" + gui_setlocation_lore: "Eigenen Wetterort festlegen" + gui_toggleweather: "Wetteranzeige umschalten" + gui_toggleweather_lore: "Wetter-Actionbar ein-/ausschalten" + gui_forecast: "Wettervorhersage" + gui_forecast_lore: "5-Tage-Wettervorhersage anzeigen" + gui_info: "Info" + gui_info_lore: "Plugin-Informationen anzeigen" + gui_setlocation_prompt: "Gib den Ort ein (z.B. Berlin,de)" + toggle_enabled: "Wetteranzeige für {world} aktiviert!" + toggle_disabled: "Wetteranzeige für {world} deaktiviert!" + forecast_header: "Wettervorhersage für {location}" + weather: + clear: "Klar" + clouds: "Bewölkt" + rain: "Regen" + thunderstorm: "Gewitter" + snow: "Schnee" + mist: "Nebel" + fog: "Nebel" + haze: "Dunst" + en: + # Ähnliche Schlüssel wie oben, auf Englisch +``` + +markdown# RealTimeWeather + +Ein Minecraft-Plugin, das Echtzeit-Wetter und -Zeit in deine Welten bringt. Entwickelt für Minecraft 1.21.1. + +## Befehle + +- `/wetter help`: Zeigt die Hilfeübersicht an. +- `/wetter reload`: Lädt die Konfiguration neu (Berechtigung: `realtimeweather.reload`). +- `/wetter setlocation `: Legt einen individuellen Ort für den Spieler fest. +- `/wetter query`: Zeigt aktuelles Wetter für den Spielerort oder die Welt. +- `/wetter info`: Zeigt Plugin-Informationen an. +- `/wetter gui`: Öffnet die Wetter-GUI. +- `/weatherforecast`: Zeigt die 5-Tage-Wettervorhersage. +- `/toggleweather`: Schaltet die Wetteranzeige in der Actionbar ein/aus. + +## Berechtigungen + +- `realtimeweather.reload`: Erlaubt `/wetter reload`. +- `realtimeweather.admin`: Erlaubt Admin-Benachrichtigungen bei Wetterabfrage-Fehlern. + +### Actionbar-Anzeige (Regenwetter) + +- **Beschreibung**: Zeigt die Actionbar mit Datum, Uhrzeit, Wetter-Symbol (🌧️) und Temperatur (z. B. "07.08.2025 18:54:00 🌧️ 15.2°C") in einer Welt mit Regenwetter. +- **Anleitung**: Stelle dich in eine Welt mit `location: "Berlin,de"`, aktiviere `display-actionbar: true` und `display-weather-icon: true` in `config.yml`, und mache einen Screenshot (F2 in Minecraft). +- **Bildgenerierung-Prompt**: "Ein Minecraft-Spielbild mit regnerischer Landschaft. Zeige eine Actionbar oben rechts mit dem Text '07.08.2025 18:54:00 🌧️ 15.2°C' in weißer Schrift auf schwarzem Hintergrund. Pixelgrafik im Minecraft-Stil." + +### Wetter-GUI + +- **Beschreibung**: Zeigt die GUI mit Items für "Ort festlegen" (Buch), "Wetteranzeige umschalten" (Redstone-Fackel), "Vorhersage" (Papier) und "Info" (Schild). +- **Anleitung**: Führe `/wetter gui` aus und mache einen Screenshot der Inventar-GUI. +- **Bildgenerierung-Prompt**: "Eine Minecraft-Inventar-GUI mit 9 Slots. Slots 2-5 enthalten: Buch ('Ort festlegen'), Redstone-Fackel ('Wetteranzeige umschalten'), Papier ('Vorhersage'), Schild ('Info'). Beschriftungen in Deutsch, Minecraft-Pixelstil." + +### Wettervorhersage + +- **Beschreibung**: Zeigt den Chat mit der Ausgabe von `/weatherforecast`, z. B. "Wettervorhersage für Berlin: 07.08.2025: Bewölkt, 16.0°C | 08.08.2025: Klar, 18.5°C | ...". +- **Anleitung**: Führe `/weatherforecast` aus und mache einen Screenshot des Chats. +- **Bildgenerierung-Prompt**: "Ein Minecraft-Chat mit einer Wettervorhersage: 'Wettervorhersage für Berlin: 07.08.2025: Bewölkt, 16.0°C | 08.08.2025: Klar, 18.5°C | 09.08.2025: Regen, 14.5°C' in grüner Schrift auf schwarzem Hintergrund. Minecraft-Pixelstil." \ No newline at end of file