Upstream/ViaBackwards
1
0
Fork 0
mirror of https://github.com/ViaVersion/ViaBackwards.git synced 2024-11-21 12:07:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

Nassim Jahnke 2023-03-09 11:00:24 +01:00
parent 816c2fd6b7
commit fa71312fd5
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Home.md

@ -1,3 +1,4 @@
# NBT Mappings
## Changing item and entity names ## Changing item and entity names
Since 4.6.0, mapping files are stored in a new, compact format, so editing them has become slightly more difficult: Since 4.6.0, mapping files are stored in a new, compact format, so editing them has become slightly more difficult:
1. Open the ViaBackwards jar (with a program like 7zip or WinRAR) and navigate to `assets/viabackwards/data`. 1. Open the ViaBackwards jar (with a program like 7zip or WinRAR) and navigate to `assets/viabackwards/data`.
@ -5,13 +6,27 @@ Since 4.6.0, mapping files are stored in a new, compact format, so editing them
1. Open the NBT file with an NBT editor program or website, for example https://irath96.github.io/webNBT/ or the [Minecraft Dev Plugin for IntelliJ](https://mcdev.io/). 1. Open the NBT file with an NBT editor program or website, for example https://irath96.github.io/webNBT/ or the [Minecraft Dev Plugin for IntelliJ](https://mcdev.io/).
1. Look for `itemnames` and `entitynames`, edit the values you want to change, and save the file. Now ViaBackwards will load the file from its plugin directory if present. 1. Look for `itemnames` and `entitynames`, edit the values you want to change, and save the file. Now ViaBackwards will load the file from its plugin directory if present.
## Adding custom model data
Add a new compound tag under `itemdata`. Similar to the `itemnames` field, the key is the registry id of the item (same as in the `itemnames` tag), the value in this case is another compound tag, which can contain a `custom_model_data` number tag. An example of this looks like:
```nbt
itemdata: {
"123": {
custom_model_data: 1
}
"1234": {
custom_model_data: 2
}
}
```
## Changing block/item/sound id mappings
You cannot easily edit these from the NBT mapping files. The human readable diff mappings are stored in a [separate repository](https://github.com/ViaVersion/Mappings/tree/main/mappings/diff) and [require compiling](https://github.com/ViaVersion/Mappings#compiling-json-mapping-files-into-compact-nbt-files).
We'd suggest simply creating a pull request to change the json file mappings if you think different mappings would be more suitable, so they can be changed in ViaBackwards proper.
# JSON Mappings
## Changing 1.16+->1.15 biome mappings ## Changing 1.16+->1.15 biome mappings
Similar to the mappings from above, you can move the `biome-mappings.json` file into the plugin folder and directly add mappings for custom biomes to map them to legacy biomes (the static biome names that existed until 1.15.2). Make sure to keep the file up to date with ViaBackwards updates. Similar to the mappings from above, you can move the `biome-mappings.json` file into the plugin folder and directly add mappings for custom biomes to map them to legacy biomes (the static biome names that existed until 1.15.2). Make sure to keep the file up to date with ViaBackwards updates.
## Changing backwards translations ## Changing backwards translations
Same thing as biome mappings but with the translation json file. Same thing as biome mappings but with the translation json file.
## Changing block/item/sound id mappings (advanced, not recommended)
You cannot easily edit these from the NBT mapping files. The human readable diff mappings are stored in a [separate repository](https://github.com/ViaVersion/Mappings/tree/main/mappings/diff) and [require compiling](https://github.com/ViaVersion/Mappings#compiling-json-mapping-files-into-compact-nbt-files).
We'd suggest simply creating a pull request to change the json file mappings if you think different mappings would be more suitable, so they can be changed in ViaBackwards proper.