Raiza.dev/better-ping-display-fabric
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity

Compare commits

base: Raiza.dev:1.20.x
Branches Tags
Raiza.dev:1.20.x
Raiza.dev:1.20
Raiza.dev:1.18.x
Raiza.dev:1.17.x
Raiza.dev:1.16.x
Raiza.dev:1.15.x
Raiza.dev:1.19.4
..
compare: Raiza.dev:1.18.x
Branches Tags
Raiza.dev:1.20.x
Raiza.dev:1.20
Raiza.dev:1.18.x
Raiza.dev:1.17.x
Raiza.dev:1.16.x
Raiza.dev:1.15.x
Raiza.dev:1.19.4

No commits in common. "1.20.x" and "1.18.x" have entirely different histories.
1.20.x ... 1.18.x

13 changed files with 263 additions and 247 deletions
Show stats Expand all files Collapse all files

2
README.md
View file

@ -25,8 +25,6 @@ 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**
* **1.20.x**
## Requirements
* [Fabric](https://fabricmc.net/)

15
build.gradle
View file

@ -1,5 +1,5 @@
plugins {
id 'fabric-loom' version '1.2-SNAPSHOT'
id 'fabric-loom' version '0.10.64'
id 'maven-publish'
}
@ -32,10 +32,18 @@ processResources {
}
}
tasks.withType(JavaCompile).configureEach {
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
}
jar {
from "LICENSE"
}
@ -48,6 +56,9 @@ publishing {
artifact(remapJar) {
builtBy remapJar
}
artifact(sourcesJar) {
builtBy remapSourcesJar
}
}
}

18
gradle.properties
View file

@ -2,16 +2,16 @@
org.gradle.jvmargs=-Xmx1G
# Fabric Properties
# check these on https://fabricmc.net/use
minecraft_version=1.20.1
yarn_mappings=1.20.1+build.1
loader_version=0.14.21
# check these on https://fabricmc.net/use
minecraft_version=1.18.2
yarn_mappings=1.18.2+build.2
loader_version=0.13.3
# Mod Properties
mod_version = 1.1.4
maven_group = com.vladmarica
archives_base_name = BetterPingDisplay-Fabric
mod_version = 1.1.1
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.83.0+1.20.1
# currently not on the main fabric site, check on the maven: https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-api
fabric_version=0.48.0+1.18.2

2
gradle/wrapper/gradle-wrapper.properties vendored
View file

@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

73
src/main/java/com/vladmarica/betterpingdisplay/BetterPingDisplayMod.java
View file

@ -1,53 +1,52 @@
package com.vladmarica.betterpingdisplay;
import com.vladmarica.betterpingdisplay.Config.ConfigData;
import java.io.File;
import java.nio.file.Path;
import net.fabricmc.api.ModInitializer;
import net.fabricmc.loader.api.FabricLoader;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.io.File;
import java.nio.file.Path;
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;
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 Config config = new Config();
@Override
public void onInitialize() {
INSTANCE = this;
@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());
}
}
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());
}
}
LOGGER.info("BetterPingDisplay mod loaded");
}
LOGGER.info("BetterPingDisplay mod loaded");
}
public Config getConfig() {
return config;
}
public Config getConfig() {
return config;
}
public static BetterPingDisplayMod instance() {
return INSTANCE;
}
public static BetterPingDisplayMod instance() {
return INSTANCE;
}
}

159
src/main/java/com/vladmarica/betterpingdisplay/Config.java
View file

@ -3,96 +3,103 @@ package com.vladmarica.betterpingdisplay;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.annotations.Expose;
import java.io.*;
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 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;
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(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");
}
public Config() {
this(new ConfigData());
if (configFileFormat.pingTextFormatString.contains("%d")) {
textFormatString = configFileFormat.pingTextFormatString;
}
else {
BetterPingDisplayMod.LOGGER.error("Config option 'pingTextFormatString' is invalid - it needs to contain %d");
}
public int getTextColor() {
return this.textColor;
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);
}
public String getTextFormatString() {
return this.textFormatString;
finally {
if (reader != null) {
reader.close();
}
}
}
public boolean shouldAutoColorPingText() {
return this.autoColorPingText;
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 boolean shouldRenderPingBars() {
return this.renderPingBars;
}
public static class ConfigData implements Serializable {
@Expose
private boolean autoColorPingText = true;
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();
}
}
}
@Expose
private boolean renderPingBars = false;
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();
}
}
}
@Expose
private String pingTextColor = "#A0A0A0";
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";
}
@Expose
private String pingTextFormatString = "%dms";
}
}

