sync VP 1.2.8

Author: TexBlock

README-EN.md

@@ -8,13 +8,15 @@ An unofficial Fabric Port of Vault Patcher. Let the hard coded strings change in
 
 [ZH-CN](README.md) / English
 
+## ⚠Warning: Version 1.0.1 and below is no longer supported!
+
 </div></center>
 
 # Configs File
 
 ## Modular
 
-the format in `config/HardcodePatcher/` directory like is `config.json` and several `module.json`. (Module files are currently required to exist in one or more of the Fabric versions)
+The format in `config/HardcodePatcher/` directory like is `config.json` and several `module.json`. (Module files are currently required to exist in one or more of the Fabric versions)
 
 `config.json` must be provided.
 It is as follows:
@@ -27,6 +29,11 @@ It is as follows:
     "is_enable": false,
     "output_mode": 0,
     "output_format": "<source> -> <target>"
+  },
+  "optimize_params": {
+    "disable_export": true,
+    "stack_min": -1,
+    "stack_max": -1
   }
 }
 ```
@@ -36,24 +43,33 @@ It is as follows:
 Only in this way can `module.json` read and used normally.
 
 ### Debug Mode
-**(Tips: ONLY DEBUG)**
+Can be used when debugging and finding text.
 
-`is_enable` determines whether the debugging feature is enabled.
-If it is `true`, a line of debugging information will be output to the log when replacing the string,
-The format of debugging information is `output_format`, and determines the content of debugging information by `output_format`.
-If it is `false`, Will not output anything to the log when replacing the string.
+`is_enable` determines whether the debugging feature is enabled. If it is `true`, a line of debugging information will be output to the log when replacing the string,
+The format of debugging information is `output_format`, and determines the content of debugging information by `output_mode`.
 
 `output_format` determines the format of debugging information. The default is `<source> -> <target>`.
-`<source>` is the source string, that is, the string before replacement. and `<target>`is the replacement string.
-There is another `<stack>` that is not shown, if you include it in `output_format`,
-the log will be polluted because of the large amount of output information.
-`<stack>` is a stacktrace array, which is the `StackTrace` (including this mod) of the class of this string,
-This value is more for `stack_depth` and `name` in `target_class`.
+* `<source>`: Source string, the string before replacement.
+* `<target>`: The replacement string.
+* `<stack>`: Stacktrace array, which is the `StackTrace` (including this mod) of the class of this string.
+* `<method>`: The method called when this text rendering.
 
 `output_mode` determines the content of debugging information.
 If it is 0, only the replaced string will be output,
 If it is 1, only the strings that are not replaced are output.
 
+### Optimization Parameters
+
+Optimize the parameters of the algorithm.
+
+`disable_export` determines whether to disable the `export` feature, which is very useful for optimization.
+But at the same time, `/vaultpatcher export` will also be disabled.
+The default is false.
+
+`stack_min` and `stack_max` determines the upper and lower limits of the stack trace array,
+and the optimization effect can be achieved by properly adjusting the parameters.
+The default is -1 (The upper and lower limits are not changed).
+
 ## Module
 
 The format of the Module File is roughly as follows:

README.md

@@ -8,6 +8,8 @@ Vault Patcher 的非官方 Fabric 移植版。让一些mod中硬编码的字符
 
 ZH-CN / [English](README-EN.md)
 
+## ⚠警告：1.0.1及以下的版本不再受支持！
+
 </div></center>
 
 # 配置文件
@@ -27,6 +29,11 @@ ZH-CN / [English](README-EN.md)
     "is_enable": false,
     "output_mode": 0,
     "output_format": "<source> -> <target>"
+  },
+  "optimize_params": {
+    "disable_export": true,
+    "stack_min": -1,
+    "stack_max": -1
   }
 }
 ```
@@ -35,21 +42,32 @@ ZH-CN / [English](README-EN.md)
 `模块.json`才会被正常读取读取并使用。反之亦然。
 
 ### 调试模式（Debug Mode）
