Bedrock Edition level format - Revision history

imported>LPT4: /* Key derivation */ imgur example was in big endian

2024-02-03T13:03:26Z

Key derivation: imgur example was in big endian

← Older revision		Revision as of 13:03, 3 February 2024
Line 21:		Line 21:
	* Write a 8-bit integer (Key Type) specifying the type of data being stored (see below)		* Write a 8-bit integer (Key Type) specifying the type of data being stored (see below)
	* If writing data at a specific SubChunk, write the subchunk index as in i8 else continue		* If writing data at a specific SubChunk, write the subchunk index as in i8 else continue

	~~[https://i.imgur.com/5ljYxry.png Example]~~


Line 28:		Line 26:

	<span id="key-type"></span>		<span id="key-type"></span>

	=== Key Type ===		=== Key Type ===

imported>Extremeheat: fix typo

2022-10-03T06:22:23Z

fix typo

← Older revision		Revision as of 06:22, 3 October 2022
Line 127:		Line 127:
	=== Scenario 3 (1.18 format+) ===		=== Scenario 3 (1.18 format+) ===

	If '''LevelChunk''' packet sent by server ~~contains~~ full chunk data (SubChunkCount == -1)…		If '''LevelChunk''' packet sent by server doesn't contain full chunk data (SubChunkCount == -1)…

	The '''Payload''' section contains the following concatenated data:		The '''Payload''' section contains the following concatenated data:

imported>SamuelLipoff: /* SubChunk serialization */ spelling correction

2022-04-23T00:52:39Z

SubChunk serialization: spelling correction

← Older revision		Revision as of 00:52, 23 April 2022
Line 53:		Line 53:
	== SubChunk serialization ==		== SubChunk serialization ==

	A SubChunk is a 16x16x16 subsection of a chunk column. Block and biome data is stored by SubChunks. As of 1.18, SubChunks range from Y=-4 to Y=20. A SubChunk’s payload is encoded as follows:		A SubChunk is a 16x16x16 subsection of a chunk column. Block and biome data is stored by SubChunks. As of 1.18, SubChunks range from Y=-64 to Y=320. A SubChunk’s payload is encoded as follows:

	[https://user-images.githubusercontent.com/13713600/148380033-6223ac76-54b7-472c-a355-5923b87cb7c5.png Infographic]		[https://user-images.githubusercontent.com/13713600/148380033-6223ac76-54b7-472c-a355-5923b87cb7c5.png Infographic]
Line 73:		Line 73:

	<span id="network"></span>		<span id="network"></span>

	== Network serialization ==		== Network serialization ==

imported>Extremeheat at 13:55, 6 January 2022

2022-01-06T13:55:08Z

← Older revision		Revision as of 13:55, 6 January 2022
Line 22:		Line 22:
	* If writing data at a specific SubChunk, write the subchunk index as in i8 else continue		* If writing data at a specific SubChunk, write the subchunk index as in i8 else continue

	[https://i.imgur.com/5ljYxry.png]		[https://i.imgur.com/5ljYxry.png Example]


Line 55:		Line 55:
	A SubChunk is a 16x16x16 subsection of a chunk column. Block and biome data is stored by SubChunks. As of 1.18, SubChunks range from Y=-4 to Y=20. A SubChunk’s payload is encoded as follows:		A SubChunk is a 16x16x16 subsection of a chunk column. Block and biome data is stored by SubChunks. As of 1.18, SubChunks range from Y=-4 to Y=20. A SubChunk’s payload is encoded as follows:

	[https://user-images.githubusercontent.com/13713600/148380033-6223ac76-54b7-472c-a355-5923b87cb7c5.png]		[https://user-images.githubusercontent.com/13713600/148380033-6223ac76-54b7-472c-a355-5923b87cb7c5.png Infographic]

	<span id="palette"></span>		<span id="palette"></span>
Line 116:		Line 116:
	If '''LevelChunk''' packet sent by server contains full chunk data ('''SubChunkCount''' != -1)…		If '''LevelChunk''' packet sent by server contains full chunk data ('''SubChunkCount''' != -1)…

	The '''Payload''' section contains the following concatenated data: * '''Border blocks''', Varint of length + that many sequential Border Blocks. Only used on Education Edition, length of 0 written otherwise. * '''Block entities''', written as a sequential set of NBT tags, read until EOF		The '''Payload''' section contains the following concatenated data:

			* '''Border blocks''', Varint of length + that many sequential Border Blocks. Only used on Education Edition, length of 0 written otherwise.
			* '''Block entities''', written as a sequential set of NBT tags, read until EOF

	<span id="scenario-3-1.18"></span>		<span id="scenario-3-1.18"></span>

imported>Extremeheat: /* Network serialization */ formatting

2022-01-06T13:52:37Z

Network serialization: formatting

← Older revision		Revision as of 13:52, 6 January 2022
Line 82:		Line 82:
	* Server ➡️ Client – Send '''Network Chunk Publisher Update''' packet to specify the origin point for the client to start requesting chunks from		* Server ➡️ Client – Send '''Network Chunk Publisher Update''' packet to specify the origin point for the client to start requesting chunks from

	The LevelChunk packet’s sent by the server can either: * Contain a full payload including that includes terrain, biome and height map data for the column, OR * Contain blob hashes with data which correlate to the above if client supports caching, OR * Have a SubChunkCount set to -1, if so: * Payload contains ONLY biome data, OR * Payload contains blob hashes which have biome data if the client supports caching		The LevelChunk packet’s sent by the server can either:

	If the payload only contains biome data, the client will have to continually poll for the information from the server via Subchunk Request packets.		* Contain a full payload including that includes terrain, biome and height map data for the column, OR
			* Contain blob hashes with data which correlate to the above if client supports caching, OR
			* Have a SubChunkCount set to -1, if so:
			** Payload contains ONLY biome data, OR
			** Payload contains blob hashes which have biome data if the client supports caching

			If the payload only contains biome data, the client will have to continually poll for the information from the server via '''Subchunk Request''' packets.

	<span id="caching"></span>		<span id="caching"></span>

imported>Extremeheat: Create page for bedrock level format

2022-01-06T12:42:43Z

Create page for bedrock level format

New page

== Overview ==

* Chunk block and biome data in Bedrock Edition is stored in sub-chunks, grouped under one Chunk Column similar to Java Edition
* Chunk data is only saved to disk by the server if it has changed since chunk generation
* Block data is stored across 4-dimensions: x, y, z and storage layer. Currently, only two block layers are utilized by the vanilla game. Layer 0 stores normal terrain, and layer 1 stores liquid and snow data.
* This is unlike Java Edition, where blocks typically have “waterlogged” or “snowy” block state properties.


== Disk serialization ==

Minecraft Bedrock Edition stores world data in LevelDB databases. The Mojang LevelDB code can be found [https://github.com/Mojang/leveldb-mcpe here], it is forked from Google’s repo with the addition of Zlib compressors, which are used in Minecraft. Depending on the version of the data, the database could be saved with either raw DEFLATE or GZIP encoding.


=== Key derivation ===

The keys inside the database are of variable length. Keys relating to locational chunk data, such as chunk column blocks, entities, block entities and biomes have their keys serialized under the following rules:

* Write the X and Z coordinates as 32-bit signed little endian integers
* If non-overworld data, write a LE i32 for the dimension (1 for Nether, 2 for End) else continue
* Write a 8-bit integer (Key Type) specifying the type of data being stored (see below)
* If writing data at a specific SubChunk, write the subchunk index as in i8 else continue

[https://i.imgur.com/5ljYxry.png]

Some other keys, those that to not correspond to 3D locational data, such as information about players or villagers may be stored in text-encoded keys. See the [https://minecraft.fandom.com/wiki/Bedrock_Edition_level_format Minecraft Wiki for more information].


=== Key Type ===

Some known key tag types are below:

<syntaxhighlight lang="ts">enum Tag {
Data3D = 43, // 0x2b (+)
VersionNew = 44, // 0x2c (,)
Data2D = 45, // 0x2d (-), height map + biomes
Data2DLegacy = 46, // 0x2e (.)
SubChunkTerrain = 47, // 0x2f (/)
LegacyTerrain = 48, // 0x30 (0)
BlockEntity = 49,
Entity = 50,
PendingTicks = 51,
BlockExtraData = 52,
BiomeState = 53,
FinalizedState = 54,
BorderBlocks = 56, // Education Edition Feature
HardCodedSpawnAreas = 57,
Checksums = 59, // 0x3b (;)
VersionOld = 118 // 0x76 (v)
}</syntaxhighlight>

== SubChunk serialization ==

A SubChunk is a 16x16x16 subsection of a chunk column. Block and biome data is stored by SubChunks. As of 1.18, SubChunks range from Y=-4 to Y=20. A SubChunk’s payload is encoded as follows:

[https://user-images.githubusercontent.com/13713600/148380033-6223ac76-54b7-472c-a355-5923b87cb7c5.png]



=== Palette ===

If the subchunk is serialized for disk (Persistence) then the palette size is written as a LE i32, followed by that many NBT tags, which can look like:

<syntaxhighlight lang="js"> // Root compound tag, empty string name
'': Compound({
name: String('minecraft:bedrock'),
states: Compound({
infiniburn_bit: Byte(0)
})
})</syntaxhighlight>
If the subchunk is serialized over the network (Runtime) then the pelette size is a varint, followed by that many varints which are indexes to the global block palette.


== Network serialization ==


=== Chunk Fetching Procedure ===

* Client ➡️ Server – Send '''Client Cache Status''' packet to inform server if client supports caching
* Server ➡️ Client – Send preliminary '''Level Chunk''' packets close to the player
* Server ➡️ Client – Send '''Network Chunk Publisher Update''' packet to specify the origin point for the client to start requesting chunks from

The LevelChunk packet’s sent by the server can either: * Contain a full payload including that includes terrain, biome and height map data for the column, OR * Contain blob hashes with data which correlate to the above if client supports caching, OR * Have a SubChunkCount set to -1, if so: * Payload contains ONLY biome data, OR * Payload contains blob hashes which have biome data if the client supports caching

If the payload only contains biome data, the client will have to continually poll for the information from the server via Subchunk Request packets.


==== Caching ====

* If blob hashes are sent by the server, then the client must look up the blob hash from its Blob Store and see if the relevant hash exists in the store. The client should inform the server of chunks it has (HIT) and does not have (MISS) in '''Client Cache Blob Status''' packet to the server.
* If a hash is missing, the client must send a '''Chunk Cache Miss Packet''' and request the missing data, then cache it in the blob store. The server will respond with the '''Chunk Cache Miss Response''' packet.


=== Scenario 1 (pre-1.18 format) ===

If '''LevelChunk''' packet sent by server contains full chunk data ( '''SubChunkCount''' != -1)…

The '''Payload''' section contains the following concatenated data:

* '''Sub-chunk buffers''', amount based on LevelChunk’s SubChunkCount field.
* '''Heightmap data''', 512-byte height map data
* '''Biome buffer data''', 256-byte 2D biome data
* '''Border blocks''', Varint of length + that many sequential Border Blocks. Only used on Education Edition, length of 0 written otherwise.
* '''Block entities''', written as a sequential set of NBT tags, read until EOF


=== Scenario 2 (pre-1.18 format, with caching enabled) ===

If '''LevelChunk''' packet sent by server contains full chunk data ('''SubChunkCount''' != -1)…

The '''Payload''' section contains the following concatenated data: * '''Border blocks''', Varint of length + that many sequential Border Blocks. Only used on Education Edition, length of 0 written otherwise. * '''Block entities''', written as a sequential set of NBT tags, read until EOF




=== Scenario 3 (1.18 format+) ===

If '''LevelChunk''' packet sent by server contains full chunk data (SubChunkCount == -1)…

The '''Payload''' section contains the following concatenated data:

* '''Border blocks''', Varint of length + that many sequential Border Blocks. Only used on Education Edition, length of 0 written otherwise.
* '''Block entities''', written as a sequential set of NBT tags, read until EOF

After the client has received LevelChunk, it may send '''SubChunkRequest''' packets for terrain data in that chunk. The '''SubChunk''' response packet will contain height map data (if it exists for the chunk section) and a data section that contains block and biome data.