-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c755eda
commit a355a98
Showing
5 changed files
with
197 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| # Vanilla Hardcoded Breaker（Vault Patcher） | ||
|
|
||
| [简体中文](README.md) [English](README_en_us.md) | ||
|
|
||
| ### Hardcoded -> Localization | ||
| ### Let the hard coded change into localization string in some mods. | ||
|
|
||
| ## Basic Config | ||
| `Vanilla Hardcoded Breaker` will generate config.json in `.minecraft\config\vaultpatcher` | ||
| (Hereinafter collectively referred to as ***Config File***) | ||
|
|
||
| The format of the config file is roughly as follows: | ||
| ```json | ||
| [ | ||
| { | ||
| "target_class":{ | ||
| "name":"", | ||
| "mapping":"SRG", | ||
| "stack_depth":-1 | ||
| }, | ||
| "key":"I'm key", | ||
| "value":"Im value" | ||
| }, | ||
| { | ||
| "target_class":{ | ||
| "name":"me.modid.item.relics", | ||
| "mapping":"SRG", | ||
| "stack_depth":3 | ||
| }, | ||
| "key":"Dragon Relic", | ||
| "value":"namespace.modify.modid.item.relics.dragonrelic" | ||
| }, | ||
| { | ||
| "target_class":{ | ||
| "name":"", | ||
| "mapping":"SRG", | ||
| "stack_depth":0 | ||
| }, | ||
| "key":"Talents", | ||
| "value":"namespace.modify.the_vault.gui.talnets" | ||
| } | ||
| ] | ||
| ``` | ||
| Where | ||
| ```json | ||
| { | ||
| "target_class":{ | ||
| "name":"", | ||
| "mapping":"SRG", | ||
| "stack_depth":-1 | ||
| }, | ||
| "key":"I'm key", | ||
| "value":"Im value" | ||
| } | ||
| ``` | ||
| is a Translate Key Value Pair Objects, this object includes`key`, `value` and `target_class`. | ||
|
|
||
| ### Key & Value | ||
| `key`, as the name implies, it refers to the string to be translated. | ||
|
|
||
| If you want to translate the `Copyright Mojang AB. Do not distribute!` in the title screen, | ||
| you can type `"key":"Copyright Mojang AB. Do not distribute!"`. | ||
|
|
||
| With keys, there must be values. | ||
|
|
||
| So if you want to change `Copyright Mojang AB. Do not distribute!` to `Mojang AB.`. | ||
| you can type `"value":"Mojang AB."`. | ||
|
|
||
| This completes a basic key value pair. | ||
| If there is no mistake, it should be as follows: | ||
| ```json | ||
| { | ||
| "key":"Copyright Mojang AB. Do not distribute!", | ||
| "value":"Mojang AB." | ||
| } | ||
| ``` | ||
|
|
||
| However, this is not enough, | ||
| you must add `target_class`. | ||
|
|
||
| For Example: | ||
| ```json | ||
| { | ||
| "target_class":{ | ||
| "name":"", | ||
| "mapping":"SRG", | ||
| "stack_depth":-1 | ||
| }, | ||
| "key":"Copyright Mojang AB. Do not distribute!", | ||
| "value":"Mojang AB." | ||
| } | ||
| ``` | ||
|
|
||
| ## Advanced Config | ||
|
|
||
| ### Target Class | ||
|
|
||
| `target_class`, this object is mainly used to specify different `value` of two identical `key`. | ||
| Simple explanation： | ||
|
|
||
| Now there is a GUI with `Close` button (Refers to close the GUI), and there is another gui with `Close` button (Refers to close the Pipe), | ||
|
|
||
| they have different meanings, but if not added `target_class`, then their translation content is the same. | ||
| So we need`target_class`. | ||
|
|
||
| `target_class` has three keys: `name`, `mapping` and `stack_depth`. | ||
|
|
||
| ### Name | ||
| The matching rules of `name` are as follows: | ||
| * The string starts with `#`, will be regarded as fuzzy match (For Example: `#TitleScreen` will match `net.minecraft.client.gui.screens.TitleScreen` and `net.minecraft.client.gui.screens.titlescreen` | ||
| but will not match `net.minecraft.client.gui.titlescreen.screens`) | ||
| * The string does not start with `#`, will be considered as a full match (For Example: `net.minecraft.client.gui.screens.TitleScreen` will match `net.minecraft.client.gui.screens.TitleScreen` and `net.minecraft.client.gui.screens.titlescreen` | ||
| but will not match `net.minecraft.client.gui.titlescreen.screens`) | ||
|
|
||
| ### Mapping | ||
| Reserved Field. | ||
|
|
||
| ### Stack Depth | ||
| The stack depth is used for more accurate matching classes in the stack, | ||
| for example, in the following stack: | ||
| ``` | ||
| java.base/java.lang.Thread.getStackTrace(Thread.java:1610), | ||
| TRANSFORMER/minecraft@1.18.2/net.minecraft.network.chat.TextComponent.handler$zza000$proxy_init(TextComponent.java:531), | ||
| TRANSFORMER/minecraft@1.18.2/net.minecraft.client.gui.screens.TitleScreen(TitleScreen.java:3), | ||
| ... | ||
| ``` | ||
| `stack_depth` of `net.minecraft.client.gui.screens.TitleScreen` is 2. | ||
| The size of `stack_depth` depends on the position of the stack to be located in the array, | ||
| Use `stack_depth`, `name` cannot be fuzzy match. | ||
|
|
||
| For Example： | ||
| ```json | ||
| { | ||
| "target_class":{ | ||
| "name":"net.minecraft.client.gui.screens.TitleScreen", | ||
| "mapping":"SRG", | ||
| "stack_depth":2 | ||
| }, | ||
| "key":"Copyright Mojang AB. Do not distribute!", | ||
| "value":"Mojang AB." | ||
| } | ||
| ``` | ||
| Now, you can accurately locate the class `net.minecraft.client.gui.screens.TitleScreen`. | ||
|
|
||
| ### Sample Config | ||
| **_（For Vault Hunter 3rd Edition）_** | ||
| ```json | ||
| [ | ||
| { | ||
| "target_class":{ | ||
| "name":"", | ||
| "mapping":"SRG", | ||
| "stack_depth":0 | ||
| }, | ||
| "key":"Attack Damage", | ||
| "value":"namespace.modify.the_vault.gui.attackdamage" | ||
| }, | ||
| { | ||
| "target_class":{ | ||
| "name":"", | ||
| "mapping":"SRG", | ||
| "stack_depth":0 | ||
| }, | ||
| "key":"Dragon Relic", | ||
| "value":"namespace.modify.the_vault.item.relics.dragonrelic" | ||
| }, | ||
| { | ||
| "target_class":{ | ||
| "name":"", | ||
| "mapping":"SRG", | ||
| "stack_depth":0 | ||
| }, | ||
| "key":"Talents", | ||
| "value":"namespace.modify.the_vault.gui.talnets" | ||
| } | ||
| ] | ||
| ``` | ||
| If you look carefully, you will find that `target_class` key is rarely used in config. | ||
|
|
||
| ## Others | ||
| #### Author：FengMing([github](https://github.com/3093FengMing)) | ||
| #### Configuration Author：teddyxlandlee([github](https://github.com/teddyxlandlee)) | ||
| #### Idea：yiqv([github](https://github.com/yiqv)) | ||
| #### Mod Link：[github](https://github.com/3093FengMing/VaultPatcher)，[mcmod](.)，[bilibili](.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.