Updated Home (markdown)

Nassim Jahnke 2023-03-06 11:18:01 +01:00
parent 720477041f
commit 755298156e

20
Home.md

@ -2,10 +2,20 @@ Welcome to the ViaBackwards wiki!
There's only one configurable thing of interest for ViaBackwards, so here it is.
## Changing block/item/sound mappings
Open the ViaBackwards jar file with WinRAR (or any similar unpacking software), copy out the mapping file of interest out of `assets/viabackwards/data/` into the plugin's configuration folder, and edit away!
## 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:
1. Open the ViaBackwards jar (with a program like 7zip or WinRAR) and navigate to `assets/viabackwards/data`.
1. Look for the mapping file you need, e.g. `mappings-1.19to1.18.nbt` for 1.19 -> 1.18 mappings and copy it into ViaBackward's plugin folder.
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.
Example: If you want to change the mapping of the 1.16 soul soil block, copy out the `mapping-1.15to1.16.json` file into the plugin folder, change whatever is in the `"minecraft:soul_soil": ` line in the blockstates section (as well as the items section somewhere at the bottom of the file) and restart your server.
## 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.
## 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 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
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.