Pre-release protocol
This page documents the changes from the last stable Minecraft release (currently 1.16.5, protocol 754) to the current pre-release (currently 21w05a, protocol Snapshot 12). Note that this page contains bleeding-edge information that may not be completely or correctly documented.
One who wishes to commandeer the merging of this into Protocol when an update is made must be sure to respect any changes that may have occurred to the respective packets there.
Contents
Data types
No changes so far.
Packets
ID | Packet name | Documentation | |
---|---|---|---|
Play clientbound | |||
0x05 | Sculk Vibration Signal | Pre | |
Entity Animation (clientbound) | Current | (unchanged) | |
Statistics | Current | (unchanged) | |
Acknowledge Player Digging | Current | (unchanged) | |
Block Break Animation | Current | (unchanged) | |
Block Entity Data | Current | (unchanged) | |
Block Action | Current | (unchanged) | |
Block Change | Current | (unchanged) | |
Boss Bar | Current | (unchanged) | |
Server Difficulty | Current | (unchanged) | |
Chat Message (clientbound) | Current | (unchanged) | |
Tab-Complete (clientbound) | Current | (unchanged) | |
Declare Commands | Current | (unchanged) | |
Window Confirmation (clientbound) | Current | (unchanged) | |
Close Window (clientbound) | Current | (unchanged) | |
Window Items | Current | (unchanged) | |
Window Property | Current | (unchanged) | |
Set Slot | Current | (unchanged) | |
Set Cooldown | Current | (unchanged) | |
Plugin Message (clientbound) | Current | (unchanged) | |
Named Sound Effect | Current | (unchanged) | |
Disconnect (play) | Current | (unchanged) | |
Entity Status | Current | (unchanged) | |
Explosion | Current | (unchanged) | |
Unload Chunk | Current | (unchanged) | |
Change Game State | Current | (unchanged) | |
Open Horse Window | Current | (unchanged) | |
Keep Alive (clientbound) | Current | (unchanged) | |
Chunk Data | Current | Pre | |
Effect | Current | (unchanged) | |
Particle | Current | (unchanged) | |
Update Light | Current | Pre | |
Join Game | Current | (unchanged) | |
Map Data | Current | Pre | |
Trade List | Current | (unchanged) | |
Entity Position | Current | (unchanged) | |
Entity Position and Rotation | Current | (unchanged) | |
Entity Rotation | Current | (unchanged) | |
Entity Movement | Current | (unchanged) | |
Vehicle Move (clientbound) | Current | (unchanged) | |
Open Book | Current | (unchanged) | |
Open Window | Current | (unchanged) | |
Open Sign Editor | Current | (unchanged) | |
Craft Recipe Response | Current | (unchanged) | |
Player Abilities (clientbound) | Current | (unchanged) | |
Combat Event | Current | (unchanged) | |
Player Info | Current | (unchanged) | |
Face Player | Current | (unchanged) | |
Player Position And Look (clientbound) | Current | Pre | |
Unlock Recipes | Current | (unchanged) | |
Destroy Entities | Current | (unchanged) | |
Remove Entity Effect | Current | (unchanged) | |
Resource Pack Send | Current | Pre | |
Respawn | Current | (unchanged) | |
Entity Head Look | Current | (unchanged) | |
Multi Block Change | Current | (unchanged) | |
Select Advancement Tab | Current | (unchanged) | |
World Border | Current | (unchanged) | |
Camera | Current | (unchanged) | |
Held Item Change (clientbound) | Current | (unchanged) | |
Update View Position | Current | (unchanged) | |
Update View Distance | Current | (unchanged) | |
Spawn Position | Current | (unchanged) | |
Display Scoreboard | Current | (unchanged) | |
Entity Metadata | Current | (unchanged) | |
Attach Entity | Current | (unchanged) | |
Entity Velocity | Current | (unchanged) | |
Entity Equipment | Current | (unchanged) | |
Set Experience | Current | (unchanged) | |
Update Health | Current | (unchanged) | |
Scoreboard Objective | Current | (unchanged) | |
Set Passengers | Current | (unchanged) | |
Teams | Current | (unchanged) | |
Update Score | Current | (unchanged) | |
Time Update | Current | (unchanged) | |
Title | Current | (unchanged) | |
Entity Sound Effect | Current | (unchanged) | |
Sound Effect | Current | (unchanged) | |
Stop Sound | Current | (unchanged) | |
Player List Header And Footer | Current | (unchanged) | |
NBT Query Response | Current | (unchanged) | |
Collect Item | Current | (unchanged) | |
Entity Teleport | Current | (unchanged) | |
Advancements | Current | (unchanged) | |
Entity Properties | Current | (unchanged) | |
Entity Effect | Current | (unchanged) | |
Declare Recipes | Current | (unchanged) | |
Tags | Current | Pre | |
Handshaking serverbound | |||
0x00 | Handshake | Current | Pre |
New/modified data types
No changes so far.
Entity Metadata
Entity
The base class.
Index | Type | Meaning | Default | |
---|---|---|---|---|
0 | Byte | Bit mask | Meaning | 0 |
0x01 | Is on fire | |||
0x02 | Is crouching | |||
0x04 | Unused (previously riding) | |||
0x08 | Is sprinting | |||
0x10 | Is swimming | |||
0x20 | Is invisible | |||
0x40 | has glowing effect | |||
0x80 | Is flying with an elytra | |||
1 | VarInt | Air ticks | 300 | |
2 | OptChat | Custom name | empty | |
3 | Boolean | Is custom name visible | false | |
4 | Boolean | Is silent | false | |
5 | Boolean | Has no gravity | false | |
6 | Pose | Pose | STANDING | |
7 | VarInt | Ticks frozen in powdered snow | 0 |
Block Actions
No changes so far.
Inventories
No changes so far.
Plugin Channels
No changes so far.
Play
Clientbound
Sculk Vibration Signal
Packet ID | State | Bound To | Field Name | Field Type | Notes |
---|---|---|---|---|---|
0x05 | Play | Client | Source Position | Position | Source position for the vibration |
Destination Identifier | Identifier | Identifier of the destination codec type | |||
Destination | Varies | Vanilla default destinations are a block position encoded as a long for "block" or an entity id encoded as a VarInt for "entity" | |||
Arrival Ticks | VarInt | Ticks for the signal to arrive at the destination |
This packet shows a permanent particle
Chunk Data
- Main article: Chunk Format
- See also: #Unload Chunk
The following information needs to be added to this page: | |
How do biomes work now? The biome change happened at the same time as the seed change, but it's not clear how/if biomes could be computed given that it's not the actual seed... (/r/mojira discussion which notes that it seems to be some kind of interpolation, and 3D biomes are only used in the nether) |
The server only sends skylight information for chunk pillars in the Overworld, it's up to the client to know in which dimension the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent. This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with Update Block Entity later).
Packet ID | State | Bound To | Field Name | Field Type | Notes |
---|---|---|---|---|---|
Play | Client | Chunk X | Int | Chunk coordinate (block coordinate divided by 16, rounded down) | |
Chunk Z | Int | Chunk coordinate (block coordinate divided by 16, rounded down) | |||
Full chunk | Boolean | See Chunk Format | |||
Primary Bit Mask | VarInt | Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15). | |||
Bit Mask Length | VarInt | Length of the following array | |||
Primary Bit Mask | Array of Long | BitSet with bits (world height in blocks / 16) set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from the lowest y to 15 blocks above). | |||
Heightmaps | NBT | Compound containing one long array named MOTION_BLOCKING , which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry totaling 36 longs). The Notchian server also adds a WORLD_SURFACE long array, the purpose of which is unknown, but it's not required for the chunk to be accepted.
| |||
Biomes length | VarInt | Size of the following array. | |||
Biomes | Array of VarInt | ||||
Size | VarInt | Size of Data in bytes | |||
Data | Byte array | See data structure in Chunk Format | |||
Number of block entities | VarInt | Number of elements in the following array | |||
Block entities | Array of NBT Tag | All block entities in the chunk. Use the x, y, and z tags in the NBT to determine their positions. |
Note that the Notchian client requires an Update View Position packet when it crosses a chunk border, otherwise it'll only display render distance + 2 chunks around the chunk it spawned in.
The compacted array format has been adjusted so that individual entries no longer span across multiple longs, affecting the main data array and heightmaps.
New format, 5 bits per block, containing the following references to blocks in a palette (not shown): 122344566480743131516914101202
0020863148418841
0000000000100000100001100011000101001000010000011000100001000001
01018A7260F68C87
0000000100000001100010100111001001100000111101101000110010000111
Update Light
Updates light levels for a chunk.
Packet ID | State | Bound To | Field Name | Field Type | Notes | ||
---|---|---|---|---|---|---|---|
Play | Client | Chunk X | VarInt | Chunk coordinate (block coordinate divided by 16, rounded down) | |||
Chunk Z | VarInt | Chunk coordinate (block coordinate divided by 16, rounded down) | |||||
Trust Edges | Boolean | If edges should be trusted for light updates. | |||||
Sky Light Mask | VarInt | Mask containing 18 bits, with the lowest bit corresponding to chunk section -1 (in the void, y=-16 to y=-1) and the highest bit for chunk section 16 (above the world, y=256 to y=271) | |||||
Block Light Mask | VarInt | Mask containing 18 bits, with the same order as sky light | |||||
Empty Sky Light Mask | VarInt | Mask containing 18 bits, which indicates sections that have 0 for all their sky light values. If a section is set in both this mask and the main sky light mask, it is ignored for this mask and it is included in the sky light arrays (the notchian server does not create such masks). If it is only set in this mask, it is not included in the sky light arrays. | |||||
Empty Block Light Mask | VarInt | Mask containing 18 bits, which indicates sections that have 0 for all their block light values. If a section is set in both this mask and the main block light mask, it is ignored for this mask and it is included in the block light arrays (the notchian server does not create such masks). If it is only set in this mask, it is not included in the block light arrays. | |||||
Length 1 | VarInt | Length of the following array | |||||
Sky Light Mask | Array of Long | BitSet containing bits for each sections in the world + 2 (lowest bit 16-1 blocks below min world height, highest 1-16 above max world height) | |||||
Length 2 | VarInt | Length of the following array | |||||
Block Light Mask | Array of Long | BitSet containing bits for each sections in the world + 2, same order as sky light | |||||
Length 3 | VarInt | Length of the following array | |||||
Empty Sky Light Mask | Array of Long | BitSet containing a variable amount of bits (see sky/block light) which indicates sections that have 0 for all their sky light values | |||||
Length 4 | VarInt | Length of the following array | |||||
Empty Block Light Mask | Array of Long | BitSet containing a variable amount of bits (see sky/block light) which indicates sections that have 0 for all their block light values | |||||
Sky Light array count | VarInt | Number of entries in the following array | |||||
Sky Light arrays | Length | Array | VarInt | Length of the following array in bytes (always 2048) | |||
Sky Light array | Array of 2048 bytes | There is 1 array for each bit set to true in the sky light mask, starting with the lowest value. Half a byte per light value. | |||||
Block Light array count | VarInt | Number of entries in the following array | |||||
Block Light arrays | Length | Array | VarInt | Length of the following array in bytes (always 2048) | |||
Block Light array | Array of 2048 bytes | There is 1 array for each bit set to true in the block light mask, starting with the lowest value. Half a byte per light value. |
Map Data
Updates a rectangular area on a map item.
Packet ID | State | Bound To | Field Name | Field Type | Notes | ||
---|---|---|---|---|---|---|---|
Play | Client | Map ID | VarInt | Map ID of the map being modified | |||
Scale | Byte | From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel) | |||||
Tracking Position | Boolean | Specifies whether player and item frame icons are shown | |||||
Locked | Boolean | True if the map has been locked in a cartography table | |||||
Tracking Position | Boolean | Specifies whether player and item frame icons are shown | |||||
Icon Count | VarInt | Number of elements in the following array. Only present if "Tracking Position" is true. | |||||
Icon | Type | Array | VarInt enum | See below | |||
X | Byte | Map coordinates: -128 for furthest left, +127 for furthest right | |||||
Z | Byte | Map coordinates: -128 for highest, +127 for lowest | |||||
Direction | Byte | 0-15 | |||||
Has Display Name | Boolean | ||||||
Display Name | Optional Chat | Only present if previous Boolean is true | |||||
Columns | Unsigned Byte | Number of columns updated | |||||
Rows | Optional Byte | Only if Columns is more than 0; number of rows updated | |||||
X | Optional Byte | Only if Columns is more than 0; x offset of the westernmost column | |||||
Z | Optional Byte | Only if Columns is more than 0; z offset of the northernmost row | |||||
Length | Optional VarInt | Only if Columns is more than 0; length of the following array | |||||
Data | Optional Array of Unsigned Byte | Only if Columns is more than 0; see Map item format |
For icons, a direction of 0 is a vertical icon and increments by 22.5° (360/16).
Types are based off of rows and columns in map_icons.png
:
Icon type | Result |
---|---|
0 | White arrow (players) |
1 | Green arrow (item frames) |
2 | Red arrow |
3 | Blue arrow |
4 | White cross |
5 | Red pointer |
6 | White circle (off-map players) |
7 | Small white circle (far-off-map players) |
8 | Mansion |
9 | Temple |
10 | White Banner |
11 | Orange Banner |
12 | Magenta Banner |
13 | Light Blue Banner |
14 | Yellow Banner |
15 | Lime Banner |
16 | Pink Banner |
17 | Gray Banner |
18 | Light Gray Banner |
19 | Cyan Banner |
20 | Purple Banner |
21 | Blue Banner |
22 | Brown Banner |
23 | Green Banner |
24 | Red Banner |
25 | Black Banner |
26 | Treasure marker |
Player Position And Look (clientbound)
Updates the player's position on the server. This packet will also close the “Downloading Terrain” screen when joining/respawning.
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 meters, the client will be kicked for “You moved too quickly :( (Hacking?)”.
Also if the fixed-point number of X or Z is set greater than 3.2E7D
the client will be kicked for “Illegal position”.
Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0, -1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
Packet ID | State | Bound To | Field Name | Field Type | Notes |
---|---|---|---|---|---|
Play | Client | X | Double | Absolute or relative position, depending on Flags. | |
Y | Double | Absolute or relative position, depending on Flags. | |||
Z | Double | Absolute or relative position, depending on Flags. | |||
Yaw | Float | Absolute or relative rotation on the X axis, in degrees. | |||
Pitch | Float | Absolute or relative rotation on the Y axis, in degrees. | |||
Flags | Byte | Bit field, see below. | |||
Teleport ID | VarInt | Client should confirm this packet with Teleport Confirm containing the same Teleport ID. | |||
Dismount Vehicle | Boolean | True if the player should dismount their vehicle. |
About the Flags field:
<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
Field | Bit |
---|---|
X | 0x01 |
Y | 0x02 |
Z | 0x04 |
Y_ROT | 0x08 |
X_ROT | 0x10 |
Resource Pack Send
Packet ID | State | Bound To | Field Name | Field Type | Notes |
---|---|---|---|---|---|
Play | Client | URL | String (32767) | The URL to the resource pack. | |
Hash | String (40) | A 40 character hexadecimal and lowercase SHA-1 hash of the resource pack file. (must be lower case in order to work) If it's not a 40 character hexadecimal string, the client will not use it for hash verification and likely waste bandwidth — but it will still treat it as a unique id | |||
Forced | Boolean | The notchian client will be forced to use the resource pack from the server. If they decline they will be kicked from the server. |
Tags
Packet ID | State | Bound To | Field Name | Field Type | Notes | ||
---|---|---|---|---|---|---|---|
Play | Client | ||||||
Block Tags | (See below) | IDs are block IDs | |||||
Item Tags | (See below) | IDs are item IDs | |||||
Fluid Tags | (See below) | IDs are fluid IDs | |||||
Entity Tags | (See below) | IDs are entity IDs | |||||
Length of the array | VarInt | ||||||
Array of tags | Tag type | Array | Identifier | Tag identifier (Vanilla required tags are minecraft:block , minecraft:item , minecraft:fluid , minecraft:entity_type , and minecraft:game_event )
| |||
Array of Tag | (See below) |
Tags look like:
Field Name | Field Type | Notes | ||
---|---|---|---|---|
Length | VarInt | Number of elements in the following array | ||
Tags | Tag name | Array | Identifier | |
Count | VarInt | Number of elements in the following array | ||
Entries | Array of VarInt | Numeric ID of the given type (block, item, etc.). |
Serverbound
No changes so far.
Handshaking
Clientbound
There are no clientbound packets in the Handshaking state, since the protocol immediately switches to a different state after the client sends the first packet.
Serverbound
Handshake
This causes the server to switch into the target state.
Packet ID | State | Bound To | Field Name | Field Type | Notes |
---|---|---|---|---|---|
0x00 | Handshaking | Server | Protocol Version | VarInt | See protocol version numbers (currently |
Server Address | String | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it. | |||
Server Port | Unsigned Short | Default is 25565. The Notchian server does not use this information. | |||
Next State | VarInt Enum | 1 for status, 2 for login |
Status
Clientbound
No changes so far.
Serverbound
No changes so far.
Login
Clientbound
No changes so far.
Serverbound
No changes so far.