unknownore / mapping

Mod for auto-generating various useful data from Bedrock Dedicated Server

mapping

This is a BDS (Bedrock Dedicated Server) mod which allows generating mappings and tables of various kinds.

This includes (but is not limited to) the current block palette for a given version, blockstate upgrade tables from previous versions, item upgrade tables, and more besides.

Usage

Set up a BDS using modloader-helper. Once you've done this, clone this repository into the code subdirectory, run helper.sh build mapping Then, run the server using the run.sh script. The output files will be produced on server start.

Input files

Input files should be placed in input_files. The following files are used by this mod:

File name	Description
r12_block_states.json	JSON table of 1.12 block states as seen here. Used to generate r12_to_current_block_map.bin.
old_palettes/*.nbt	Old blockstate tables in the same format as seen here. Used to generate blockstate mapping tables of old blockstates -> current version.

Output files

Output files are placed in the mapping_files directory.

File name	Description
biome_id_map.json	Map of biome string ID -> legacy numeric ID.
canonical_block_states.nbt	Ordered list of blockstates required by the chosen version, in varint NBT format. Read TAG_Compounds until the end of file.
hardness_table.json	Map of block string ID -> hardness value.
level_sound_id_map.json	Map of string LevelSoundEvent name -> numeric ID. NOTE: This is not complete since the game itself doesn't map all of them to strings.
old_palette_mappings/*_to_current_block_map.bin	Map of old version's blockstates -> current version. The files are an array of TAG_Compound, where the 0th, 2nd, 4th etc. indexes are the old NBT, and the 1st, 3rd, 5th etc. indexes are the new NBT. Only the versions provided in input_files/old_palettes are generated. NOTE: These files contain mappings even for states that haven't changed. You may wish to post-process them to remove unchanged states and reduce their size.
particle_id_map.json	Map of string particle name -> LevelEvent ID (without the 0x4000 flag).
r12_to_current_block_map.bin	Map of legacy 1.12 block ID+metadata -> blockstate NBT for the current version.
r16_to_current_item_map.json	Map of old item ID+meta -> current version IDs (where changed).