diff --git a/README.md b/README.md index 759d1a3..1d5c7ed 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ # BedrockData Blobs of data generated from Minecraft: Bedrock Edition used by PocketMine-MP -### `required_block_states.nbt` +### required_block_states.nbt This file contains a network-format NBT list of all the blockstate permutations needed by MCPE's `StartGamePacket`. It's provided as-is directly from `StartGamePacket` sent by the current vanilla server. -### `block_id_map.json` +### block_id_map.json This file contains a mapping of all block stringy IDs to legacy numeric IDs (which are still used internally, and still needed by third party developers for conversion and for items). #### Note Where a block's legacy ID is > 255, its item ID is `255 - legacyBlockId`. This means prismarine stairs = -2 and so on. -### `r12_to_current_block_map.bin` +### r12_to_current_block_map.bin This file contains a list of mappings from legacy pre-1.13 blockstates to states of the current version. This data is obtained by plugging the legacy states into `BlockPalette` in the vanilla BDS using [`pmmp/mapping`](https://github.com/pmmp/mapping), and writing the resulting NBT state obtained. @@ -26,20 +26,20 @@ The following structure is repeated until EOF. There is **no** length prefix, so An example of how to read this file using the PocketMine-MP core library can be seen on the [stable branch](https://github.com/pmmp/PocketMine-MP/blob/41f7c07703bf3f7ef2d9504bbdbdf74257e75d12/src/pocketmine/network/mcpe/convert/RuntimeBlockMapping.php#L71-L86) or on the [master branch](https://github.com/pmmp/PocketMine-MP/blob/master/src/network/mcpe/convert/RuntimeBlockMapping.php#L74-L86). -### `item_id_map.json` +### item_id_map.json This file contains a mapping of all item stringy IDs to legacy numeric IDs. -### `banner_patterns.json` +### banner_patterns.json This file defines all the known banner pattern types and their crafting requirements. -### `recipes.json` +### recipes.json This file defines all crafting-table, furnace and chemistry recipes. This includes recipes for the smoker, cartography table etc. -### `creativeitems.json` +### creativeitems.json This file contains an ordered list of items which appear in the vanilla creative inventory with Education Edition and Experimental Gameplay enabled. -### `biome_definitions.nbt` +### biome_definitions.nbt This file contains a network-format NBT blob containing biome definitions obtained from `BiomeDefinitionListPacket`. -### `entity_identifiers.nbt` +### entity_identifiers.nbt This file contains a network-format NBT blob containing entity identifier mappings obtained from `AvailableActorIdentifiersPacket`.