Pre-release protocol
This page documents the changes from the last stable Minecraft release (currently 1.11.2, protocol 316) to the current pre-release (currently 17w13b, protocol 319). 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 | |
---|---|---|---|
Handshaking serverbound | |||
0x00 | Handshake | Current | Pre |
Play clientbound | |||
0x08 | Advancements | Pre | |
Block Break Animation | Current | (unchanged) | |
Update Block Entity | Current | (unchanged) | |
Block Action | Current | (unchanged) | |
Block Change | Current | (unchanged) | |
Boss Bar | Current | (unchanged) | |
Server Difficulty | Current | (unchanged) | |
Tab-Complete (clientbound) | Current | (unchanged) | |
Chat Message (clientbound) | Current | (unchanged) | |
Multi Block Change | Current | (unchanged) | |
Confirm Transation (clientbound) | Current | (unchanged) | |
Close Window (clientbound) | Current | (unchanged) | |
Open Window | 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) | |
Keep Alive (clientbound) | Current | (unchanged) | |
Chunk Data | Current | (unchanged) | |
Effect | Current | (unchanged) | |
Particle | Current | (unchanged) | |
Join Game | Current | (unchanged) | |
Particle | Current | (unchanged) | |
Entity Relative Move | Current | (unchanged) | |
Entity Look And Relative Move | Current | (unchanged) | |
Entity Look | Current | (unchanged) | |
Entity | Current | (unchanged) | |
Vehicle Move (clientbound) | Current | (unchanged) | |
Open Sign Editor | Current | (unchanged) | |
Player Abilities (clientbound) | Current | (unchanged) | |
Combat Event | Current | (unchanged) | |
Player List Item | Current | (unchanged) | |
Player Position And Look (clientbound) | Current | (unchanged) | |
Use Bed | Current | (unchanged) | |
0x31 | Unlock Recipes | Pre | |
Destroy Entities | Current | (unchanged) | |
Remove Entity Effect | Current | (unchanged) | |
Resource Pack Send | Current | (unchanged) | |
Respawn | Current | (unchanged) | |
Entity Head Look | Current | (unchanged) | |
World Border | Current | (unchanged) | |
Camera | Current | (unchanged) | |
Held Item Change (clientbound) | 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) | |
Spawn Position | Current | (unchanged) | |
Time Update | Current | (unchanged) | |
Title | Current | (unchanged) | |
Sound Effect | Current | (unchanged) | |
Player List Header And Footer | Current | (unchanged) | |
Collect Item | Current | (unchanged) | |
Entity Teleport | Current | (unchanged) | |
Entity Properties | Current | (unchanged) | |
Entity Effect | Current | (unchanged) | |
Play serverbound | |||
0x01 | Unknown | Pre | |
Tab-Complete (serverbound) | Current | (unchanged) | |
Chat Message (serverbound) | Current | (unchanged) | |
Client Status | Current | (unchanged) | |
Client Settings | Current | (unchanged) | |
Confirm Transaction (serverbound) | Current | (unchanged) | |
Enchant Item | Current | (unchanged) | |
Click Window | Current | (unchanged) | |
Close Window (serverbound) | Current | (unchanged) | |
Plugin Message (serverbound) | Current | (unchanged) | |
Use Entity | Current | (unchanged) | |
Keep Alive (serverbound) | Current | (unchanged) | |
Player Position | Current | (unchanged) | |
Player Position And Look (serverbound) | Current | (unchanged) | |
Player Look | Current | (unchanged) | |
Player | Current | (unchanged) | |
Vehicle Move (serverbound) | Current | (unchanged) | |
Steer Boat | Current | (unchanged) | |
Player Abilities (serverbound) | Current | (unchanged) | |
Player Digging | Current | (unchanged) | |
Entity Action | Current | (unchanged) | |
Steer Vehicle | Current | (unchanged) | |
0x17 | Recipe Displayed | Pre | |
Resource Pack Status | Current | (unchanged) | |
Held Item Change (serverbound) | Current | (unchanged) | |
Creative Inventory Action | Current | (unchanged) | |
Update Sign | Current | (unchanged) | |
Animation (serverbound) | Current | (unchanged) | |
Spectate | Current | (unchanged) | |
Player Block Placement | Current | (unchanged) | |
Use Item | Current | (unchanged) |
New/modified data types
Entity Metadata
Note that entity metadata is a totally distinct concept from block metadata. It is not required to send all metadata fields, or even any metadata fields, so long as the terminating entry is correctly sent.
Entity Metadata is an array of entries, each of which looks like the following:
Name | Type | Meaning |
---|---|---|
Index | Unsigned Byte | Unique index key determining the meaning of the following value, see the table below. If this is 0xff then the it is the end of the Entity Metadata array and no more is read.
|
Type | Optional Byte Enum | Only if Index is not 0xff ; the type of the index, see the table below
|
Value | Optional value of Type | Only if Index is not 0xff : the value of the metadata field
|
Value of Type field | Type of Value field | Notes |
---|---|---|
0 | Byte | |
1 | VarInt | |
2 | Float | |
3 | String | |
4 | Chat | |
5 | Slot | |
6 | Boolean | |
7 | Rotation | 3 floats: rotation on x, rotation on y, rotation on z |
8 | Position | |
9 | OptPosition (Boolean + Optional Position) | Position is present if the Boolean is set to true |
10 | Direction (VarInt) | (Down = 0, Up = 1, North = 2, South = 3, West = 4, East = 5) |
11 | OptUUID (Boolean + Optional UUID) | UUID is present if the Boolean is set to true |
12 | OptBlockID (VarInt) | 0 for absent otherwise, id << 4 | data
|
13 | NBT Tag |
Entity classes also recursively inherit fields from classes they extend.
Parrot
Extends TameableAnimal.
Index | Type | Meaning | Default | |
---|---|---|---|---|
15 | VarInt | Variant (0: red/blue, 1: blue, 2: green, 3: yellow/blue, 4: silver) | 0 |
Player
Extends Living.
Index | Type | Meaning | Default | |
---|---|---|---|---|
11 | Float | Additional Hearts | 0.0 | |
12 | VarInt | Score | 0 | |
13 | Byte | The Displayed Skin Parts bit mask that is sent in Client Settings | 0 | |
Bit mask | Meaning | |||
0x01 | Cape enabled | |||
0x02 | Jacket enabled | |||
0x04 | Left sleeve enabled | |||
0x08 | Right sleeve enabled | |||
0x10 | Left pants leg enabled | |||
0x20 | Right pants leg enabled | |||
0x40 | Hat enabled | |||
0x80 | Unused | |||
14 | Byte | Main hand (0 : Left, 1 : Right) | 1 | |
15 | NBT Tag | Left shoulder entity data | ||
16 | NBT Tag | Right shoulder entity data |
Block Actions
No changes so far.
Plugin Channels
No changes so far.
Play
Clientbound
Advancements
Packet ID | State | Bound To | Field Name | Field Type | Notes | ||
---|---|---|---|---|---|---|---|
0x08 | Play | Client | Reset/Clear | Boolean | Whether to reset/clear the current advancements | ||
Mapping size | VarInt | Size of the following array | |||||
Advancement mapping | Key | Array | Identifier | The identifier of the advancement | |||
Value | Advancement | See below | |||||
List size | VarInt | Size of the following array | |||||
Identifiers | Array of Identifier | The identifiers of the advancements that should be removed | |||||
Progress size | VarInt | Size of the following array | |||||
Progress mapping | Key | Array | Identifier | The identifier of the advancement | |||
Value | Advancement progress | See below |
Advancement structure:
Field Name | Field Type | Notes | ||
---|---|---|---|---|
Has parent | Boolean | Indicates whether the next field exists | ||
Parent id | Optional Identifier | The identifier of the parent advancement. | ||
Has display | Boolean | Indicates whether the next field exists | ||
Display data | Optional advancement display | See below. | ||
Number of criteria | VarInt | Size of the following array | ||
Criteria | Key | Array | Identifier | The identifier of the criterion |
Value | Void | There is no content written here. Perhaps this will be expanded in the future? | ||
Array length | VarInt | Number of arrays in the following array | ||
Requirements | Array length 2 | Array | VarInt | Number of elements in the following array |
Requirement | Array of String | Array of required criteria |
Advancement display:
Field Name | Field Type | Notes |
---|---|---|
Title | Chat | |
Icon | VarInt | Advancement icon item id. 0 indicates null
|
Frame type | VarInt enum | 0 = TASK, 1 = CHALLENGE |
Has background | Boolean | Indicates whether the next field exists |
Background texture | Optional Identifier | Background texture location |
X coord | VarInt | |
Y coord | INVALID (VarInt when writing, Int when reading) |
Advancement progress:
Field Name | Field Type | Notes | ||
---|---|---|---|---|
Size | VarInt | Size of the following array | ||
Criteria | Criterion identifier | Array | Identifier | The identifier of the criterion. |
Criterion progress | Criterion progress |
Criterion progress:
Field Name | Field Type | Notes |
---|---|---|
Achieved | Boolean | If true, next field is present |
Date of acheiving | Optional Long | As returned by Date.getTime
|
Unlock Recipes
Packet ID | State | Bound To | Field Name | Field Type | Notes | ||
---|---|---|---|---|---|---|---|
0x31 | Play | Client | |||||
Array size | VarInt | Number of elements in the following array | |||||
Recipes | Identifier | Array | Identifier | ||||
Is unlocked | Boolean | ||||||
Has been displayed | Boolean |
Serverbound
Unknown
Packet ID | State | Bound To | Field Name | Field Type | Notes | ||
---|---|---|---|---|---|---|---|
0x01 | Play | Server | Window ID | Byte | The window id. | ||
Action number | Short | The transaction number. Will be send to the client in a Confirm Transaction packet. | |||||
Flag | Boolean | See below | |||||
Array size | Byte | Number of elements in the following array | |||||
Entry | Item Identifier | Array | String (64) | The identifier of an item type, or empty if not present
| |||
Item Data | Short | The data value of the item, or 0 if not present | |||||
Slot A | Byte | The target slot index in the active container | |||||
Slot B | Byte | The target slot index in the player inventory |
If the flag is set to true:
- The amount if items in Slot B is descreased by one.
- A item stack created from the provided identifier and data will be put in Slot A.
Otherwise:
- The amount if items in Slot B is increased by one if not empty, otherwise will a new stack be created from the provided identifier and data.
- The item in Slot A will be cleared.
In both cases will the crafting grid be updated and a Confirm Transaction packet send back to the client, with the window id and action number send by the client.
Client Status
Sent when the client is ready to complete login and when the client is ready to respawn after death.
Packet ID | State | Bound To | Field Name | Field Type | Notes |
---|---|---|---|---|---|
0x04 | Play | Server | Action ID | VarInt Enum | See below |
Action ID values:
Action ID | Action |
---|---|
0 | Perform respawn |
1 | Request stats |
Recipe displayed
Packet ID | State | Bound To | Field Name | Field Type | Notes |
---|---|---|---|---|---|
0x17 | Play | Server | Identifier | Identifier | |
? | Int | Currently always -1 |
Handshaking
Clientbound
No changes so far.
Serverbound
No changes so far.
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. | |||
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.