commit 6405c16d64c5e210566cd6eef476d4895839007a Author: Jack Fitch <55409055+Jack1424@users.noreply.github.com> Date: Thu Oct 20 19:47:25 2022 -0400 initial commit Signed-off-by: Jack Fitch <55409055+Jack1424@users.noreply.github.com> diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bacfb35 --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +# User-specific IDEA files +.idea +*.iml + +# Gradle build files +.gradle +**/build/ +!src/**/build/ + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f8f552 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# RealTimeWeather +A lightweight Minecraft Java server plugin that allows you to sync your server's time and weather with the real world \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..a040f94 --- /dev/null +++ b/build.gradle @@ -0,0 +1,49 @@ +plugins { + id 'java' + id 'com.github.johnrengelman.shadow' version '7.1.2' +} + +group = 'io.github.Jack1424' +version = '0.1.0' + +repositories { + mavenCentral() + maven { + name = 'papermc-repo' + url = 'https://repo.papermc.io/repository/maven-public/' + } + maven { + name = 'sonatype' + url = 'https://oss.sonatype.org/content/groups/public/' + } +} + +dependencies { + compileOnly 'io.papermc.paper:paper-api:1.19.2-R0.1-SNAPSHOT' + implementation 'com.github.prominence:openweathermap-api:2.3.0' +} + +def targetJavaVersion = 17 +java { + def javaVersion = JavaVersion.toVersion(targetJavaVersion) + sourceCompatibility = javaVersion + targetCompatibility = javaVersion + if (JavaVersion.current() < javaVersion) { + toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion) + } +} + +tasks.withType(JavaCompile).configureEach { + if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible()) { + options.release = targetJavaVersion + } +} + +processResources { + def props = [version: version] + inputs.properties props + filteringCharset 'UTF-8' + filesMatching('plugin.yml') { + expand props + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..e69de29 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..2e6e589 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..c53aefa --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..067c2e8 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'RealTimeWeather' diff --git a/src/main/java/io/github/jack1424/realtimeweather/RealTimeWeather.java b/src/main/java/io/github/jack1424/realtimeweather/RealTimeWeather.java new file mode 100644 index 0000000..92d0557 --- /dev/null +++ b/src/main/java/io/github/jack1424/realtimeweather/RealTimeWeather.java @@ -0,0 +1,160 @@ +package io.github.jack1424.realtimeweather; + +import com.github.prominence.openweathermap.api.OpenWeatherMapClient; +import org.bukkit.GameRule; +import org.bukkit.World; +import org.bukkit.plugin.java.JavaPlugin; + +import javax.net.ssl.HttpsURLConnection; +import java.net.URL; +import java.time.ZoneId; +import java.time.zone.ZoneRulesException; +import java.util.Calendar; +import java.util.Objects; +import java.util.TimeZone; +import java.util.logging.Logger; + +public final class RealTimeWeather extends JavaPlugin { + /* + TODO: + - Check configuration error handling + - Check debug outputs + - Make logs look better (colors and stuff) + - Override default minecraft time/weather commands (when applicable) + */ + + private Logger logger; + private String zipCode, countryCode; + private ZoneId timezone; + private boolean timeEnabled, weatherEnabled, debug; + + @Override + public void onEnable() { + logger = getLogger(); + logger.info("Starting..."); + + saveDefaultConfig(); + + debug = getConfig().getBoolean("Debug"); + + timeEnabled = getConfig().getBoolean("SyncTime"); + if (timeEnabled) + setupTime(); + + weatherEnabled = getConfig().getBoolean("SyncWeather"); + if (weatherEnabled) + setupWeather(); + + logger.info("Started!"); + } + + @Override + public void onDisable() { + for (World world : getServer().getWorlds()) + if (world.getEnvironment().equals(World.Environment.NORMAL)) { + debug("Re-enabling normal daylight and weather cycles..."); + + world.setGameRule(GameRule.DO_DAYLIGHT_CYCLE, true); + world.setGameRule(GameRule.DO_WEATHER_CYCLE, true); + } + + logger.info("Stopping..."); + } + + private void setupTime() { + try { + timezone = ZoneId.of(Objects.requireNonNull(getConfig().getString("Timezone"))); + } catch (NullPointerException|ZoneRulesException e) { + logger.severe("Error loading timezone. Check that the values in your configuration file are valid."); + debug(e.getMessage()); + logger.severe("Disabling time sync..."); + + timeEnabled = false; + return; + } + + debug("Enabling time zone sync (every second)"); + debug("Syncing time with " + timezone.toString()); + + for (World world : getServer().getWorlds()) + if (world.getEnvironment().equals(World.Environment.NORMAL)) + world.setGameRule(GameRule.DO_DAYLIGHT_CYCLE, false); + + getServer().getScheduler().scheduleSyncRepeatingTask(this, () -> { + if (timeEnabled) { + Calendar cal = Calendar.getInstance(TimeZone.getTimeZone(timezone)); + for (World world : getServer().getWorlds()) + if (world.getEnvironment().equals(World.Environment.NORMAL)) + world.setTime((1000 * cal.get(Calendar.HOUR_OF_DAY)) + (16 * cal.get(Calendar.MINUTE)) - 6000); // TODO: Time is one minute behind + } + }, 0L, 20L); // TODO: Does this really need to update every second? + } + + private void setupWeather() { + String apiKey = getConfig().getString("APIKey"); + zipCode = getConfig().getString("ZipCode"); + countryCode = getConfig().getString("CountryCode"); + + try { + HttpsURLConnection con = (HttpsURLConnection) new URL(String.format("https://api.openweathermap.org/geo/1.0/zip?zip=%s,%s&appid=%s", zipCode, countryCode, apiKey)).openConnection(); + con.setRequestMethod("GET"); + con.connect(); + + int response = con.getResponseCode(); + if (response > 499) { + logger.severe("There was a server error when requesting weather information. Please try again later"); + throw new Exception("Server error"); + } + else if (response > 399) { + String message = "Error when getting weather information:"; + switch (response) { + case 401: logger.severe(message + "API key incorrect"); + case 404: logger.severe(message + "Zip/Country code incorrect"); + default: logger.severe("Unknown error"); + } + logger.severe("Please check that the values set in the config file are correct"); + + throw new Exception("Configuration error"); + } + } catch (Exception e) { + debug(e.getMessage()); + logger.severe("Disabling weather sync..."); + + weatherEnabled = false; + return; + } + + OpenWeatherMapClient owm = new OpenWeatherMapClient(apiKey); + + getServer().getScheduler().scheduleSyncRepeatingTask(this, () -> { + debug("Syncing weather..."); + + int weatherId = 0; + try { + weatherId = owm.currentWeather().single().byZipCodeAndCountry(zipCode, countryCode).retrieve().asJava().getWeatherState().getId(); + } catch (Exception e) { + logger.severe("There was an error when attempting to get weather information"); + debug(e.getMessage()); + } + + while(weatherId >= 10) + weatherId /= 10; + + boolean rain = weatherId == 2 || weatherId == 3 || weatherId == 5 || weatherId == 6; + boolean thunder = weatherId == 2; + + debug("Setting weather (Rain: " + rain + ", Thunder: " + thunder + ")..."); + for (World world : getServer().getWorlds()) + if (world.getEnvironment().equals(World.Environment.NORMAL)) { + world.setStorm(rain); + world.setThundering(thunder); + } + }, 0L, 6000L); + } + + private void debug(String message) { + if (debug) { + logger.info(message); + } + } +} diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml new file mode 100644 index 0000000..948808d --- /dev/null +++ b/src/main/resources/config.yml @@ -0,0 +1,35 @@ +# RealTimeWeather Configuration File (v1) +# Configure RTM below BEFORE using it + +################################# TIME SYNC SETTINGS ################################################################# +# Set to true to enable time syncing, or false to disable # +SyncTime: false +# # +# Enter the time zone that you want to sync your world(s) with # +# This value CAN be different from your chosen weather location # +# Acceptable formats include: EST, America/Los_Angeles, and GMT-8:00 # +# You can find a full list of timezones here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List # +Timezone: 'America/New_York' +# # +###################################################################################################################### + +################################# WEATHER SYNC SETTINGS ############################################################## +# Set to true to enable weather syncing, or false to disable # +SyncWeather: false +# # +# In order to access the weather sync feature, create an account at https://openweathermap.org/ # +# Then, create an API key at https://openweathermap.org/appid and copy it # +# Finally, paste the API key below and DO NOT SHARE IT WITH OTHERS # +APIKey: 'API_KEY' +# Enter the zip code and country code of the location that you want to sync your world(s) weather with # +# NOTE: A list of country codes can be found at https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes # +ZipCode: '10001' +CountryCode: 'US' +# # +###################################################################################################################### + +# Set to true for various console messages when time and weather sync are executed +# This will also provide java error messages when an error is caught and managed by RTM +# Note: There will be no messages during a time sync because they happen every second +# Note: Java exceptions and fatal plugin errors will still be logged regardless of the debug value +Debug: false \ No newline at end of file diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml new file mode 100644 index 0000000..b792591 --- /dev/null +++ b/src/main/resources/plugin.yml @@ -0,0 +1,7 @@ +name: RealTimeWeather +version: '${version}' +description: Sync your server time and weather with the real world +main: io.github.jack1424.realtimeweather.RealTimeWeather +api-version: 1.19 +authors: [ Jack1424 ] +website: https://github.com/Jack1424/RealTimeWeather