Allow showing button tooltips outside of editor screen

Author: NotRyken

changelog.md

@@ -4,6 +4,7 @@
 
 - Added save-state after server-accelerated operations
 - Disabled operations and buttons in spectator mode
+- Added an option to show button tooltips
 
 ## 2.1.5
 

common/src/main/java/dev/terminalmc/clientsort/client/config/Config.java

@@ -231,6 +231,9 @@ public enum ExtraSlotScope {
         public static final boolean showButtonsDefault = true;
         public boolean showButtons = showButtonsDefault;
 
+        public static final boolean showButtonTooltipsDefault = false;
+        public boolean showButtonTooltips = showButtonTooltipsDefault;
+
         public static final boolean anchorButtonsLeftDefault = false;
         public boolean anchorButtonsLeft = anchorButtonsLeftDefault;
 

common/src/main/java/dev/terminalmc/clientsort/client/gui/screen/config/ClothScreenProvider.java

@@ -512,6 +512,15 @@ else if (val > Config.Options.SOUND_VOLUME_MAX)
                 .setSaveConsumer(val -> options.showButtons = val)
                 .build());
 
+        buttons.addEntry(eb.startBooleanToggle(
+                        localized("option", "showButtonTooltips"),
+                        options.showButtonTooltips
+                )
+                .setTooltip(localized("option", "showButtonTooltips.tooltip"))
+                .setDefaultValue(Config.Options.showButtonTooltipsDefault)
+                .setSaveConsumer(val -> options.showButtonTooltips = val)
+                .build());
+
         buttons.addEntry(eb.startBooleanToggle(
                         localized("option", "anchorButtonsLeft"),
                         options.anchorButtonsLeft

common/src/main/java/dev/terminalmc/clientsort/client/gui/widget/TriggerButton.java

@@ -45,6 +45,7 @@
 
 import java.util.Collection;
 
+import static dev.terminalmc.clientsort.client.config.Config.options;
 import static dev.terminalmc.clientsort.util.Localization.localized;
 
 public abstract class TriggerButton extends Button {
@@ -181,25 +182,29 @@ public void renderWidget(
 
         // Refresh tooltip
         if (isMouseOver(mouseX, mouseY)) {
-            if (Minecraft.getInstance().screen instanceof EditorScreen && getTooltip() == null) {
-                Component visibilityStatus = localized(
-                        "editor", active ? "enabled" : "disabled")
-                        .withStyle(active
-                                ? ChatFormatting.GREEN
-                                : ChatFormatting.RED);
-                Component operationStatus = localized(
-                        "editor", operationAllowed ? "enabled" : "disabled")
-                        .withStyle(operationAllowed
-                                ? ChatFormatting.GREEN
-                                : ChatFormatting.RED);
-                setTooltip(Tooltip.create(Component.empty().append(name)
-                        .append("\n")
-                        .append(localized("editor", "visibility", visibilityStatus))
-                        .append("\n")
-                        .append(localized("editor", "operation", operationStatus))));
-            } else {
-                setTooltip(null);
+            if (getTooltip() == null) {
+                if (Minecraft.getInstance().screen instanceof EditorScreen) {
+                    Component visibilityStatus = localized(
+                            "editor", active ? "enabled" : "disabled")
+                            .withStyle(active
+                                    ? ChatFormatting.GREEN
+                                    : ChatFormatting.RED);
+                    Component operationStatus = localized(
+                            "editor", operationAllowed ? "enabled" : "disabled")
+                            .withStyle(operationAllowed
+                                    ? ChatFormatting.GREEN
+                                    : ChatFormatting.RED);
+                    setTooltip(Tooltip.create(Component.empty().append(name)
+                            .append("\n")
+                            .append(localized("editor", "visibility", visibilityStatus))
+                            .append("\n")
+                            .append(localized("editor", "operation", operationStatus))));
+                } else if (options().showButtonTooltips) {
+                    setTooltip(Tooltip.create(name));
+                }
             }
+        } else {
+            setTooltip(null);
         }
     }
 

common/src/main/resources/assets/clientsort/lang/en_us.json

@@ -133,6 +133,8 @@
   "option.clientsort.buttons": "Buttons",
   "option.clientsort.showButtons": "Show Buttons",
   "option.clientsort.showButtons.tooltip": "Whether to show extra buttons on the GUI for inventory operations.",
+  "option.clientsort.showButtonTooltips": "Show Button Tooltips",
+  "option.clientsort.showButtonTooltips.tooltip": "Whether to show tooltips when hovering over buttons.",
   "option.clientsort.anchorButtonsLeft": "Anchor Left",
   "option.clientsort.anchorButtonsLeft.tooltip": "Whether to anchor the buttons to the left side of the inventory.",
   "option.clientsort.firstButtonOp": "First Button Operation",

common/src/main/resources/assets/clientsort/lang/ru_ru.json

@@ -133,6 +133,8 @@
   "option.clientsort.buttons": "Интерфейс",
   "option.clientsort.showButtons": "Показывать кнопки",
   "option.clientsort.showButtons.tooltip": "Показывать ли дополнительные кнопки в интерфейсе для операций с инвентарём.",
+  "option.clientsort.showButtonTooltips": "Show Button Tooltips",
+  "option.clientsort.showButtonTooltips.tooltip": "Whether to show tooltips when hovering over buttons.",
   "option.clientsort.anchorButtonsLeft": "Прикрепить слева",
   "option.clientsort.anchorButtonsLeft.tooltip": "Определяет, нужно ли закреплять кнопки слева от инвентаря.",
   "option.clientsort.firstButtonOp": "Операция первой кнопки",

common/src/main/resources/assets/clientsort/lang/zh_cn.json

@@ -135,6 +135,8 @@
   "option.clientsort.buttons": "按钮",
   "option.clientsort.showButtons": "显示按钮",
   "option.clientsort.showButtons.tooltip": "是否在图形界面上显示用于物品栏操作的额外按钮。",
+  "option.clientsort.showButtonTooltips": "Show Button Tooltips",
+  "option.clientsort.showButtonTooltips.tooltip": "Whether to show tooltips when hovering over buttons.",
   "option.clientsort.anchorButtonsLeft": "固定在左侧",
   "option.clientsort.anchorButtonsLeft.tooltip": "是否将按钮固定在物品栏左侧",
   "option.clientsort.firstButtonOp": "第一个按钮操作",