1
0
mirror of https://github.com/pmmp/BedrockData.git synced 2024-07-02 12:54:21 -03:00

Update README.md

This commit is contained in:
Dylan T 2020-12-23 20:43:52 +00:00 committed by GitHub
parent 4e58a3c67d
commit 471704c1d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,9 +1,10 @@
# BedrockData
Blobs of data generated from Minecraft: Bedrock Edition used by PocketMine-MP
### 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.
### canonical_block_states.nbt
This file contains an ordered list of `TAG_Compound`s (in varint NBT format) representing the pre-agreed blockstates in MCPE.
The runtime ID of a state is the offset in the list that the state appears.
The contents of this file are extracted from the vanilla BDS using [`pmmp/mapping`](https://github.com/pmmp/mapping).
### 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).
@ -26,6 +27,12 @@ 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).
### r16_to_current_block_map.json
This file contains mappings to translate pre-1.16.100 item IDs into post-1.16.100 item IDs.
It contains two structures:
- `simple`: these are 1:1 replacement IDs (e.g. `carrotonastick` was renamed to `carrot_on_a_stick`)
- `complex`: these are items that were previously metadata values on other items (e.g. `dye:4` is now represented by `lapis_lazuli`).
### item_id_map.json
This file contains a mapping of all item stringy IDs to legacy numeric IDs.