diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..097f9f9 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..b01da52 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,37 @@ +# Automatically build the project and run any configured tests for every push +# and submitted pull request. This can help catch issues that only occur on +# certain platforms or Java versions, and provides a first line of defence +# against bad commits. + +name: build +on: [pull_request, push] + +jobs: + build: + strategy: + matrix: + # Use these Java versions + java: [ + 21, # Current Java LTS + ] + runs-on: ubuntu-22.04 + steps: + - name: checkout repository + uses: actions/checkout@v4 + - name: validate gradle wrapper + uses: gradle/wrapper-validation-action@v2 + - name: setup jdk ${{ matrix.java }} + uses: actions/setup-java@v4 + with: + java-version: ${{ matrix.java }} + distribution: 'microsoft' + - name: make gradle wrapper executable + run: chmod +x ./gradlew + - name: build + run: ./gradlew build + - name: capture build artifacts + if: ${{ matrix.java == '21' }} # Only upload artifacts built from latest java + uses: actions/upload-artifact@v4 + with: + name: Artifacts + path: build/libs/ \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c476faf --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +# gradle + +.gradle/ +build/ +out/ +classes/ + +# eclipse + +*.launch + +# idea + +.idea/ +*.iml +*.ipr +*.iws + +# vscode + +.settings/ +.vscode/ +bin/ +.classpath +.project + +# macos + +*.DS_Store + +# fabric + +run/ + +# java + +hs_err_*.log +replay_*.log +*.hprof +*.jfr diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cd955f3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2024 fliplus + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..5112726 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# Simple Player List + +Simple Player List is a **server-side** mod which introduces the ability to customize server's player list through a +configuration file. + +## Features + +- Modify the player list appearance using a JSON configuration file. +- Show real-time server statistics directly in the player list. + +## Configuration + +Upon loading the mod for the first time, a default configuration file will be generated +(`config/simpleplayerlist.json`): + +```json +{ + "enable_mod": true, + "header": "§lDefault Config§r\n\n§7To change this, edit\nconfig/simpleplayerlist.json\n\n§r§b§m §r", + "footer": "§r§b§m §r\n\n§7TPS: %tps%§7/%mspt% §8-§7 Ping: %ping%\n§7Day: §b%day%", + "tick_update_interval": 20 +} +``` + +This file supports the [§-based formatting system](https://minecraft.wiki/w/Formatting_codes) and hex colors +(e.g., `§#FFFFFF`). + +The following placeholders will be dynamically replaced with real-time server information at the interval specified by +`tick_update_interval`: + +- `%mspt%`: Displays server the server's MSPT (Milliseconds Per Tick). +- `%tps%`: Displays the server's TPS (Ticks Per Second). +- `%ping%`: Shows the player's ping in milliseconds. +- `%day%`: Indicates the current in-game day. + +`%mspt%`, `%tps%` and `%ping%` are heatmap colored for easier interpretation. + +## Commands + +To apply changes made to the configuration file, you can use the in-game command `/playerlist reload`. You can also +enable or disable the mod with `/playerlist toggle`. + +Players without operator status can run `/playerlist` to toggle the mod on their end. + +## Support and Contributions + +Feel free to report issues or suggest features through the mod's issue tracker. Contributions are welcome - simply fork +the repository and submit a pull request with your improvements. + +--- + +[Fabric API](https://modrinth.com/mod/fabric-api) is required to run this mod. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..3b9fb21 --- /dev/null +++ b/build.gradle @@ -0,0 +1,65 @@ +plugins { + id 'fabric-loom' version '1.7-SNAPSHOT' +} + +version = project.mod_version +group = project.maven_group + +base { + archivesName = project.archives_base_name +} + +repositories { + // Add repositories to retrieve artifacts from in here. + // You should only use this when depending on other mods because + // Loom adds the essential maven repositories to download Minecraft and libraries from automatically. + // See https://docs.gradle.org/current/userguide/declaring_repositories.html + // for more information about repositories. + + maven { + name = 'ParchmentMC' + url = 'https://maven.parchmentmc.org' + } +} + +dependencies { + // To change the versions see the gradle.properties file + minecraft "com.mojang:minecraft:${project.minecraft_version}" + mappings loom.layered() { + officialMojangMappings() + parchment("org.parchmentmc.data:parchment-${project.minecraft_version}:${project.parchment_version}@zip") + } + modImplementation "net.fabricmc:fabric-loader:${project.loader_version}" + + // Fabric API. This is technically optional, but you probably want it anyway. + modImplementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}" + +} + +processResources { + inputs.property "version", project.version + + filesMatching("fabric.mod.json") { + expand "version": project.version + } +} + +tasks.withType(JavaCompile).configureEach { + it.options.release = 21 +} + +java { + // Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task + // if it is present. + // If you remove this line, sources will not be generated. + withSourcesJar() + + sourceCompatibility = JavaVersion.VERSION_21 + targetCompatibility = JavaVersion.VERSION_21 +} + +jar { + from("LICENSE") { + rename { "${it}_${project.base.archivesName.get()}"} + } +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..5a86fc4 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,17 @@ +# Done to increase the memory available to gradle. +org.gradle.jvmargs=-Xmx2G +org.gradle.parallel=true + +# Fabric Properties +# check these on https://fabricmc.net/develop +minecraft_version=1.21 +parchment_version=2024.07.28 +loader_version=0.15.11 + +# Mod Properties +mod_version=1.0 +maven_group=fliplus.simpleplayerlist +archives_base_name=simple-player-list + +# Dependencies +fabric_version=0.102.0+1.21 \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e644113 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..a441313 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..b740cf1 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/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/HEAD/platforms/jvm/plugins-application/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 + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# 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 + if ! command -v java >/dev/null 2>&1 + then + 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 +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + 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 + + +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +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 new file mode 100644 index 0000000..25da30d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@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=. +@rem This is normally unused +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% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +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% 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! +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 + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..75c4d72 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,10 @@ +pluginManagement { + repositories { + maven { + name = 'Fabric' + url = 'https://maven.fabricmc.net/' + } + mavenCentral() + gradlePluginPortal() + } +} \ No newline at end of file diff --git a/src/main/java/fliplus/simpleplayerlist/SimplePlayerList.java b/src/main/java/fliplus/simpleplayerlist/SimplePlayerList.java new file mode 100644 index 0000000..55eb094 --- /dev/null +++ b/src/main/java/fliplus/simpleplayerlist/SimplePlayerList.java @@ -0,0 +1,20 @@ +package fliplus.simpleplayerlist; + +import fliplus.simpleplayerlist.commands.PlayerListCommand; +import fliplus.simpleplayerlist.config.SimplePlayerListConfig; +import net.fabricmc.api.ModInitializer; + +import net.fabricmc.fabric.api.command.v2.CommandRegistrationCallback; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class SimplePlayerList implements ModInitializer { + public static final String MOD_ID = "simpleplayerlist"; + public static final Logger LOGGER = LoggerFactory.getLogger("simpleplayerlist"); + + @Override + public void onInitialize() { + SimplePlayerListConfig.INSTANCE.load(null); + CommandRegistrationCallback.EVENT.register(((dispatcher, registryAccess, environment) -> PlayerListCommand.register(dispatcher))); + } +} \ No newline at end of file diff --git a/src/main/java/fliplus/simpleplayerlist/commands/PlayerListCommand.java b/src/main/java/fliplus/simpleplayerlist/commands/PlayerListCommand.java new file mode 100644 index 0000000..cc0bf24 --- /dev/null +++ b/src/main/java/fliplus/simpleplayerlist/commands/PlayerListCommand.java @@ -0,0 +1,55 @@ +package fliplus.simpleplayerlist.commands; + +import com.mojang.brigadier.CommandDispatcher; +import fliplus.simpleplayerlist.config.SimplePlayerListConfig; +import net.minecraft.ChatFormatting; +import net.minecraft.commands.CommandSourceStack; +import net.minecraft.commands.Commands; +import net.minecraft.network.chat.Component; +import net.minecraft.network.protocol.game.ClientboundTabListPacket; +import net.minecraft.server.MinecraftServer; +import net.minecraft.server.level.ServerPlayer; + +public class PlayerListCommand { + public static void register(CommandDispatcher dispatcher) { + dispatcher.register(Commands.literal("playerlist").executes(context -> { + ServerPlayer player = context.getSource().getPlayer(); + assert player != null; + + boolean isDisabled = SimplePlayerListConfig.disabledPlayers.contains(player); + if (!isDisabled) { + SimplePlayerListConfig.disabledPlayers.add(player); + player.connection.send(new ClientboundTabListPacket(Component.literal(""), Component.literal(""))); + } else { + SimplePlayerListConfig.disabledPlayers.remove(player); + } + + String message = isDisabled ? "Player list re-enabled on your end" : "Player list disabled on your end"; + context.getSource().sendSuccess(() -> Component.literal(message).withStyle(ChatFormatting.ITALIC, ChatFormatting.GRAY), false); + + return 0; + }).requires(source -> source.hasPermission(2)).then(Commands.literal("reload").executes(context -> { + ServerPlayer player = context.getSource().getPlayer(); + assert player != null; + + SimplePlayerListConfig.INSTANCE.load(context.getSource()); + + return 0; + })).then(Commands.literal("toggle").executes(context -> { + MinecraftServer server = context.getSource().getServer(); + ServerPlayer player = context.getSource().getPlayer(); + assert player != null; + + SimplePlayerListConfig.INSTANCE.enableMod = !SimplePlayerListConfig.INSTANCE.enableMod; + + for (ServerPlayer playerEntity : server.getPlayerList().getPlayers()) { + playerEntity.connection.send(new ClientboundTabListPacket(Component.literal(""), Component.literal(""))); + } + + String message = player.getName().getString() + (SimplePlayerListConfig.INSTANCE.enableMod ? " enabled player list" : " disabled player list"); + context.getSource().sendSuccess(() -> Component.literal(message), true); + + return 0; + }))); + } +} diff --git a/src/main/java/fliplus/simpleplayerlist/config/SimplePlayerListConfig.java b/src/main/java/fliplus/simpleplayerlist/config/SimplePlayerListConfig.java new file mode 100644 index 0000000..0c24882 --- /dev/null +++ b/src/main/java/fliplus/simpleplayerlist/config/SimplePlayerListConfig.java @@ -0,0 +1,96 @@ +package fliplus.simpleplayerlist.config; + +import com.google.gson.FieldNamingPolicy; +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonSyntaxException; +import net.fabricmc.loader.api.FabricLoader; +import net.minecraft.commands.CommandSourceStack; +import net.minecraft.network.chat.Component; +import net.minecraft.server.level.ServerPlayer; + +import java.io.FileReader; +import java.io.FileWriter; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; + +import static fliplus.simpleplayerlist.SimplePlayerList.LOGGER; +import static fliplus.simpleplayerlist.SimplePlayerList.MOD_ID; + +public class SimplePlayerListConfig { + private static final Path path = FabricLoader.getInstance().getConfigDir().resolve(MOD_ID + ".json"); + private static final Gson gson = new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES).setPrettyPrinting().create(); + + public static SimplePlayerListConfig INSTANCE = new SimplePlayerListConfig(); + public static List disabledPlayers = new ArrayList<>(); + + public boolean enableMod; + public String header; + public String footer; + public int tickUpdateInterval; + + private void loadDefaults() { + enableMod = true; + header = "§lDefault Config§r\n\n§7To change this, edit\nconfig/simpleplayerlist.json\n\n§r§b§m §r"; + footer = "§r§b§m §r\n\n§7TPS: %tps%§7/%mspt% §8-§7 Ping: %ping%\n§7Day: §b%day%"; + tickUpdateInterval = 20; + } + + public void load(CommandSourceStack source) { + if (!Files.exists(path)) { + loadDefaults(); + create(INSTANCE); + return; + } + + try (FileReader file = new FileReader(path.toFile())) { + SimplePlayerListConfig config = gson.fromJson(file, SimplePlayerListConfig.class); + + boolean firstLoad = this.header == null; + if (isValidConfig(config)) { + this.enableMod = config.enableMod; + this.header = config.header; + this.footer = config.footer; + this.tickUpdateInterval = config.tickUpdateInterval; + + LOGGER.info("Config {}loaded", firstLoad ? "" : "re"); + if (!(source == null)) { + String message = Objects.requireNonNull(source.getPlayer()).getName().getString() + " reloaded player list config"; + source.sendSuccess(() -> Component.literal(message), true); + } + } else { + String message = "Config is missing required fields, loading default config"; + LOGGER.error(message); + if (!(source == null)) { + source.sendFailure(Component.literal(message)); + } + loadDefaults(); + } + } catch (JsonSyntaxException | IOException e) { + String message = "Failed to load config due to syntax error or IO exception, loading default config"; + LOGGER.error(message, e); + if (!(source == null)) { + source.sendFailure(Component.literal(message)); + } + loadDefaults(); + } + } + + private void create(SimplePlayerListConfig config) { + try (FileWriter file = new FileWriter(path.toFile())) { + file.write(gson.toJson(config)); + + LOGGER.info("Config created"); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + private boolean isValidConfig(SimplePlayerListConfig config) { + return config != null && config.header != null && config.footer != null; + } +} diff --git a/src/main/java/fliplus/simpleplayerlist/mixin/PlayerListMixin.java b/src/main/java/fliplus/simpleplayerlist/mixin/PlayerListMixin.java new file mode 100644 index 0000000..ad22a39 --- /dev/null +++ b/src/main/java/fliplus/simpleplayerlist/mixin/PlayerListMixin.java @@ -0,0 +1,119 @@ +package fliplus.simpleplayerlist.mixin; + +import fliplus.simpleplayerlist.config.SimplePlayerListConfig; +import net.minecraft.network.chat.Component; +import net.minecraft.network.chat.MutableComponent; +import net.minecraft.network.chat.Style; +import net.minecraft.network.chat.TextColor; +import net.minecraft.network.protocol.game.ClientboundTabListPacket; +import net.minecraft.server.MinecraftServer; +import net.minecraft.server.ServerTickRateManager; +import net.minecraft.server.level.ServerPlayer; +import net.minecraft.server.players.PlayerList; +import net.minecraft.util.TimeUtil; +import org.spongepowered.asm.mixin.Final; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.Shadow; +import org.spongepowered.asm.mixin.Unique; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +@Mixin(PlayerList.class) +public class PlayerListMixin { + @Shadow + @Final + private MinecraftServer server; + + @Unique + private int headerUpdateTimer; + + @Inject(at = @At("HEAD"), method = "tick") + private void tick(CallbackInfo info) { + SimplePlayerListConfig config = SimplePlayerListConfig.INSTANCE; + + if (config.enableMod && ++this.headerUpdateTimer > config.tickUpdateInterval) { + for (ServerPlayer player : server.getPlayerList().getPlayers()) { + if (SimplePlayerListConfig.disabledPlayers.contains(player)) continue; + + player.connection.send(new ClientboundTabListPacket( + replacePlaceholders(player, config.header), + replacePlaceholders(player, config.footer) + )); + + this.headerUpdateTimer = 0; + } + } + } + + @Unique + private MutableComponent replacePlaceholders(ServerPlayer player, String text) { + double MSPT = ((double) server.getAverageTickTimeNanos()) / TimeUtil.NANOSECONDS_PER_MILLISECOND; + ServerTickRateManager tickManager = server.tickRateManager(); + + double TPS = 1000.0 / Math.max(tickManager.isSprinting() ? 0.0 : tickManager.millisecondsPerTick(), MSPT); + if (tickManager.isFrozen()) TPS = 0; + + int ping = player.connection.latency(); + + int day = (int) (server.overworld().getDayTime() / 24000); + + String formatedMSPT = heatmapColor(formatDecimal(MSPT), MSPT, tickManager.millisecondsPerTick()); + String formatedTPS = heatmapColor(formatDecimal(TPS), MSPT, tickManager.millisecondsPerTick()); + String formatedPing = heatmapColor(ping + "ms", ping, 200); + + text = text + .replaceAll("(?i)%mspt%", formatedMSPT) + .replaceAll("(?i)%tps%", formatedTPS) + .replaceAll("(?i)%ping%", formatedPing) + .replaceAll("(?i)%day%", String.valueOf(day)); + + return parseHexColor(text); + } + + @Unique + private String formatDecimal(double value) { + return String.valueOf(Math.round(value * 10) / 10.0); + } + + @Unique + private String heatmapColor(String text, double actual, double reference) { + String color = ""; + if (actual >= 0.0D) color = "§a"; + if (actual > 0.5D * reference) color = "§e"; + if (actual > 0.8D * reference) color = "§c"; + if (actual > reference) color = "§d"; + return "§r" + color + text + "§r"; + } + + @Unique + private MutableComponent parseHexColor(String text) { + MutableComponent result = Component.literal(""); + + Matcher textMatcher = Pattern.compile("§#[0-9a-fA-F]{6}[^§]*").matcher(text); + + int lastEnd = 0; + while (textMatcher.find()) { + if (textMatcher.start() > lastEnd) { + result.append(text.substring(lastEnd, textMatcher.start())); + } + + Matcher hexMatcher = Pattern.compile("#[0-9a-fA-F]{6}").matcher(textMatcher.group()); + if (hexMatcher.find()) { + TextColor color = TextColor.fromRgb(Integer.parseInt(hexMatcher.group().substring(1), 16)); + result.append(Component.literal(textMatcher.group().substring(8)).setStyle(Style.EMPTY.withColor(color))); + } + + lastEnd = textMatcher.end(); + } + + if (lastEnd < text.length()) { + result.append(text.substring(lastEnd)); + } + + return result; + } +} \ No newline at end of file diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json new file mode 100644 index 0000000..8d2a99b --- /dev/null +++ b/src/main/resources/fabric.mod.json @@ -0,0 +1,29 @@ +{ + "schemaVersion": 1, + "id": "simpleplayerlist", + "version": "${version}", + "name": "Simple Player List", + "description": "Introduces the ability to customize server's player list.", + "authors": [ + "fliplus" + ], + "contact": { + "sources": "https://github.com/fliplus/simple-player-list" + }, + "license": "MIT", + "environment": "server", + "entrypoints": { + "main": [ + "fliplus.simpleplayerlist.SimplePlayerList" + ] + }, + "mixins": [ + "simpleplayerlist.mixins.json" + ], + "depends": { + "fabricloader": ">=0.15.11", + "minecraft": ">=1.21", + "java": ">=21", + "fabric-api": "*" + } +} \ No newline at end of file diff --git a/src/main/resources/simpleplayerlist.mixins.json b/src/main/resources/simpleplayerlist.mixins.json new file mode 100644 index 0000000..e7fc2d9 --- /dev/null +++ b/src/main/resources/simpleplayerlist.mixins.json @@ -0,0 +1,11 @@ +{ + "required": true, + "package": "fliplus.simpleplayerlist.mixin", + "compatibilityLevel": "JAVA_21", + "mixins": [ + "PlayerListMixin" + ], + "injectors": { + "defaultRequire": 1 + } +} \ No newline at end of file