diff --git a/README.md b/README.md index ad7d7ee..017fd9c 100644 --- a/README.md +++ b/README.md @@ -1,141 +1,108 @@ # 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. +**RealTimeWeather** ist ein Bukkit/Spigot/Paper-Plugin, das echte Wetter- und Zeitdaten aus der realen Welt in deine Minecraft-Welt synchronisiert und live auf der Actionbar anzeigt – inklusive Temperatur, Wettericon, Luftfeuchtigkeit, Windstärke und Sonnenauf-/untergang. -## Funktionen +## ⭐ Features -- **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. +- Echte Wetter- und Uhrzeit-Synchronisation pro Welt +- Anzeige auf der Actionbar: + Datum, Uhrzeit, Wetter-Icon, Temperatur, Luftfeuchtigkeit 💧, Windgeschwindigkeit 🌬️, Sonnenaufgang 🌅 & Sonnenuntergang 🌇 +- Eigene Location pro Spieler möglich (GUI & Befehl) +- Ingame-Vorhersage (5 Tage) als Command +- Wetterumschaltung auf Server synchron mit echten Wetterdaten (optional) +- Volle Mehrsprachigkeit über lang.yml +- Kompatibel mit Minecraft 1.19.x – 1.21.x -## Installation +## 🔧 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. +1. **Kopiere die Dateien:**
+ Die JAR nach `/plugins/` kopieren, Server neu starten. +2. **OpenWeatherMap API-Key** im `/plugins/RealTimeWeather/config.yml` eintragen: -## Konfiguration +api-key: "DEIN_OPENWEATHERMAP_API_KEY" -Die Konfigurationsdateien befinden sich im Ordner `plugins/RealTimeWeather/`. +Registriere gratis unter https://openweathermap.org. -### config.yml +3. **Plugin starten/neu laden:**
+`reload` Befehl (`/wetter reload`) oder Server-Neustart. + +## ⚙️ Kurzes Setup + +- Die wichtigsten Einstellungen sind in der `config.yml` dokumentiert (siehe unten). +- Du kannst für jede Welt eigene Locations, Anzeige-Modi oder Wettertypen setzen. + +## 🕹️ Kommandos + +| Befehl | Beschreibung | +|-----------------------|-----------------------------------------------| +| `/wetter help` | Alle Befehle und Kurzinfos anzeigen | +| `/wetter reload` | Konfiguration und Sprache neu laden | +| `/wetter setlocation ` | Eigene Stadt für Anzeige wählen | +| `/wetter query` | Zeigt das aktuelle Wetter für dich an | +| `/wetter info` | Infos zum Plugin | +| `/wetter gui` | Öffnet das GUI mit Schnell-Optionen | +| `/weatherforecast` | 5-Tage-Wetterprognose deiner Location | +| `/toggleweather` | Actionbar-Wetteranzeige für Welt (de)aktivieren | + +## 📊 Live-Anzeige (Actionbar) + +Beispiel: + +08.08.2025 18:31 ☁️ 21.7°C | 💧 68% | 🌬️ 2.5 m/s | 🌅 05:48 | 🌇 21:34 + +´´´yaml +## 📝 Beispiel-config.yml -```yaml api-key: "DEIN_API_KEY_HIER" -update-interval: 60 # Sekunden +update-interval: 60 + 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 +enabled: true +location: "Berlin,de" +units: "metric" +time-format: "24h" +display-actionbar: true +display-weather-icon: true + +display-position / padding-right werden zentriert ignoriert +display-position: "top-right" +padding-right: 100 +sync-in-game-weather: true + 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 - 1.21.8. - -## Konfiguration +world: +enabled: true +location: "Berlin,de" +units: "metric" +time-format: "24h" +display-actionbar: true +display-weather-icon: true +display-position: "top-left" +padding-right: 50 +sync-in-game-weather: true +world_nether: +enabled: false +location: "Berlin,de" +units: "metric" +time-format: "24h" +display-actionbar: true +display-weather-icon: false +display-position: "top-right" +padding-right: 150 +sync-in-game-weather: false +´´´ -### lang.yml +## 🧑‍💻 Erweiterungen -Enthält Übersetzungen für Deutsch (`de`) und Englisch (`en`). Beispiel für Deutsch: +- Anzeige von Feuchtigkeit, Wind & Sonnenzeiten kann leicht deaktiviert/angepasst werden (siehe Actionbar-Code). +- Ländercodes und Städte werden in OpenWeatherMap-Syntax verwendet, z. B. `London,gb`, `Frankfurt,de`. -```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 -``` +## ❤️ Lizenz -# RealTimeWeather +[MIT License](LICENSE) -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. +> Fragen, Feature-Wünsche oder Bugreports gerne als Gitea-Issue!