Intelligently style chat messages

Author: PointerRain

gradle.properties

@@ -9,7 +9,7 @@ yarn_mappings=1.21.3+build.2
 loader_version=0.16.7
 
 # Mod Properties
-mod_version=1.0.0
+mod_version=1.1.0a15
 maven_group=com.scnamelink
 archives_base_name=sc-name-link
 

src/client/java/com/scnamelink/SpooncraftNameLinkClient.java

@@ -5,6 +5,7 @@
 import me.shedaniel.autoconfig.serializer.Toml4jConfigSerializer;
 import net.fabricmc.api.ClientModInitializer;
 import net.fabricmc.fabric.api.client.command.v2.ClientCommandRegistrationCallback;
+import net.minecraft.text.HoverEvent;
 import net.minecraft.text.MutableText;
 import net.minecraft.text.Style;
 import net.minecraft.text.Text;
@@ -30,12 +31,56 @@ public class SpooncraftNameLinkClient implements ClientModInitializer {
     // List of mappings for replacement and optional color changes
     private static List<DisplayMapping> mappings = new ArrayList<>();
 
+    /**
+     * Applies the mapping to a given message. It optionally replaces the Minecraft name with
+     * the Discord nickname and applies the colour styling.
+     *
+     * @param message       The original in-game message or name
+     * @param mapping       The {@code DisplayMapping} object containing the name and color mapping
+     *                      details
+     * @param replaceName   Whether to replace the name with the name defined in the mapping
+     * @param replaceColour Whether to replace the colour with the colour defined in the mapping
+     * @return A new MutableText object with the mapping applied (replacements and color changes)
+     */
+    static MutableText applyMapping(Text message, DisplayMapping mapping,
+                                           boolean replaceName, boolean replaceColour) {
+        if (message == null || message.getString().isEmpty() || mapping == null) {
+            return Text.empty();
+        }
+
+        MutableText outputMessage = Text.empty();
+        message.visit((style, text) -> {
+            String replacedText = text;
+            Style replacedStyle = style;
+
+            // Apply the mapping
+            if (replacedText.contains(mapping.mc_name)) {
+                // Replace the string
+                if (mapping.discord_nick != null && replaceName) {
+                    replacedText = replacedText.replace(mapping.mc_name, mapping.discord_nick);
+                }
+                // Apply color if specified
+                if (mapping.colour != null && replaceColour) {
+                    replacedStyle = replacedStyle.withColor(Integer.parseInt(mapping.colour, 16));
+                }
+            }
+
+            // Create new MutableText with the display string and style
+            MutableText newText = (MutableText) Text.of(replacedText);
+            newText.setStyle(replacedStyle);
+            outputMessage.append(newText);
+
+            return Optional.empty();  // Continue visiting
+       }, Style.EMPTY);
+
+        return outputMessage;
+    }
 
     /**
      * Retrieves and applies the correct name mapping (if any) for a given Minecraft username or
      * UUID.
-     * This method checks the mappings list to see if the provided displayName or uuid has a
-     * corresponding mapping, and if found, applies it by optionally altering the name and color.
+     * Checks the mappings list to see if the provided displayName or uuid has a corresponding
+     * mapping, and if found, applies it by optionally altering the name and color.
      *
      * @param displayName   The original in-game name to be displayed
      * @param uuid          The UUID of the Minecraft player
@@ -46,28 +91,18 @@ public class SpooncraftNameLinkClient implements ClientModInitializer {
      */
     public static Text getStyledName(Text displayName, UUID uuid, String name, boolean replaceName,
                                      boolean replaceColour) {
-        DisplayMapping correctMapping = null;
-
         // Iterate over the mappings to find the correct match based on UUID or Minecraft name
         for (DisplayMapping mapping : mappings) {
-            // If the UUID matches or the name matches, select the mapping and break
+            // If the UUID matches or the name matches, apply the mapping and return it
             if (Objects.equals(mapping.mc_uuid, uuid) || Objects.equals(mapping.mc_name, name)) {
-                correctMapping = mapping;
-                break;
+                return applyMapping(displayName, mapping, replaceName, replaceColour);
             }
         }
-
-        // If a matching mapping is found, apply it; otherwise, return the original displayName
-        if (correctMapping != null) {     // If a mapping could be found.
-            return applyMapping(displayName, correctMapping, replaceName, replaceColour);
-        }
-        // If the mapping couldn't be found, simply return what we got.
         return displayName;
     }
 
     /**
-     * Retrieves and applies the correct name mapping (if any) for a given Minecraft username or
-     * UUID.
+     * Retrieves and applies the correct name mapping (if any) for a given Minecraft username.
      *
      * @param displayName   The original in-game name to be displayed
      * @param name          The in-game name as a Text object
@@ -78,78 +113,43 @@ public static Text getStyledName(Text displayName, UUID uuid, String name, boole
      */
     public static Text getStyledName(Text displayName, String name, boolean replaceName,
                                      boolean replaceColour) {
-        return getStyledName(displayName, new UUID(0, 0), name, replaceName, replaceColour);
+        return getStyledName(displayName, UUID.fromString("00000000-0000-0000-0000-000000000000"), name, replaceName, replaceColour);
     }
 
     /**
-     * Applies the mapping to a given message. It optionally replaces the Minecraft name with
-     * the Discord nickname and applies the colour styling.
+     * Styles the chat message by replacing the name and colour if specified.
+     * Only styles the name if the text has a {@code HoverEvent} component.
      *
      * @param message       The original in-game message or name
-     * @param mapping       The {@code DisplayMapping} object containing the name and color mapping
-     *                      details
      * @param replaceName   Whether to replace the name with the name defined in the mapping
      * @param replaceColour Whether to replace the colour with the colour defined in the mapping
      * @return A new MutableText object with the mapping applied (replacements and color changes)
      */
-    public static MutableText applyMapping(Text message, DisplayMapping mapping,
-                                           boolean replaceName, boolean replaceColour) {
-        MutableText outputMessage = Text.empty();
-
-        if (message == null || message.getString().isEmpty() || mapping == null) {
-            return outputMessage;
+    public static Text getStyledChat(Text message, boolean replaceName, boolean replaceColour) {
+        if (message == null || message.getString().isEmpty()) {
+            return Text.empty();
         }
 
+        MutableText outputMessage = Text.empty();
         message.visit((style, text) -> {
-            Style replacedStyle = style;
-            String replacedText = text;
-
-            // Apply the mapping
-            if (replacedText.contains(mapping.mc_name)) {
-                // Replace the string
-                if (mapping.discord_nick != null && replaceName) {
-                    replacedText = replacedText.replace(mapping.mc_name, mapping.discord_nick);
-                }
-                // Apply color if specified
-                if (mapping.colour != null && replaceColour) {
-                    replacedStyle = replacedStyle.withColor(Integer.parseInt(mapping.colour, 16));
+            MutableText newText = Text.literal(text).setStyle(style);
+
+            HoverEvent event = style.getHoverEvent();
+            if (event != null) {
+                HoverEvent.EntityContent value = event.getValue(HoverEvent.Action.SHOW_ENTITY);
+                if (value != null && value.name.isPresent()) {
+                    newText = (MutableText) getStyledName(newText, value.uuid, String.valueOf(value.name), replaceName, replaceColour)
+                            .setStyle(newText.getStyle().withHoverEvent(event));
                 }
             }
 
-            // Create new MutableText with the display string and style
-            MutableText newText = (MutableText) Text.of(replacedText);
-            newText.setStyle(replacedStyle);
             outputMessage.append(newText);
-
-            return Optional.empty();  // Continue visiting
+            return Optional.empty();
         }, Style.EMPTY);
 
         return outputMessage;
     }
 
-    /**
-     * Naively applies styling and replacements to a given message.
-     * This method applies every name mapping in the mappings list to the message, regardless of
-     * context.
-     *
-     * @param message       The original message to which mappings will be applied
-     * @param replaceName   Whether to replace the name with the name defined in the mapping
-     * @param replaceColour Whether to replace the colour with the colour defined in the mapping
-     * @return A new Text object with all applicable mappings and styles applied
-     */
-    public static Text naivelyStyleText(Text message, boolean replaceName, boolean replaceColour) {
-        MutableText outputMessage = (MutableText) message;
-
-        // Apply each mapping sequentially to the message
-        for (DisplayMapping mapping : mappings) {
-            outputMessage = applyMapping(outputMessage, mapping, replaceName, replaceColour);
-        }
-
-        // Return the final styled message
-        return outputMessage;
-    }
-
-
     /**
      * Retrieves the mappings from the specified source URL or the default URL if none is provided.
      * If the mod is disabled in the configuration, it disables the mod and logs a warning.
@@ -159,26 +159,23 @@ public static Text naivelyStyleText(Text message, boolean replaceName, boolean r
      * @return The number of mappings retrieved.
      */
     public static int getMappings(String source) {
-        String s = source;
-        if (s == null || s.isEmpty())
-            s = "https://gwaff.uqcloud.net/api/spooncraft";
-
+        String s = (source == null || source.isEmpty()) ? "https://gwaff.uqcloud.net/api/spooncraft" : source;
         mappings = NameLinkAPI.getMappings(s);
-
         return mappings.size();
     }
 
+    /**
+     * Retrieves a Text object detailing the status of the mod.
+     *
+     * @return A Text object containing the status of the mod
+     */
     public static Text getStatusString() {
         String status = NameLinkAPI.getStatus();
         return switch (status) {
-            case "Success" ->
-                    Text.translatable("text.scnamelink.status.success").formatted(Formatting.WHITE);
-            case "Working" ->
-                    Text.translatable("text.scnamelink.status.working").formatted(Formatting.YELLOW);
-            case "Fallback" ->
-                    Text.translatable("text.scnamelink.status.fallback").formatted(Formatting.RED);
-            case "Failure" ->
-                    Text.translatable("text.scnamelink.status.failure").formatted(Formatting.RED, Formatting.BOLD);
+            case "Success" -> Text.translatable("text.scnamelink.status.success").formatted(Formatting.WHITE);
+            case "Working" -> Text.translatable("text.scnamelink.status.working").formatted(Formatting.YELLOW);
+            case "Fallback" -> Text.translatable("text.scnamelink.status.fallback").formatted(Formatting.RED);
+            case "Failure" -> Text.translatable("text.scnamelink.status.failure").formatted(Formatting.RED, Formatting.BOLD);
             default -> Text.of(NameLinkAPI.getStatus());
         };
     }
@@ -189,9 +186,11 @@ public void onInitializeClient() {
         config = AutoConfig.getConfigHolder(SCNameLinkConfig.class).getConfig();
 
         final int count = getMappings(config.apiLink);
-        if (count > 0)
+        if (count > 0) {
             LOGGER.info("{} initialised with {} mappings", MOD_ID, mappings.size());
-        else LOGGER.warn("{} initialised with NO mappings found", MOD_ID);
+        } else {
+            LOGGER.warn("{} initialised with NO mappings found", MOD_ID);
+        }
 
         if (!config.enableMod) {
             NameLinkAPI.disableMod();

src/client/java/com/scnamelink/config/SCNameLinkConfig.java

@@ -26,5 +26,5 @@ public class SCNameLinkConfig implements ConfigData {
     // Whether to replace names in the chat using discord nicknames.
     public boolean replacechat = true;
     // Whether to colour names in the chat using the colour from discord.
-    public boolean colourchat = false;
+    public boolean colourchat = true;
 }

src/client/java/com/scnamelink/mixin/client/ChatHudMixin.java

@@ -25,7 +25,7 @@ public void onReceivingMessages(Args args) {
 
         Text message = args.get(1);
 
-        args.set(1, SpooncraftNameLinkClient.naivelyStyleText(message,CONFIG.replacechat,
-                                                              CONFIG.colourchat));
+        args.set(1, SpooncraftNameLinkClient.getStyledChat(message, CONFIG.replacechat,
+                                                           CONFIG.colourchat));
     }
 }