Add a global-config length limit check on send

NotRyken · NotRyken · commit 0daaf52476ba · 2025-07-01T21:43:24.000+08:00
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.3.11
+
+- Added a configurable message length limit to mitigate being kicked when sending overlength messages
+
 ## 2.3.10
 
 - Execute non-delayed macros immediately to preserve relative ordering (Starjon)
diff --git a/common/src/main/java/dev/terminalmc/commandkeys/CommandKeys.java b/common/src/main/java/dev/terminalmc/commandkeys/CommandKeys.java
@@ -137,14 +137,13 @@ public static boolean canTrigger(InputConstants.Key key, boolean sendMessage) {
             if (sendMessage && ratelimitedKey != key) {
                 Minecraft.getInstance().gui.getChat().addMessage(PREFIX.copy().append(
                         localized(
-                                "message", "sendBlocked",
+                                "message", "blocked.ratelimit",
                                 key.getDisplayName().copy().withStyle(ChatFormatting.GRAY),
                                 Component.literal(String.valueOf(Config.get().getRatelimitCount()))
                                         .withStyle(ChatFormatting.GRAY),
                                 Component.literal(String.valueOf(Config.get().getRatelimitTicks()))
                                         .withStyle(ChatFormatting.GRAY)
-                        )
-                                .withStyle(ChatFormatting.RED)));
+                        ).withStyle(ChatFormatting.RED)));
                 ratelimitedKey = key;
             }
             if (Config.getAndSave().ratelimitStrict)
@@ -181,6 +180,16 @@ public static void send(
         if (faults == 0) {
             if (type) {
                 mc.setScreen(new ChatScreen(message));
+            } else if (message.length() > Config.get().getLengthLimitLength()) {
+                MutableComponent msg = PREFIX.copy();
+                msg.append(localized(
+                        "message", "blocked.lengthlimit",
+                        Component.literal(String.valueOf(message.length()))
+                                .withStyle(ChatFormatting.GRAY),
+                        Component.literal(String.valueOf(Config.get().getLengthLimitLength()))
+                                .withStyle(ChatFormatting.GRAY)
+                ).withStyle(ChatFormatting.RED));
+                mc.gui.getChat().addMessage(msg);
             } else {
                 // new ChatScreen("").handleChatInput(message, addToHistory)
                 // could be slightly better for compat but costs performance.
@@ -202,8 +211,7 @@ public static void send(
             msg.append(localized(
                     "message", "placeholderFault",
                     Component.literal(message).withStyle(ChatFormatting.GRAY)
-            )
-                    .withStyle(ChatFormatting.RED));
+            ).withStyle(ChatFormatting.RED));
             mc.gui.getChat().addMessage(msg);
         }
     }
diff --git a/common/src/main/java/dev/terminalmc/commandkeys/config/Config.java b/common/src/main/java/dev/terminalmc/commandkeys/config/Config.java
@@ -20,6 +20,7 @@
 import dev.terminalmc.commandkeys.CommandKeys;
 import dev.terminalmc.commandkeys.platform.Services;
 import dev.terminalmc.commandkeys.util.JsonUtil;