-**(Tips: 仅供调试使用)**
+可以在调试和查找文本时使用。
 
-`is_enable`决定调试功能是否开启。
-若为`true`，那么会在替换字符串时向日志中输出一行调试信息，调试信息的格式由`output_format`决定，调试信息的内容由`output_mode`决定。
-若为`false`，则不会在替换字符串时向日志中输出任何内容。
+`is_enable`决定调试功能是否开启。开启时会在替换字符串时向日志中输出一行调试信息，调试信息的格式由`output_format`决定，调试信息的内容由`output_mode`决定。
+默认为 false。
 
 `output_format`决定了调试信息的格式，默认为`<source> -> <target>`。
-`<source>`为源内容，即未做替换前的字符串；`<target>`为做替换后的字符串。
-还有一个`<stack>`未展示出来，因为输出的很多，容易污染日志。
-`<stack>`为堆栈跟踪数组，是此字符串所在类的`StackTrace`(包括本mod)，它更多是为`target_class`中的`stack_depth`和`name`服务的。
+允许占位符，支持的占位符如下：
+* `<source>`：源内容，即未做替换前的字符串。
+* `<target>`：替换后的字符串。
+* `<stack>`：堆栈跟踪数组，是此字符串所在类的`StackTrace`(包括本mod)。
+* `<method>`：该文本渲染所调用的方法。
 
 `output_mode`决定了调试信息的内容。
 若为 0, 则仅输出替换的字符串；
 若为 1, 则仅输出不被替换的字符串。
 
+### 优化参数（Optimization Parameters）
+
+更改优化替换算法的参数。
+
+`disable_export`决定是否禁用`export`功能，该选项对于优化有很大的作用。但同时`/vaultpatcher export`也将禁用。
+默认为 false。
+
+`stack_min`和`stack_max`，决定了堆栈跟踪数组中的上限与下限，适当调整参数可以达到优化效果。
+默认均为 -1（即不更改上限下限）。
+
 ## 模块
 
 模块的格式大概这样：

build.gradle

@@ -9,6 +9,8 @@ archivesBaseName = project.archives_base_name
 version = project.mod_version
 group = project.maven_group
 
+
+
 repositories {
 
 }

gradle.properties

@@ -8,8 +8,8 @@ org.gradle.jvmargs=-Xmx1G
 	loader_version=0.14.6
 
 # Mod Properties
-	mod_version = 1.0.1-1.18.x
-	maven_group = org.localmc.tools.hardcodepatcher
+	mod_version = 1.0.2-1.18.x
+	maven_group = org.localmc.tools
 	archives_base_name = HardcodePatcher-Fabric
 
 # Dependencies

src/main/java/org/localmc/tools/hardcodepatcher/HardcodePatcher.java