55
src/main/java/com/vladmarica/betterpingdisplay/hud/ColorUtil.java
View file

@ -3,37 +3,36 @@ package com.vladmarica.betterpingdisplay.hud;
import com.google.common.annotations.VisibleForTesting;
public final class ColorUtil {
public static int interpolate(int colorStart, int colorEnd, float offset) {
if (offset < 0 || offset > 1) {
throw new IllegalArgumentException("Offset must be between 0.0 and 1.0");
}
int redDiff = getRed(colorEnd) - getRed(colorStart);
int greenDiff = getGreen(colorEnd) - getGreen(colorStart);
int blueDiff = getBlue(colorEnd) - getBlue(colorStart);
int newRed = Math.round(getRed(colorStart) + (redDiff * offset));
int newGreen = Math.round(getGreen(colorStart) + (greenDiff * offset));
int newBlue = Math.round(getBlue(colorStart) + (blueDiff * offset));
return (newRed << 16) | (newGreen << 8) | newBlue;
public static int interpolate(int colorStart, int colorEnd, float offset) {
if (offset < 0 || offset > 1) {
throw new IllegalArgumentException("Offset must be between 0.0 and 1.0");
}
@VisibleForTesting
static int getRed(int color) {
return (color >> 16) & 0xFF;
}
int redDiff = getRed(colorEnd) - getRed(colorStart);
int greenDiff = getGreen(colorEnd) - getGreen(colorStart);
int blueDiff = getBlue(colorEnd) - getBlue(colorStart);
@VisibleForTesting
static int getGreen(int color) {
return (color >> 8) & 0xFF;
}
int newRed = Math.round(getRed(colorStart) + (redDiff * offset));
int newGreen = Math.round(getGreen(colorStart) + (greenDiff * offset));
int newBlue = Math.round(getBlue(colorStart) + (blueDiff * offset));
@VisibleForTesting
static int getBlue(int color) {
return color & 0xFF;
}
return (newRed << 16) | (newGreen << 8) | newBlue;
}
private ColorUtil() {
}
@VisibleForTesting
static int getRed(int color) {
return (color >> 16) & 0xFF;
}
@VisibleForTesting
static int getGreen(int color) {
return (color >> 8) & 0xFF;
}
@VisibleForTesting
static int getBlue(int color) {
return color & 0xFF;
}
private ColorUtil() {}
}

50
src/main/java/com/vladmarica/betterpingdisplay/hud/CustomPlayerListHud.java
View file

@ -5,36 +5,38 @@ import com.vladmarica.betterpingdisplay.BetterPingDisplayMod;
import com.vladmarica.betterpingdisplay.Config;
import com.vladmarica.betterpingdisplay.mixin.PlayerListHudInvoker;
import net.minecraft.client.MinecraftClient;
import net.minecraft.client.gui.DrawContext;
import net.minecraft.client.font.TextRenderer;
import net.minecraft.client.gui.hud.PlayerListHud;
import net.minecraft.client.network.PlayerListEntry;
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 int PING_TEXT_RENDER_OFFSET = -13;
private static final int PING_BARS_WIDTH = 11;
private static final Config config = BetterPingDisplayMod.instance().getConfig();
public static void renderPingDisplay(
MinecraftClient client, PlayerListHud hud, DrawContext context, int width, int x, int y, PlayerListEntry player) {
String pingString = String.format(config.getTextFormatString(), player.getLatency());
int pingStringWidth = client.textRenderer.getWidth(pingString);
int pingTextColor = config.shouldAutoColorPingText()
? PingColors.getColor(player.getLatency()) : config.getTextColor();
int textX = width + x - pingStringWidth + PING_TEXT_RENDER_OFFSET;
public static void renderPingDisplay(
MinecraftClient client, PlayerListHud hud, MatrixStack matrixStack, int width, int x, int y, PlayerListEntry player) {
TextRenderer textRenderer = client.textRenderer;
if (!config.shouldRenderPingBars()) {
textX += PING_BARS_WIDTH;
}
String pingString = String.format(config.getTextFormatString(), player.getLatency());
int pingStringWidth = textRenderer.getWidth(pingString);
int pingTextColor = config.shouldAutoColorPingText() ? PingColors.getColor(player.getLatency()) : config.getTextColor();
int textX = width + x - pingStringWidth + PING_TEXT_RENDER_OFFSET;
// Draw the ping text for the given player
context.drawTextWithShadow(client.textRenderer, pingString, textX, y, pingTextColor);
if (config.shouldRenderPingBars()) {
((PlayerListHudInvoker) hud).invokeRenderLatencyIcon(context, width, x, y, player);
} else {
// If we don't render ping bars, we need to reset the render system color so the rest
// of the player list renders properly
RenderSystem.setShaderColor(1.0F, 1.0F, 1.0F, 1.0F);
}
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()) {
((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
// of the player list renders properly
RenderSystem.setShaderColor(1.0F, 1.0F, 1.0F, 1.0F);
}
}
}

55
src/main/java/com/vladmarica/betterpingdisplay/hud/PingColors.java
View file

@ -3,38 +3,37 @@ package com.vladmarica.betterpingdisplay.hud;
import net.minecraft.util.math.MathHelper;
public final class PingColors {
public static final int PING_START = 0;
public static final int PING_MID = 150;
public static final int PING_END = 300;
public static final int PING_START = 0;
public static final int PING_MID = 150;
public static final int PING_END = 300;
public static final int COLOR_GREY = 0x535353;
public static final int COLOR_START = 0x00E676;
public static final int COLOR_MID = 0xD6CD30;
public static final int COLOR_END = 0xE53935;
public static final int COLOR_GREY = 0x535353;
public static final int COLOR_START = 0x00E676;
public static final int COLOR_MID = 0xD6CD30;
public static final int COLOR_END = 0xE53935;
public static int getColor(int ping) {
if (ping < PING_START) {
return COLOR_GREY;
}
if (ping < PING_MID) {
return ColorUtil.interpolate(
COLOR_START,
COLOR_MID,
computeOffset(PING_START, PING_MID, ping));
}
return ColorUtil.interpolate(
COLOR_MID,
COLOR_END,
computeOffset(PING_MID, PING_END, Math.min(ping, PING_END)));
public static int getColor(int ping) {
if (ping < PING_START) {
return COLOR_GREY;
}
private static float computeOffset(int start, int end, int value) {
float offset = (value - start) / (float) (end - start);
return MathHelper.clamp(offset, 0.0F, 1.0F);
if (ping < PING_MID) {
return ColorUtil.interpolate(
COLOR_START,
COLOR_MID,
computeOffset(PING_START, PING_MID, ping));
}
private PingColors() {
}
return ColorUtil.interpolate(
COLOR_MID,
COLOR_END,
computeOffset(PING_MID, PING_END, Math.min(ping, PING_END)));
}
private static float computeOffset(int start, int end, int value) {
float offset = (value - start) / (float) ( end - start);
return MathHelper.clamp(offset, 0.0F, 1.0F);
}
private PingColors() {}
}

6
src/main/java/com/vladmarica/betterpingdisplay/mixin/PlayerListHudInvoker.java
View file

@ -1,13 +1,13 @@
package com.vladmarica.betterpingdisplay.mixin;
import net.minecraft.client.gui.DrawContext;
import net.minecraft.client.gui.hud.PlayerListHud;
import net.minecraft.client.network.PlayerListEntry;
import net.minecraft.client.util.math.MatrixStack;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.gen.Invoker;
@Mixin(PlayerListHud.class)
public interface PlayerListHudInvoker {
@Invoker("renderLatencyIcon")
void invokeRenderLatencyIcon(DrawContext context, int width, int x, int y, PlayerListEntry entry);
@Invoker("renderLatencyIcon")
void invokeRenderLatencyIcon(MatrixStack matrices, int width, int x, int y, PlayerListEntry entry);
}

54
src/main/java/com/vladmarica/betterpingdisplay/mixin/PlayerListHudMixin.java
View file

@ -2,9 +2,11 @@ package com.vladmarica.betterpingdisplay.mixin;
import com.vladmarica.betterpingdisplay.hud.CustomPlayerListHud;
import net.minecraft.client.MinecraftClient;
import net.minecraft.client.gui.DrawContext;
import net.minecraft.client.gui.hud.PlayerListHud;
import net.minecraft.client.network.PlayerListEntry;
import net.minecraft.client.util.math.MatrixStack;
import net.minecraft.scoreboard.Scoreboard;
import net.minecraft.scoreboard.ScoreboardObjective;
import org.jetbrains.annotations.NotNull;
import org.spongepowered.asm.mixin.Final;
import org.spongepowered.asm.mixin.Mixin;
@ -17,32 +19,32 @@ import org.spongepowered.asm.mixin.injection.Redirect;
@Mixin(PlayerListHud.class)
public abstract class PlayerListHudMixin {
@Unique
@Final
private static final int PLAYER_SLOT_EXTRA_WIDTH = 45;
@Unique
@Final
private static final int PLAYER_SLOT_EXTRA_WIDTH = 45;
@Shadow
@Final
private MinecraftClient client;
@Shadow
@Final
private MinecraftClient client;
/**
* Increases the int constant {@code 13} in the {@link PlayerListHud#render} method by
* {@value #PLAYER_SLOT_EXTRA_WIDTH}. This constant is used to define the width of the "slots" in the player list.
* In order to fit the ping text, this needs to be increased.
*/
@ModifyConstant(method = "render", constant = @Constant(intValue = 13))
private int modifySlotWidthConstant(int original) {
return original + PLAYER_SLOT_EXTRA_WIDTH;
}
/**
* Increases the int constant {@code 13} in the {@link PlayerListHud#render} method by
* {@value #PLAYER_SLOT_EXTRA_WIDTH}. This constant is used to define the width of the "slots" in the player list.
* In order to fit the ping text, this needs to be increased.
*/
@ModifyConstant(method = "render", constant = @Constant(intValue = 13))
private int modifySlotWidthConstant(int original) {
return original + PLAYER_SLOT_EXTRA_WIDTH;
}
/**
* Redirects the call to {@code renderLatencyIcon} in {@link PlayerListHud#render} to instead call
* {@link CustomPlayerListHud#renderPingDisplay}.
*/
@Redirect(method = "render",
at = @At(value = "INVOKE", target = "net/minecraft/client/gui/hud/PlayerListHud.renderLatencyIcon(Lnet/minecraft/client/gui/DrawContext;IIILnet/minecraft/client/network/PlayerListEntry;)V"))
private void redirectRenderLatencyIconCall(
PlayerListHud instance, DrawContext context, int width, int x, int y, @NotNull PlayerListEntry entry) {
CustomPlayerListHud.renderPingDisplay(client, instance, context, width, x, y, entry);
}
/**
* Redirects the call to {@code renderLatencyIcon} in {@link PlayerListHud#render} to instead call
* {@link CustomPlayerListHud#renderPingDisplay}.
*/
@Redirect(method = "render",
at = @At(value = "INVOKE", target = "net/minecraft/client/gui/hud/PlayerListHud.renderLatencyIcon(Lnet/minecraft/client/util/math/MatrixStack;IIILnet/minecraft/client/network/PlayerListEntry;)V"))
private void redirectRenderLatencyIconCall(
PlayerListHud instance, MatrixStack matrices, int width, int x, int y, @NotNull PlayerListEntry entry) {
CustomPlayerListHud.renderPingDisplay(client, instance, matrices, width, x, y, entry);
}
}

15
src/main/resources/fabric.mod.json
View file

@ -1,18 +1,17 @@
{
"schemaVersion": 1,
"id": "betterpingdisplay",
"version": "1.1.3",
"version": "1.1.1",
"name": "Better Ping Display",
"description": "Shows the actual ping number instead of just bars in the player list!",
"authors": [
"Quintinity",
"Yuuki"
"Quintinity"
],
"contact": {
"homepage": "https://git.raiza.dev/Raiza.dev/better-ping-display-fabric",
"sources": "https://git.raiza.dev/Raiza.dev/better-ping-display-fabric",
"issues": "https://git.raiza.dev/Raiza.dev/better-ping-display-fabric/issues"
"homepage": "https://github.com/vladmarica/better-ping-display-fabric",
"sources": "https://github.com/vladmarica/better-ping-display-fabric",
"issues": "https://github.com/vladmarica/better-ping-display-fabric/issues"
},
"license": "MIT",
@ -29,8 +28,8 @@
],
"depends": {
"fabricloader": ">=0.14",
"minecraft": ">=1.19"
"fabricloader": ">=0.12",
"minecraft": "1.18.x"
},
"suggests": {}
}