Skip to content
This repository has been archived by the owner on Sep 11, 2023. It is now read-only.

A VaultPatcher Unofficial Fabric port. Let the hard coded change into localization string in some mods.

License

Notifications You must be signed in to change notification settings

LocalizedMC/HardcodePatcher

 
 

Repository files navigation

Hardcode Patcher

Vault Patcher 的非官方 Fabric 移植版。让一些mod中硬编码的字符串转化为可以本地化的字符串。

ZH-CN / English

⚠警告:1.0.1以下的版本不再受支持!

模组可用指令

/hardcodepatcher/hp为基础,共有3个可用的命令或参数,分别为:exportlistreload

  • /hp export会向.Minecraft根目录输出一个叫langpacther.json的文件,里面存放的是你已经加载的文本内容(并不代表加载的模组和游戏的全部文本,将鼠标放在模组物品上,这个物品的名字和描述将全部记录) 该指令与optimize_params功能有关
  • /hp list在聊天栏列举加载的模块.json,鼠标放在绿色字符串上会显示相关信息
  • /hp reload重新加载资源包内容

配置文件

配置

在1.2.5以后,配置文件均采用模块的形式 在config/HardcodePatcher/下的格式为config.json和若干个模块.json。(模块文件目前在Fabric版中是必须存在一个及以上)

config.json是必须的。

如下:

{
  "mods": [
    "模块"
  ],
  "debug_mode": {
    "is_enable": false,
    "test_mode": false,
    "output_mode": 0,
    "output_format": "<source> -> <target>"
  },
  "optimize_params": {
    "disable_export": true,
    "disable_stacks": true,
    "stack_min": -1,
    "stack_max": -1
  }
}

模块(mods)

config.json定义了模块.json模块.json才会被正常读取读取并使用。反之亦然。

编辑模式(test_mode,虽然没有编辑功能)

开启后,模组会把字符串匹配度高达50%的做一个标记,替换的地方会做一个标记

调试模式(Debug Mode)

可以在调试和查找文本时使用。

is_enable决定调试功能是否开启。开启时会在替换字符串时向日志中输出一行调试信息,调试信息的格式由output_format决定,调试信息的内容由output_mode决定。 默认为 false。

output_format决定了调试信息的格式,默认为<source> -> <target>。 允许占位符,支持的占位符如下:

  • <source>:源内容,即未做替换前的字符串。
  • <target>:替换后的字符串。
  • <stack>:堆栈跟踪数组,是此字符串所在类的StackTrace(包括本mod)。
  • <method>:该文本渲染所调用的方法。

output_mode决定了调试信息的内容。 若为 0, 则仅输出替换的字符串; 若为 1, 则仅输出不被替换的字符串。

优化参数(Optimization Parameters)

更改优化替换算法的参数。

disable_export决定是否禁用export功能,该选项对于优化有很大的作用。但同时/vaultpatcher export也将禁用。 默认为 false。

disable_stacks决定是否禁用堆栈匹配,该选项对于优化有很大的作用。但同时类匹配也将禁用。 默认为 false。

stack_minstack_max,决定了堆栈跟踪数组中的上限与下限,适当调整参数可以达到优化效果。 默认均为 -1(即不更改上限下限)。

模块

模块的格式大概这样:

[
  {
    "target_class": {
      "name": "",
      "method": "",
      "stack_depth": -1
    },
    "key": "I'm key",
    "value": "@I'm value"
  },
  {
    "target_class": {
      "name": "me.modid.item.relics",
      "method": "",
      "stack_depth": 3
    },
    "key": "Dragon Relic",
    "value": "namespace.modify.modid.item.relics.dragonrelic"
  },
  {
    "target_class": {
      "name": "",
      "method": "",
      "stack_depth": 0
    },
    "key": "Talents",
    "value": "namespace.modify.the_vault.gui.talnets"
  }
]

或者

[
  {
    "key": "I'm key",
    "value": "@I'm value"
  },
  {
    "key": "Dragon Relic",
    "value": "namespace.modify.modid.item.relics.dragonrelic"
  },
  {
    "key": "Talents",
    "value": "namespace.modify.the_vault.gui.talnets"
  }
]

。其中,

{
  "target_class": {
    "name": "",
    "method": "",
    "stack_depth": -1
  },
  "key": "I'm key",
  "value": "Im value"
}

就是一个翻译键值对,主要涉及到keyvaluetarget_class

键值对(key-value pair)

键(Key)

key,顾名思义,指定的是要翻译的字符串。