@@ -16,7 +16,7 @@
 
 public class HardcodePatcher implements ModInitializer {
     public static final String MODID = "hardcodepatcher";
-    public static final String patchFileName = "hardcodepatcher.json";
+    public static final String patchFileName = "langpatcher.json";
     public static final Path configPath = FabricLoader.getInstance().getConfigDir().resolve("HardcodePatcher");
     public static final Logger LOGGER = LogUtils.getLogger();
     public static List<HardcodePatcherPatch> vpps = new ArrayList<>();
@@ -31,7 +31,7 @@ public void onInitialize() {
             for (String mod : mods) {
                 HardcodePatcherPatch vpp = new HardcodePatcherPatch(mod + ".json");
                 try {
-                    vpp.readConfig();
+                    vpp.read();
                     vpps.add(vpp);
                 } catch (IOException e) {
                     e.printStackTrace();
@@ -42,24 +42,4 @@ public void onInitialize() {
             throw new RuntimeException(e);
         }
     }
-/*
-    public static void loadConfig() {
-        try {
-            HardcodeTextPatcherConfig.readConfig();
-            List<String> mods = HardcodeTextPatcherConfig.getMods();
-            for (String mod : mods) {
-                HardcodeTextPatcherPatch vpp = new HardcodeTextPatcherPatch(mod + ".json");
-                try {
-                    vpp.readConfig();
-                    vpps.add(vpp);
-                } catch (IOException e) {
-                    e.printStackTrace();
-                }
-            }
-        } catch (IOException e) {
-            LOGGER.error("Failed to load config: ", e);
-            throw new RuntimeException(e);
-        }
-    }
- */
 }

src/main/java/org/localmc/tools/hardcodepatcher/HardcodePatcherUtils.java

@@ -7,12 +7,14 @@
 public class HardcodePatcherUtils {
     public static ArrayList<String> exportList = new ArrayList<>();
     public static Map<String, Boolean> exported = new HashMap<>();
+
     public static void addToExportList(String text) {
         if (!exported.getOrDefault(text, false) || !isInExportList(text)) {
             exported.put(text, true);
             exportList.add(text);
         }
     }
+
     public static boolean isInExportList(String text) {
         return exportList.lastIndexOf(text) != -1;
     }

src/main/java/org/localmc/tools/hardcodepatcher/ModuleEvent.java

@@ -0,0 +1,28 @@
+package org.localmc.tools.hardcodepatcher;
+
+import org.localmc.tools.hardcodepatcher.config.HardcodePatcherConfig;
+import org.localmc.tools.hardcodepatcher.config.HardcodePatcherPatch;
+
+import java.io.IOException;
+import java.util.List;
+
+public class ModuleEvent {
+     static void loadConfig() {
+        try {
+            HardcodePatcherConfig.readConfig();
+            List<String> mods = HardcodePatcherConfig.getMods();
+            for (String mod : mods) {
+                HardcodePatcherPatch vpp = new HardcodePatcherPatch(mod + ".json");
+                try {
+                    vpp.read();
+                    HardcodePatcher.vpps.add(vpp);
+                } catch (IOException e) {
+                    e.printStackTrace();
+                }
+            }
+        } catch (IOException e) {
+            HardcodePatcher.LOGGER.error("Failed to load config: ", e);
+            throw new RuntimeException(e);
+        }
+    }
+}

src/main/java/org/localmc/tools/hardcodepatcher/ThePatcher.java

@@ -10,38 +10,51 @@ public class ThePatcher {
     public ThePatcher() {
     }
 
-    public static String patch(String s) {
-        if (s == null || s.isBlank()) {
-            return s;
+    public static String patch(String string, String method) {
+        if (string == null || string.equals("") || string.isBlank()) {
+            return string;
         }
-        HardcodePatcherUtils.addToExportList(s);
-        // HardcodeTextPatcher.LOGGER.info(Arrays.toString(Thread.currentThread().getStackTrace()));
+
+        if (!HardcodePatcherConfig.getOptimize().isDisableExport()) {
+            HardcodePatcherUtils.addToExportList(string);
+        }
+
         String ret;
         for (HardcodePatcherPatch vpp : HardcodePatcher.vpps) {
             StackTraceElement[] stacks = Thread.currentThread().getStackTrace();
-            ret = vpp.patch(s, stacks);
+            ret = vpp.patch(string, stacks);
+
             DebugMode debug = HardcodePatcherConfig.getDebugMode();
-            String format = debug.getOutputFormat();
-            if (ret != null && !ret.equals(s)) {
-                if (debug.isEnable() && (debug.getOutputMode() == 1 || debug.getOutputMode() == 0)) {
-                    HardcodePatcher.LOGGER.info(
-                            format.replace("<source>", s)
-                                    .replace("<target>", ret)
-                                    .replace("<stack>", Arrays.toString(stacks))
-                    );
-                }
-                return ret;
-            } else {
-                if (debug.isEnable() && debug.getOutputMode() == 1) {
-                    HardcodePatcher.LOGGER.info(
-                            format.replace("<source>", s)
-                                    .replace("<target>", s)
-                                    .replace("<stack>", Arrays.toString(stacks))
-                    );
-                }
-                return s;
+
+            if (debug.isEnable()) {
+                return outputDebugIndo(string, method, ret, stacks, debug);
+            } else return ret;
+
+        }
+        return string;
+    }
+
+    private static String outputDebugIndo(String s, String m, String ret, StackTraceElement[] stacks, DebugMode debug) {
+        String format = debug.getOutputFormat();
+        if (ret != null && !ret.equals(s)) {
+            if (debug.getOutputMode() == 1 || debug.getOutputMode() == 0) {
+                HardcodePatcher.LOGGER.info(
+                        format.replace("<source>", s)
+                                .replace("<target>", ret)
+                                .replace("<method>", m)
+                                .replace("<stack>", Arrays.toString(stacks))
+                );
+            }
+        } else {
+            if (debug.getOutputMode() == 1) {
+                HardcodePatcher.LOGGER.info(
+                        format.replace("<source>", s)
+                                .replace("<target>", s)
+                                .replace("<method>", m)
+                                .replace("<stack>", Arrays.toString(stacks))
+                );
             }
         }
-        return s;
+        return ret;
     }
 }

src/main/java/org/localmc/tools/hardcodepatcher/command/CommandEventHandler.java

@@ -10,14 +10,14 @@ public class CommandEventHandler {
     public static void registerClientCommands(CommandDispatcher<ServerCommandSource> dispatcher, Boolean dedicated) {
         LiteralCommandNode<ServerCommandSource> cmd = dispatcher.register(
                 CommandManager.literal(HardcodePatcher.MODID
-                ).then(
-                        CommandManager.literal("export")
+                    ).then(
+                            CommandManager.literal("export")
                                 .executes(ExportCommand.instance)
-                ).then(
-                        CommandManager.literal("list")
+                    ).then(
+                            CommandManager.literal("list")
                                 .executes(ListCommand.instance)
-                ).then(
-                        CommandManager.literal("reload")
+                    ).then(
+                            CommandManager.literal("reload")
                                 .executes(ReloadCommand.instance)
                 ));
         dispatcher.register(CommandManager.literal("hp").redirect(cmd));

src/main/java/org/localmc/tools/hardcodepatcher/command/ExportCommand.java

@@ -9,6 +9,7 @@
 import net.minecraft.server.command.ServerCommandSource;
 import net.minecraft.text.TranslatableText;
 import org.localmc.tools.hardcodepatcher.HardcodePatcherUtils;
+import org.localmc.tools.hardcodepatcher.config.HardcodePatcherConfig;
 
 import java.io.BufferedWriter;
 import java.io.FileWriter;
@@ -21,10 +22,15 @@ public class ExportCommand implements Command<ServerCommandSource> {
 
     @Override
     public int run(CommandContext<ServerCommandSource> context) {
-        context.getSource().sendFeedback(new TranslatableText("commands.hardcodepatcher.export.warning.wip"), true);
         Gson gson = new Gson();
         String json = gson.toJson(HardcodePatcherUtils.exportList, new TypeToken<ArrayList<String>>() {
         }.getType());
+
+        if (HardcodePatcherConfig.getOptimize().isDisableExport()) {
+            context.getSource().sendError(new TranslatableText("commands.hardcodepatcher.export.tips.disabled"));
+            return 1;
+        }
+
         //Export
         try {
             BufferedWriter bw = new BufferedWriter(
@@ -38,7 +44,7 @@ public int run(CommandContext<ServerCommandSource> context) {
         } catch (IOException e) {
             e.printStackTrace();
         }
-        context.getSource().sendFeedback(new TranslatableText("commands.hardcodepatcher.export.tips.success"), true);
+        context.getSource().sendFeedback(new TranslatableText("commands.hardcodepatcher.export.tips.success" + HardcodePatcher.patchFileName), true);
         return 0;
     }
 }