Add an item's base repair-level its tooltip

Author: Protonull

.github/README.md

@@ -26,6 +26,8 @@ which is located at `.minecraft/config/civmodern.properties`.
 - Better toggle-sneak (bound to `]` by default). Will automatically deactivate itself if you manually `SHIFT` sneak, or
   if you enter water, or start swimming, sprinting, elytra gliding, or creative flying.
 
+- Shows an item's base repair level by default in advanced-tooltips mode.
+
 ## Removed
 
 - Radar has been removed. Why? Because it's duplicated effort. [CombatRadar](https://modrinth.com/mod/combatradar) and

src/main/java/sh/okx/civmodern/mod/CivModernConfig.java

@@ -19,6 +19,7 @@ public final class CivModernConfig {
     public static @NotNull File CONFIG_DIR = null, CONFIG_FILE = null; // Will be set during mod init
 
     public static int compactedItemColour;
+    public static boolean showItemRepairLevel;
 
     public static boolean iceRoadPitchCardinalEnabled;
     public static boolean iceRoadYawCardinalEnabled;
@@ -63,6 +64,7 @@ public static void parse(
         final @NotNull Properties properties
     ) {
         compactedItemColour = Integer.parseInt(properties.getProperty("compacted_colour", "16777048"));
+        showItemRepairLevel = Boolean.parseBoolean(properties.getProperty("show_repair_level", "true"));
 
         iceRoadPitchCardinalEnabled = Boolean.parseBoolean(properties.getProperty("ice_road_cardinal_pitch", "true"));
         iceRoadYawCardinalEnabled = Boolean.parseBoolean(properties.getProperty("ice_road_cardinal_yaw", "true"));
@@ -74,6 +76,7 @@ public static void parse(
     public static void save() {
         final var properties = new Properties();
         properties.setProperty("compacted_colour", Integer.toString(compactedItemColour));
+        properties.setProperty("show_repair_level", Boolean.toString(showItemRepairLevel));
 
         properties.setProperty("ice_road_cardinal_pitch", Boolean.toString(iceRoadPitchCardinalEnabled));
         properties.setProperty("ice_road_cardinal_yaw", Boolean.toString(iceRoadYawCardinalEnabled));

src/main/java/sh/okx/civmodern/mod/gui/screen/CompactedConfigScreen.java src/main/java/sh/okx/civmodern/mod/gui/screen/ItemConfigScreen.java

@@ -18,10 +18,11 @@
 import org.lwjgl.glfw.GLFW;
 import sh.okx.civmodern.mod.CivModernConfig;
 import sh.okx.civmodern.mod.ColourProvider;
+import sh.okx.civmodern.mod.gui.widget.CyclicButton;
 import sh.okx.civmodern.mod.gui.widget.HsbColourPicker;
 import sh.okx.civmodern.mod.gui.widget.ImageButton;
 
-public class CompactedConfigScreen extends Screen {
+public class ItemConfigScreen extends Screen {
     private static final DecimalFormat FORMAT = new DecimalFormat("##%");
 
     private static final ItemStack ITEM; static {
@@ -44,8 +45,8 @@ public class CompactedConfigScreen extends Screen {
     private final Screen parent;
     private HsbColourPicker picker;
 
-    public CompactedConfigScreen(Screen parent) {
-        super(Component.translatable("civmodern.screen.compacted.title"));
+    public ItemConfigScreen(Screen parent) {
+        super(Component.translatable("civmodern.screen.items.title"));
         this.parent = parent;
     }
 
@@ -91,6 +92,17 @@ protected void init() {
 
         addRenderableWidget(picker = hsb);
 
+        addRenderableWidget(new CyclicButton(
+            this.width / 2 - 80,
+            this.height / 6 + 72,
+            160,
+            Button.DEFAULT_HEIGHT,
+            CivModernConfig.showItemRepairLevel ? 0 : 1,
+            (button) -> CivModernConfig.showItemRepairLevel = button.getIndex() == 0,
+            Component.translatable("civmodern.screen.items.repair.enabled"),
+            Component.translatable("civmodern.screen.items.repair.disabled")
+        ));
+
         addRenderableWidget(Button.builder(CommonComponents.GUI_DONE, button -> {
             CivModernConfig.save();
             minecraft.setScreen(parent);

src/main/java/sh/okx/civmodern/mod/gui/screen/MainConfigScreen.java

@@ -14,7 +14,7 @@ public MainConfigScreen() {
     protected void init() {
         int col0 = this.width / 2 - 150 / 2;
         addRenderableWidget(Button.builder(Component.translatable("civmodern.screen.main.compacted"), button -> {
-            minecraft.setScreen(new CompactedConfigScreen(this));
+            minecraft.setScreen(new ItemConfigScreen(this));
         }).pos(col0, this.height / 6).size(150, 20).build());
         addRenderableWidget(Button.builder(Component.translatable("civmodern.screen.main.ice"), button -> {
             minecraft.setScreen(new IceRoadConfigScreen(this));

src/main/java/sh/okx/civmodern/mod/mixins/ItemStackMixin.java

@@ -1,21 +1,32 @@
 package sh.okx.civmodern.mod.mixins;
 
+import java.util.List;
 import net.minecraft.core.component.DataComponentMap;
 import net.minecraft.core.component.DataComponents;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.Style;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.component.ItemLore;
+import org.jetbrains.annotations.NotNull;
 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.ModifyVariable;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
+import sh.okx.civmodern.mod.CivModernConfig;
 import sh.okx.civmodern.mod.features.ExtendedItemStack;
 
 @Mixin(ItemStack.class)
 public abstract class ItemStackMixin implements ExtendedItemStack {
     @Shadow
     public abstract DataComponentMap getComponents();
 
+    // ============================================================
+    // Compacted item detection
+    // ============================================================
+
     @Unique
     private Boolean civmodern$isCompacted = null;
 
@@ -51,4 +62,58 @@ public boolean isMarkedAsCompacted() {
         }
         return false;
     }
+
+    // ============================================================
+    // Showing an item's repair level
+    //
+    // @ModifyVariable seems to have some difficulty finding the List<Component> local variable, likewise with local
+    // capture and @Local. Anything that works shows red lines in the IDE, and anything that the IDE thinks should work
+    // throws while testing. This may just be an issue with the Minecraft Development plugin. Nonetheless, I've done it
+    // in a roundabout way to ensure stability.
+    // ============================================================
+
+    @Unique
+    private List<Component> civmodern$tooltipLines = null;
+
+    @ModifyVariable(
+        method = "getTooltipLines",
+        at = @At("STORE")
+    )
+    private @NotNull List<Component> civmodern$captureTooltipLines(
+        final @NotNull List<Component> tooltipLines
+    ) {
+        return this.civmodern$tooltipLines = tooltipLines;
+    }
+
+    @Inject(
+        method = "getTooltipLines",
+        at = @At(
+            value = "INVOKE",
+            target = "Lnet/minecraft/world/item/ItemStack;isDamaged()Z",
+            shift = At.Shift.BEFORE
+        )
+    )
+    private void civmodern$showRepairLevel(
+        final @NotNull CallbackInfoReturnable<List<Component>> cir
+    ) {
+        if (CivModernConfig.showItemRepairLevel) {
+            final int repairCost = getComponents().getOrDefault(DataComponents.REPAIR_COST, 0);
+            if (repairCost > 0) {
+                this.civmodern$tooltipLines.add(Component.translatable(
+                    "civmodern.repair.level",
+                    Integer.toString(repairCost)
+                ));
+            }
+        }
+    }
+
+    @Inject(
+        method = "getTooltipLines",
+        at = @At("RETURN")
+    )
+    private void civmodern$releaseTooltipLines(
+        final @NotNull CallbackInfoReturnable<List<Component>> cir
+    ) {
+        this.civmodern$tooltipLines = null;
+    }
 }

src/main/resources/assets/civmodern/lang/en_us.json

@@ -11,7 +11,7 @@
     "civmodern.screen.main.radar": "Radar Settings",
     "civmodern.screen.main.ice": "Ice Road Macro",
     "civmodern.screen.main.compacted": "Compacted Item Settings",
-    "civmodern.screen.compacted.title": "Civ Modern Config (Compacted Items)",
+    "civmodern.screen.items.title": "Civ Modern Config (Items)",
     "civmodern.screen.ice.title": "Civ Modern Config (Ice Road Macro)",
     "civmodern.screen.ice.cardinal.pitch.enable": "Snap pitch: Enabled",
     "civmodern.screen.ice.cardinal.pitch.disable": "Snap pitch: Disabled",
@@ -23,5 +23,6 @@
     "civmodern.screen.ice.stop.disable": "Stop on low food: Disabled",
     "civmodern.radar.enter" : "§r%s §eappeared at §b[%s§b]",
     "civmodern.radar.hover" : "Click to highlight position\nControl click to add waypoint",
-    "civmodern.radar.leave" : "§r%s §edisappeared at §b[%s§b]"
+    "civmodern.radar.leave" : "§r%s §edisappeared at §b[%s§b]",
+    "civmodern.repair.level": "§fRepair level: %s"
 }