+import net.minecraft.SharedConstants;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -90,6 +91,10 @@ public class Config {
     public boolean ratelimitSp;
     public static final boolean ratelimitSpDefault = false;
 
+    // Length limit options
+    private int lengthLimitLength;
+    public static final int lengthLimitLengthDefault = SharedConstants.MAX_CHAT_LENGTH;
+
     /**
      * Creates a profile list with a single profile, set as both singleplayer and multiplayer
      * default.
@@ -105,7 +110,8 @@ public Config() {
                 ratelimitCountDefault,
                 ratelimitTicksDefault,
                 ratelimitStrictDefault,
-                ratelimitSpDefault
+                ratelimitSpDefault,
+                lengthLimitLengthDefault
         );
     }
 
@@ -122,7 +128,8 @@ private Config(
             int ratelimitCount,
             int ratelimitTicks,
             boolean ratelimitStrict,
-            boolean ratelimitSp
+            boolean ratelimitSp,
+            int lengthLimitLength
     ) {
         this.profiles = profiles;
         this.spDefault = spDefault;
@@ -134,6 +141,7 @@ private Config(
         this.ratelimitTicks = ratelimitTicks;
         this.ratelimitStrict = ratelimitStrict;
         this.ratelimitSp = ratelimitSp;
+        this.lengthLimitLength = lengthLimitLength;
     }
 
     // Default profile pointer management
@@ -180,6 +188,18 @@ public void setRatelimitTicks(int ticks) {
         this.ratelimitTicks = ticks;
     }
 
+    // Length limit management
+
+    public int getLengthLimitLength() {
+        return lengthLimitLength;
+    }
+
+    public void setLengthLimitLength(int length) {
+        if (length < 1)
+            throw new IllegalArgumentException();
+        this.lengthLimitLength = length;
+    }
+
     // Profile activation handling
 
     /**
@@ -422,6 +442,10 @@ private Config validate() {
         if (ratelimitTicks < 1)
             ratelimitTicks = ratelimitTicksDefault;
 
+        // Validate length limit
+        if (lengthLimitLength < 1)
+            lengthLimitLength = lengthLimitLengthDefault;
+
         return this;
     }
 
@@ -485,6 +509,9 @@ public Config deserialize(JsonElement json, Type typeOfT, JsonDeserializationCon
             boolean ratelimitSp =
                     JsonUtil.getOrDefault(obj, "ratelimitSp", ratelimitSpDefault, silent);
 
+            int lengthLimitLength =
+                    JsonUtil.getOrDefault(obj, "lengthLimitLength", lengthLimitLengthDefault, silent);
+
             return new Config(
                     profiles,
                     spDefault,
@@ -495,7 +522,8 @@ public Config deserialize(JsonElement json, Type typeOfT, JsonDeserializationCon
                     ratelimitCount,
                     ratelimitTicks,
                     ratelimitStrict,
-                    ratelimitSp
+                    ratelimitSp,
+                    lengthLimitLength
             ).validate();
         }
     }
diff --git a/common/src/main/java/dev/terminalmc/commandkeys/gui/widget/list/MainOptionList.java b/common/src/main/java/dev/terminalmc/commandkeys/gui/widget/list/MainOptionList.java
@@ -119,6 +119,14 @@ protected void addEntries() {
                 Tooltip.create(localized("option", "main.ratelimit.tooltip")), 500
         ));
         addEntry(new Entry.Ratelimit(dynEntryX, dynEntryWidth, entryHeight));
+
+        // Length limit options
+        addEntry(new OptionList.Entry.Text(
+                dynEntryX, dynEntryWidth, entryHeight,
+                localized("option", "main.lengthlimit", "\u2139"),
+                Tooltip.create(localized("option", "main.lengthlimit.tooltip")), 500
+        ));
+        addEntry(new Entry.LengthLimit(dynEntryX, dynEntryWidth, entryHeight));
     }
 
     // Sub-screen opening
@@ -564,5 +572,37 @@ private static class Ratelimit extends Entry {
                 elements.add(spButton);
             }
         }
+
+        private static class LengthLimit extends Entry {
+
+            LengthLimit(int x, int width, int height) {
+                super();
+
+                // Max length field
+                TextField lengthField = new TextField(x, 0, width, height);
+                lengthField.posIntValidator().strict();
+                lengthField.setMaxLength(6);
+                lengthField.setResponder((val) -> {
+                    try {
+                        int space = Integer.parseInt(val.strip());
+                        if (space < 1)
+                            throw new NumberFormatException();
+                        Config.get().setLengthLimitLength(space);
+                        lengthField.setTextColor(16777215);
+                    } catch (NumberFormatException ignored) {
+                        lengthField.setTextColor(16711680);
+                    }
+                });
+                lengthField.setValue(String.valueOf(Config.get().getLengthLimitLength()));
+                lengthField.setTooltip(Tooltip.create(
+                        localized("option", "main.lengthlimit.length.tooltip")
+                                .append("\n")
+                                .append(localized(
+                                        "option",
+                                        "main.lengthlimit.length.tooltip.warning"
+                                ).withStyle(ChatFormatting.RED))));
+                elements.add(lengthField);
+            }
+        }
     }
 }
diff --git a/common/src/main/resources/assets/commandkeys/lang/de_at.json b/common/src/main/resources/assets/commandkeys/lang/de_at.json
@@ -1,9 +1,10 @@
 {
   "key.commandkeys.main": "CommandKeys",
   "key.commandkeys.main.edit": "Aktives Profil bearbeiten",
-  "modmenu.descriptionTranslation.commandkeys": "Sende vorab geschriebene Chatnachrichten und Befehle per Hotkey.",
+  "message.commandkeys.blocked.lengthlimit": "Prevented sending message with length %d. Length limit is set to %d.",
+  "message.commandkeys.blocked.ratelimit": "Ratenlimit von %s Taste überschritten. Ratenlimit ist auf %s Aktivierungen pro %s Ticks eingestellt.",
   "message.commandkeys.placeholderFault": "Die Nachricht \"%s\" konnte nicht gesendet werden, da ein oder mehrere Platzhalter nicht angewendet werden konnten.",
-  "message.commandkeys.sendBlocked": "Ratenlimit von %s Taste überschritten. Ratenlimit ist auf %s Aktivierungen pro %s Ticks eingestellt.",
+  "modmenu.descriptionTranslation.commandkeys": "Sende vorab geschriebene Chatnachrichten und Befehle per Hotkey.",
   "option.commandkeys.macro": "Makro Optionen",
   "option.commandkeys.macro.activation": "Aktivierungstyp",
   "option.commandkeys.macro.activation.HOLD": "Halten",
@@ -54,6 +55,10 @@
   "option.commandkeys.main.default.tooltip": "Diese Optionen werden von neuen Makro-Instanzen verwendet.",
   "option.commandkeys.main.exitWithoutSaving": "Bist du sicher, dass du ohne Speichern beenden möchtest?",
   "option.commandkeys.main.exitWithoutSaving.confirm": "Dadurch wird die Konfigurationsdatei neu geladen und alle vorgenommenen Änderungen werden verworfen. Falls du aktive Makros hast, werden diese gestoppt.",
+  "option.commandkeys.main.lengthlimit": "Length Limit Options %s",
+  "option.commandkeys.main.lengthlimit.length.tooltip": "Maximum allowed message length.",
+  "option.commandkeys.main.lengthlimit.length.tooltip.warning": "Changing this value will NOT change the limit set by the game.",
+  "option.commandkeys.main.lengthlimit.tooltip": "Prevents sending messages over the configured length. Useful for saving you from being kicked from the game when attempting to send very long messages.",
   "option.commandkeys.main.profile.details.tooltip": "Details bearbeiten",
   "option.commandkeys.main.profile.edit.tooltip": "Profil bearbeiten",
   "option.commandkeys.main.profile.link.remove.tooltip": "Verbindung entfernen",
@@ -97,4 +102,4 @@
   "toast.commandkeys.reset.message": "Backup gespeichert unter %s",
   "toast.commandkeys.reset.title": "CommandKeys-Optionen zurückgesetzt - Ladefehler",
   "ui.commandkeys.field.error.pos_int": "Positive ganze Zahl erforderlich"
-}
+}
diff --git a/common/src/main/resources/assets/commandkeys/lang/de_ch.json b/common/src/main/resources/assets/commandkeys/lang/de_ch.json
@@ -1,9 +1,10 @@
 {
   "key.commandkeys.main": "CommandKeys",
   "key.commandkeys.main.edit": "Aktives Profil bearbeiten",
-  "modmenu.descriptionTranslation.commandkeys": "Sende vorab geschriebene Chatnachrichten und Befehle per Hotkey.",
+  "message.commandkeys.blocked.lengthlimit": "Prevented sending message with length %d. Length limit is set to %d.",
+  "message.commandkeys.blocked.ratelimit": "Ratenlimit von %s Taste überschritten. Ratenlimit ist auf %s Aktivierungen pro %s Ticks eingestellt.",
   "message.commandkeys.placeholderFault": "Die Nachricht \"%s\" konnte nicht gesendet werden, da ein oder mehrere Platzhalter nicht angewendet werden konnten.",
-  "message.commandkeys.sendBlocked": "Ratenlimit von %s Taste überschritten. Ratenlimit ist auf %s Aktivierungen pro %s Ticks eingestellt.",
+  "modmenu.descriptionTranslation.commandkeys": "Sende vorab geschriebene Chatnachrichten und Befehle per Hotkey.",
   "option.commandkeys.macro": "Makro Optionen",
   "option.commandkeys.macro.activation": "Aktivierungstyp",
   "option.commandkeys.macro.activation.HOLD": "Halten",
@@ -54,6 +55,10 @@
   "option.commandkeys.main.default.tooltip": "Diese Optionen werden von neuen Makro-Instanzen verwendet.",
   "option.commandkeys.main.exitWithoutSaving": "Bist du sicher, dass du ohne Speichern beenden möchtest?",
   "option.commandkeys.main.exitWithoutSaving.confirm": "Dadurch wird die Konfigurationsdatei neu geladen und alle vorgenommenen Änderungen werden verworfen. Falls du aktive Makros hast, werden diese gestoppt.",
+  "option.commandkeys.main.lengthlimit": "Length Limit Options %s",
+  "option.commandkeys.main.lengthlimit.length.tooltip": "Maximum allowed message length.",
+  "option.commandkeys.main.lengthlimit.length.tooltip.warning": "Changing this value will NOT change the limit set by the game.",
+  "option.commandkeys.main.lengthlimit.tooltip": "Prevents sending messages over the configured length. Useful for saving you from being kicked from the game when attempting to send very long messages.",
   "option.commandkeys.main.profile.details.tooltip": "Details bearbeiten",
   "option.commandkeys.main.profile.edit.tooltip": "Profil bearbeiten",
   "option.commandkeys.main.profile.link.remove.tooltip": "Verbindung entfernen",
@@ -97,4 +102,4 @@
   "toast.commandkeys.reset.message": "Backup gespeichert unter %s",
   "toast.commandkeys.reset.title": "CommandKeys-Optionen zurückgesetzt - Ladefehler",
   "ui.commandkeys.field.error.pos_int": "Positive ganze Zahl erforderlich"
-}
+}
diff --git a/common/src/main/resources/assets/commandkeys/lang/de_de.json b/common/src/main/resources/assets/commandkeys/lang/de_de.json
@@ -1,9 +1,10 @@
 {
   "key.commandkeys.main": "CommandKeys",
   "key.commandkeys.main.edit": "Aktives Profil bearbeiten",
-  "modmenu.descriptionTranslation.commandkeys": "Sende vorab geschriebene Chatnachrichten und Befehle per Hotkey.",
+  "message.commandkeys.blocked.lengthlimit": "Prevented sending message with length %d. Length limit is set to %d.",
+  "message.commandkeys.blocked.ratelimit": "Ratenlimit von %s Taste überschritten. Ratenlimit ist auf %s Aktivierungen pro %s Ticks eingestellt.",
   "message.commandkeys.placeholderFault": "Die Nachricht \"%s\" konnte nicht gesendet werden, da ein oder mehrere Platzhalter nicht angewendet werden konnten.",
-  "message.commandkeys.sendBlocked": "Ratenlimit von %s Taste überschritten. Ratenlimit ist auf %s Aktivierungen pro %s Ticks eingestellt.",
+  "modmenu.descriptionTranslation.commandkeys": "Sende vorab geschriebene Chatnachrichten und Befehle per Hotkey.",
   "option.commandkeys.macro": "Makro Optionen",
   "option.commandkeys.macro.activation": "Aktivierungstyp",
   "option.commandkeys.macro.activation.HOLD": "Halten",
@@ -54,6 +55,10 @@
   "option.commandkeys.main.default.tooltip": "Diese Optionen werden von neuen Makro-Instanzen verwendet.",
   "option.commandkeys.main.exitWithoutSaving": "Bist du sicher, dass du ohne Speichern beenden möchtest?",
   "option.commandkeys.main.exitWithoutSaving.confirm": "Dadurch wird die Konfigurationsdatei neu geladen und alle vorgenommenen Änderungen werden verworfen. Falls du aktive Makros hast, werden diese gestoppt.",
+  "option.commandkeys.main.lengthlimit": "Length Limit Options %s",
+  "option.commandkeys.main.lengthlimit.length.tooltip": "Maximum allowed message length.",
+  "option.commandkeys.main.lengthlimit.length.tooltip.warning": "Changing this value will NOT change the limit set by the game.",
+  "option.commandkeys.main.lengthlimit.tooltip": "Prevents sending messages over the configured length. Useful for saving you from being kicked from the game when attempting to send very long messages.",
   "option.commandkeys.main.profile.details.tooltip": "Details bearbeiten",
   "option.commandkeys.main.profile.edit.tooltip": "Profil bearbeiten",
   "option.commandkeys.main.profile.link.remove.tooltip": "Verbindung entfernen",
diff --git a/common/src/main/resources/assets/commandkeys/lang/en_us.json b/common/src/main/resources/assets/commandkeys/lang/en_us.json
@@ -1,8 +1,9 @@
 {
   "key.commandkeys.main": "CommandKeys",
   "key.commandkeys.main.edit": "Edit Active Profile",
+  "message.commandkeys.blocked.lengthlimit": "Prevented sending message with length %d. Length limit is set to %d.",
+  "message.commandkeys.blocked.ratelimit": "Ratelimit exceeded by key %s. Ratelimit is set to %s activations in %s ticks.",
   "message.commandkeys.placeholderFault": "Message \"%s\" could not be sent because one or more placeholders failed to apply.",
-  "message.commandkeys.sendBlocked": "Ratelimit exceeded by key %s. Ratelimit is set to %s activations in %s ticks.",
   "option.commandkeys.macro": "Macro Options",
   "option.commandkeys.macro.activation": "Activation Type",
   "option.commandkeys.macro.activation.HOLD": "Hold",
@@ -53,6 +54,10 @@
   "option.commandkeys.main.default.tooltip": "These options will be used by new Macro instances.",
   "option.commandkeys.main.exitWithoutSaving": "Are you sure you want to exit without saving?",
   "option.commandkeys.main.exitWithoutSaving.confirm": "This will reload the configuration file to revert any changes you have made. If you have any active macros, they will be stopped.",
+  "option.commandkeys.main.lengthlimit": "Length Limit Options %s",
+  "option.commandkeys.main.lengthlimit.length.tooltip": "Maximum allowed message length.",
+  "option.commandkeys.main.lengthlimit.length.tooltip.warning": "Changing this value will NOT change the limit set by the game.",
+  "option.commandkeys.main.lengthlimit.tooltip": "Prevents sending messages over the configured length. Useful for saving you from being kicked from the game when attempting to send very long messages.",
   "option.commandkeys.main.profile.details.tooltip": "Edit details",
   "option.commandkeys.main.profile.edit.tooltip": "Edit profile",
   "option.commandkeys.main.profile.link.remove.tooltip": "Remove link",
@@ -96,4 +101,4 @@
   "toast.commandkeys.reset.message": "Backup saved to %s",
   "toast.commandkeys.reset.title": "CommandKeys Options Reset - Load Error",
   "ui.commandkeys.field.error.pos_int": "Positive integer required"
-}
+}
diff --git a/common/src/main/resources/assets/commandkeys/lang/ru_ru.json b/common/src/main/resources/assets/commandkeys/lang/ru_ru.json
@@ -1,8 +1,9 @@
 {
   "key.commandkeys.main": "CommandKeys",
   "key.commandkeys.main.edit": "Изменить активный профиль",
+  "message.commandkeys.blocked.lengthlimit": "Prevented sending message with length %d. Length limit is set to %d.",
+  "message.commandkeys.blocked.ratelimit": "Превышен лимит для ключа %s. Лимит установлен на %s активаций за %s тиков.",
   "message.commandkeys.placeholderFault": "Сообщение \"%s\" не может быть отправлено, так как не удалось применить один или несколько заполнителей.",
-  "message.commandkeys.sendBlocked": "Превышен лимит для ключа %s. Лимит установлен на %s активаций за %s тиков.",
   "option.commandkeys.macro": "Параметры макросов",
   "option.commandkeys.macro.activation": "Тип активации",
   "option.commandkeys.macro.activation.HOLD": "Удержание",
@@ -53,6 +54,10 @@
   "option.commandkeys.main.default.tooltip": "Эти параметры будут использоваться новыми экземплярами макроса.",
   "option.commandkeys.main.exitWithoutSaving": "Вы уверены, что хотите выйти без сохранения?",
   "option.commandkeys.main.exitWithoutSaving.confirm": "Это перезагрузит файлы конфигурации, чтобы отменить ВСЕ внесённые вами изменения. Если у вас есть активные макросы, то они будут остановлены.",
+  "option.commandkeys.main.lengthlimit": "Length Limit Options %s",
+  "option.commandkeys.main.lengthlimit.length.tooltip": "Maximum allowed message length.",
+  "option.commandkeys.main.lengthlimit.length.tooltip.warning": "Changing this value will NOT change the limit set by the game.",
+  "option.commandkeys.main.lengthlimit.tooltip": "Prevents sending messages over the configured length. Useful for saving you from being kicked from the game when attempting to send very long messages.",
   "option.commandkeys.main.profile.details.tooltip": "Редактировать детали",
   "option.commandkeys.main.profile.edit.tooltip": "Редактировать профиль",
   "option.commandkeys.main.profile.link.remove.tooltip": "Удалить ссылку",
diff --git a/common/src/main/resources/assets/commandkeys/lang/uk_ua.json b/common/src/main/resources/assets/commandkeys/lang/uk_ua.json
diff --git a/common/src/main/resources/assets/commandkeys/lang/zh_cn.json b/common/src/main/resources/assets/commandkeys/lang/zh_cn.json
diff --git a/gradle.properties b/gradle.properties