如果我想翻译标题界面的Copyright Mojang AB. Do not distribute!, 那么可以指定"key":"你的翻译内容"

值(Value)

有了键,还得有值。

那么我想将Copyright Mojang AB.改为Copyright Mojang ABCD.。 那就可以指定"value":"Copyright Mojang ABCD."

半匹配

以上的方式均为全匹配(即完全替换),只替换与key相同的文本。

如果你想半匹配,或者原字符串中有无法进行全匹配的格式化文本(例如§a%d%s等)。 那么可以在value的前面加上@字符,实现半匹配。

例子:

{
  "key": "Grass",
  "value": "@CAO"
}

这样就会把所有的Grass都替换为CAO(包括Grass BlockGrassTall Grass

这样一个基础的键值对就完成了。 应该是这样子的:

{
  "target_class": {
    "name": "",
    "method": "",
    "stack_depth": 0
  },
  "key": "Copyright Mojang AB. Do not distribute!",
  "value": "Mojang AB."
}

或者

{
  "key": "Copyright Mojang AB. Do not distribute!",
  "value": "Mojang AB."
}

例如

{
  "target_class": {
    "name": "",
    "method": "",
    "stack_depth": -1
  },
  "key": "Copyright Mojang AB. Do not distribute!",
  "value": "Mojang AB."
}

高级配置

注入目标(target class)

target_class这个对象主要用于指定两个相同key的不同value。 简单解释下:

有一个GUI里面有Close(指关闭GUI)这个文本,另一个GUI也有Close(指关闭管道),

此时它们的含义不同,但是若不加上target_class,那么他们的翻译内容却是一样的。 所以要用到target_class

target_class中有三个键:namemappingstack_depth

类名(name)

类名的匹配规则大概是这样的:

类匹配

  • #开头的字符串会视为类匹配(示例:#TitleScreen会匹配net.minecraft.client.gui.screens.TitleScreennet.minecraft.client.gui.screens.titlescreen 但不匹配net.minecraft.client.gui.titlescreen.screens
  • 实际上是String.endsWith,即匹配末尾内容

包匹配

  • @开头的字符串会视为包匹配(示例:#net.minecraft.client会匹配net.minecraft.client.gui.screens.TitleScreennet.minecraft.client.gui.screens.BeaconScreen等等 也匹配net.minecraft.client.gui.titlescreen.screens
  • 实际上是String.startsWith,即匹配开头内容

完全匹配

  • 不以#@开头的字符串会视为全匹配(示例:net.minecraft.client.gui.screens.TitleScreen会匹配net.minecraft.client.gui.screens.TitleScreennet.minecraft.client.gui.screens.titlescreen 但不匹配net.minecraft.client.gui.titlescreen.screens
  • 实际上是String.equals,即匹配文本

方法(method)

方法在类之中,用于更精准的定位文本内容

堆栈深度(stack depth)

堆栈深度在堆栈中用于更精准的匹配类, 例如在如下堆栈中

java.base/java.lang.Thread.getStackTrace(Thread.java:1610), 
TRANSFORMER/[email protected]/net.minecraft.network.chat.TextComponent.handler$zza000$proxy_init(TextComponent.java:531),
TRANSFORMER/[email protected]/net.minecraft.client.gui.screens.TitleScreen(TitleScreen.java:3),
...

net.minecraft.client.gui.screens.TitleScreenstack_depth就是2。 stack_depth的大小取决于要定位的堆栈所处的位置, 使用stack_depth时,name不能为模糊匹配。

例如:

{
  "target_class": {
    "name": "net.minecraft.client.gui.screens.TitleScreen",
    "method": "",
    "stack_depth": 2
  },
  "key": "Copyright Mojang AB. Do not distribute!",
  "value": "Mojang AB."
}

此时便能精准的定位到net.minecraft.client.gui.screens.TitleScreen这个类。

参考配置

(用于Vault Hunter 3rd Edition)

[
  {
    "key": "Attack Damage",
    "value": "namespace.modify.the_vault.gui.attackdamage"
  },
  {
    "key": "Dragon Relic",
    "value": "namespace.modify.the_vault.item.relics.dragonrelic"
  },
  {
    "key": "Talents",
    "value": "namespace.modify.the_vault.gui.talnets"
  }
]

其他

原作者:FengMing(github爱发电)

配置部分:teddyxlandlee(github)

想法:yiqv(github)

原Mod地址:ModrithGithubmcmodbilibili

About

A VaultPatcher Unofficial Fabric port. Let the hard coded change into localization string in some mods.

Resources

License

Stars

Watchers

Forks

Languages

  • Java 100.0%