diff --git a/README.md b/README.md index 3b679a9..32732d8 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,9 @@ Go [**here**](https://github.com/vladmarica/better-ping-display) for the Minecra This is a client-side mod. The server doesn't need to have it installed. It works even when playing on vanilla servers. ## Configuration + +__If you have a [ModMenu](https://modrinth.com/mod/modmenu) installed, you can edit mod's config using it.__ + This mod's config file is `betterpingdisplay.json`. It contains the following options: | Option | Default Value | Description | @@ -25,6 +28,7 @@ This mod's config file is `betterpingdisplay.json`. It contains the following op * **1.16.x** * **1.17.x** * **1.18.x** +* **1.19.x** ## Requirements * [Fabric](https://fabricmc.net/) diff --git a/build.gradle b/build.gradle index 0376875..6c724e1 100644 --- a/build.gradle +++ b/build.gradle @@ -1,34 +1,37 @@ plugins { - id 'fabric-loom' version '0.12-SNAPSHOT' + id 'fabric-loom' version '1.0-SNAPSHOT' id 'maven-publish' } -sourceCompatibility = JavaVersion.VERSION_14 -targetCompatibility = JavaVersion.VERSION_14 +sourceCompatibility = JavaVersion.VERSION_17 +targetCompatibility = JavaVersion.VERSION_17 archivesBaseName = project.archives_base_name version = project.mod_version group = project.maven_group +repositories { + maven { url "https://maven.shedaniel.me/" } + maven { url "https://maven.terraformersmc.com/releases/" } +} + dependencies { minecraft "com.mojang:minecraft:${project.minecraft_version}" mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2" modImplementation "net.fabricmc:fabric-loader:${project.loader_version}" modImplementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}" + include(modImplementation("me.shedaniel.cloth:cloth-config-fabric:${project.cloth_config_version}") { + exclude(group: "net.fabricmc.fabric-api") + }) + modImplementation "com.terraformersmc:modmenu:${project.modmenu_version}" testImplementation 'junit:junit:4.13' } processResources { - inputs.property "version", project.version - duplicatesStrategy = 'warn' + inputs.property 'version', version - from(sourceSets.main.resources.srcDirs) { - include "fabric.mod.json" - expand "version": project.version - } - - from(sourceSets.main.resources.srcDirs) { - exclude "fabric.mod.json" + filesMatching('fabric.mod.json') { + expand "version": version } } @@ -36,49 +39,14 @@ tasks.withType(JavaCompile) { options.encoding = "UTF-8" } -// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task -// if it is present. -// If you remove this task, sources will not be generated. -task sourcesJar(type: Jar, dependsOn: classes) { - classifier = "sources" - from sourceSets.main.allSource +java { + withSourcesJar() } jar { from "LICENSE" } -// configure the maven publication -publishing { - publications { - mavenJava(MavenPublication) { - // add all the jars that should be included when publishing to maven - artifact(remapJar) { - builtBy remapJar - } - artifact(sourcesJar) { - builtBy remapSourcesJar - } - } - } - - // select the repositories you want to publish to - repositories { - // uncomment to publish to the local maven - // mavenLocal() - } -} - -sourceSets { - main.java { - include 'com/vladmarica/betterpingdisplay/**/*' - exclude 'net/fabricmc/*' - } - test.java { - include 'com/vladmarica/betterpingdisplay/**/*' - } -} - test { useJUnit() } diff --git a/gradle.properties b/gradle.properties index ca95ae6..ab8b473 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,17 +1,23 @@ # Done to increase the memory available to gradle. -org.gradle.jvmargs=-Xmx1G +org.gradle.jvmargs=-Xmx3G # Fabric Properties - # check these on https://fabricmc.net/use - minecraft_version=1.19.2 - yarn_mappings=1.19.2+build.18 - loader_version=0.14.9 +# check these on https://fabricmc.net/develop +minecraft_version=1.19.3 +yarn_mappings=1.19.3+build.3 +loader_version=0.14.11 # Mod Properties - mod_version = 1.1.1 - maven_group = com.vladmarica - archives_base_name = BetterPingDisplay-Fabric +mod_version=1.2.0 +maven_group=com.vladmarica +archives_base_name=BetterPingDisplay-Fabric # Dependencies - # currently not on the main fabric site, check on the maven: https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-api - fabric_version=0.62.0+1.19.2 +# check these on https://fabricmc.net/develop +fabric_version=0.68.1+1.19.3 + +# ModMenu api +modmenu_version=5.0.2 + +# Cloth config for config screen +cloth_config_version=9.0.94 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 62d4c05..249e583 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index e750102..ae04661 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index fbd7c51..a69d9cb 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# 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. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# 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 -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +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 -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +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" +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 - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +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 @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 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" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + 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 @@ -106,80 +140,101 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi -fi - -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi - -# For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi - # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" - fi - i=`expr $i + 1` - done - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; +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 -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# 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. -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +# 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 \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# 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 index 5093609..f127cfd 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -14,7 +14,7 @@ @rem limitations under the License. @rem -@if "%DEBUG%" == "" @echo off +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -25,7 +25,7 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if %ERRORLEVEL% equ 0 goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -54,7 +54,7 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% @@ -64,21 +64,6 @@ echo location of your Java installation. goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :execute @rem Setup the command line @@ -86,17 +71,19 @@ 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 %CMD_LINE_ARGS% +"%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 +if %ERRORLEVEL% equ 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 +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% :mainEnd if "%OS%"=="Windows_NT" endlocal diff --git a/src/main/java/com/vladmarica/betterpingdisplay/BetterPingDisplayMod.java b/src/main/java/com/vladmarica/betterpingdisplay/BetterPingDisplayMod.java index 29a4e33..bd2c51e 100644 --- a/src/main/java/com/vladmarica/betterpingdisplay/BetterPingDisplayMod.java +++ b/src/main/java/com/vladmarica/betterpingdisplay/BetterPingDisplayMod.java @@ -1,47 +1,33 @@ package com.vladmarica.betterpingdisplay; -import com.vladmarica.betterpingdisplay.Config.ConfigData; -import java.io.File; -import java.nio.file.Path; +import com.vladmarica.betterpingdisplay.config.Config; +import com.vladmarica.betterpingdisplay.config.ConfigManager; import net.fabricmc.api.ModInitializer; -import net.fabricmc.loader.api.FabricLoader; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; public class BetterPingDisplayMod implements ModInitializer { public static final String MODID = "betterpingdisplay"; public static final Logger LOGGER = LogManager.getLogger(MODID); - private static final String CONFIG_FILE_NAME = MODID + ".json"; private static BetterPingDisplayMod INSTANCE; - private Config config = new Config(); + private ConfigManager configManager = new ConfigManager(); + private Config config; @Override public void onInitialize() { INSTANCE = this; - Path configFilePath = FabricLoader.getInstance().getConfigDir().resolve(CONFIG_FILE_NAME); - File configFile = configFilePath.toFile(); - if (configFile.exists()) { - try { - ConfigData data = Config.loadConfigFile(configFile); - config = new Config(data); - Config.writeConfigFile(configFile, data); - } catch (Exception ex) { - LOGGER.error("Failed to load config file, using default. Error: {}", ex.getMessage()); - } - } else { - try { - LOGGER.warn("Could not find config file, creating a default one"); - Config.writeConfigFile(configFile, new ConfigData()); - } catch (Exception ex) { - LOGGER.error("Failed to write default config file. Error: {}", ex.getMessage()); - } - } + configManager = new ConfigManager(); + config = configManager.getConfig(); LOGGER.info("BetterPingDisplay mod loaded"); } + public ConfigManager getConfigManager() { + return configManager; + } + public Config getConfig() { return config; } diff --git a/src/main/java/com/vladmarica/betterpingdisplay/Config.java b/src/main/java/com/vladmarica/betterpingdisplay/Config.java deleted file mode 100644 index 90373a8..0000000 --- a/src/main/java/com/vladmarica/betterpingdisplay/Config.java +++ /dev/null @@ -1,105 +0,0 @@ -package com.vladmarica.betterpingdisplay; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.annotations.Expose; -import java.io.File; -import java.io.FileReader; -import java.io.FileWriter; -import java.io.IOException; -import java.io.Serializable; - -public class Config { - private static final int DEFAULT_PING_TEXT_COLOR = 0xA0A0A0; - private static final String DEFAULT_PING_TEXT_FORMAT = "%dms"; - - private final boolean autoColorPingText; - private final boolean renderPingBars; - private int textColor = DEFAULT_PING_TEXT_COLOR; - private String textFormatString = DEFAULT_PING_TEXT_FORMAT; - - public Config(ConfigData configFileFormat) { - if (configFileFormat.pingTextColor.startsWith("#")) { - try { - textColor = Integer.parseInt(configFileFormat.pingTextColor.substring(1), 16); - } - catch (NumberFormatException ex) { - BetterPingDisplayMod.LOGGER.error("Config option 'pingTextColor' is invalid - it must be a hex color code"); - } - } - else { - BetterPingDisplayMod.LOGGER.error("Config option 'pingTextColor' is invalid - it must be a hex color code"); - } - - if (configFileFormat.pingTextFormatString.contains("%d")) { - textFormatString = configFileFormat.pingTextFormatString; - } - else { - BetterPingDisplayMod.LOGGER.error("Config option 'pingTextFormatString' is invalid - it needs to contain %d"); - } - - autoColorPingText = configFileFormat.autoColorPingText; - renderPingBars = configFileFormat.renderPingBars; - } - - public Config() { - this(new ConfigData()); - } - - public int getTextColor() { - return this.textColor; - } - - public String getTextFormatString() { - return this.textFormatString; - } - - public boolean shouldAutoColorPingText() { - return this.autoColorPingText; - } - - public boolean shouldRenderPingBars() { - return this.renderPingBars; - } - - public static ConfigData loadConfigFile(File configFile) throws IOException { - FileReader reader = null; - try { - Gson gson = new Gson(); - reader = new FileReader(configFile); - return gson.fromJson(reader, ConfigData.class); - } - finally { - if (reader != null) { - reader.close(); - } - } - } - - public static void writeConfigFile(File configFile, ConfigData data) throws IOException { - FileWriter writer = null; - try { - Gson gson = new GsonBuilder().setPrettyPrinting().create(); - writer = new FileWriter(configFile); - writer.write(gson.toJson(data)); - } finally { - if (writer != null) { - writer.close(); - } - } - } - - public static class ConfigData implements Serializable { - @Expose - private boolean autoColorPingText = true; - - @Expose - private boolean renderPingBars = false; - - @Expose - private String pingTextColor = "#A0A0A0"; - - @Expose - private String pingTextFormatString = "%dms"; - } -} diff --git a/src/main/java/com/vladmarica/betterpingdisplay/ModMenuIntegration.java b/src/main/java/com/vladmarica/betterpingdisplay/ModMenuIntegration.java new file mode 100644 index 0000000..5f65f5a --- /dev/null +++ b/src/main/java/com/vladmarica/betterpingdisplay/ModMenuIntegration.java @@ -0,0 +1,20 @@ +/* + * Copyright (c) 2022 DenaryDev + * + * Use of this source code is governed by an MIT-style + * license that can be found in the LICENSE file or at + * https://opensource.org/licenses/MIT. + */ +package com.vladmarica.betterpingdisplay; + +import com.terraformersmc.modmenu.api.ConfigScreenFactory; +import com.terraformersmc.modmenu.api.ModMenuApi; +import com.vladmarica.betterpingdisplay.gui.ConfigScreenBuilder; + +public class ModMenuIntegration implements ModMenuApi { + + @Override + public ConfigScreenFactory getModConfigScreenFactory() { + return ConfigScreenBuilder::build; + } +} diff --git a/src/main/java/com/vladmarica/betterpingdisplay/config/Config.java b/src/main/java/com/vladmarica/betterpingdisplay/config/Config.java new file mode 100644 index 0000000..121bf84 --- /dev/null +++ b/src/main/java/com/vladmarica/betterpingdisplay/config/Config.java @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2022 DenaryDev + * + * Use of this source code is governed by an MIT-style + * license that can be found in the LICENSE file or at + * https://opensource.org/licenses/MIT. + */ +package com.vladmarica.betterpingdisplay.config; + +import com.google.gson.annotations.Expose; + +import java.io.Serializable; + +public class Config implements Serializable { + @Expose + private boolean autoColorPingText = true; + + @Expose + private boolean renderPingBars = false; + + @Expose + private String pingTextColor = "#A0A0A0"; + + @Expose + private String pingTextFormatString = "%dms"; + + private int textColor = Integer.parseInt("A0A0A0", 16); + + public boolean shouldAutoColorPingText() { + return autoColorPingText; + } + + public void setAutoColorPingText(boolean autoColorPingText) { + this.autoColorPingText = autoColorPingText; + } + + public boolean shouldRenderPingBars() { + return renderPingBars; + } + + public void setRenderPingBars(boolean renderPingBars) { + this.renderPingBars = renderPingBars; + } + + public String getPingTextColor() { + return pingTextColor; + } + + public String getPingTextFormat() { + return pingTextFormatString; + } + + public void setPingTextFormat(String pingTextFormat) { + this.pingTextFormatString = pingTextFormat; + } + + public int getTextColor() { + return textColor; + } + + public void setTextColor(int textColor) { + this.pingTextColor = "#" + Integer.toHexString(textColor); + this.textColor = textColor; + } +} diff --git a/src/main/java/com/vladmarica/betterpingdisplay/config/ConfigManager.java b/src/main/java/com/vladmarica/betterpingdisplay/config/ConfigManager.java new file mode 100644 index 0000000..0780fcc --- /dev/null +++ b/src/main/java/com/vladmarica/betterpingdisplay/config/ConfigManager.java @@ -0,0 +1,87 @@ +package com.vladmarica.betterpingdisplay.config; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.vladmarica.betterpingdisplay.BetterPingDisplayMod; +import net.fabricmc.loader.api.FabricLoader; +import org.apache.commons.io.FileUtils; + +import java.io.File; +import java.nio.charset.Charset; +import java.util.concurrent.Executor; +import java.util.concurrent.Executors; + +public class ConfigManager { + + private Config config; + + private final Gson gson; + private final File configFile; + + private final Executor executor = Executors.newSingleThreadExecutor(); + + public ConfigManager() { + this.gson = new GsonBuilder().setPrettyPrinting().excludeFieldsWithoutExposeAnnotation().create(); + this.configFile = new File(FabricLoader.getInstance().getConfigDir().toString(), BetterPingDisplayMod.MODID + ".json"); + readConfig(false); + } + + public Config getConfig() { + return config; + } + + public void readConfig(boolean async) { + Runnable task = () -> { + try { + if (configFile.exists()) { + String content = FileUtils.readFileToString(configFile, Charset.defaultCharset()); + config = gson.fromJson(content, Config.class); + + if (config.getPingTextColor().startsWith("#")) { + try { + config.setTextColor(Integer.parseInt(config.getPingTextColor().substring(1), 16)); + } catch (NumberFormatException ex) { + BetterPingDisplayMod.LOGGER.error("Config option 'pingTextColor' is invalid - it must be a hex color code"); + } + } else { + BetterPingDisplayMod.LOGGER.error("Config option 'pingTextColor' is invalid - it must be a hex color code"); + } + + if (!config.getPingTextFormat().contains("%d")) { + config.setPingTextFormat(""); + BetterPingDisplayMod.LOGGER.error("Config option 'pingTextFormatString' is invalid - it needs to contain %d"); + } + } else { + writeNewConfig(); + } + } catch (Exception ex) { + ex.printStackTrace(); + writeNewConfig(); + } + }; + + if (async) executor.execute(task); + else task.run(); + } + + public void writeNewConfig() { + config = new Config(); + writeConfig(false); + } + + public void writeConfig(boolean async) { + Runnable task = () -> { + try { + if (config != null) { + String serialized = gson.toJson(config); + FileUtils.writeStringToFile(configFile, serialized, Charset.defaultCharset()); + } + } catch (Exception e) { + e.printStackTrace(); + } + }; + + if (async) executor.execute(task); + else task.run(); + } +} diff --git a/src/main/java/com/vladmarica/betterpingdisplay/gui/ConfigScreenBuilder.java b/src/main/java/com/vladmarica/betterpingdisplay/gui/ConfigScreenBuilder.java new file mode 100644 index 0000000..48b3b9f --- /dev/null +++ b/src/main/java/com/vladmarica/betterpingdisplay/gui/ConfigScreenBuilder.java @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2022 DenaryDev + * + * Use of this source code is governed by an MIT-style + * license that can be found in the LICENSE file or at + * https://opensource.org/licenses/MIT. + */ +package com.vladmarica.betterpingdisplay.gui; + +import com.vladmarica.betterpingdisplay.BetterPingDisplayMod; +import com.vladmarica.betterpingdisplay.config.Config; +import me.shedaniel.clothconfig2.api.ConfigBuilder; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.client.resource.language.I18n; +import net.minecraft.text.Text; + +import java.util.ArrayList; +import java.util.Optional; +import java.util.function.Function; + +public class ConfigScreenBuilder { + + private static final Function yesNoSupplier = bool -> { + if (bool) return Text.translatable("label.betterpingdisplay.on"); + else return Text.translatable("label.betterpingdisplay.off"); + }; + + public static Screen build(Screen parent) { + final var defaults = new Config(); + final var current = BetterPingDisplayMod.instance().getConfig(); + + final var builder = ConfigBuilder.create() + .setParentScreen(parent) + .setTitle(Text.translatable("title.betterpingdisplay.config")) + .transparentBackground() + .setDoesConfirmSave(true) + .setSavingRunnable(() -> BetterPingDisplayMod.instance().getConfigManager().writeConfig(true)); + + final var entryBuilder = builder.entryBuilder(); + final var category = builder.getOrCreateCategory(Text.translatable("category.betterpingdisplay.main")); + + final var toggleAutoColorPingText = entryBuilder.startBooleanToggle(Text.translatable("options.betterpingdisplay.autoColorPingText"), current.shouldAutoColorPingText()) + .setDefaultValue(defaults.shouldAutoColorPingText()) + .setYesNoTextSupplier(yesNoSupplier) + .setTooltip(getTooltip("autoColorPingText")) + .setSaveConsumer(current::setAutoColorPingText) + .build(); + + final var toggleRenderPingBars = entryBuilder.startBooleanToggle(Text.translatable("options.betterpingdisplay.renderPingBars"), current.shouldRenderPingBars()) + .setDefaultValue(defaults.shouldRenderPingBars()) + .setYesNoTextSupplier(yesNoSupplier) + .setTooltip(getTooltip("renderPingBars")) + .setSaveConsumer(current::setRenderPingBars) + .build(); + + final var setPingTextColor = entryBuilder.startColorField(Text.translatable("options.betterpingdisplay.pingTextColor"), current.getTextColor()) + .setDefaultValue(defaults.getTextColor()) + .setTooltip(getTooltip("pingTextColor")) + .setSaveConsumer(current::setTextColor) + .build(); + + final var setPingTextFormat = entryBuilder.startStrField(Text.translatable("options.betterpingdisplay.pingTextFormat"), current.getPingTextFormat()) + .setDefaultValue(defaults.getPingTextFormat()) + .setTooltip(getTooltip("pingTextFormat")) + .setErrorSupplier(val -> { + if (!val.contains("%d")) { + return Optional.of(Text.translatable("options.betterpingdisplay.pingTextFormat.error")); + } + return Optional.empty(); + }) + .setSaveConsumer(current::setPingTextFormat) + .build(); + + category.addEntry(toggleAutoColorPingText); + category.addEntry(toggleRenderPingBars); + category.addEntry(setPingTextColor); + category.addEntry(setPingTextFormat); + + return builder.build(); + } + + private static Text[] getTooltip(String key) { + final var list = new ArrayList(); + + for (int i = 0; i < 10; i++) { + String finalKey = key + ".tooltip." + (i + 1); + String value = I18n.translate(finalKey); + + if (value.equals(finalKey)) break; + + list.add(Text.of(value)); + } + + return list.size() == 0 ? null : list.toArray(new Text[0]); + } +} diff --git a/src/main/java/com/vladmarica/betterpingdisplay/hud/CustomPlayerListHud.java b/src/main/java/com/vladmarica/betterpingdisplay/hud/CustomPlayerListHud.java index ed66ea5..d0890d2 100644 --- a/src/main/java/com/vladmarica/betterpingdisplay/hud/CustomPlayerListHud.java +++ b/src/main/java/com/vladmarica/betterpingdisplay/hud/CustomPlayerListHud.java @@ -2,7 +2,7 @@ package com.vladmarica.betterpingdisplay.hud; import com.mojang.blaze3d.systems.RenderSystem; import com.vladmarica.betterpingdisplay.BetterPingDisplayMod; -import com.vladmarica.betterpingdisplay.Config; +import com.vladmarica.betterpingdisplay.config.Config; import com.vladmarica.betterpingdisplay.mixin.PlayerListHudInvoker; import net.minecraft.client.MinecraftClient; import net.minecraft.client.font.TextRenderer; @@ -13,25 +13,25 @@ import net.minecraft.client.util.math.MatrixStack; public final class CustomPlayerListHud { private static final int PING_TEXT_RENDER_OFFSET = -13; private static final int PING_BARS_WIDTH = 11; - private static final Config config = BetterPingDisplayMod.instance().getConfig(); + private static final Config CONFIG = BetterPingDisplayMod.instance().getConfig(); public static void renderPingDisplay( MinecraftClient client, PlayerListHud hud, MatrixStack matrixStack, int width, int x, int y, PlayerListEntry player) { TextRenderer textRenderer = client.textRenderer; - String pingString = String.format(config.getTextFormatString(), player.getLatency()); + String pingString = String.format(CONFIG.getPingTextFormat(), player.getLatency()); int pingStringWidth = textRenderer.getWidth(pingString); - int pingTextColor = config.shouldAutoColorPingText() ? PingColors.getColor(player.getLatency()) : config.getTextColor(); + int pingTextColor = CONFIG.shouldAutoColorPingText() ? PingColors.getColor(player.getLatency()) : CONFIG.getTextColor(); int textX = width + x - pingStringWidth + PING_TEXT_RENDER_OFFSET; - if (!config.shouldRenderPingBars()) { + if (!CONFIG.shouldRenderPingBars()) { textX += PING_BARS_WIDTH; } // Draw the ping text for the given player textRenderer.drawWithShadow(matrixStack, pingString, (float) textX, (float) y, pingTextColor); - if (config.shouldRenderPingBars()) { + if (CONFIG.shouldRenderPingBars()) { ((PlayerListHudInvoker) hud).invokeRenderLatencyIcon(matrixStack, width, x, y, player); } else { // If we don't render ping bars, we need to reset the render system color so the rest diff --git a/src/main/resources/assets/betterpingdisplay/lang/en_us.json b/src/main/resources/assets/betterpingdisplay/lang/en_us.json new file mode 100644 index 0000000..1af7fb1 --- /dev/null +++ b/src/main/resources/assets/betterpingdisplay/lang/en_us.json @@ -0,0 +1,23 @@ +{ + "label.betterpingdisplay.on": "\u00A7aOn", + "label.betterpingdisplay.off": "\u00A7eOff", + + "title.betterpingdisplay.config": "BetterPingDisplay Settings", + + "options.betterpingdisplay.autoColorPingText": "Auto-color ping text", + "options.betterpingdisplay.autoColorPingText.tooltip.1": "Whether to color a player's ping based on their latency.", + "options.betterpingdisplay.autoColorPingText.tooltip.2": "E.g, low latency = green, high latency = red", + + "options.betterpingdisplay.renderPingBars": "Render ping bars", + "options.betterpingdisplay.renderPingBars.tooltip.1": "Whether to also draw the default Minecraft ping bars", + + "options.betterpingdisplay.pingTextColor": "Ping text color", + "options.betterpingdisplay.pingTextColor.tooltip.1": "The ping text color to use.", + "options.betterpingdisplay.pingTextColor.tooltip.2": "It only works when the auto-color ping text is turned off", + + "options.betterpingdisplay.pingTextFormat": "Ping text format", + "options.betterpingdisplay.pingTextFormat.tooltip.1": "The format string for ping text.", + "options.betterpingdisplay.pingTextFormat.tooltip.2": "Must include a `%d`, which will be replaced", + "options.betterpingdisplay.pingTextFormat.tooltip.3": "dynamically by the actual ping value.", + "options.betterpingdisplay.pingTextFormat.error": "This parameter must contain %d" +} \ No newline at end of file diff --git a/src/main/resources/assets/betterpingdisplay/lang/ru_ru.json b/src/main/resources/assets/betterpingdisplay/lang/ru_ru.json new file mode 100644 index 0000000..108922e --- /dev/null +++ b/src/main/resources/assets/betterpingdisplay/lang/ru_ru.json @@ -0,0 +1,22 @@ +{ + "label.betterpingdisplay.on": "\u00A7aВкл", + "label.betterpingdisplay.off": "\u00A7eВыкл", + + "title.betterpingdisplay.config": "Настройки BetterPingDisplay", + + "options.betterpingdisplay.autoColorPingText": "Автоматический цвет пинга", + "options.betterpingdisplay.autoColorPingText.tooltip.1": "Следует ли изменять цвет пинга в зависимости от значения.", + "options.betterpingdisplay.autoColorPingText.tooltip.2": "Например, низкий пинг = зелёный, высокий пинг = красный", + + "options.betterpingdisplay.renderPingBars": "Отображать пинг-бары", + "options.betterpingdisplay.renderPingBars.tooltip.1": "Следует ли также рисовать пинг-бары Minecraft по умолчанию", + + "options.betterpingdisplay.pingTextColor": "Цвет пинга", + "options.betterpingdisplay.pingTextColor.tooltip.2": "Это работает только если автоматический цвет выключен", + + "options.betterpingdisplay.pingTextFormat": "Формат пинга", + "options.betterpingdisplay.pingTextFormat.tooltip.1": "Формат для текста пинга", + "options.betterpingdisplay.pingTextFormat.tooltip.2": "Должен содержать `%d`, который будет заменён", + "options.betterpingdisplay.pingTextFormat.tooltip.3": "на текущее значение пинга игрока.", + "options.betterpingdisplay.pingTextFormat.error": "Этот параметр должен содержать `%d`" +} \ No newline at end of file diff --git a/src/main/resources/betterpingdisplay.mixins.json b/src/main/resources/betterpingdisplay.mixins.json index 0fe092b..0366dcc 100644 --- a/src/main/resources/betterpingdisplay.mixins.json +++ b/src/main/resources/betterpingdisplay.mixins.json @@ -2,7 +2,7 @@ "required": true, "minVersion": "0.8", "package": "com.vladmarica.betterpingdisplay.mixin", - "compatibilityLevel": "JAVA_8", + "compatibilityLevel": "JAVA_17", "mixins": [ ], "client": [ diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json index 79136cf..7a4181a 100644 --- a/src/main/resources/fabric.mod.json +++ b/src/main/resources/fabric.mod.json @@ -1,7 +1,7 @@ { "schemaVersion": 1, "id": "betterpingdisplay", - "version": "1.1.1", + "version": "${version}", "name": "Better Ping Display", "description": "Shows the actual ping number instead of just bars in the player list!", @@ -21,6 +21,9 @@ "entrypoints": { "main": [ "com.vladmarica.betterpingdisplay.BetterPingDisplayMod" + ], + "modmenu": [ + "com.vladmarica.betterpingdisplay.ModMenuIntegration" ] }, "mixins": [ @@ -29,7 +32,7 @@ "depends": { "fabricloader": ">=0.14", - "minecraft": "1.19.2" + "minecraft": "1.19.3" }, "suggests": {} }