Add dialog styling options (#1072)

Author: FlorianMichael

common/src/main/java/com/viaversion/viabackwards/ViaBackwardsConfig.java

@@ -17,7 +17,10 @@
  */
 package com.viaversion.viabackwards;
 
+import com.viaversion.viabackwards.api.DialogStyleConfig;
+import com.viaversion.viaversion.util.ChatColorUtil;
 import com.viaversion.viaversion.util.Config;
+import com.viaversion.viaversion.util.ConfigSection;
 import java.io.File;
 import java.io.InputStream;
 import java.net.URL;
@@ -41,6 +44,7 @@ public class ViaBackwardsConfig extends Config implements com.viaversion.viaback
     private boolean mapCustomModelData;
     private boolean mapDisplayEntities;
     private boolean suppressEmulationWarnings;
+    private DialogStyleConfig dialogStyleConfig;
 
     public ViaBackwardsConfig(File configFile, Logger logger) {
         super(configFile, logger);
@@ -66,6 +70,29 @@ private void loadFields() {
         mapCustomModelData = getBoolean("map-custom-model-data", true);
         mapDisplayEntities = getBoolean("map-display-entities", true);
         suppressEmulationWarnings = getBoolean("suppress-emulation-warnings", false);
+        dialogStyleConfig = loadDialogStyleConfig(getSection("dialog-style"));
+    }
+
+    private DialogStyleConfig loadDialogStyleConfig(final ConfigSection section) {
+        return new DialogStyleConfig(
+            getString(section, "page-navigation-title", "&9&lPage navigation"),
+            getString(section, "page-navigation-next", "&9Left click: &6Go to next page"),
+            getString(section, "page-navigation-previous", "&9Right click: &6Go to previous page"),
+            getString(section, "increase-value", "&9Left click: &6Increase value by %s"),
+            getString(section, "decrease-value", "&9Right click: &6Decrease value by %s"),
+            getString(section, "value-range", "&7(Value between &a%s &7and &a%s&7)"),
+            getString(section, "next-option", "&9Left click: &6Go to next option"),
+            getString(section, "previous-option", "&9Right click: &6Go to previous option"),
+            getString(section, "current-value", "&7Current value: &a%s"),
+            getString(section, "edit-value", "&9Left click: &6Edit text"),
+            getString(section, "set-text", "&9Left click/close: &6Set text"),
+            getString(section, "close", "&9Left click: &6Close"),
+            getString(section, "toggle-value", "&9Left click: &6Toggle value")
+        );
+    }
+
+    protected String getString(final ConfigSection section, final String key, final String def) {
+        return ChatColorUtil.translateAlternateColorCodes(section.getString(key, def));
     }
 
     @Override
@@ -133,6 +160,11 @@ public boolean suppressEmulationWarnings() {
         return suppressEmulationWarnings;
     }
 
+    @Override
+    public DialogStyleConfig dialogStyleConfig() {
+        return dialogStyleConfig;
+    }
+
     @Override
     public URL getDefaultConfigURL() {
         return getClass().getClassLoader().getResource("assets/viabackwards/config.yml");

common/src/main/java/com/viaversion/viabackwards/api/DialogStyleConfig.java

@@ -0,0 +1,25 @@
+/*
+ * This file is part of ViaBackwards - https://github.com/ViaVersion/ViaBackwards
+ * Copyright (C) 2016-2025 ViaVersion and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.viaversion.viabackwards.api;
+
+public record DialogStyleConfig(String pageNavigationTitle, String pageNavigationNext, String pageNavigationPrevious,
+                                String increaseValue, String decreaseValue, String valueRange, String nextOption,
+                                String previousOption, String currentValue, String editValue, String setText,
+                                String close, String toggleValue) {
+
+}

common/src/main/java/com/viaversion/viabackwards/api/ViaBackwardsConfig.java

@@ -112,4 +112,11 @@ public interface ViaBackwardsConfig extends Config {
      * @return true if enabled
      */
     boolean suppressEmulationWarnings();
+
+    /**
+     * Returns the dialog style configuration.
+     *
+     * @return the dialog style configuration
+     */
+    DialogStyleConfig dialogStyleConfig();
 }

common/src/main/java/com/viaversion/viabackwards/protocol/v1_21_6to1_21_5/data/input/NumberRangeInput.java

@@ -21,7 +21,6 @@
 import com.viaversion.nbt.tag.FloatTag;
 import com.viaversion.nbt.tag.Tag;
 
-import static com.viaversion.viabackwards.utils.ChatUtil.text;
 import static com.viaversion.viabackwards.utils.ChatUtil.translate;
 
 public final class NumberRangeInput implements Input {
@@ -109,6 +108,6 @@ public void setClampedValue(final float value) {
     }
 
     public Tag displayName() {
-        return translate(labelFormat, label, text(valueAsString()));
+        return translate(labelFormat, label, translate(valueAsString()));
     }
 }

common/src/main/java/com/viaversion/viabackwards/protocol/v1_21_6to1_21_5/provider/ChestDialogViewProvider.java

@@ -19,6 +19,8 @@
 
 import com.viaversion.nbt.tag.CompoundTag;
 import com.viaversion.nbt.tag.Tag;
+import com.viaversion.viabackwards.ViaBackwards;
+import com.viaversion.viabackwards.api.DialogStyleConfig;
 import com.viaversion.viabackwards.protocol.v1_21_6to1_21_5.Protocol1_21_6To1_21_5;
 import com.viaversion.viabackwards.protocol.v1_21_6to1_21_5.data.Button;
 import com.viaversion.viabackwards.protocol.v1_21_6to1_21_5.data.Dialog;
@@ -52,7 +54,6 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 import static com.viaversion.viabackwards.utils.ChatUtil.fixStyle;
-import static com.viaversion.viabackwards.utils.ChatUtil.text;
 import static com.viaversion.viabackwards.utils.ChatUtil.translate;
 
 /**
@@ -225,12 +226,14 @@ public void updateDialog(final UserConnection connection, final Dialog dialog) {
     }
 
     protected Item createPageNavigationItem() {
+        final DialogStyleConfig config = ViaBackwards.getConfig().dialogStyleConfig();
+
         return createItem(
             "minecraft:arrow",
-            text("§9§lPage navigation"),
+            translate(config.pageNavigationTitle()),
 
-            "§9Left click: §6Go to next page",
-            "§9Right click: §6Go to previous page"
+            config.pageNavigationNext(),
+            config.pageNavigationPrevious()
         );
     }
 
@@ -251,7 +254,7 @@ protected Item getItemWidget(final UserConnection connection, final ItemWidget i
         final String identifier = itemWidget.item().getString("id");
         final int count = itemWidget.item().getInt("count", 1);
 
-        final Tag label = text(Key.stripMinecraftNamespace(identifier));
+        final Tag label = translate(Key.stripMinecraftNamespace(identifier));
         final Item item = createItem(identifier, label);
         item.setAmount(count);
         if (itemWidget.description() != null) {
@@ -282,6 +285,8 @@ protected Item getMultiTextWidget(final UserConnection connection, final MultiTe
     }
 
     protected Item getBooleanInput(final UserConnection connection, final BooleanInput booleanInput) {
+        final DialogStyleConfig config = ViaBackwards.getConfig().dialogStyleConfig();
+
         final String item = booleanInput.value() ? "minecraft:lime_dye" : "minecraft:gray_dye";
         final Tag[] label = ChatUtil.split(booleanInput.label(), "\n");
 
@@ -290,14 +295,14 @@ protected Item getBooleanInput(final UserConnection connection, final BooleanInp
             return createItem(
                 item,
                 handleTag(connection, booleanInput.label()),
-                text("§9Left click: §6Toggle value")
+                translate(config.toggleValue())
             );
         } else {
             final Tag[] lore = new Tag[label.length];
             for (int i = 1; i < label.length; i++) {
                 lore[i - 1] = handleTag(connection, fixStyle(label[i]));
             }
-            lore[lore.length - 1] = text("§9Left click: §6Toggle value");
+            lore[lore.length - 1] = translate(config.toggleValue());
             return createItem(
                 item,
                 handleTag(connection, label[0]),
@@ -311,14 +316,16 @@ protected void clickBooleanInput(final BooleanInput booleanInput) {
     }
 
     protected Item getNumberRangeInput(final UserConnection connection, final NumberRangeInput numberRangeInput) {
+        final DialogStyleConfig config = ViaBackwards.getConfig().dialogStyleConfig();
+
         final Tag label = handleTag(connection, numberRangeInput.displayName());
         return createItem(
             "minecraft:clock",
             label,
 
-            "§9Left click: §6Increase value by " + numberRangeInput.step(),
-            "§9Right click: §6Decrease value by " + numberRangeInput.step(),
-            "§7(Value between §a" + numberRangeInput.start() + " §7and §a" + numberRangeInput.end() + "§7)"
+            String.format(config.increaseValue(), numberRangeInput.step()),
+            String.format(config.decreaseValue(), numberRangeInput.step()),
+            String.format(config.valueRange(), numberRangeInput.start(), numberRangeInput.end())
         );
     }
 
@@ -333,21 +340,25 @@ protected void clickNumberRangeInput(final NumberRangeInput numberRangeInput, fi
     }
 
     protected Item getTextInput(final UserConnection connection, final TextInput textInput) {
-        final Tag currentValue = text("§7Current value: §a" + textInput.value());
+        final DialogStyleConfig config = ViaBackwards.getConfig().dialogStyleConfig();
+
+        final Tag currentValue = translate(String.format(config.currentValue(), textInput.value()));
         if (textInput.label() == null) {
             return createItem("minecraft:writable_book", currentValue);
         } else {
             final Tag label = handleTag(connection, textInput.label());
-            return createItem("minecraft:writable_book", label, currentValue, text("§9Left click: §6Edit text"));
+            return createItem("minecraft:writable_book", label, currentValue, translate(config.editValue()));
         }
     }
 
     protected void clickTextInput(final UserConnection connection, final TextInput textInput) {
         final ChestDialogStorage storage = connection.get(ChestDialogStorage.class);
-        openAnvilView(connection, storage, text("§7Edit text"), textInput.value(), textInput);
+        openAnvilView(connection, storage, translate("§7Edit text"), textInput.value(), textInput);
     }
 
     protected Item getSingleOptionInput(final UserConnection connection, final SingleOptionInput singleOptionInput) {
+        final DialogStyleConfig config = ViaBackwards.getConfig().dialogStyleConfig();
+
         final Tag displayName = singleOptionInput.options()[singleOptionInput.value()].computeDisplay();
         final Tag label;
         if (singleOptionInput.label() != null) {
@@ -358,8 +369,8 @@ protected Item getSingleOptionInput(final UserConnection connection, final Singl
         return createItem(
             "minecraft:bookshelf",
             handleTag(connection, label),
-            "§9Left click: §6Go to next option",
-            "§9Right click: §6Go to previous option"
+            config.nextOption(),
+            config.previousOption()
         );
     }
 
@@ -388,7 +399,7 @@ public void clickButton(final UserConnection connection, final Dialog.AfterActio
             case "open_url" -> {
                 // We can't open a URL for the client, so roughly emulate by opening an Anvil containing the URL.
                 final String url = clickEvent.getString("url");
-                openAnvilView(connection, storage, text("Open URL"), url, null);
+                openAnvilView(connection, storage, translate("Open URL"), url, null);
             }
             case "run_command" -> {
                 // The vanilla client validates for signed argument types and has more requirements for this click event,
@@ -404,19 +415,21 @@ public void clickButton(final UserConnection connection, final Dialog.AfterActio
             case "copy_to_clipboard" -> {
                 // Same as above, we can't access the clipboard
                 final String value = clickEvent.getString("value");
-                openAnvilView(connection, storage, text("Copy to clipboard"), value, null);
+                openAnvilView(connection, storage, translate("Copy to clipboard"), value, null);
             }
         }
 
         ClickEvents.handleClickEvent(connection, clickEvent); // Handle show_dialog and custom
     }
 
     protected Item createTextInputItem(final String value) {
-        return createItem("minecraft:paper", text(value), "§9Left click/close: §6Set text");
+        final DialogStyleConfig config = ViaBackwards.getConfig().dialogStyleConfig();
+        return createItem("minecraft:paper", translate(value), config.setText());
     }
 
     protected Item createTextCopyItem(final String value) {
-        return createItem("minecraft:paper", text(value), "§9Left click: §6Close");
+        final DialogStyleConfig config = ViaBackwards.getConfig().dialogStyleConfig();
+        return createItem("minecraft:paper", translate(value), config.close());
     }
 
     private void openAnvilView(
@@ -589,7 +602,7 @@ protected Item createItem(final String identifier, final Tag name, final String.
         if (description.length > 0) {
             final List<Tag> lore = new ArrayList<>();
             for (final String s : description) {
-                lore.add(text(s));
+                lore.add(translate(s));
             }
             data.set(StructuredDataKey.LORE, lore.toArray(new Tag[0]));
         }

common/src/main/java/com/viaversion/viabackwards/protocol/v1_21_6to1_21_5/storage/ChestDialogStorage.java

@@ -31,7 +31,6 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
-import static com.viaversion.viabackwards.utils.ChatUtil.text;
 import static com.viaversion.viabackwards.utils.ChatUtil.translate;
 
 /**
@@ -44,7 +43,7 @@ public final class ChestDialogStorage implements StorableObject {
     private static final AtomicInteger FAKE_ID_COUNTER = new AtomicInteger(MIN_FAKE_ID);
 
     private static final Tag[] RESPONSE_BUTTON_LABELS = new Tag[]{
-        text(""),
+        translate(""),
         translate("gui.waitingForResponse.button.inactive", 4),
         translate("gui.waitingForResponse.button.inactive", 3),
         translate("gui.waitingForResponse.button.inactive", 2),

common/src/main/java/com/viaversion/viabackwards/utils/ChatUtil.java

@@ -69,12 +69,6 @@ public static Tag fixStyle(final Tag tag) {
     public static CompoundTag translate(final String key) {
         final CompoundTag tag = new CompoundTag();
         tag.putString("translate", key);
-        return tag;
-    }
-
-    public static CompoundTag text(final String text) {
-        final CompoundTag tag = new CompoundTag();
-        tag.putString("text", text);
         tag.putString("color", "white");
         tag.putBoolean("italic", false);
         return tag;

common/src/main/resources/assets/viabackwards/config.yml

@@ -44,3 +44,19 @@ map-display-entities: true
 #
 # Suppresses warnings of missing emulations for certain features that are not supported (e.g. world height in 1.17+).
 suppress-emulation-warnings: false
+#
+# Dialog styling. You can also use translation keys here.
+dialog-style:
+  page-navigation-title: "&9&lPage navigation"
+  page-navigation-next: "&9Left click: &6Go to next page"
+  page-navigation-previous: "&9Right click: &6Go to previous page"
+  toggle-value: "&9Left click: &6Toggle value"
+  increase-value: "&9Left click: &6Increase value by %s"
+  decrease-value: "&9Right click: &6Decrease value by %s"
+  value-range: "&7(Value between &a%s &7and &a%s&7)"
+  current-value: "&7Current value: &a%s"
+  edit-value: "&9Left click: &6Edit text"
+  next-option: "&9Left click: &6Go to next option"
+  previous-option: "&9Right click: &6Go to previous option"
+  set-text: "&9Left click/close: &6Set text"
+  close: "&9Left click: &6Close"