Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
(→‎Login: Add info from Dinnerbone on login plugin messages)
(moar stuff)
 
(615 intermediate revisions by 45 users not shown)
Line 1: Line 1:
This page documents the changes from the [[Protocol|last stable Minecraft release]] (currently [[Protocol version numbers|1.12.2, protocol 340]]) to the current pre-release (currently [[Protocol version numbers|1.13-pre5, protocol 387]]). Note that this page contains bleeding-edge information that may not be completely or correctly documented.
+
This page documents the changes from release 1.21.1 (protocol 767) to the current release (1.21.3, protocol 768). The stable protocol documentation is currently lagging behind, and the changes documented here will be merged soon, once they are complete. The current pre-release (snapshot 24w44a) is not yet 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.
 
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.
Line 9: Line 9:
 
=== Data types ===
 
=== Data types ===
  
==== Other definitions ====
+
{| class="wikitable"
 +
|-
 +
! Name
 +
! Size (bytes)
 +
! Encodes
 +
! Notes
 +
|- {{added}}
 +
! id=Type:Teleport_Flags | {{Type|Teleport Flags}}
 +
| 4
 +
| Bit field specifying how a teleportation is to be applied on each axis.
 +
| See [[#Teleport Flags]]
 +
|}
  
===== Global palette =====
+
==== Teleport Flags ====
A table/dictionary/palette mapping nonnegative integers to block states. {{change|The block state IDs can be constructed from this table by multiplying what the Minecraft Wiki calls “block IDs” by 16 and adding the metadata/damage value (or in most programming languages block_id << 4 {{!}} metadata).|Block state IDs are created in a linear fashion based off of order of assignment.  One block state ID allocated for each unique block state for a block; if a block has multiple properties then the number of allocated states is the product of the number of values for each property.  A current list of properties and state ID ranges is found on [http://pokechu22.github.io/Burger/18w22c.html burger].}}
 
  
{{Change||Alternatively, the vanilla server now includes an option to export the current block state ID mapping, by running <code>java -cp minecraft_server.18w22c.jar net.minecraft.data.Main --reports</code> (use <code>--help</code> for a list of other options).  One can parse the generated <code>blocks.json</code> to convert known block states to and from ids.}}
+
A bit field represented as an {{Type|Int}}, specifying how a teleportation is to be applied on each axis.
  
=== Packets ===
+
In the lower 8 bits of the bit field, a set bit means the teleportation on the corresponding axis is relative, and an unset bit that it is absolute.
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID
 
! Packet name
 
!colspan="2"| Documentation
 
 
  |-
 
  |-
!colspan="4"| Handshaking serverbound
+
! Hex Mask
{{PacketList|0x00|Handshake}}
+
! Field
 
  |-
 
  |-
!colspan="4"| Play clientbound
+
| 0x0001
{{PacketList|0x04|Spawn Painting}}
+
| Relative X
{{PacketList|0x07|Statistics}}
 
{{PacketList|0x09|Update Block Entity}}
 
{{PacketList|0x0B|Block Change}}
 
{{PacketList|{{change|0x0F|0x0E}}|Chat Message (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x10|0x0F}}|Multi Block Change}}
 
{{PacketList|{{change|0x0E|0x10}}|Tab-Complete (clientbound)}}
 
{{PacketList|0x11|Declare Commands|rel=added}}
 
{{PacketList|{{change|0x11|0x12}}|Confirm Transaction (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x12|0x13}}|Close Window (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x13|0x14}}|Open Window|pre=unchanged}}
 
{{PacketList|{{change|0x14|0x15}}|Window Items|pre=unchanged}}
 
{{PacketList|{{change|0x15|0x16}}|Window Property|pre=unchanged}}
 
{{PacketList|{{change|0x16|0x17}}|Set Slot|pre=unchanged}}
 
{{PacketList|{{change|0x17|0x18}}|Set Cooldown|pre=unchanged}}
 
{{PacketList|{{change|0x18|0x19}}|Plugin Message (clientbound)}}
 
{{PacketList|{{change|0x19|0x1A}}|Named Sound Effect}}
 
{{PacketList|{{change|0x1A|0x1B}}|Disconnect (play)|pre=unchanged}}
 
{{PacketList|{{change|0x1B|0x1C}}|Entity Status|pre=unchanged}}
 
{{PacketList|{{change|0x1C|0x1D}}|Explosion|pre=unchanged}}
 
{{PacketList|{{change|0x1D|0x1E}}|Unload Chunk|pre=unchanged}}
 
{{PacketList|{{change|0x1E|0x1F}}|Change Game State|pre=unchanged}}
 
{{PacketList|{{change|0x1F|0x20}}|Keep Alive (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x20|0x21}}|Chunk Data}}
 
{{PacketList|{{change|0x21|0x22}}|Effect|pre=unchanged}}
 
{{PacketList|{{change|0x22|0x23}}|Spawn Particle}}
 
{{PacketList|{{change|0x23|0x24}}|Join Game|pre=unchanged}}
 
{{PacketList|{{change|0x24|0x25}}|Map}}
 
{{PacketList|{{change|0x25|0x26}}|Entity|pre=unchanged}}
 
{{PacketList|{{change|0x26|0x27}}|Entity Relative Move|pre=unchanged}}
 
{{PacketList|{{change|0x27|0x28}}|Entity Look And Relative Move|pre=unchanged}}
 
{{PacketList|{{change|0x28|0x29}}|Entity Look|pre=unchanged}}
 
{{PacketList|{{change|0x29|0x2A}}|Vehicle Move (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x2A|0x2B}}|Open Sign Editor|pre=unchanged}}
 
{{PacketList|{{change|0x2B|0x2C}}|Craft Recipe Response}}
 
{{PacketList|{{change|0x2C|0x2D}}|Player Abilities (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x2D|0x2E}}|Combat Event|pre=unchanged}}
 
{{PacketList|{{change|0x2E|0x2F}}|Player List Item|pre=unchanged}}
 
{{PacketList|0x30|Face Player|rel=added}}
 
{{PacketList|{{change|0x2F|0x31}}|Player Position And Look (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x30|0x32}}|Use Bed|pre=unchanged}}
 
{{PacketList|{{change|0x31|0x33}}|Unlock Recipes}}
 
{{PacketList|{{change|0x32|0x34}}|Destroy Entities|pre=unchanged}}
 
{{PacketList|{{change|0x33|0x35}}|Remove Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x34|0x36}}|Resource Pack Send|pre=unchanged}}
 
{{PacketList|{{change|0x35|0x37}}|Respawn|pre=unchanged}}
 
{{PacketList|{{change|0x36|0x38}}|Entity Head Look|pre=unchanged}}
 
{{PacketList|{{change|0x37|0x39}}|Select Advancement Tab|pre=unchanged}}
 
{{PacketList|{{change|0x38|0x3A}}|World Border|pre=unchanged}}
 
{{PacketList|{{change|0x39|0x3B}}|Camera|pre=unchanged}}
 
{{PacketList|{{change|0x3A|0x3C}}|Held Item Change (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x3B|0x3D}}|Display Scoreboard|pre=unchanged}}
 
{{PacketList|{{change|0x3C|0x3E}}|Entity Metadata|pre=unchanged}}
 
{{PacketList|{{change|0x3D|0x3F}}|Attach Entity|pre=unchanged}}
 
{{PacketList|{{change|0x3E|0x40}}|Entity Velocity|pre=unchanged}}
 
{{PacketList|{{change|0x3F|0x41}}|Entity Equipment|pre=unchanged}}
 
{{PacketList|{{change|0x40|0x42}}|Set Experience|pre=unchanged}}
 
{{PacketList|{{change|0x41|0x43}}|Update Health|pre=unchanged}}
 
{{PacketList|{{change|0x42|0x44}}|Scoreboard Objective}}
 
{{PacketList|{{change|0x43|0x45}}|Set Passengers|pre=unchanged}}
 
{{PacketList|{{change|0x44|0x46}}|Teams}}
 
{{PacketList|{{change|0x45|0x47}}|Update Score|pre=unchanged}}
 
{{PacketList|{{change|0x46|0x48}}|Spawn Position|pre=unchanged}}
 
{{PacketList|{{change|0x47|0x49}}|Time Update|pre=unchanged}}
 
{{PacketList|{{change|0x48|0x4A}}|Title|pre=unchanged}}
 
{{PacketList|0x4B|Stop Sound|rel=added}}
 
{{PacketList|{{change|0x49|0x4C}}|Sound Effect|pre=unchanged}}
 
{{PacketList|{{change|0x4A|0x4D}}|Player List Header And Footer|pre=unchanged}}
 
{{PacketList|{{change|0x4B|0x4E}}|Collect Item|pre=unchanged}}
 
{{PacketList|{{change|0x4C|0x4F}}|Entity Teleport|pre=unchanged}}
 
{{PacketList|{{change|0x4D|0x50}}|Advancements|pre=unchanged}}
 
{{PacketList|{{change|0x4E|0x51}}|Entity Properties|pre=unchanged}}
 
{{PacketList|{{change|0x4F|0x52}}|Entity Effect|pre=unchanged}}
 
{{PacketList|0x53|Declare Recipes|rel=added}}
 
{{PacketList|0x54|Tags|rel=added}}
 
 
  |-
 
  |-
!colspan="4"| Play serverbound
+
| 0x0002
{{PacketList|{{change|0x02|0x01}}|Chat Message (serverbound)|pre=unchanged}}
+
  | Relative Y
{{PacketList|{{change|0x03|0x02}}|Client Status|pre=unchanged}}
 
{{PacketList|{{change|0x04|0x03}}|Client Settings|pre=unchanged}}
 
{{PacketList|{{change|0x01|0x04}}|Tab-Complete (serverbound)}}
 
{{PacketList|0x09|Plugin message (serverbound)}}
 
{{PacketList|0x0A|Edit Book|rel=added}}
 
{{PacketList|{{change|0x0A|0x0B}}|Use Entity|pre=unchanged}}
 
{{PacketList|{{change|0x0B|0x0C}}|Keep Alive (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x0C|0x0D}}|Player|pre=unchanged}}
 
{{PacketList|{{change|0x0D|0x0E}}|Player Position|pre=unchanged}}
 
{{PacketList|{{change|0x0E|0x0F}}|Player Position And Look (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x0F|0x10}}|Player Look|pre=unchanged}}
 
{{PacketList|{{change|0x10|0x11}}|Vehicle Move (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x11|0x12}}|Steer Boat|pre=unchanged}}
 
{{PacketList|0x13|Pick Item|rel=added}}
 
{{PacketList|{{change|0x12|0x14}}|Craft Recipe Request}}
 
{{PacketList|{{change|0x13|0x15}}|Player Abilities (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x14|0x16}}|Player Digging|pre=unchanged}}
 
{{PacketList|{{change|0x15|0x17}}|Entity Action|pre=unchanged}}
 
{{PacketList|{{change|0x16|0x18}}|Steer Vehicle|pre=unchanged}}
 
{{PacketList|{{change|0x17|0x19}}|Recipe Book Data}}
 
{{PacketList|0x1A|Name Item|rel=added}}
 
{{PacketList|{{change|0x18|0x1B}}|Resource Pack Status|pre=unchanged}}
 
{{PacketList|{{change|0x19|0x1C}}|Advancement Tab|pre=unchanged}}
 
{{PacketList|0x1D|Select Trade|rel=added}}
 
{{PacketList|0x1E|Set Beacon Effect|rel=added}}
 
{{PacketList|{{change|0x1A|0x1F}}|Held Item Change (serverbound)|pre=unchanged}}
 
{{PacketList|0x20|Update Command Block|rel=added}}
 
{{PacketList|0x21|Update Command Block Minecart|rel=added}}
 
{{PacketList|{{change|0x1B|0x22}}|Creative Inventory Action|pre=unchanged}}
 
{{PacketList|0x23|Update Structure Block|rel=added}}
 
{{PacketList|{{change|0x1C|0x24}}|Update Sign|pre=unchanged}}
 
{{PacketList|{{change|0x1D|0x25}}|Animation (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x1E|0x26}}|Spectate|pre=unchanged}}
 
{{PacketList|{{change|0x1F|0x27}}|Player Block Placement|pre=unchanged}}
 
{{PacketList|{{change|0x20|0x28}}|Use Item|pre=unchanged}}
 
|-
 
!colspan="5"| Login clientbound
 
{{PacketList|0x00|Login Plugin Message (clientbound)|rel=added}}
 
{{PacketList|{{change|0x00|0x01}}|Disconnect (login)|pre=unchanged}}
 
{{PacketList|{{change|0x01|0x02}}|Encryption Request|pre=unchanged}}
 
{{PacketList|{{change|0x02|0x03}}|Login Success|pre=unchanged}}
 
{{PacketList|{{change|0x03|0x04}}|Set Compression|pre=unchanged}}
 
|-
 
!colspan="3"| Login serverbound
 
{{PacketList|0x00|Login Plugin Message (serverbound)|rel=added}}
 
{{PacketList|{{change|0x00|0x01}}|Login Start|pre=unchanged}}
 
{{PacketList|{{change|0x01|0x02}}|Encryption Response|pre=unchanged}}
 
  |}
 
 
 
== New/modified data types ==
 
 
 
=== [[Slot]] ===
 
 
 
{| class="wikitable"
 
! Name
 
! Type
 
! Meaning
 
 
  |-
 
  |-
  | {{Change|Block ID|Item ID}}
+
  | 0x0004
| Short
+
  | Relative Z
  | The {{Minecraft Wiki|Data values#Block IDs|item{{change|/block}} ID}}. A value of <code>-1</code> signifies that the slot is empty, and no further data follows. {{Change||Item IDs are now uniquely defined and are completely independent of block IDs.}}
 
 
  |-
 
  |-
  | Item Count
+
  | 0x0008
  | Optional Byte
+
  | Relative Yaw
| Not present if Block ID is <code>-1</code>.
 
|- {{Removed}}
 
| Item Damage
 
| Optional Short
 
| Not present if Block ID is <code>-1</code>.
 
 
  |-
 
  |-
  | NBT
+
  | 0x0010
  | Optional NBT
+
  | Relative Pitch
  | Not present if Block ID is <code>-1</code>. If 0, there is no NBT data, and no further data follows. Otherwise the byte is the start of an NBT blob as shown below:
+
|- {{added}}
 +
| 0x0020
 +
| Relative Velocity X
 +
|- {{added}}
 +
| 0x0040
 +
| Relative Velocity Y
 +
|- {{added}}
 +
| 0x0080
 +
| Relative Velocity Z
 +
  |- {{added}}
 +
| 0x0100
 +
| Rotate velocity according to the change in rotation, ''before'' applying the velocity change in this packet. Combining this with absolute rotation works as expected&mdash;the difference in rotation is still used.
 
  |}
 
  |}
  
=== Particle ===
+
=== Packets ===
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Field Name
+
  ! ID
  ! Field Type
+
  ! Packet name
  ! Meaning
+
  !colspan="2"| Documentation
 
  |-
 
  |-
  | ID
+
  !colspan="4"| Play clientbound
  | VarInt
+
  {{PacketList|0x12|Close Container}}
  | The ID of the particle type, see below.
+
{{PacketList|0x13|Set Container Content}}
 +
{{PacketList|0x14|Set Container Property}}
 +
{{PacketList|0x15|Set Container Slot}}
 +
{{PacketList|0x17|Set Cooldown}}
 +
{{PacketList|{{change|0x70|0x20}}|Teleport Entity}}
 +
{{PacketList|{{change|0x20|0x21}}|Explosion}}
 +
{{PacketList|{{change|0x23|0x24}}|Open Horse Screen}}
 +
{{PacketList|{{change|0x2B|0x2C}}|Login (play)}}
 +
{{PacketList|0x31|Move Minecart Along Track|rel=added}}
 +
{{PacketList|{{change|0x37|0x39}}|Place Ghost Recipe}}
 +
{{PacketList|{{change|0x3E|0x40}}|Player Info Update}}
 +
{{PacketList|{{change|0x40|0x42}}|Synchronize Player Position}}
 +
{{PacketList|0x41|Update Recipe Book|pre=removed}}
 +
{{PacketList|0x43|Player Rotation|rel=added}}
 +
{{PacketList|0x44|Recipe Book Add|rel=added}}
 +
{{PacketList|0x45|Recipe Book Remove|rel=added}}
 +
{{PacketList|0x46|Recipe Book Settings|rel=added}}
 +
{{PacketList|{{change|0x47|0x4C}}|Respawn}}
 +
{{PacketList|0x5a|Set Cursor Item|rel=added}}
 +
{{PacketList|{{change|0x53|0x63}}|Set Held Item|pre=unchanged}}
 +
{{PacketList|0x66|Set Player Inventory Slot|rel=added}}
 +
  {{PacketList|{{change|0x64|0x6b}}|Update Time}}
 +
{{PacketList|0x77|Synchronize Vehicle Position|rel=added}}
 
  |-
 
  |-
  | Data
+
  !colspan="4"| Play serverbound
  | Varies
+
  {{PacketList|0x02|Bundle Item Selected|rel=added}}
  | Varies based on the particle type, see below.
+
{{PacketList|0x0b|Client Tick End|rel=added}}
 +
{{PacketList|{{change|0x0E|0x10}}|Click Container}}
 +
{{PacketList|{{change|0x0F|0x11}}|Close Container}}
 +
{{PacketList|{{change|0x14|0x16}}|Edit Book}}
 +
{{PacketList|{{change|0x1A|0x1C}}|Set Player Position}}
 +
{{PacketList|{{change|0x1B|0x1D}}|Set Player Position and Rotation}}
 +
{{PacketList|{{change|0x1C|0x1E}}|Set Player Rotation}}
 +
  {{PacketList|0x1D|Set Player On Ground|pre=removed}}
 +
{{PacketList|0x1F|Set Player Movement Flags|rel=added}}
 +
{{PacketList|{{change|0x22|0x24}}|Place Recipe}}
 +
{{PacketList|{{change|0x26|0x28}}|Player Input}}
 +
{{PacketList|{{change|0x29|0x2B}}|Set Seen Recipe}}
 +
{{PacketList|{{change|0x38|0x3A}}|Use Item On}}
 
  |}
 
  |}
  
{| class="wikitable"
+
== Entity Metadata ==
|-
 
! Particle Name
 
! Particle ID
 
! Data
 
|-
 
| <code>minecraft:ambient_entity_effect</code>
 
| 0
 
| None
 
|-
 
| <code>minecraft:angry_villager</code>
 
| 1
 
| None
 
|-
 
| <code>minecraft:barrier</code>
 
| 2
 
| None
 
|-
 
| <code>minecraft:block</code>
 
| 3
 
|
 
{| class="wikitable"
 
  ! Field Name
 
  ! Field Type
 
  ! Meaning
 
  |-
 
  | BlockState
 
  | VarInt
 
  | The ID of the block state.
 
  |}
 
|-
 
| <code>minecraft:bubble</code>
 
| 4
 
| None
 
|-
 
| <code>minecraft:cloud</code>
 
| 5
 
| None
 
|-
 
| <code>minecraft:crit</code>
 
| 6
 
| None
 
|-
 
| <code>minecraft:damage_indicator</code>
 
| 7
 
| None
 
|-
 
| <code>minecraft:dragon_breath</code>
 
| 8
 
| None
 
|-
 
| <code>minecraft:dripping_lava</code>
 
| 9
 
| None
 
|-
 
| <code>minecraft:dripping_water</code>
 
| 10
 
| None
 
|-
 
| <code>minecraft:dust</code>
 
| 11
 
|
 
{| class="wikitable"
 
  ! Field Name
 
  ! Field Type
 
  ! Meaning
 
  |-
 
  | Red
 
  | Float
 
  | Red value, 0-1
 
  |-
 
  | Green
 
  | Float
 
  | Green value, 0-1
 
  |-
 
  | Blue
 
  | Float
 
  | Blue value, 0-1
 
  |-
 
  | Scale
 
  | Float
 
  | The scale, will be clamped between 0.01 and 4.
 
  |}
 
|-
 
| <code>minecraft:effect</code>
 
| 12
 
| None
 
|-
 
| <code>minecraft:elder_guardian</code>
 
| 13
 
| None
 
|-
 
| <code>minecraft:enchanted_hit</code>
 
| 14
 
| None
 
|-
 
| <code>minecraft:enchant</code>
 
| 15
 
| None
 
|-
 
| <code>minecraft:end_rod</code>
 
| 16
 
| None
 
|-
 
| <code>minecraft:entity_effect</code>
 
| 17
 
| None
 
|-
 
| <code>minecraft:explosion_emitter</code>
 
| 18
 
| None
 
|-
 
| <code>minecraft:explosion</code>
 
| 19
 
| None
 
|-
 
| <code>minecraft:falling_dust</code>
 
| 20
 
|
 
{| class="wikitable"
 
  ! Field Name
 
  ! Field Type
 
  ! Meaning
 
  |-
 
  | BlockState
 
  | VarInt
 
  | The ID of the block state.
 
  |}
 
|-
 
| <code>minecraft:firework</code>
 
| 21
 
| None
 
|-
 
| <code>minecraft:fishing</code>
 
| 22
 
| None
 
|-
 
| <code>minecraft:flame</code>
 
| 23
 
| None
 
|-
 
| <code>minecraft:happy_villager</code>
 
| 24
 
| None
 
|-
 
| <code>minecraft:heart</code>
 
| 25
 
| None
 
|-
 
| <code>minecraft:instant_effect</code>
 
| 26
 
| None
 
|-
 
| <code>minecraft:item</code>
 
| 27
 
|
 
{| class="wikitable"
 
  ! Field Name
 
  ! Field Type
 
  ! Meaning
 
  |-
 
  | Item
 
  | [[Slot]]
 
  | The item that will be used.
 
  |}
 
|-
 
| <code>minecraft:item_slime</code>
 
| 28
 
| None
 
|-
 
| <code>minecraft:item_snowball</code>
 
| 29
 
| None
 
|-
 
| <code>minecraft:large_smoke</code>
 
| 30
 
| None
 
|-
 
| <code>minecraft:lava</code>
 
| 31
 
| None
 
|-
 
| <code>minecraft:mycelium</code>
 
| 32
 
| None
 
|-
 
| <code>minecraft:note</code>
 
| 33
 
| None
 
|-
 
| <code>minecraft:poof</code>
 
| 34
 
| None
 
|-
 
| <code>minecraft:portal</code>
 
| 35
 
| None
 
|-
 
| <code>minecraft:rain</code>
 
| 36
 
| None
 
|-
 
| <code>minecraft:smoke</code>
 
| 37
 
| None
 
|-
 
| <code>minecraft:spit</code>
 
| 38
 
| None
 
|-
 
| <code>minecraft:squid_ink</code>
 
| 39
 
| None
 
|-
 
| <code>minecraft:sweep_attack</code>
 
| 40
 
| None
 
|-
 
| <code>minecraft:totem_of_undying</code>
 
| 41
 
| None
 
|-
 
| <code>minecraft:underwater</code>
 
| 42
 
| None
 
|-
 
| <code>minecraft:splash</code>
 
| 43
 
| None
 
|-
 
| <code>minecraft:witch</code>
 
| 44
 
| None
 
|-
 
| <code>minecraft:bubble_pop</code>
 
| 45
 
| None
 
|-
 
| <code>minecraft:current_down</code>
 
| 46
 
| None
 
|-
 
| <code>minecraft:bubble_column_up</code>
 
| 47
 
| None
 
|-
 
| <code>minecraft:nautilus</code>
 
| 48
 
| None
 
|-
 
| <code>minecraft:dolphin</code>
 
| 49
 
| None
 
|}
 
 
 
=== [[Chat]] ===
 
 
 
==== Selector component ====
 
 
 
Displays the results of an entity selector.  '''Should not be sent to clients'''; only intended for commands and client-to-server actions.  If the component contains a <code>selector</code> key, then it is a selector component.
 
  
The server resolves the list selector into a list of entities, each with an appropriate hover event, {{change|and joined with commas and "and" (but it lacks a [[wikipedia:serial comma|serial comma]])|joined with commas between each entry, without an "and"}}.
+
=== Entity Metadata Format ===
  
== Entity Metadata Format ==
+
==== Painting Variant ====
  
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.
+
{{See also|Registry Data#Painting Variant}}
 
 
Entity Metadata is an array of entries, each of which looks like the following:
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 470: Line 124:
 
  ! Meaning
 
  ! Meaning
 
  |-
 
  |-
  | Index
+
  | Width
  | Unsigned Byte
+
  | {{Type|Int}}
  | Unique index key determining the meaning of the following value, see the table below. If this is <code>0xff</code> then the it is the end of the Entity Metadata array and no more is read.
+
  | The width of the painting, in blocks.  
 
  |-
 
  |-
  | Type
+
  | Height
  | Optional Byte Enum
+
  | {{Type|Int}}
  | Only if Index is not <code>0xff</code>; the type of the index, see the table below
+
  | The height of the painting, in blocks.
 
  |-
 
  |-
  | Value
+
  | Asset ID
  | Optional ''value of Type''
+
  | {{Type|Identifier}}
  | Only if Index is not <code>0xff</code>: the value of the metadata field
+
  | The texture for the painting.
 +
The Notchian client uses the corresponding asset located at
 +
<code>textures/painting</code>.
 +
|- {{added}}
 +
| Has title
 +
| {{Type|Boolean}}
 +
|
 +
|- {{added}}
 +
| Title
 +
| {{Type|Optional}} {{Type|Text Component}}
 +
| The displayed title of the painting. Only present if Has title is true.
 +
|- {{added}}
 +
| Has author
 +
| {{Type|Boolean}}
 +
|
 +
|- {{added}}
 +
| Author
 +
| {{Type|Optional}} {{Type|Text Component}}
 +
| The displayed author of the painting. Only present if Has author is true.
 
  |}
 
  |}
  
{| class="wikitable"
+
== Registry Data ==
! Value of Type field
 
! [[Data types|Type]] of Value field
 
! Notes
 
|-
 
| 0
 
| Byte
 
|
 
|-
 
| 1
 
| VarInt
 
|
 
|-
 
| 2
 
| Float
 
|
 
|-
 
| 3
 
| String
 
|
 
|-
 
| 4
 
| [[Chat]]
 
|
 
|- {{Added}}
 
| 5
 
| OptChat (Boolean + Optional [[Chat]])
 
| [[Chat]] is present if the Boolean is set to true
 
|-
 
| {{change|5|6}}
 
| [[Slot]]
 
|
 
|-
 
| {{change|6|7}}
 
| Boolean
 
|
 
|-
 
| {{change|7|8}}
 
| Rotation
 
| 3 floats: rotation on x, rotation on y, rotation on z
 
|-
 
| {{change|8|9}}
 
| [[Data Types#Position|Position]]
 
|
 
|-
 
| {{change|9|10}}
 
| OptPosition (Boolean + Optional Position)
 
| Position is present if the Boolean is set to true
 
|-
 
| {{change|10|11}}
 
| Direction (VarInt)
 
| (Down = 0, Up = 1, North = 2, South = 3, West = 4, East = 5)
 
|-
 
| {{change|11|12}}
 
| OptUUID (Boolean + Optional UUID)
 
| UUID is present if the Boolean is set to true
 
|-
 
| {{change|12|13}}
 
| OptBlockID (VarInt)
 
| 0 for absent, otherwise index into the global palette.  (Air is treated as absent)
 
|-
 
| {{change|13|14}}
 
| [[NBT|NBT Tag]]
 
|
 
|- {{Added}}
 
| 15
 
| [[#Particle]]
 
|
 
|}
 
  
=== Entity ===
+
=== Painting Variant ===
  
The base class.
+
The <code>minecraft:painting_variant</code> registry. It defines the textures and dimensions for the game's paintings.  
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Index
+
  ! Name
 
  ! Type
 
  ! Type
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
|rowspan="9"| 0
 
|rowspan="9"| Byte
 
! Bit mask
 
 
  ! Meaning
 
  ! Meaning
  |rowspan="9"| 0
+
  ! Values
 
  |-
 
  |-
  | 0x01
+
  | asset_id
  | On Fire
+
  | [[NBT#Specification:string_tag|String Tag]]
 +
| The texture for the painting.
 +
The Notchian client uses the corresponding asset located at
 +
<code>textures/painting</code>.
 +
| Example: "minecraft:backyard".
 
  |-
 
  |-
  | 0x02
+
  | height
  | Crouched
+
  | [[NBT#Specification:int_tag|Int Tag]]
 +
| The height of the painting, in blocks.
 +
| Example: <code>2</code>
 
  |-
 
  |-
  | 0x04
+
  | width
  | Unused (previously riding)
+
  | [[NBT#Specification:int_tag|Int Tag]]
|-
+
  | The width of the painting, in blocks.
| 0x08
+
  |
| Sprinting
+
  |- {{added}}
|-
+
  | title
| 0x10
+
  | [[NBT#Specification:compound_tag|Compound Tag]] or [[NBT#Specification:string_tag|String Tag]]
| Unused (previously eating/drinking/blocking; use hand state now)
+
  | The displayed title of the painting. See [[Text formatting]].
|-
+
  | Example: <code>{"color": "gray", "translate": "painting.minecraft.skeleton.title"}</code>
| 0x20
+
  |- {{added}}
| Invisible
+
  | author
|-
+
  | [[NBT#Specification:compound_tag|Compound Tag]] or [[NBT#Specification:string_tag|String Tag]]
  | 0x40
+
  | The displayed author of the painting. See [[Text formatting]].
  | Glowing effect
+
  | Example: <code>{"color": "gray", "translate": "painting.minecraft.skeleton.author"}</code>
  |-
 
| 0x80
 
| Flying with {{Minecraft Wiki|elytra}}
 
  |-
 
  | 1
 
  | VarInt
 
  |colspan="2"| Air
 
| 300
 
  |-
 
| 2
 
| {{change|String|OptChat}}
 
  |colspan="2"| Custom name
 
  | empty
 
|-
 
| 3
 
  | Boolean
 
  |colspan="2"| Is custom name visible
 
| false
 
|-
 
| 4
 
| Boolean
 
|colspan="2"| Is silent
 
| false
 
|-
 
| 5
 
| Boolean
 
|colspan="2"| No gravity
 
| false
 
 
  |}
 
  |}
  
=== AreaEffectCloud ===
+
== Slot Data ==
  
Extends [[#Entity|Entity]].
+
=== Structured components ===
  
 
{| class="wikitable"
 
{| class="wikitable"
! Index
 
 
  ! Type
 
  ! Type
  !style="width: 250px;" colspan="2"| Meaning
+
! Name
! Default
+
! Description
 +
  ! style="width: 50%" | Data
 +
|- {{added}}
 +
| 6
 +
| <code>minecraft:item_model</code>
 +
| Item's model.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Model
 +
    | {{Type|Identifier}}
 +
    |
 +
    |}
 
  |-
 
  |-
  | 6
+
  | {{change|20|21}}
  | Float
+
| <code>minecraft:food</code>
|colspan="2"| Radius
+
| Makes the item {{change|consumable|restore the player's hunger bar when consumed}}.
  | 0.5
+
  | As follows:
 +
  {| class="wikitable"
 +
    ! colspan="2"| Name
 +
    ! colspan="2"| Type
 +
    ! Description
 +
    |-
 +
    | colspan="2"| Nutrition
 +
    | colspan="2"| {{Type|VarInt}}
 +
    | Non-negative
 +
    |-
 +
    | colspan="2"| Saturation Modifier
 +
    | colspan="2"| {{Type|Float}}
 +
    | How much saturation will be given after consuming the item.
 +
    |-
 +
    | colspan="2"| Can Always Eat
 +
    | colspan="2"| {{Type|Boolean}}
 +
    | Whether the item can always be eaten, even at full hunger.
 +
    |- {{removed}}
 +
    | colspan="2"| Seconds To Eat
 +
    | colspan="2"| {{Type|Float}}
 +
    | How long it takes to consume the item.
 +
    |- {{removed}}
 +
    | colspan="2"| Using converts to
 +
    | colspan="2"| {{Type|Slot Data}}
 +
    | This specifies the item produced after consuming the current item. In the Notchian server, this is used for stews, which turn into bowls. Set this to Air if the item should be consumed normally without leaving any other item after.
 +
    |- {{removed}}
 +
    | colspan="2"| Number of effects
 +
    | colspan="2"| {{Type|VarInt}}
 +
    | Number of elements in the following array.
 +
    |- {{removed}}
 +
    | rowspan="2"| Effect
 +
    | Type ID
 +
    | rowspan="2"| {{Type|Array}}
 +
    | [[#Potion_Effect|Potion Effect]]
 +
    | The potion effect. See [[#Potion_Effect|Potion Effect]].
 +
    |- {{removed}}
 +
    | Probability
 +
    | {{Type|Float}}
 +
    | The probability for this effect to be chosen.
 +
    |}
 +
|- {{added}}
 +
| 22
 +
| <code>minecraft:consumable</code>
 +
  | Makes the item consumable.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Consume seconds
 +
    | {{Type|Float}}
 +
    | How long it takes to consume the item.
 +
    |-
 +
    | Animation
 +
    | {{Type|VarInt}} {{Type|Enum}}
 +
    | 0: none, 1: eat, 2: drink, 3: block, 4: bow, 5: spear, 6: crossbow, 7: spyglass, 8: toot_horn, 9: brush
 +
    |-
 +
    | Sound
 +
    | {{Type|ID or}} {{Type|Sound Event}}
 +
    | ID in the <code>minecraft:sound_event</code> registry, or an inline definition.
 +
    |-
 +
    | Has consume particles
 +
    | {{Type|Boolean}}
 +
    |
 +
    |-
 +
    | Number of effects
 +
    | {{Type|VarInt}}
 +
    | Number of elements in the following array.
 +
    |-
 +
    | Effects
 +
    | {{Type|Array}} of [[#Consume Effect|Consume Effect]]
 +
    | Effects to apply on consumption. See [[#Consume Effect|Consume Effect]].
 +
    |}
 +
|- {{added}}
 +
| 23
 +
| <code>minecraft:use_remainder</code>
 +
| This specifies the item produced after using the current item. In the Notchian server, this is used for stews, which turn into bowls.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Remainder
 +
    | {{Type|Slot}}
 +
    |
 +
    |}
 +
|- {{added}}
 +
| 24
 +
| <code>minecraft:use_cooldown</code>
 +
| Cooldown to apply on use of the item.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Seconds
 +
    | {{Type|Float}}
 +
    |
 +
    |-
 +
    | Cooldown group
 +
    | {{Type|Optional}} {{Type|Identifier}}
 +
    | Group of items to apply the cooldown to. Only present if Has cooldown group is true; otherwise defaults to the item's identifier.
 +
    |}
 
  |-
 
  |-
  | 7
+
  | {{change|21|25}}
  | VarInt
+
| <code>minecraft:{{change|fire|damage}}_resistant</code>
  |colspan="2"| Color (only for mob spell particle)
+
| Marks this item as {{change|fire|damage}} resistant.<br>The client won't render the item as being on-fire if this component is present.
  | 0
+
| {{change|None.|As follows:}}
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Types
 +
    | {{Type|Identifier}}
 +
    | Tag specifying damage types the item is immune to. Not prefixed by '#'!.
 +
    |}
 +
  |- {{added}}
 +
| 27
 +
| <code>minecraft:enchantable</code>
 +
| Allows the item to be enchanted by an enchanting table.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Value
 +
    | {{Type|VarInt}}
 +
    | Opaque internal value controlling how expensive enchantments may be offered.
 +
    |}
 +
|- {{added}}
 +
| 28
 +
| <code>minecraft:equippable</code>
 +
| Allows the item to be equipped by the player.
 +
  | As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Slot
 +
    | {{Type|VarInt}} {{Type|Enum}}
 +
    | 0: mainhand, 1: feet, 2: legs, 3: chest, 4: head, 5: offhand, 6: body
 +
    |-
 +
    | Equip sound
 +
    | {{Type|ID or}} {{Type|Sound Event}}
 +
    | ID in the <code>minecraft:sound_event</code> registry, or an inline definition.
 +
    |-
 +
    | Has model
 +
    | {{Type|Boolean}}
 +
    |
 +
    |-
 +
    | Model
 +
    | {{Type|Optional}} {{Type|Identifier}}
 +
    | Only present if Has model is true.
 +
    |-
 +
    | Has camera overlay
 +
    | {{Type|Boolean}}
 +
    |
 +
    |-
 +
    | Camera overlay
 +
    | {{Type|Optional}} {{Type|Identifier}}
 +
    | Only present if Has camera overlay is true.
 +
    |-
 +
    | Has allowed entities
 +
    | {{Type|Boolean}}
 +
    |-
 +
    | Allowed entities
 +
    | {{Type|Optional}} {{Type|ID Set}}
 +
    | IDs in the <code>minecraft:entity_type</code> registry. Only present if Has allowed entities is true.
 +
    |-
 +
    | Dispensable
 +
    | {{Type|Boolean}}
 +
    |
 +
    |-
 +
    | Swappable
 +
    | {{Type|Boolean}}
 +
    |
 +
    |-
 +
    | Damage on hurt
 +
    | {{Type|Boolean}}
 +
    |
 +
    |}
 +
|- {{added}}
 +
| 29
 +
| <code>minecraft:repairable</code>
 +
| Items that can be combined with this item in an anvil to repair it.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Items
 +
    | {{Type|ID Set}}
 +
    | IDs in the <code>minecraft:item</code> registry.
 +
    |}
 +
|- {{added}}
 +
| 30
 +
| <code>minecraft:glider</code>
 +
| Makes the item function like elytra.
 +
| None.
 +
|- {{added}}
 +
| 31
 +
| <code>minecraft:tooltip_style</code>
 +
| Custom textures for the item tooltip.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Style
 +
    | {{Type|Identifier}}
 +
    |
 +
    |}
 +
  |- {{added}}
 +
| 32
 +
| <code>minecraft:death_protection</code>
 +
| Makes the item function like a totem of undying.
 +
| As follows:
 +
  {| class="wikitable" {{added}}
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Number of effects
 +
    | {{Type|VarInt}}
 +
    | Number of elements in the following array.
 +
    |-
 +
    | Effects
 +
    | {{Type|Array}} of [[#Consume Effect|Consume Effect]]
 +
    | Effects to apply on consumption. See [[#Consume Effect|Consume Effect]].
 +
    |}
 
  |-
 
  |-
  | 8
+
  | {{change|31|41}}
  | Boolean
+
| <code>minecraft:potion_contents</code>
  |colspan="2"| Ignore radius and show effect as single point, not area
+
  | Visual and effects of a potion item.
| false
+
  | As follows:
|- {{Added}}
+
  {| class="wikitable"
| 9
+
    ! Name
| Particle
+
    ! Type
| colspan="2"| The [[#Particle]]
+
    ! Description
| <code>effect</code>
+
    |-
|- {{Removed}}
+
    | Has Potion ID
| 9
+
    | {{Type|Boolean}}
| VarInt
+
    | Whether this potion has an ID in the potion registry. If true, it has the default effects associated with the potion type.
|colspan="2"| Particle ID
+
    |-
| 15 (mobSpell)
+
    | Potion ID
|- {{Removed}}
+
    | {{Type|Optional}} {{Type|VarInt}}
| 10
+
    | The ID of the potion type in the potion registry. Only present if Has Potion ID is true.
| VarInt
+
    |-
|colspan="2"| Particle parameter 1
+
    | Has Custom Color
| 0
+
    | {{Type|Boolean}}
|- {{Removed}}
+
    | Whether this potion has a custom color. If false, it uses the default color associated with the potion type.
| 11
+
    |-
| VarInt
+
    | Custom Color
|colspan="2"| Particle parameter 2
+
    | {{Type|Optional}} {{Type|Int}}
| 0
+
    | The RGB components of the color, encoded as an integer. Only present if Has Custom Color is true.
 +
    |-
 +
    | Number Of Custom Effects
 +
    | {{Type|VarInt}}
 +
    | The number of elements in the following array.
 +
    |-
 +
    | Custom Effects
 +
    | {{Type|Array}} of [[#Potion_Effect|Potion Effect]]
 +
    | Any custom effects the potion might have. See [[#Potion_Effect|Potion Effect]].
 +
    |- {{added}}
 +
    | Custom Name
 +
    | {{Type|String}}
 +
    |
 +
    |}
 
  |}
 
  |}
  
=== Trident ===
+
=== Other types ===
  
Extends [[#Arrow|Arrow]].
+
==== Consume Effect ====
 
 
{| class="wikitable" {{Added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 7
 
| VarInt
 
|colspan="2"| Loyalty level (enchantment)
 
| 0
 
|}
 
  
=== Boat ===
+
WIP
  
Extends [[#Entity|Entity]].
+
==== Instrument ====
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Index
+
  ! Name
 
  ! Type
 
  ! Type
  !style="width: 250px;" colspan="2"| Meaning
+
  ! Description
! Default
 
|-
 
| 6
 
| VarInt
 
|colspan="2"| Time since last hit
 
| 0
 
|-
 
| 7
 
| VarInt
 
|colspan="2"| Forward direction
 
| 1
 
|-
 
| 8
 
| Float
 
|colspan="2"| Damage taken
 
| 0.0
 
 
  |-
 
  |-
  | 9
+
  | Sound Event
  | VarInt
+
  | {{Type|Id or}} {{Type|Sound Event}}
|colspan="2"| Type (0=oak, 1=spruce, 2=birch, 3=jungle, 4=acacia, 5=dark oak)
+
  | The sound to be played.
  | 0
 
 
  |-
 
  |-
  | 10
+
  | Use duration
  | Boolean
+
  | {{change|{{Type|VarInt}}|{{Type|Float}}}}
|colspan="2"| Right paddle turning
+
  | The maximum range of the sound.
  | false
 
 
  |-
 
  |-
  | 11
+
  | Range
  | Boolean
+
  | {{Type|Float}}
|colspan="2"| Left paddle turning
+
  | The range of the instrument.
  | false
+
  |- {{added}}
  |- {{Added}}
+
  | Description
  | 12
+
  | {{Type|Text Component}}
  | VarInt
+
  | Description shown in the item tooltip.
|colspan="2"| Splash timer (?)
 
  | 0
 
 
  |}
 
  |}
  
=== Phantom ===
+
== Particles ==
  
Extends [[#Flying|Flying]].
+
{| class="wikitable"
 
 
{| class="wikitable" {{Added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
 
  |-
 
  |-
| 12
+
  ! Particle Name
| VarInt
+
  ! Particle ID
|colspan="2"| Size
+
  ! Data
| 0
 
|}
 
 
 
Hitbox size is determined by horizontal=0.9 + 0.2*size and vertical=0.5 + 0.1 * i
 
 
 
=== Dolphin ===
 
 
 
Extends [[#Creature|Creature]].
 
 
 
No additional metadata.
 
 
 
=== WaterMob ===
 
 
 
Extends {{Change|[[#Insentient|Insentient]]|[[#Creature|Creature]]}}.
 
 
 
No additional metadata.
 
 
 
=== Abstract fish ===
 
 
 
Extends [[#WaterMob|WaterMob]].
 
 
 
{| class="wikitable" {{Added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 12
 
| Boolean
 
|colspan="2"| From bucket
 
| False
 
|}
 
 
 
=== Cod ===
 
 
 
Extends [[#AbstractFish|AbstractFish]].
 
 
 
No additional metadata.
 
 
 
=== Puffer fish ===
 
 
 
Extends [[#AbstractFish|AbstractFish]].
 
 
 
{| class="wikitable" {{Added}}
 
! Index
 
  ! Type
 
  !style="width: 250px;" colspan="2"| Meaning
 
  ! Default
 
 
  |-
 
  |-
 +
| <code>minecraft:dust</code>
 
  | 13
 
  | 13
  | VarInt
+
  |
  |colspan="2"| PuffState (varies from 0 to 2)
+
  {| class="wikitable"
| 0
+
  ! Field Name
|}
+
  ! Field Type
 
+
  ! Meaning
=== Salmon ===
+
  |- {{removed}}
 
+
  | Red
Extends [[#AbstractFish|AbstractFish]].
+
  | {{Type|Float}}
 
+
  | The red RGB value, between 0 and 1. Divide actual RGB value by 255.
No additional metadata.
+
  |- {{removed}}
 
+
  | Green
=== Tropical fish ===
+
  | {{Type|Float}}
 
+
  | The green RGB value, between 0 and 1. Divide actual RGB value by 255.
Extends [[#AbstractFish|AbstractFish]].
+
  |- {{removed}}
 
+
  | Blue
{| class="wikitable" {{Added}}
+
  | {{Type|Float}}
! Index
+
  | The blue RGB value, between 0 and 1. Divide actual RGB value by 255.
! Type
+
  |- {{added}}
!style="width: 250px;" colspan="2"| Meaning
+
  | Color
! Default
+
  | {{Type|Int}}
|-
+
  | The color, encoded as 0xRRGGBB; top bits are ignored.
| 13
+
  |-
| VarInt
+
  | Scale
|colspan="2"| Variant
+
  | {{Type|Float}}
| 0
+
  | The scale, will be clamped between 0.01 and 4.
|}
+
  |}
 
 
=== Turtle ===
 
 
 
Extends [[#Animal|Animal]].
 
 
 
{| class="wikitable" {{Added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 13
 
| BlockPos
 
|colspan="2"| Home pos
 
| (0, 0, 0)
 
 
  |-
 
  |-
 +
| <code>minecraft:dust_color_transition</code>
 
  | 14
 
  | 14
  | Boolean
+
  |
  |colspan="2"| Has egg
+
  {| class="wikitable"
| false
+
  ! Field Name
|-
+
  ! Field Type
| 15
+
  ! Meaning
| Boolean
+
  |- {{removed}}
|colspan="2"| Laying egg (?)
+
  | From Red
| false
+
  | {{Type|Float}}
|-
+
  | The start red RGB value, between 0 and 1. Divide actual RGB value by 255.
| 16
+
  |- {{removed}}
| BlockPos
+
  | From Green
|colspan="2"| Travel pos
+
  | {{Type|Float}}
| (0, 0, 0)
+
  | The start green RGB value, between 0 and 1. Divide actual RGB value by 255.
|-
+
  |- {{removed}}
| 17
+
  | From Blue
| Boolean
+
  | {{Type|Float}}
|colspan="2"| Going home
+
  | The start blue RGB value, between 0 and 1. Divide actual RGB value by 255.
| false
+
  |- {{added}}
|-
+
  | From Color
| 18
+
  | {{Type|Int}}
| Boolean
+
  | The start color, encoded as 0xRRGGBB; top bits are ignored.
|colspan="2"| Traveling
+
  |- {{removed}}
| false
+
  | To Red
 +
  | {{Type|Float}}
 +
  | The end red RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{removed}}
 +
  | To Green
 +
  | {{Type|Float}}
 +
  | The end green RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{removed}}
 +
  | To Blue
 +
  | {{Type|Float}}
 +
  | The end blue RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{added}}
 +
  | To Color
 +
  | {{Type|Int}}
 +
  | The end color, encoded as 0xRRGGBB; top bits are ignored.
 +
  |-
 +
  | Scale
 +
  | {{Type|Float}}
 +
  | The scale, will be clamped between 0.01 and 4.
 +
  |}
 
  |}
 
  |}
  
=== Drowned ===
+
== Handshake ==
  
Extends [[#Drowned|Drowned]].
+
No changes so far.
  
{| class="wikitable" {{Added}}
+
== Status ==
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 15
 
| Boolean
 
|colspan="2"| Has target (?)
 
| false
 
|}
 
  
== Block Actions ==
+
No changes so far.
  
No changes so far.
+
== Login ==
  
== Plugin Channels ==
+
No changes so far.
  
All clientbound channels have been renamed to be namespaced identifiers.
+
== Configuration ==
  
=== <code>minecraft:register</code> ===
+
No changes so far.
  
Formerly <code>REGISTER</code>.
+
== Play ==
  
=== <code>minecraft:unregister</code> ===
+
=== Clientbound ===
  
Formerly <code>UNREGISTER</code>.
+
==== Close Container ====
  
=== <code>minecraft:brand</code> ===
+
This packet is sent from the server to the client when a window is forcibly closed, such as when a chest is destroyed while it's open. The notchian client disregards the provided window ID and closes any active window.
  
Formerly <code>MC|Brand</code>.
+
{| class="wikitable"
 
+
! Packet ID
=== <code>minecraft:book_open</code> ===
+
! State
 
+
! Bound To
Formerly <code>MC|BOpen</code>.
+
  ! Field Name
 
+
  ! Field Type
=== <code>minecraft:trader_list</code> ===
 
 
 
Formerly <code>MC|TrList</code>.
 
 
 
=== <code>MC|StopSound</code> ===
 
 
 
{{Change|''Server to client''}}
 
 
 
{{Change|Used to implement {{Minecraft Wiki|Commands#StopSound|the <code>/stopsound</code> command}}.  Stops a sound that is currently playing on the client.}}
 
 
 
{| class="wikitable" {{Removed}}
 
  ! Field name
 
  ! Field type
 
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | Sound category
+
  | ''protocol:''<br/><code>0x12</code><br/><br/>''resource:''<br/><code>container_close</code>
| String
+
| Play
| Should be one of the sound categories used in [[Protocol#Named Sound Effect|Named Sound Effect]], but if it's invalid or empty then it is (intentionally) treated as ''all'' sound categories.
+
  | Client
  |-
+
  | Window ID
  | Sound name
+
  | {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
  | String
+
  | This is the ID of the window that was closed. 0 for inventory.
  | A [http://pokechu22.github.io/Burger/1.11.html#sounds sound effect name].  If left empty, ''all'' sounds are stopped.
 
 
  |}
 
  |}
  
{{Change|Emptiness of sound category or sound name can be combined, IE a empty sound name but a set sound category will stop all sounds in the given category.}}
+
==== Set Container Content ====
 +
[[File:Inventory-slots.png|thumb|The inventory slots]]
  
{{Change||This plugin channel has been replaced by the [[#Stop sound|stop sound]] packet.}}
+
Replaces the contents of a container window. Sent by the server upon initialization of a container window or the player's inventory, and in response to state ID mismatches (see [[#Click Container]]).
  
=== <code>minecraft:debug/paths</code> ===
+
{| class="wikitable"
 
+
  ! Packet ID
Formerly <code>MC|DebugPath</code>.
+
! State
 
+
! Bound To
=== <code>minecraft:debug/neighbors_update</code> ===
+
! Field Name
 
+
  ! Field Type
Formerly <code>MC|DebugNeighborsUpdate</code>.
 
 
 
=== <code>minecraft:debug/caves</code> ===
 
 
 
Never sent, but (presumably) used to debug caves.  Does not render without modifying the client.
 
 
 
{| class="wikitable" {{Added}}
 
  !colspan="2"| Field name
 
  !colspan="2"| Field type
 
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |colspan="2"| Unknown 1
+
  | rowspan="5"| ''protocol:''<br/><code>0x13</code><br/><br/>''resource:''<br/><code>container_set_content</code>
  |colspan="2"| Position
+
  | rowspan="5"| Play
  |
+
  | rowspan="5"| Client
 +
| Window ID
 +
| {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
 +
| The ID of window which items are being sent for. 0 for player inventory. The client ignores any packets targeting a Window ID other than the current one. However, an exception is made for the player inventory, which may be targeted at any time. (The Notchian server does not appear to utilize this special case.)
 
  |-
 
  |-
  |colspan="2"| Count
+
  | State ID
  |colspan="2"| Int
+
  | {{Type|VarInt}}
  | Number of elements in the following array
+
  | A server-managed sequence number used to avoid desynchronization; see [[#Click Container]].
 
  |-
 
  |-
  |rowspan="2"| Data
+
  | Count
  | Unknown 2
+
  | {{Type|VarInt}}
|rowspan="2"| Array
+
  | Number of elements in the following array.
| Position
 
|
 
|-
 
| Unknown 3
 
| Float
 
|
 
|}
 
 
 
=== <code>minecraft:debug/structures</code> ===
 
 
 
Never sent, but (presumably) used to debug structures.  Does not render without modifying the client.
 
 
 
{| class="wikitable" {{Added}}
 
!colspan="2"| Field name
 
!colspan="2"| Field type
 
! Notes
 
|-
 
|colspan="2"| Unknown 1
 
|colspan="2"| Int
 
|
 
|-
 
|colspan="2"| Bounding box minX
 
|colspan="2"| Int
 
|rowspan="6"| min must be less than max
 
|-
 
|colspan="2"| Bounding box minY
 
|colspan="2"| Int
 
|-
 
|colspan="2"| Bounding box minZ
 
|colspan="2"| Int
 
|-
 
|colspan="2"| Bounding box maxX
 
|colspan="2"| Int
 
|-
 
|colspan="2"| Bounding box maxY
 
|colspan="2"| Int
 
|-
 
|colspan="2"| Bounding box maxZ
 
|colspan="2"| Int
 
|-
 
|colspan="2"| Count
 
|colspan="2"| Int
 
  | Number of elements in the following array
 
|-
 
|rowspan="7"| Unknown
 
| Bounding box minX
 
|rowspan="7"| Array
 
| Int
 
|rowspan="6"| min must be less than max
 
|-
 
| Bounding box minY
 
| Int
 
|-
 
| Bounding box minZ
 
| Int
 
|-
 
| Bounding box maxX
 
| Int
 
|-
 
| Bounding box maxY
 
| Int
 
|-
 
| Bounding box maxZ
 
| Int
 
|-
 
| Unknown
 
| Boolean
 
|
 
|}
 
 
 
=== <code>minecraft:debug/worldgen_attempt</code> ===
 
 
 
Never sent, but (presumably) used to debug something with world generation. Does not render without modifying the client.
 
 
 
{{warning|This channel is invalid, as its name is longer than the max length (23 > 20).}}
 
 
 
{| class="wikitable" {{Added}}
 
! Field name
 
! Field type
 
! Notes
 
|-
 
| Unknown 1
 
| Position
 
|
 
|-
 
| Unknown 2
 
| Float
 
|
 
|-
 
| Unknown 3
 
| Float
 
|
 
 
  |-
 
  |-
  | Unknown 4
+
  | Slot Data
  | Float
+
  | {{Type|Array}} of [[Slot Data|Slot]]
|
 
 
  |-
 
  |-
  | Unknown 5
+
  | Carried Item
  | Float
+
  | {{Type|Slot}}
|
+
  | Item being dragged with the mouse.
|-
 
| Unknown 6
 
| Float
 
  |
 
 
  |}
 
  |}
  
== Play ==
+
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 +
Use [[#Open Screen|Open Screen]] to open the container on the client.
  
=== Clientbound ===
+
==== Set Container Property ====
  
==== Spawn Painting ====
+
This packet is used to inform the client that part of a GUI window should be updated.
 
 
This packet shows location, name, and type of painting.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,076: Line 704:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x04
+
  | rowspan="3"| ''protocol:''<br/><code>0x14</code><br/><br/>''resource:''<br/><code>container_set_data</code>
  |rowspan="5"| Play
+
  | rowspan="3"| Play
  |rowspan="5"| Client
+
  | rowspan="3"| Client
  | Entity ID
+
  | Window ID
  | VarInt
+
  | {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
|  
+
  |
|-
 
| Entity UUID
 
| UUID
 
  |  
 
 
  |-
 
  |-
  | Motive
+
  | Property
  | {{Change|String (13)|VarInt}}
+
  | {{Type|Short}}
  | {{Change|Name of the painting. Max length 13|Panting's ID, see below}}
+
  | The property to be updated, see below.
 
  |-
 
  |-
  | Location
+
  | Value
  | Position
+
  | {{Type|Short}}
| Center coordinates (see below)
+
  | The new value for the property, see below.
  |-
 
| Direction
 
| Byte Enum
 
| Direction the painting faces (North = 2, South = 0, West = 1, East = 3)
 
 
  |}
 
  |}
  
Calculating the center of an image: given a (width × height) grid of cells, with <code>(0, 0)</code> being the top left corner, the center is <code>(max(0, width / 2 - 1), height / 2)</code>. E.g. <code>(1, 0)</code> for a 2×1 painting, or <code>(1, 2)</code> for a 4×4 painting.
+
The meaning of the Property field depends on the type of the window. The following table shows the known combinations of window type and property, and how the value is to be interpreted.
 
 
List of paintings by coordinates in <code>paintings_kristoffer_zetterstrand.png</code> (where x and y are in pixels from the top left and width and height are in pixels or 16ths of a block):
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Name
 
!{{Added}}| ID
 
! x
 
! y
 
! width
 
! height
 
 
  |-
 
  |-
  | {{Change|<code>Kebab</code>|<code>minecraft:kebab</code>}}
+
  ! Window type
  | 0
+
  ! Property
  | 0
+
  ! Value
| 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | {{Change|<code>Aztec</code>|<code>minecraft:aztec</code>}}
+
  | rowspan="4"| Furnace
  | 1
+
  | 0: Fire icon (fuel left)
| 16
+
  | counting from fuel burn time down to 0 (in-game ticks)
  | 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Alban</code>|<code>minecraft:alban</code>}}
+
  | 1: Maximum fuel burn time
| 2
+
  | fuel burn time or 0 (in-game ticks)
| 32
 
  | 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Aztec2</code>|<code>minecraft:aztec2</code>}}
+
  | 2: Progress arrow
| 3
+
  | counting from 0 to maximum progress (in-game ticks)
| 48
 
  | 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Bomb</code>|<code>minecraft:bomb</code>}}
+
  | 3: Maximum progress
| 4
+
  | always 200 on the notchian server
| 64
 
| 0
 
| 16
 
  | 16
 
 
  |-
 
  |-
  | {{change|<code>Plant</code>|<code>minecraft:plant</code>}}
+
  | rowspan="10"| Enchantment Table
| 5
+
  | 0: Level requirement for top enchantment slot
| 80
+
  | rowspan="3"| The enchantment's xp level requirement
  | 0
 
  | 16
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Wasteland</code>|<code>minecraft:wasteland</code>}}
+
  | 1: Level requirement for middle enchantment slot
| 6
 
| 96
 
| 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Pool</code>|<code>minecraft:pool</code>}}
+
  | 2: Level requirement for bottom enchantment slot
| 7
 
| 0
 
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Courbet</code>|<code>minecraft:courbet</code>}}
+
  | 3: The enchantment seed
| 8
+
| Used for drawing the enchantment names (in [[Wikipedia:Standard Galactic Alphabet|SGA]]) clientside.  The same seed ''is'' used to calculate enchantments, but some of the data isn't sent to the client to prevent easily guessing the entire list (the seed value here is the regular seed bitwise and <code>0xFFFFFFF0</code>).
| 32
 
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Sea</code>|<code>minecraft:sea</code>}}
+
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
  | 9
+
  | rowspan="3"| The enchantment id (set to -1 to hide it), see below for values
| 64
 
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Sunset</code>|<code>minecraft:sunset</code>}}
+
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
| 10
 
| 96
 
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Creebet</code>|<code>minecraft:creebet</code>}}
+
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
| 11
 
| 128
 
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | {{change|<code>Wanderer</code>|<code>minecraft:wanderer</code>}}
+
  | 7: Enchantment level shown on mouse hover over the top slot
  | 12
+
  | rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
| 0
 
| 64
 
| 16
 
| 32
 
 
  |-
 
  |-
  | {{change|<code>Graham</code>|<code>minecraft:graham</code>}}
+
  | 8: Enchantment level shown on mouse hover over the middle slot
| 13
 
| 16
 
| 64
 
| 16
 
| 32
 
|-
 
| {{change|<code>Match</code>|<code>minecraft:match</code>}}
 
| 14
 
| 0
 
| 128
 
| 32
 
| 32
 
|-
 
| {{change|<code>Bust</code>|<code>minecraft:bust</code>}}
 
| 15
 
| 32
 
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | {{change|<code>Stage</code>|<code>minecraft:stage</code>}}
+
  | 9: Enchantment level shown on mouse hover over the bottom slot
| 16
 
| 64
 
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | {{change|<code>Void</code>|<code>minecraft:void</code>}}
+
  | rowspan="3"| Beacon
  | 17
+
  | 0: Power level
| 96
+
  | 0-4, controls what effect buttons are enabled
| 128
 
| 32
 
  | 32
 
 
  |-
 
  |-
  | {{change|<code>SkullAndRoses</code>|<code>skull_and_roses</code>}}
+
| 1: First potion effect
| 18
+
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
| 128
 
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | {{change|<code>Wither</code>|<code>minecraft:wither</code>}}
+
| 2: Second potion effect
| 19
+
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
| 160
 
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | {{change|<code>Fighters</code>|<code>minecraft:fighters</code>}}
+
  | Anvil
| 20
+
  | 0: Repair cost
  | 0
+
  | The repair's cost in xp levels
  | 96
 
| 64
 
| 32
 
 
  |-
 
  |-
  | {{change|<code>Pointer</code>|<code>minecraft:pointer</code>}}
+
  | rowspan="2"| Brewing Stand
  | 21
+
  | 0: Brew time
  | 0
+
  | 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
| 192
 
| 64
 
| 64
 
 
  |-
 
  |-
  | {{change|<code>Pigscene</code>|<code>minecraft:pigscene</code>}}
+
  | 1: Fuel time
| 22
+
  | 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
| 64
 
| 192
 
| 64
 
  | 64
 
 
  |-
 
  |-
  | {{change|<code>BurningSkull</code>|<code>minecraft:burning_skull</code>}}
+
  | Stonecutter
  | 23
+
  | 0: Selected recipe
| 128
+
  | The index of the selected recipe. -1 means none is selected.
| 192
 
| 64
 
  | 64
 
 
  |-
 
  |-
  | {{change|<code>Skeleton</code>|<code>minecraft:skeleton</code>}}
+
  | Loom
  | 24
+
  | 0: Selected pattern
| 192
+
  | The index of the selected pattern. 0 means none is selected, 0 is also the internal id of the "base" pattern.
| 64
 
| 64
 
  | 48
 
 
  |-
 
  |-
  | {{change|<code>DonkeyKong</code>|<code>minecraft:donkey_kong</code>}}
+
  | Lectern
  | 25
+
  | 0: Page number
| 192
+
  | The current page number, starting from 0.
| 112
 
| 64
 
  | 48
 
 
  |}
 
  |}
  
The {{Minecraft Wiki|Painting#Canvases|Minecraft Wiki article on paintings}} also provides a list of painting names to the actual images.
+
For an enchanting table, the following numerical IDs are used:
 
 
==== Statistics ====
 
 
 
Sent as a response to [[#Client_Status|Client Status]] (id 1).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Numerical ID
  ! State
+
  ! Enchantment ID
  ! Bound To
+
  ! Enchantment Name
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
 
  |-
 
  |-
|rowspan="6"| 0x07
 
|rowspan="6"| Play
 
|rowspan="6"| Client
 
|colspan="2"| Count
 
|colspan="2"| VarInt
 
| Number of elements in the following array
 
|-
 
|rowspan="4"| Statistic
 
|{{Removed}}| Name
 
|rowspan="4"| Array
 
|{{Removed}}| String (32767)
 
|{{Removed}}| [https://gist.github.com/Alvin-LB/8d0d13db00b3c00fd0e822a562025eff https://gist.github.com/Alvin-LB/8d0d13db00b3c00fd0e822a562025eff]
 
|- {{Added}}
 
| Category ID
 
| VarInt
 
| See below
 
|- {{Added}}
 
| Statistic ID
 
| VarInt
 
| See below
 
|-
 
| Value
 
| VarInt
 
| The amount to set it to
 
|}
 
 
Categories (these are namespaced, but with <code>:</code>. replaced with <code>.</code>):
 
 
{| class="wikitable"
 
! Name
 
! ID
 
! Registry
 
|-
 
| <code>minecraft.mined</code>
 
 
  | 0
 
  | 0
  | Blocks
+
  | minecraft:protection
 +
| Protection
 
  |-
 
  |-
| <code>minecraft.crafted</code>
 
 
  | 1
 
  | 1
  | Items
+
  | minecraft:fire_protection
 +
| Fire Protection
 
  |-
 
  |-
| <code>minecraft.used</code>
 
 
  | 2
 
  | 2
  | Items
+
  | minecraft:feather_falling
 +
| Feather Falling
 
  |-
 
  |-
| <code>minecraft.broken</code>
 
 
  | 3
 
  | 3
  | Items
+
  | minecraft:blast_protection
 +
| Blast Protection
 
  |-
 
  |-
| <code>minecraft.picked_up</code>
 
 
  | 4
 
  | 4
  | Items
+
  | minecraft:projectile_protection
 +
| Projectile Protection
 
  |-
 
  |-
| <code>minecraft.dropped</code>
 
 
  | 5
 
  | 5
  | Items
+
  | minecraft:respiration
 +
| Respiration
 
  |-
 
  |-
| <code>minecraft.killed</code>
 
 
  | 6
 
  | 6
  | Entities
+
  | minecraft:aqua_affinity
 +
| Aqua Affinity
 
  |-
 
  |-
| <code>minecraft.killed_by</code>
 
 
  | 7
 
  | 7
  | Entities
+
  | minecraft:thorns
 +
| Thorns
 
  |-
 
  |-
| <code>minecraft.custom</code>
 
 
  | 8
 
  | 8
  | Custom
+
  | minecraft:depth_strider
|}
+
  | Depth Strider
 
 
Blocks, Items, and Entities use block (not block state), item, and entity ids.
 
 
 
Custom has the following (unit only matters for clients):
 
 
 
{| class="wikitable"
 
! Name
 
! ID
 
! Unit
 
|-
 
| <code>minecraft.leave_game</code>
 
| 0
 
  | None
 
 
  |-
 
  |-
| <code>minecraft.play_one_minute</code>
 
| 1
 
| Time
 
|-
 
| <code>minecraft.time_since_death</code>
 
| 2
 
| Time
 
|-
 
| <code>minecraft.sneak_Time</code>
 
| 3
 
| Time
 
|-
 
| <code>minecraft.walk_one_cm</code>
 
| 4
 
| Distance
 
|-
 
| <code>minecraft.crouch_one_cm</code>
 
| 5
 
| Distance
 
|-
 
| <code>minecraft.sprint_one_cm</code>
 
| 6
 
| Distance
 
|-
 
| <code>minecraft.swim_one_cm</code>
 
| 7
 
| Distance
 
|-
 
| <code>minecraft.fall_one_cm</code>
 
| 8
 
| Distance
 
|-
 
| <code>minecraft.climb_one_cm</code>
 
 
  | 9
 
  | 9
  | Distance
+
  | minecraft:frost_walker
 +
| Frost Walker
 
  |-
 
  |-
| <code>minecraft.fly_one_cm</code>
 
 
  | 10
 
  | 10
  | Distance
+
  | minecraft:binding_curse
 +
| Curse of Binding
 
  |-
 
  |-
| <code>minecraft.dive_one_cm</code>
 
 
  | 11
 
  | 11
  | Distance
+
  | minecraft:soul_speed
 +
| Soul Speed
 
  |-
 
  |-
| <code>minecraft.minecart_one_cm</code>
 
 
  | 12
 
  | 12
  | Distance
+
  | minecraft:swift_sneak
 +
| Swift Sneak
 
  |-
 
  |-
| <code>minecraft.boat_one_cm</code>
 
 
  | 13
 
  | 13
  | Distance
+
  | minecraft:sharpness
 +
| Sharpness
 
  |-
 
  |-
| <code>minecraft.pig_one_cm</code>
 
 
  | 14
 
  | 14
  | Distance
+
  | minecraft:smite
 +
| Smite
 
  |-
 
  |-
| <code>minecraft.horse_one_cm</code>
 
 
  | 15
 
  | 15
  | Distance
+
  | minecraft:bane_of_arthropods
 +
| Bane of Arthropods
 
  |-
 
  |-
| <code>minecraft.aviate_one_cm</code>
 
 
  | 16
 
  | 16
  | Distance
+
  | minecraft:knockback
 +
| Knockback
 
  |-
 
  |-
| <code>minecraft.jump</code>
 
 
  | 17
 
  | 17
  | None
+
  | minecraft:fire_aspect
 +
| Fire Aspect
 
  |-
 
  |-
| <code>minecraft.drop</code>
 
 
  | 18
 
  | 18
  | None
+
  | minecraft:looting
 +
| Looting
 
  |-
 
  |-
| <code>minecraft.damage_dealt</code>
 
 
  | 19
 
  | 19
  | Damage
+
  | minecraft:sweeping_edge
 +
| Sweeping Edge
 
  |-
 
  |-
| <code>minecraft.damage_taken</code>
 
 
  | 20
 
  | 20
  | Damage
+
  | minecraft:efficiency
 +
| Efficiency
 
  |-
 
  |-
| <code>minecraft.deaths</code>
 
 
  | 21
 
  | 21
  | None
+
  | minecraft:silk_touch
 +
| Silk Touch
 
  |-
 
  |-
| <code>minecraft.mob_kills</code>
 
 
  | 22
 
  | 22
  | None
+
  | minecraft:unbreaking
 +
| Unbreaking
 
  |-
 
  |-
| <code>minecraft.animals_bred</code>
 
 
  | 23
 
  | 23
  | None
+
  | minecraft:fortune
 +
| Fortune
 
  |-
 
  |-
| <code>minecraft.player_kills</code>
 
 
  | 24
 
  | 24
  | None
+
  | minecraft:power
 +
| Power
 
  |-
 
  |-
| <code>minecraft.fish_caught</code>
 
 
  | 25
 
  | 25
  | None
+
  | minecraft:punch
 +
| Punch
 
  |-
 
  |-
| <code>minecraft.talked_to_villager</code>
 
 
  | 26
 
  | 26
  | None
+
  | minecraft:flame
 +
| Flame
 
  |-
 
  |-
| <code>minecraft.traded_with_villager</code>
 
 
  | 27
 
  | 27
  | None
+
  | minecraft:infinity
 +
| Infinity
 
  |-
 
  |-
| <code>minecraft.eat_cake_slice</code>
 
 
  | 28
 
  | 28
  | None
+
  | minecraft:luck_of_the_sea
 +
| Luck of the Sea
 
  |-
 
  |-
| <code>minecraft.fill_cauldron</code>
 
 
  | 29
 
  | 29
  | None
+
  | minecraft:lure
 +
| Lure
 
  |-
 
  |-
| <code>minecraft.use_cauldron</code>
 
 
  | 30
 
  | 30
  | None
+
  | minecraft:loyalty
 +
| Loyalty
 
  |-
 
  |-
| <code>minecraft.clean_armor</code>
 
 
  | 31
 
  | 31
  | None
+
  | minecraft:impaling
 +
| Impaling
 
  |-
 
  |-
| <code>minecraft.clean_banner</code>
 
 
  | 32
 
  | 32
  | None
+
  | minecraft:riptide
 +
| Riptide
 
  |-
 
  |-
| <code>minecraft.interact_with_brewingstand</code>
 
 
  | 33
 
  | 33
  | None
+
  | minecraft:channeling
 +
| Channeling
 
  |-
 
  |-
| <code>minecraft.interact_with_beacon</code>
 
 
  | 34
 
  | 34
  | None
+
  | minecraft:multishot
 +
| Multishot
 
  |-
 
  |-
| <code>minecraft.inspect_dropper</code>
 
 
  | 35
 
  | 35
  | None
+
  | minecraft:quick_charge
 +
| Quick Charge
 
  |-
 
  |-
| <code>minecraft.inspect_hopper</code>
 
 
  | 36
 
  | 36
  | None
+
  | minecraft:piercing
 +
| Piercing
 
  |-
 
  |-
| <code>minecraft.inspect_dispenser</code>
 
 
  | 37
 
  | 37
  | None
+
  | minecraft:density
 +
| Density
 
  |-
 
  |-
| <code>minecraft.play_noteblock</code>
 
 
  | 38
 
  | 38
  | None
+
  | minecraft:breach
 +
| Breach
 
  |-
 
  |-
| <code>minecraft.tune_noteblock</code>
 
 
  | 39
 
  | 39
  | None
+
  | minecraft:wind_burst
 +
| Wind Burst
 
  |-
 
  |-
| <code>minecraft.pot_flower</code>
 
 
  | 40
 
  | 40
  | None
+
  | minecraft:mending
 +
| Mending
 
  |-
 
  |-
| <code>minecraft.trigger_trapped_chest</code>
 
 
  | 41
 
  | 41
  | None
+
  | minecraft:vanishing_curse
|-
+
  | Curse of Vanishing
| <code>minecraft.open_enderchest</code>
 
| 42
 
| None
 
|-
 
| <code>minecraft.enchant_item</code>
 
| 43
 
| None
 
|-
 
| <code>minecraft.play_record</code>
 
| 44
 
| None
 
|-
 
| <code>minecraft.interact_with_furnace</code>
 
| 45
 
| None
 
|-
 
| <code>minecraft.interact_with_crafting_table</code>
 
| 46
 
| None
 
|-
 
| <code>minecraft.open_chest</code>
 
| 47
 
| None
 
|-
 
| <code>minecraft.sleep_in_bed</code>
 
| 48
 
| None
 
|-
 
| <code>minecraft.open_shulker_box</code>
 
| 49
 
  | None
 
 
  |}
 
  |}
  
Units:
+
==== Set Container Slot ====
 
 
* None: just a normal number (formatted with 0 decimal places)
 
* Damage: value is 10 times the normal amount
 
* Distance: a distance in centimeters (hundredths of blocks)
 
* Time: a time span in ticks
 
 
 
==== Update Block Entity ====
 
  
Sets tile entity associated with the block at the given location.
+
Sent by the server when an item in a slot (in a window) is added/removed.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,608: Line 988:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x09
+
  | rowspan="4"| ''protocol:''<br/><code>0x15</code><br/><br/>''resource:''<br/><code>container_set_slot</code>
  |rowspan="3"| Play
+
  | rowspan="4"| Play
  |rowspan="3"| Client
+
  | rowspan="4"| Client
  | Location
+
  | Window ID
  | Position
+
  | {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
  |  
+
| The window which is being updated. 0 for player inventory. The client ignores any packets targeting a Window ID other than the current one{{change|; see below for exceptions|, unless it is 0 (see below)}}.
 +
|-
 +
| State ID
 +
| {{Type|VarInt}}
 +
  | A server-managed sequence number used to avoid desynchronization; see [[#Click Container]].
 
  |-
 
  |-
  | Action
+
  | Slot
  | Unsigned Byte
+
  | {{Type|Short}}
  | The type of update to perform, see below
+
  | The slot that should be updated.
 
  |-
 
  |-
  | NBT Data
+
  | Slot Data
  | [[NBT|NBT Tag]]
+
  | {{Type|Slot}}
  | Data to set.  May be a TAG_END (0), in which case the block entity at the given location is removed (though this is not required since the client will remove the block entity automatically on chunk unload or block removal)
+
  |
 
  |}
 
  |}
  
''Action'' field:
+
If Window ID is 0, the hotbar and offhand slots (slots 36 through 45) may be updated even when a different container window is open. (The Notchian server does not appear to utilize this special case.) Updates are also restricted to those slots when the player is looking at a creative inventory tab other than the survival inventory. (The Notchian server does ''not'' handle this restriction in any way, leading to [https://bugs.mojang.com/browse/MC-242392 MC-242392].)
  
* '''1''': Set data of a mob spawner (everything except for SpawnPotentials: current delay, min/max delay, mob to be spawned, spawn count, spawn range, etc.)
+
{{change|If Window ID is -1, the item being dragged with the mouse is set. In this case, State ID and Slot are ignored.|}}
* '''2''': Set command block text (command and last execution status)
 
* '''3''': Set the level, primary, and secondary powers of a beacon
 
* '''4''': Set rotation and skin of mob head
 
* {{Change|'''5''': Set type of flower in flower pot}}
 
* {{Change||'''5''': Declare a conduit}}
 
* '''6''': Set base color and patterns on a banner
 
* '''7''': Set the data for a Structure tile entity
 
* '''8''': Set the destination for a end gateway
 
* '''9''': Set the text on a sign
 
* '''10''': Declare a shulker box, no data appears to be sent and the client seems to do fine without this packet. Perhaps it is a leftover from earlier versions?
 
* '''11''': {{change|Set the color of a bed|Declare a bed}}
 
  
==== Block Change ====
+
{{change|If Window ID is -2, any slot in the player's inventory can be updated irrespective of the current container window. In this case, State ID is ignored, and the Notchian server uses a bogus value of 0. Used by the Notchian server to implement the [[#Pick Item]] functionality.|}}
  
Fired whenever a block is changed within the render distance.
+
When a container window is open, the server never sends updates targeting Window ID 0&mdash;all of the [[Inventory|window types]] include slots for the player inventory. The client must automatically apply changes targeting the inventory portion of a container window to the main inventory; the server does not resend them for ID 0 when the window is closed. However, since the armor and offhand slots are only present on ID 0, updates to those slots occurring while a window is open must be deferred by the server until the window's closure.
  
{{Warning2|Changing a block in a chunk that is not loaded is not a stable actionThe Notchian client currently uses a ''shared'' empty chunk which is modified for all block changes in unloaded chunks; while in 1.9 this chunk never renders in older versions the changed block will appear in all copies of the empty chunk. Servers should avoid sending block changes in unloaded chunks and clients should ignore such packets.}}
+
==== Set Cooldown ====
 +
 
 +
Applies a cooldown period to all items with the given typeUsed by the Notchian server with enderpearls.  This packet should be sent when the cooldown starts and also when the cooldown ends (to compensate for lag), although the client will end the cooldown automatically. Can be applied to any item, note that interactions still get sent to the server with the item but the client does not play the animation nor attempt to predict results (i.e block placing).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,652: Line 1,027:
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 +
|-
 +
| rowspan="2"| ''protocol:''<br/><code>0x17</code><br/><br/>''resource:''<br/><code>cooldown</code>
 +
| rowspan="2"| Play
 +
| rowspan="2"| Client
 +
| {{change|Item ID|Cooldown Group}}
 +
| {{change|{{Type|VarInt}}|{{Type|Identifier}}}}
 +
| {{change|Numeric ID of the item|Group of items}} to apply a cooldown to.
 
  |-
 
  |-
  |rowspan="2"| 0x0B
+
  | Cooldown Ticks
  |rowspan="2"| Play
+
  | {{Type|VarInt}}
|rowspan="2"| Client
+
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
| Location
 
| Position
 
| Block Coordinates
 
|-
 
| Block ID
 
| VarInt
 
  | The new block state ID for the block as given in the [[#global palette|global palette]].  {{change|(When reading data: <code>type {{=}} id >> 4</code>, <code>meta {{=}} id & 15</code>, when writing data: <code>id {{=}} type << 4 {{!}} (meta & 15)</code>)|See that section for more information.}}
 
 
  |}
 
  |}
  
==== Multi Block Change ====
+
==== Teleport Entity ====
  
Fired whenever 2 or more blocks are changed within the same chunk on the same tick.
+
{{Warning2|{{change||The Mojang-specified name of this packet was changed in 1.21.2 from <code>teleport_entity</code> to <code>entity_position_sync</code>. There is a new <code>teleport_entity</code>, which this document more appropriately calls [[#Synchronize Vehicle Position|Synchronize Vehicle Position]]. That packet has a different function and will lead to confusing results if used in place of this one.}}}}
  
{{Warning|Changing blocks in chunks not loaded by the client is unsafe (see note on [[#Block Change|Block Change]]).}}
+
This packet is sent by the server when an entity moves more than 8 blocks.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,675: Line 1,050:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| {{Change|0x10|0x0F}}
+
  | rowspan="10"| ''protocol:''<br/><code>{{change|0x70|0x20}}</code><br/><br/>''resource:''<br/><code>{{change|teleport_entity|entity_position_sync}}</code>
  |rowspan="6"| Play
+
  | rowspan="10"| Play
  |rowspan="6"| Client
+
  | rowspan="10"| Client
  |colspan="2"| Chunk X
+
  | Entity ID
  |colspan="2"| Int
+
  | {{Type|VarInt}}
  | Chunk X coordinate
+
  |
 
  |-
 
  |-
  |colspan="2"| Chunk Z
+
  | X
  |colspan="2"| Int
+
  | {{Type|Double}}
  | Chunk Z coordinate
+
  |  
 
  |-
 
  |-
  |colspan="2"| Record Count
+
  | Y
  |colspan="2"| VarInt
+
  | {{Type|Double}}
  | Number of elements in the following array, i.e. the number of blocks affected
+
  |
 
  |-
 
  |-
  |rowspan="3"| Record
+
  | Z
  | Horizontal Position
+
| {{Type|Double}}
  |rowspan="3"| Array
+
|
  | Unsigned Byte
+
|- {{added}}
  | The 4 most significant bits (<code>0xF0</code>) encode the X coordinate, relative to the chunk. The 4 least significant bits (<code>0x0F</code>) encode the Z coordinate, relative to the chunk.
+
| Velocity X
 +
| {{Type|Double}}
 +
|
 +
|- {{added}}
 +
| Velocity Y
 +
| {{Type|Double}}
 +
|
 +
|- {{added}}
 +
| Velocity Z
 +
| {{Type|Double}}
 +
  |
 +
  |-
 +
| Yaw
 +
  | {{change|{{Type|Angle}}|{{Type|Float}}}}
 +
  | Rotation on the X axis, in degrees.
 
  |-
 
  |-
  | Y Coordinate
+
  | Pitch
  | Unsigned Byte
+
  | {{change|{{Type|Angle}}|{{Type|Float}}}}
  | Y coordinate of the block
+
  | Rotation on the Y axis, in degrees.
 
  |-
 
  |-
  | Block ID
+
  | On Ground
  | VarInt
+
  | {{Type|Boolean}}
| The new block state ID for the block as given in the [[#global palette|global palette]].  {{change|(When reading data: <code>type {{=}} id >> 4</code>, <code>meta {{=}} id & 15</code>, when writing data: <code>id {{=}} type << 4 {{!}} (meta & 15)</code>)|See that section for more information.}}
+
|
|}
+
|}
 
 
To decode the position into a world position:
 
 
 
<syntaxhighlight lang="java">
 
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
 
worldY = vertPos;
 
worldZ = (horizPos & 15) + (chunkZ * 16);
 
</syntaxhighlight>
 
  
 +
==== Explosion ====
  
==== Tab-Complete (clientbound) ====
+
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
  
Used to respond to the client's previous tab complete request.
+
{{change|Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x|}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,726: Line 1,108:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! colspan="2" | Field Name
  !colspan="2"|  Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| {{Change|0x0E|0x10}}
+
  | rowspan="16"| ''protocol:''<br/><code>{{change|0x20|0x21}}</code><br/><br/>''resource:''<br/><code>explode</code>
  |rowspan="7"| Play
+
  | rowspan="16"| Play
  |rowspan="7"| Client
+
  | rowspan="16"| Client
  |colspan="2" {{Added}}| Transaction Id
+
  | X
  |colspan="2" {{Added}}| VarInt
+
| {{Type|Double}}
  |{{Added}}| This id should also be used in the tab completion response packet, or it will be ignored.
+
|
  |- {{Added}}
+
|-
  |colspan="2"|  Start
+
| Y
  |colspan="2"| VarInt
+
| {{Type|Double}}
  | Start of the text to replace
+
|
  |- {{Added}}
+
|-
  |colspan="2"Length
+
| Z
  |colspan="2"VarInt
+
| {{Type|Double}}
  | Length of the text to replace
+
|
 +
  |- {{removed}}
 +
| Strength
 +
  | {{Type|Float}}
 +
| If the strength is greater or equal to 2.0, or the block interaction is not 0 (keep), large explosion particles are used. Otherwise, small explosion particles are used.
 +
  |- {{removed}}
 +
  | Record Count
 +
  | {{Type|VarInt}}
 +
  | Number of elements in the following array.
 +
  |- {{removed}}
 +
  | Records
 +
| {{Type|Array}} of ({{Type|Byte}}, {{Type|Byte}}, {{Type|Byte}})
 +
  | Each record is 3 signed bytes long; the 3 bytes are the XYZ (respectively) signed offsets of affected blocks.
 +
  |- {{added}}
 +
| Has Player Motion
 +
  | {{Type|Boolean}}
 +
  |
 
  |-
 
  |-
  |colspan="2"|  Count
+
  | Player Motion X
  |colspan="2"| VarInt
+
  | {{change|{{Type|Float}}|{{Type|Optional}} {{Type|Double}}}}
  | Number of elements in the following array
+
  | X velocity of the player being pushed by the explosion.{{change|| Only present if Has Player Motion is true.}}
 
  |-
 
  |-
  |rowspan="3"| Matches
+
  | Player Motion Y
  | Match
+
  | {{change|{{Type|Float}}|{{Type|Optional}} {{Type|Double}}}}
|rowspan="3"| Array
+
| Y velocity of the player being pushed by the explosion.{{change|| Only present if Has Player Motion is true.}}
| String (32767)
 
| One eligible {{change|command|value to insert}}, note that each command is sent separately instead of in a single string, hence the need for Count. {{change||Note that for instance this doesn't include a leading <code>/</code> on commands.}}
 
 
  |-
 
  |-
  |{{Added}}| Has tooltip
+
  | Player Motion Z
  |{{Added}}| Boolean
+
| {{change|{{Type|Float}}|{{Type|Optional}} {{Type|Double}}}}
  |{{Added}}| True if the following is present
+
| Z velocity of the player being pushed by the explosion.{{change|| Only present if Has Player Motion is true.}}
 +
  |- {{removed}}
 +
| Block Interaction
 +
  | {{Type|VarInt}} {{Type|Enum}}
 +
| 0 = keep, 1 = destroy, 2 = destroy_with_decay, 3 = trigger_block.
 
  |-
 
  |-
  |{{Added}}| Tooltip
+
  | {{change|Small |}}Explosion Particle ID
  |{{Added}}| Optional [[Chat]]
+
| {{Type|VarInt}}
  |{{Added}}| Tooltip to display; only present if previous Boolean is true
+
| The particle ID listed in [[Particles]].
 +
|-
 +
  | {{change|Small |}}Explosion Particle Data
 +
| Varies
 +
| Particle data as specified in [[Particles]].
 +
  |- {{removed}}
 +
| Large Explosion Particle ID
 +
| {{Type|VarInt}}
 +
| The particle ID listed in [[Particles]].
 +
|- {{removed}}
 +
| Large Explosion Particle Data
 +
| Varies
 +
| Particle data as specified in [[Particles]].
 +
|-
 +
| Explosion Sound
 +
| {{Type|ID or}} {{Type|Sound Event}}
 +
| ID in the <code>minecraft:sound_event</code> registry, or an inline definition.
 
  |}
 
  |}
  
==== Declare Commands ====
+
==== Open Horse Screen ====
  
Lists all of the commands on the server, and how they are parsed.
+
This packet is used exclusively for opening the horse GUI. [[#Open Screen|Open Screen]] is used for all other GUIsThe client will not open the inventory if the Entity ID does not point to an horse-like animal.
 
 
This is a directed graph, with one root nodeEach redirect or child node must refer only to nodes that have already been declared.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,778: Line 1,192:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x11
+
  | rowspan="3"| ''protocol:''<br/><code>0x23</code><br/><br/>''resource:''<br/><code>horse_screen_open</code>
  |rowspan="3"| Play
+
  | rowspan="3"| Play
  |rowspan="3"| Client
+
  | rowspan="3"| Client
  | Count
+
  | Window ID
  | VarInt
+
  | {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
  | Number of elements in the following array
+
  |
 
  |-
 
  |-
  | Nodes
+
  | Slot count
  | Array of [[Command Data|Node]]
+
  | {{Type|VarInt}}
  | An array of nodes
+
  |
 
  |-
 
  |-
  | Root index
+
  | Entity ID
  | VarInt
+
  | {{Type|Int}}
  | Index of the <code>root</code> node in the previous array
+
  |
 
  |}
 
  |}
  
For more information on this packet, see the [[Command Data]] article.
+
==== Login (play) ====
  
==== Plugin Message (clientbound) ====
+
{{Need Info|Although the number of portal cooldown ticks is included in this packet, the whole portal usage process is still dictated entirely by the server. What kind of effect does this value have on the client, if any?}}
  
{{Main|Plugin channels}}
+
See [[Protocol Encryption]] for information on logging in.
 
 
Mods and plugins can use this to send their data. Minecraft itself uses a number of [[plugin channel]]s. These internal channels are prefixed with <code>MC|</code>.
 
 
 
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,812: Line 1,222:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| {{Change|0x18|0x19}}
+
  | rowspan="23"| ''protocol:''<br/><code>{{change|0x2B|0x2C}}</code><br/><br/>''resource:''<br/><code>login</code>
  |rowspan="2"| Play
+
  | rowspan="23"| Play
  |rowspan="2"| Client
+
  | rowspan="23"| Client
  | Channel
+
  | Entity ID
  | {{Change|String (20)|Identifier}}
+
  | {{Type|Int}}
  | Name of the [[plugin channel]] used to send the data
+
| The player's Entity ID (EID).
 +
|-
 +
| Is hardcore
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Dimension Count
 +
| {{Type|VarInt}}
 +
  | Size of the following array.
 
  |-
 
  |-
  | Data
+
  | Dimension Names
  | Byte Array
+
  | {{Type|Array}} of {{Type|Identifier}}
  | Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
+
| Identifiers for all dimensions on the server.
 +
|-
 +
| Max Players
 +
| {{Type|VarInt}}
 +
| Was once used by the client to draw the player list, but now is ignored.
 +
|-
 +
| View Distance
 +
| {{Type|VarInt}}
 +
| Render distance (2-32).
 +
|-
 +
| Simulation Distance
 +
| {{Type|VarInt}}
 +
| The distance that the client will process specific things, such as entities.
 +
|-
 +
| Reduced Debug Info
 +
| {{Type|Boolean}}
 +
  | If true, a Notchian client shows reduced information on the {{Minecraft Wiki|debug screen}}.  For servers in development, this should almost always be false.
 +
|-
 +
| Enable respawn screen
 +
| {{Type|Boolean}}
 +
| Set to false when the doImmediateRespawn gamerule is true.
 +
|-
 +
| Do limited crafting
 +
| {{Type|Boolean}}
 +
| Whether players can only craft recipes they have already unlocked. Currently unused by the client.
 +
|-
 +
| Dimension Type
 +
| {{Type|VarInt}}
 +
| The ID of the type of dimension in the <code>minecraft:dimension_type</code> registry, defined by the Registry Data packet.
 +
|-
 +
| Dimension Name
 +
| {{Type|Identifier}}
 +
| Name of the dimension being spawned into.
 +
|-
 +
| Hashed seed
 +
| {{Type|Long}}
 +
| First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
 +
|-
 +
| Game mode
 +
| {{Type|Unsigned Byte}}
 +
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
 +
|-
 +
| Previous Game mode
 +
| {{Type|Byte}}
 +
| -1: Undefined (null), 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. The previous game mode. Vanilla client uses this for the debug (F3 + N & F3 + F4) game mode switch. (More information needed)
 +
|-
 +
| Is Debug
 +
| {{Type|Boolean}}
 +
| True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
 +
|-
 +
| Is Flat
 +
| {{Type|Boolean}}
 +
| True if the world is a {{Minecraft Wiki|superflat}} world; flat worlds have different void fog and a horizon at y=0 instead of y=63.
 +
|-
 +
| Has death location
 +
| {{Type|Boolean}}
 +
| If true, then the next two fields are present.
 +
|-
 +
| Death dimension name
 +
| {{Type|Optional}} {{Type|Identifier}}
 +
| Name of the dimension the player died in.
 +
|-
 +
| Death location
 +
| {{Type|Optional}} {{Type|Position}}
 +
| The location that the player died at.
 +
|-
 +
  | Portal cooldown
 +
| {{Type|VarInt}}
 +
| The number of ticks until the player can use the portal again.
 +
|- {{added}}
 +
| Sea level
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Enforces Secure Chat
 +
| {{Type|Boolean}}
 +
|
 
  |}
 
  |}
  
 +
==== Move Minecart Along Track ====
  
==== Named Sound Effect ====
+
{| class="wikitable" {{added}}
{{See also|#Sound Effect}}
 
 
 
Used to play a sound effect on the client. Custom sounds may be added by resource packs.
 
 
 
{| class="wikitable"
 
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
  ! Notes
+
  ! colspan="2"| Notes
 +
|-
 +
| rowspan="11"| ''protocol:''<br/><code>0x31</code><br/><br/>''resource:''<br/><code>move_minecart_along_track</code>
 +
| rowspan="11"| Play
 +
| rowspan="11"| Client
 +
| colspan="2"| Entity ID
 +
| colspan="2"| {{Type|VarInt}}
 +
|
 +
|-
 +
| colspan="2"| Step Count
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| rowspan="9"| Steps
 +
| X
 +
| rowspan="9"| {{Type|Array}}
 +
| {{Type|Double}}
 +
|
 
  |-
 
  |-
  |rowspan="7"| {{Change|0x19|0x1A}}
+
  | Y
|rowspan="7"| Play
+
  | {{Type|Double}}
|rowspan="7"| Client
+
  |  
| Sound Name
 
  | {{Change|String (256)|Identifier}}
 
  | All sound effect names as of 1.12.2 can be seen [http://pokechu22.github.io/Burger/1.12.2.html#sounds here].
 
 
  |-
 
  |-
  | Sound Category
+
  | Z
  | VarInt Enum
+
  | {{Type|Double}}
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
  |  
 
  |-
 
  |-
  | Effect Position X
+
  | Velocity X
  | Int
+
  | {{Type|Double}}
  | Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  |
 
  |-
 
  |-
  | Effect Position Y
+
  | Velocity Y
  | Int
+
  | {{Type|Double}}
  | Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  |
 
  |-
 
  |-
  | Effect Position Z
+
  | Velocity Z
  | Int
+
  | {{Type|Double}}
  | Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  |
 
  |-
 
  |-
  | Volume
+
  | Yaw
  | Float
+
  | {{Type|Angle}}
  | 1 is 100%, can be more
+
  |
 
  |-
 
  |-
 
  | Pitch
 
  | Pitch
  | Float
+
  | {{Type|Angle}}
  | Float between 0.5 and 2.0 by Notchian clients
+
  |
  |}
+
  |-
 
+
| Weight
==== Chunk Data ====
+
| {{Type|Float}}
{{Main|Chunk Format}}
+
|}
{{See also|#Unload Chunk}}
 
 
 
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimenison 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|Update Block Entity]] later).
 
  
{{Change||Indexes into the global palette are still used, but since the global palette has changed, behavior is different.}}
+
==== Player Info Update ====
{{Change||The Palette length field is no longer sent when using the global palette}}
 
 
 
The bits per block value used to index in the global palette is {{change|13|14}}, which is determined by taking the base 2 logarithm of the highest state ID and then rounding up (or alternatively, simply checking how many bits are needed to represent the highest state ID).
 
  
 +
Sent by the server to update the user list (<tab> in the client).
 
{| class="wikitable"
 
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="4"| ''protocol:''<br/><code>{{change|0x3E|0x40}}</code><br/><br/>''resource:''<br/><code>player_info_update</code>
 +
| rowspan="4"| Play
 +
| rowspan="4"| Client
 +
| colspan="2"| Actions
 +
| colspan="2"| {{Type|Byte}}
 +
| Determines what actions are present.
 +
|-
 +
| colspan="2"| Number Of Players
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| rowspan="2" | Players
 +
| UUID
 +
| rowspan="2" | {{Type|Array}}
 +
| {{Type|UUID}}
 +
| The player UUID
 +
|-
 +
| Player Actions
 +
| {{Type|Array}} of [[#player-info:player-actions|Player&nbsp;Actions]]
 +
| The length of this array is determined by the number of [[#player-info:player-actions|Player Actions]] that give a non-zero value when applying its mask to the actions flag. For example given the decimal number 5, binary 00000101. The masks 0x01 and 0x04 would return a non-zero value, meaning the Player Actions array would include two actions: Add Player and Update Game Mode.
 +
|}
 +
 
 +
{| class="wikitable"
 +
|+ id="player-info:player-actions" | Player Actions
 +
! Action
 +
! Mask
 +
! colspan="2" | Field Name
 +
! colspan="2" | Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="9"| {{Change|0x20|0x21}}
+
  | rowspan="6" | Add Player
  |rowspan="9"| Play
+
| rowspan="6" | 0x01
  |rowspan="9"| Client
+
| colspan="2" | Name
  | Chunk X
+
| colspan="2" | {{Type|String}} (16)
  | Int
+
|-
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
| colspan="2" | Number Of Properties
 +
| colspan="2" | {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
  | rowspan="4" | Property
 +
| Name
 +
  | rowspan="4"| {{Type|Array}}
 +
| {{Type|String}} (32767)
 +
|
 +
  |-
 +
  | Value
 +
  | {{Type|String}} (32767)
 +
|
 +
|-
 +
| Is Signed
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Signature
 +
| {{Type|Optional}} {{Type|String}} (32767)
 +
| Only if Is Signed is true.
 +
|-
 +
| rowspan="7" | Initialize Chat
 +
| rowspan="7" | 0x02
 +
| colspan="2" | Has Signature Data
 +
| colspan="2" | {{Type|Boolean}}
 
  |-
 
  |-
  | Chunk Z
+
  | colspan="2" | Chat session ID
  | Int
+
  | colspan="2" | {{Type|UUID}}
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  | Only sent if Has Signature Data is true.
 
  |-
 
  |-
  | Ground-Up Continuous
+
  | colspan="2" | Public key expiry time
  | Boolean
+
  | colspan="2" | {{Type|Long}}
  | See [[Chunk Format#Ground-up continuous|Chunk Format]]
+
  | Key expiry time, as a UNIX timestamp in milliseconds. Only sent if Has Signature Data is true.
 
  |-
 
  |-
  | Primary Bit Mask
+
  | colspan="2" | Encoded public key size
  | VarInt
+
  | colspan="2" | {{Type|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).
+
  | Size of the following array. Only sent if Has Signature Data is true. Maximum length is 512 bytes.
  |-  
+
|-
  | Size
+
| colspan="2" | Encoded public key
  | VarInt
+
| colspan="2" | {{Type|Byte Array}} (512)
  | Size of Data in bytes
+
| The player's public key, in bytes. Only sent if Has Signature Data is true.
 +
  |-
 +
  | colspan="2" | Public key signature size
 +
  | colspan="2" | {{Type|VarInt}}
 +
  | Size of the following array. Only sent if Has Signature Data is true. Maximum length is 4096 bytes.
 
  |-
 
  |-
  | Data
+
  | colspan="2" | Public key signature
  | Byte array
+
  | colspan="2" | {{Type|Byte Array}} (4096)
  | See [[Chunk Format#Data structure|data structure]] in Chunk Format
+
  | The public key's digital signature. Only sent if Has Signature Data is true.
 
  |-
 
  |-
  | Number of block entities
+
  | Update Game Mode
  | VarInt
+
  | 0x04
  | Number of elements in the following array
+
| colspan="2" | Game Mode
 +
  | colspan="2" | {{Type|VarInt}}
 
  |-
 
  |-
  | Block entities
+
  | Update Listed
  | Array of [[NBT|NBT Tag]]
+
  | 0x08
  | All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
+
  | colspan="2" | Listed
  |}
+
  | colspan="2" | {{Type|Boolean}}
 
+
| Whether the player should be listed on the player list.
{{Warning2|The chunk data packet currently (for 1.13 snapshots) may allocate a data array slightly larger than necessary; see [https://bugs.mojang.com/browse/MC-131684 MC-131684].  As such, there may be extra data (all zeros) after the end of the buffer that is not used.}}
 
 
 
===== Data structure =====
 
 
 
The data section of the packet contains most of the useful data for the chunk.
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Field Name
+
  | Update Latency
  ! Field Type
+
  | 0x10
  ! Notes
+
| colspan="2" | Ping
 +
| colspan="2" | {{Type|VarInt}}
 +
  | Measured in milliseconds.
 
  |-
 
  |-
  | Data
+
  | rowspan="2" | Update Display Name
  | Array of [[Chunk Format#Chunk Section structure|Chunk Section]]
+
  | rowspan="2" | 0x20
  | The number of elements is equal to the number of bits set in Primary Bit Mask. Sections are sent bottom-to-top, i.e. the first section, if sent, extends from Y=0 to Y=15.
+
  | colspan="2" | Has Display Name
 +
| colspan="2" | {{Type|Boolean}}
 
  |-
 
  |-
  | Biomes
+
  | colspan="2" | Display Name
  | Optional {{Change|Byte|Int}} Array
+
  | colspan="2" | {{Type|Optional}} {{Type|Text Component}}
  | Only sent if Ground-Up Continuous is true; 256 {{change|bytes|entries}} if present
+
  | Only sent if Has Display Name is true.
 +
|- {{added}}
 +
| Update List Priority
 +
| 0x40
 +
| colspan="2" | Priority
 +
| colspan="2" | {{Type|VarInt}}
 +
| See below.
 
  |}
 
  |}
  
===== Direct palette =====
+
The properties included in this packet are the same as in [[#Login Success|Login Success]], for the current player.
  
This format is used for bits per block values greater than 9. The number of bits used to represent a block are the base 2 logarithm of the number of block states, rounded up. For the current vanilla release, this is 13 bits per block.
+
Ping values correspond with icons in the following way:
 +
* A ping that negative (i.e. not known to the server yet) will result in the no connection icon.
 +
* A ping under 150 milliseconds will result in 5 bars
 +
* A ping under 300 milliseconds will result in 4 bars
 +
* A ping under 600 milliseconds will result in 3 bars
 +
* A ping under 1000 milliseconds (1 second) will result in 2 bars
 +
* A ping greater than or equal to 1 second will result in 1 bar.
  
:The "palette" uses the following format:
+
The order of players in the player list is determined as follows:
:{| class="wikitable"
+
* {{change||Players with higher priorities are sorted before those with lower priorities.}}
|-
+
* {{change||Among players of equal priorities, }}spectators are sorted after non-spectators.
! Field Name
+
* Within each of those groups, players are sorted into teams. The teams are ordered case-sensitively by team name in ascending order. Players with no team are listed first.
! Field Type
+
* The players of each team (and non-team) are sorted case-insensitively by name in ascending order.
! Notes
+
 
|- {{Removed}}
+
==== Synchronize Player Position ====
| Dummy Palette Length
+
 
| VarInt
+
Teleports the client, e.g. during login, when using an ender pearl, in response to invalid move packets, etc.
| Should always be 0. Only exists to mirror the format used elsewhere.
 
|-
 
|colspan="3"| ''no fields''
 
|}
 
  
If Minecraft Forge is installed and a sufficiently large number of blocks are added, the bits per block value for the global palette will be increased to compensate for the increased ID count. This increase can go up to 16 bits per block (for a total of 4096 block IDs; when combined with the 16 damage values, there are 65536 total states).  You can get the number of blocks with the "Number of ids" field found in the [[Minecraft Forge Handshake#RegistryData|RegistryData packet in the Forge Handshake]].
+
Due to latency, the server may receive outdated movement packets sent before the client was aware of the teleport. To account for this, the server ignores all movement packets from the client until a [[#Confirm Teleportation|Confirm Teleportation]] packet with an ID matching the one sent in the teleport packet is received.
  
==== Spawn Particle ====
+
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 (see [https://bugs.mojang.com/browse/MC-90097 MC-90097]).
  
Displays the named particle
+
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,978: Line 1,541:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="11"| {{Change|0x22|0x23}}
+
  | rowspan="11"| ''protocol:''<br/><code>{{change|0x40|0x42}}</code><br/><br/>''resource:''<br/><code>player_position</code>
  |rowspan="11"| Play
+
  | rowspan="11"| Play
  |rowspan="11"| Client
+
  | rowspan="11"| Client
  | Particle ID
+
  | {{added}} | Teleport ID
  | Int
+
  | {{added}} | {{Type|VarInt}}
  | The particle ID listed in [[#Particle]].
+
  | {{added}} | Client should confirm this packet with [[#Confirm Teleportation|Confirm Teleportation]] containing the same Teleport ID.
|-
 
| Long Distance
 
| Boolean
 
| If true, particle distance increases from 256 to 65536
 
 
  |-
 
  |-
 
  | X
 
  | X
  | Float
+
  | {{Type|Double}}
  | X position of the particle
+
  | Absolute or relative position, depending on Flags.
 
  |-
 
  |-
 
  | Y
 
  | Y
  | Float
+
  | {{Type|Double}}
  | Y position of the particle
+
  | Absolute or relative position, depending on Flags.
 
  |-
 
  |-
 
  | Z
 
  | Z
  | Float
+
  | {{Type|Double}}
  | Z position of the particle
+
| Absolute or relative position, depending on Flags.
 +
|- {{added}}
 +
| Velocity X
 +
| {{Type|Double}}
 +
|
 +
|- {{added}}
 +
| Velocity Y
 +
  | {{Type|Double}}
 +
|
 +
|- {{added}}
 +
| Velocity Z
 +
| {{Type|Double}}
 +
|
 
  |-
 
  |-
  | Offset X
+
  | Yaw
  | Float
+
  | {{Type|Float}}
  | This is added to the X position after being multiplied by random.nextGaussian()
+
  | Absolute or relative rotation on the X axis, in degrees.
 
  |-
 
  |-
  | Offset Y
+
  | Pitch
  | Float
+
  | {{Type|Float}}
  | This is added to the Y position after being multiplied by random.nextGaussian()
+
  | Absolute or relative rotation on the Y axis, in degrees.
 
  |-
 
  |-
  | Offset Z
+
  | Flags
  | Float
+
  | {{change|{{Type|Byte}}|{{Type|Teleport Flags}}}}
  | This is added to the Z position after being multiplied by random.nextGaussian()
+
  | {{change|Reference the Flags table below. When the value of the this byte masked is zero the field is absolute, otherwise relative.|}}
 +
|- {{removed}}
 +
| Teleport ID
 +
| {{Type|VarInt}}
 +
| Client should confirm this packet with [[#Confirm Teleportation|Confirm Teleportation]] containing the same Teleport ID.
 +
|}
 +
 
 +
==== Player Rotation ====
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Particle Data
+
  | rowspan="2"| ''protocol:''<br/><code>0x43</code><br/><br/>''resource:''<br/><code>player_rotation</code>
  | Float
+
  | rowspan="2"| Play
  | The data of each particle
+
| rowspan="2"| Client
 +
| Yaw
 +
| {{Type|Float}}
 +
  | Rotation on the X axis, in degrees.
 
  |-
 
  |-
  | Particle Count
+
  | Pitch
| Int
+
  | {{Type|Float}}
| The number of particles to create
+
  | Rotation on the Y axis, in degrees.
|-
 
| Data
 
  | {{Change|Array of VarInt|Varies}}
 
  | {{Change|Length depends on particle. "iconcrack" has length of 2, "blockcrack", "blockdust", and "fallingdust" have lengths of 1, the rest have 0.|The variable data listed in [[#Particle]]}}
 
 
  |}
 
  |}
  
==== Map ====
+
==== Place Ghost Recipe ====
  
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
+
Response to the serverbound packet ([[#Place Recipe|Place Recipe]]), with the same recipe ID. Appears to be used to notify the UI.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,034: Line 1,619:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="16"| {{Change|0x24|0x25}}
+
  | rowspan="4"| ''protocol:''<br/><code>{{change|0x37|0x39}}</code><br/><br/>''resource:''<br/><code>place_ghost_recipe</code>
  |rowspan="16"| Play
+
  | rowspan="4"| Play
  |rowspan="16"| Client
+
  | rowspan="4"| Client
  |colspan="2"| Item Damage
+
  | Window ID
|colspan="2"| VarInt
+
  | {{change|{{Type|Byte}}|{{Type|VarInt}}}}
| The damage value (map ID) of the map being modified
 
|-
 
|colspan="2"| Scale
 
|colspan="2"| 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)
 
|-
 
|colspan="2"| Tracking Position
 
|colspan="2"| Boolean
 
| Specifies whether the icons are shown
 
|-
 
|colspan="2"| Icon Count
 
|colspan="2"| VarInt
 
| Number of elements in the following array
 
|-
 
|rowspan="6"| Icon
 
  | {{Change|Direction And Type|Type}}
 
|rowspan="6"| Array
 
| {{Change|Byte|VarInt enum}}
 
| {{Change|0xF0 {{=}} Type, 0x0F {{=}} Direction|Type (see below)}}
 
|-
 
| X
 
| Byte
 
|
 
|-
 
| Z
 
| Byte
 
|
 
|- {{Added}}
 
| Direction
 
| Byte
 
| 0-15
 
|- {{Added}}
 
| Has Display Name
 
| Boolean
 
 
  |
 
  |
  |- {{Added}}
+
  |- {{removed}}
  | Display Name
+
  | Recipe
  | Optional [[Chat]]
+
  | {{Type|Identifier}}
| Only present if previous Boolean is true
+
  | A recipe ID.
|-
+
  |- {{added}}
  |colspan="2"| Columns
+
  | Recipe Display ID
|colspan="2"| Byte
+
  | {{Type|VarInt}}
| Number of columns updated
+
  | ID in the <code>minecraft:recipe_display</code> registry.
  |-
+
  |- {{added}}
  |colspan="2"| Rows
+
  | Recipe Data
  |colspan="2"| Optional Byte
+
  | Varies
| Only if Columns is more than 0; number of rows updated
+
  | Depends on Recipe Type; see below.
|-
 
|colspan="2"| X
 
|colspan="2"| Optional Byte
 
| Only if Columns is more than 0; x offset of the westernmost column
 
|-
 
|colspan="2"| Z
 
|colspan="2"| Optional Byte
 
| Only if Columns is more than 0; z offset of the northernmost row
 
|-
 
|colspan="2"| Length
 
|colspan="2"| Optional VarInt
 
  | Only if Columns is more than 0; length of the following array
 
  |-
 
  |colspan="2"| Data
 
  |colspan="2"| Optional Array of Unsigned Byte
 
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
 
 
  |}
 
  |}
  
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
+
''below''
  
Types are based off of rows and columns in <code>map_icons.png</code>:
+
==== Recipe Book Add ====
  
{| class="wikitable"
+
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! colspan="2"| Notes
 
  |-
 
  |-
  ! Icon type
+
  | rowspan="10"| ''protocol:''<br/><code>0x44</code><br/><br/>''resource:''<br/><code>recipe_book_add</code>
  ! Result
+
  | rowspan="10"| Play
 +
| rowspan="10"| Client
 +
| colspan="2"| Recipe Count
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 
  |-
 
  |-
  | 0
+
  | rowspan="8"| Recipes
  | White arrow (players)
+
| Recipe ID
 +
| rowspan="8"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
  | ID to assign to the recipe.
 
  |-
 
  |-
  | 1
+
  | Display ID
  | Green arrow (item frames)
+
  | {{Type|VarInt}}
 +
| ID in the <code>minecraft:recipe_display</code> registry.
 
  |-
 
  |-
  | 2
+
  | Group ID
  | Red arrow
+
| {{Type|VarInt}}
 +
  |
 
  |-
 
  |-
  | 3
+
  | Category ID
  | Blue arrow
+
  | {{Type|VarInt}}
 +
| ID in the <code>minecraft:recipe_book_category</code> registry.
 
  |-
 
  |-
  | 4
+
  | Has Ingredients
  | White cross
+
| {{Type|Boolean}}
 +
  |
 
  |-
 
  |-
  | 5
+
  | Ingredient Count
  | Red pointer
+
  | {{Type|Optional}} {{Type|VarInt}}
 +
| Number of elements in the following array. Only present if Has Ingredients is true.
 
  |-
 
  |-
  | 6
+
  | Ingredients
  | White circle (off-map players)
+
  | {{Type|Optional}} {{Type|Array}} of {{Type|ID Set}}
 +
| IDs in the <code>minecraft:item</code> registry, or an inline definition. Only present if Has Ingredients is true.
 
  |-
 
  |-
  | 7
+
  | Flags
  | Small white circle (far-off-map players)
+
  | {{Type|Byte}}
|-
+
  | 0x01: show notification; 0x02: highlight as new
| 8
 
  | Mansion
 
 
  |-
 
  |-
  | 9
+
  | colspan="2"| Replace
| Temple
+
  | colspan="2"| {{Type|Boolean}}
|- {{Added}}
+
  | Replace or Add to known recipes
| 10
 
| White Banner
 
|- {{Added}}
 
| 11
 
| Orange Banner
 
|- {{Added}}
 
| 12
 
| Magenta Banner
 
|- {{Added}}
 
| 13
 
| Light Blue Banner
 
|- {{Added}}
 
| 14
 
  | Yellow Banner
 
|- {{Added}}
 
| 15
 
| Lime Banner
 
|- {{Added}}
 
  | 16
 
| Pink Banner
 
|- {{Added}}
 
| 17
 
| Gray Banner
 
|- {{Added}}
 
| 18
 
| Light Gray Banner
 
|- {{Added}}
 
| 19
 
| Cyan Banner
 
|- {{Added}}
 
| 20
 
| Purple Banner
 
|- {{Added}}
 
| 21
 
| Blue Banner
 
|- {{Added}}
 
| 22
 
| Brown Banner
 
|- {{Added}}
 
| 23
 
| Green Banner
 
|- {{Added}}
 
| 24
 
| Red Banner
 
|- {{Added}}
 
| 25
 
| Black Banner
 
|- {{Added}}
 
| 26
 
| Treasure marker
 
 
  |}
 
  |}
  
==== Craft Recipe Response ====
+
==== Recipe Book Remove ====
  
Response to the serverbound packet ([[#Craft Recipe Request|Craft Recipe Request]]), with the same recipe ID.  Appears to be used to notify the UI.
+
{| class="wikitable" {{added}}
 
 
{| class="wikitable"
 
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 2,211: Line 1,711:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| {{Change|0x2B|0x2C}}
+
  | rowspan="2"| ''protocol:''<br/><code>0x45</code><br/><br/>''resource:''<br/><code>recipe_book_remove</code>
  |rowspan="2"| Play
+
  | rowspan="2"| Play
  |rowspan="2"| Client
+
  | rowspan="2"| Client
  | Window ID
+
  | Recipe Count
  | Byte
+
  | {{Type|VarInt}}
  |
+
  | Number of elements in the following array.
 
  |-
 
  |-
  | Recipe
+
  | Recipes
  | {{Change|VarInt|Identifer}}
+
  | {{Type|Array}} of {{Type|VarInt}}
  | A recipe ID
+
  | IDs of recipes to remove.
 
  |}
 
  |}
  
==== Face Player ====
+
==== Recipe Book Settings ====
 
 
Used to rotate the client player to face the given location or entity (for <code>/teleport [<targets>] <x> <y> <z> facing</code>).
 
  
{| class="wikitable"
+
{| class="wikitable" {{added}}
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 2,235: Line 1,733:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x30
+
  | rowspan="8"| ''protocol:''<br/><code>0x46</code><br/><br/>''resource:''<br/><code>recipe_book_settings</code>
  |rowspan="8"| Play
+
  | rowspan="8"| Play
  |rowspan="8"| Client
+
  | rowspan="8"| Client
 +
| Crafting Recipe Book Open
 +
| {{Type|Boolean}}
 +
| If true, then the crafting recipe book will be open when the player opens its inventory.
 
  |-
 
  |-
  | Feet/eyes
+
  | Crafting Recipe Book Filter Active
  | VarInt enum
+
  | {{Type|Boolean}}
  | Values are feet=0, eyes=1.  If set to eyes, aims using the head position; otherwise aims using the feet position.
+
  | If true, then the filtering option is active when the players opens its inventory.
 
  |-
 
  |-
  | Target x
+
  | Smelting Recipe Book Open
  | Double
+
  | {{Type|Boolean}}
  | x coordinate of the point to face towards
+
  | If true, then the smelting recipe book will be open when the player opens its inventory.
 
  |-
 
  |-
  | Target y
+
  | Smelting Recipe Book Filter Active
  | Double
+
  | {{Type|Boolean}}
  | y coordinate of the point to face towards
+
  | If true, then the filtering option is active when the players opens its inventory.
 
  |-
 
  |-
  | Target z
+
  | Blast Furnace Recipe Book Open
  | Double
+
  | {{Type|Boolean}}
  | z coordinate of the point to face towards
+
  | If true, then the blast furnace recipe book will be open when the player opens its inventory.
 
  |-
 
  |-
  | Is entity
+
  | Blast Furnace Recipe Book Filter Active
  | Boolean
+
  | {{Type|Boolean}}
  | If true, additional information about an entity is provided.
+
  | If true, then the filtering option is active when the players opens its inventory.
 
  |-
 
  |-
  | Entity ID
+
  | Smoker Recipe Book Open
  | Optional VarInt
+
  | {{Type|Boolean}}
  | Only if is entity is true &mdash; the entity to face towards
+
  | If true, then the smoker recipe book will be open when the player opens its inventory.
 
  |-
 
  |-
  | Entity feet/eyes
+
  | Smoker Recipe Book Filter Active
  | Optional VarInt enum
+
  | {{Type|Boolean}}
  | Whether to look at the entity's eyes or feet.  Same values and meanings as before, just for the entity's head/feet.
+
  | If true, then the filtering option is active when the players opens its inventory.
 
  |}
 
  |}
  
If the entity given by entity ID cannot be found, this packet should be treated as if is entity was false.
+
==== Respawn ====
  
==== Unlock Recipes ====
+
{{Need Info|Although the number of portal cooldown ticks is included in this packet, the whole portal usage process is still dictated entirely by the server. What kind of effect does this value have on the client, if any?}}
 +
 
 +
To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,280: Line 1,783:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="10"| {{Change|0x31|0x33}}
+
  | rowspan="13"| ''protocol:''<br/><code>{{change|0x47|0x4C}}</code><br/><br/>''resource:''<br/><code>respawn</code>
  |rowspan="10"| Play
+
  | rowspan="13"| Play
  |rowspan="10"| Client
+
  | rowspan="13"| Client
 +
| Dimension Type
 +
| {{Type|VarInt}}
 +
| The ID of type of dimension in the <code>minecraft:dimension_type</code> registry, defined by the [[Protocol#Registry_Data|Registry Data]] packet.
 
  |-
 
  |-
  | Action
+
  | Dimension Name
  | VarInt
+
  | {{Type|Identifier}}
  | 0: init, 1: add, 2: remove
+
  | Name of the dimension being spawned into.
 
  |-
 
  |-
  | Crafting Recipe Book Open
+
  | Hashed seed
  | Boolean
+
  | {{Type|Long}}
  | If true, then the crafting recipe book will be open when the player opens its inventory.
+
| First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
 +
|-
 +
| Game mode
 +
| {{Type|Unsigned Byte}}
 +
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
 +
|-
 +
| Previous Game mode
 +
| {{Type|Byte}}
 +
| -1: Undefined (null), 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. The previous game mode. Vanilla client uses this for the debug (F3 + N & F3 + F4) game mode switch. (More information needed)
 +
|-
 +
| Is Debug
 +
| {{Type|Boolean}}
 +
  | True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
 
  |-
 
  |-
  | Crafting Recipe Book Filter Active
+
  | Is Flat
  | Boolean
+
  | {{Type|Boolean}}
  | If true, then the filtering option is active when the players opens its inventory.
+
  | True if the world is a {{Minecraft Wiki|superflat}} world; flat worlds have different void fog and a horizon at y=0 instead of y=63.
 
  |-
 
  |-
  |{{Added}}| Smelting Recipe Book Open
+
| Has death location
| Boolean
+
  | {{Type|Boolean}}
  | If true, then the smelting recipe book will be open when the player opens its inventory.
+
  | If true, then the next two fields are present.
 
  |-
 
  |-
  |{{Added}}| Smelting Recipe Book Filter Active
+
| Death dimension Name
| Boolean
+
  | {{Type|Optional}} {{Type|Identifier}}
  | If true, then the filtering option is active when the players opens its inventory.
+
  | Name of the dimension the player died in.
 
  |-
 
  |-
  | Array size 1
+
  | Death location
  | VarInt
+
  | {{Type|Optional}} {{Type|Position}}
  | Number of elements in the following array
+
  | The location that the player died at.
 
  |-
 
  |-
  | Recipe IDs
+
  | Portal cooldown
  | Array of {{Change|VarInt|Identifier}}
+
  | {{Type|VarInt}}
 +
| The number of ticks until the player can use the portal again.
 +
|- {{added}}
 +
| Sea level
 +
| {{Type|VarInt}}
 
  |
 
  |
 
  |-
 
  |-
  | Array size 2
+
  | Data kept
  | Optional VarInt
+
  | {{Type|Byte}}
  | Number of elements in the following array, only present if mode is 0 (init)
+
  | Bit mask. 0x01: Keep attributes, 0x02: Keep metadata. Tells which data should be kept on the client side once the player has respawned.
 +
In the Notchian implementation, this is context dependent:
 +
* normal respawns (after death) keep no data;
 +
* exiting the end poem/credits keeps the attributes;
 +
* other dimension changes (portals or teleports) keep all data.
 +
|}
 +
 
 +
{{Warning2|Avoid changing player's dimension to same dimension they were already in unless they are dead. If you change the dimension to one they are already in, weird bugs can occur, such as the player being unable to attack other players in new world (until they die and respawn).
 +
 
 +
Before 1.16, if you must respawn a player in the same dimension without killing them, send two respawn packets, one to a different world and then another to the world you want. You do not need to complete the first respawn; it only matters that you send two packets.}}
 +
 
 +
==== Set Cursor Item ====
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Recipe IDs
+
  | 0x5A
  | Optional Array of {{Change|VarInt|Identifier}}, only present if mode is 0 (init)
+
| Play
 +
| Client
 +
| Slot Data
 +
  | {{Type|Slot}}
 
  |
 
  |
 
  |}
 
  |}
Action:
 
* 0 (init) = All the recipes in the list 2 will added to the recipe book. All the recipes in list 1 will be tagged as displayed, recipes that aren't tagged will be shown in the notification. VERIFY LIST ORDER?
 
* 1 (add) = All the recipes in the list are added and their icon will be shown in the notification.
 
* 2 (remove) = Remove all the recipes in the list. This allows them to re-displayed when they are readded.
 
  
==== Scoreboard Objective ====
+
==== Update Time ====
  
This is sent to the client when it should create a new {{Minecraft Wiki|scoreboard}} objective or remove one.
+
Time is based on ticks, where 20 ticks happen every second. There are 24000 ticks in a day, making Minecraft days exactly 20 minutes long.
  
{{Warning|Since snapshot 17w49a (1.13), [https://bugs.mojang.com/browse/MC-131382 mode 2 is broken]}}
+
The time of day is based on the timestamp modulo 24000. 0 is sunrise, 6000 is noon, 12000 is sunset, and 18000 is midnight.
 +
 
 +
The default SMP server increments the time by <code>20</code> every second.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,339: Line 1,881:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| {{Change|0x42|0x44}}
+
  | rowspan="3"| ''protocol:''<br/><code>{{change|0x64|0x6B}}</code><br/><br/>''resource:''<br/><code>set_time</code>
  |rowspan="4"| Play
+
  | rowspan="3"| Play
  |rowspan="4"| Client
+
  | rowspan="3"| Client
  | Objective Name
+
  | World Age
  | String (16)
+
  | {{Type|Long}}
  | An unique name for the objective
+
  | In ticks; not changed by server commands.
 
  |-
 
  |-
  | Mode
+
  | Time of day
  | Byte
+
  | {{Type|Long}}
  | 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
+
  | The world (or region) time, in ticks. {{change|If negative the sun will stop moving at the Math.abs of the time.|}}
 +
|- {{added}}
 +
| Time of day increasing
 +
| {{Type|Boolean}}
 +
| If true, the client should automatically advance the time of day according to its ticking rate.
 +
|}
 +
 
 +
==== Set Player Inventory Slot ====
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Objective Value
+
  | rowspan="2"| ''protocol:''<br/><code>0x66</code><br/><br/>''resource:''<br/><code>set_player_inventory</code>
  | Optional String (32)
+
  | rowspan="2"| Play
  | Only if mode is 0 or 2. The text to be displayed for the score
+
  | rowspan="2"| Client
 +
| Slot
 +
| {{Type|VarInt}}
 +
|
 
  |-
 
  |-
  | Type
+
  | Slot Data
  | Optional {{change|String|VarInt Enum}}
+
  | {{Type|Slot}}
  | Only if mode is 0 or 2. {{change|“integer” or “hearts”|0 = "integer", 1 = "hearts"}}
+
  |
 
  |}
 
  |}
  
==== Teams ====
+
==== Synchronize Vehicle Position ====
  
Creates and updates teams.
+
Teleports the entity on the client without changing the reference point of movement deltas in future [[#Update Entity Position|Update Entity Position]] packets. Seems to be used to make relative adjustments to vehicle positions; more information needed.
  
{| class="wikitable"
+
{| class="wikitable" {{added}}
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="27"| {{Change|0x44|0x46}}
+
  | rowspan="11"| ''protocol:''<br/><code>0x77</code><br/><br/>''resource:''<br/><code>teleport_entity</code>
  |rowspan="27"| Play
+
  | rowspan="11"| Play
  |rowspan="27"| Client
+
  | rowspan="11"| Client
  |colspan="2"| Team Name
+
  | Entity ID
  | String (16)
+
  | {{Type|VarInt}}
  | A unique name for the team. (Shared with scoreboard).
+
  |
 
  |-
 
  |-
  |colspan="2"| Mode
+
  | X
  | Byte
+
  | {{Type|Double}}
  | Determines the layout of the remaining packet
+
  |
 
  |-
 
  |-
  |rowspan="11"| 0: create team
+
  | Y
| Team Display Name
+
  | {{Type|Double}}
| String (32)
+
  |
|
 
  |- {{Removed}}
 
| Team Prefix
 
| String (16)
 
| Displayed before the names of players that are part of this team
 
|- {{Removed}}
 
  | Team Suffix
 
| String (16)
 
| Displayed after the names of players that are part of this team
 
 
  |-
 
  |-
  | Friendly Flags
+
  | Z
  | Byte
+
  | {{Type|Double}}
  | Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team
+
  |
 
  |-
 
  |-
  | Name Tag Visibility
+
  | Velocity X
  | String Enum (32)
+
  | {{Type|Double}}
  | <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
+
  |
 
  |-
 
  |-
  | Collision Rule
+
  | Velocity Y
  | String Enum (32)
+
  | {{Type|Double}}
  | <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
+
  |
 
  |-
 
  |-
  | {{change|Color|Formatting}}
+
  | Velocity Z
  | {{Change|Byte|VarInt enum}}
+
  | {{Type|Double}}
  | {{change|For colors, the same [[Chat]] colors (0-15). -1 indicates RESET/no color.|See below for more info.}}
+
  |
|- {{Added}}
 
| Team Prefix
 
| Chat
 
| Displayed before the names of players that are part of this team
 
|- {{Added}}
 
| Team Suffix
 
| Chat
 
| Displayed after the names of players that are part of this team
 
 
  |-
 
  |-
  | Entity Count
+
  | Yaw
  | VarInt
+
  | {{Type|Float}}
  | Number of elements in the following array
+
  | Rotation on the Y axis, in degrees.
 
  |-
 
  |-
  | Entities
+
  | Pitch
  | Array of String (40)
+
  | {{Type|Float}}
  | Identifiers for the entities in this teamFor players, this is their username; for other entities, it is their UUID.
+
  | Rotation on the Y axis, in degrees.
 +
  |- {{added}}
 +
| Flags
 +
| {{Type|Teleport Flags}}
 +
|
 
  |-
 
  |-
  | 1: remove team
+
  | On Ground
| ''no fields''
+
  | {{Type|Boolean}}
| ''no fields''
+
  |
|
 
|-
 
|rowspan="9"| 2: update team info
 
| Team Display Name
 
| String (32)
 
|
 
|- {{Removed}}
 
| Team Prefix
 
| String (16)
 
| Displayed before the names of entities that are part of this team
 
|- {{Removed}}
 
| Team Suffix
 
| String (16)
 
| Displayed after the names of entities that are part of this team
 
|-
 
| Friendly Flags
 
| Byte
 
| Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible entities on same team
 
|-
 
| Name Tag Visibility
 
| String Enum (32)
 
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
 
|-
 
| Collision Rule
 
| String Enum (32)
 
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 
|-
 
| {{change|Color|Formatting}}
 
| {{Change|Byte|VarInt enum}}
 
  | {{change|For colors, the same [[Chat]] colors (0-15). -1 indicates RESET/no color.|See below for more info.}}
 
  |- {{Added}}
 
| Team Prefix
 
| Chat
 
| Displayed before the names of players that are part of this team
 
|- {{Added}}
 
| Team Suffix
 
| Chat
 
| Displayed after the names of players that are part of this team
 
|-
 
|rowspan="2"| 3: add players to team
 
| Entity Count
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Entities
 
| Array of String (40)
 
| Identifiers for the entities added.  For players, this is their username; for other entities, it is their UUID.
 
|-
 
|rowspan="2"| 4: remove players from team
 
| Entity Count
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Entities
 
| Array of String (40)
 
| Identifiers for the entities removed.  For players, this is their username; for other entities, it is their UUID.
 
 
  |}
 
  |}
  
Formatting: The formatting of a team defines how the names of the team members are visualized. The following table lists all the possible formattings.
+
=== Serverbound ===
  
{| class="wikitable"
+
==== Bundle Item Selected ====
  ! ID
+
 
  ! Formatting
+
{| class="wikitable" {{added}}
 +
  ! Packet ID
 +
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0-15
+
  | rowspan="2"| ''protocol:''<br/><code>0x02</code><br/><br/>''resource:''<br/><code>bundle_item_selected</code>
  | Color formatting, same values as [[Chat]] colors.
+
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Slot of Bundle
 +
| {{Type|VarInt}}
 +
  |
 
  |-
 
  |-
  | 16
+
  | Slot in Bundle
  | Obfuscated
+
  | {{Type|VarInt}}
|-
+
  |
| 17
 
| Bold
 
|-
 
| 18
 
| Strikethrough
 
|-
 
| 19
 
| Underlined
 
|-
 
| 20
 
| Italic
 
|-
 
| 21
 
  | Reset
 
 
  |}
 
  |}
  
==== Stop Sound ====
+
==== Client Tick End ====
  
{| class="wikitable"
+
{| class="wikitable" {{added}}
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 2,526: Line 2,013:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x4B
+
  | ''protocol:''<br/><code>0x0B</code><br/><br/>''resource:''<br/><code>client_tick_end</code>
  |rowspan="7"| Play
+
| Play
  |rowspan="7"| Client
+
  | Server
| Flags
+
  | colspan="3"| ''no fields''
| Byte
 
| Controls which fields are present.
 
|-
 
| Source
 
| Optional VarInt enum
 
| Only if flags is 3 or 1 (bit mask 0x1).  See below.  If not present, then sounds from all sources are cleared.
 
|-
 
| Sound
 
| Optional Identifier
 
| Only if flags is 2 or 3 (bit mask 0x2).  A sound effect name, see [[#Named Sound Effect|Named Sound Effect]].  If not present, then all sounds are cleared.
 
 
  |}
 
  |}
  
Categories:
+
==== Click Container ====
 +
 
 +
This packet is sent by the client when the player clicks on a slot in a window.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Name !! Value
+
  ! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | master || 0
+
  | rowspan="9"| ''protocol:''<br/><code>{{change|0x0E|0x10}}</code><br/><br/>''resource:''<br/><code>container_click</code>
 +
| rowspan="9"| Play
 +
| rowspan="9"| Server
 +
| colspan="2"| Window ID
 +
| colspan="2"| {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
 +
| colspan="2"| The ID of the window which was clicked. 0 for player inventory. The server ignores any packets targeting a Window ID other than the current one, including ignoring 0 when any other window is open.
 
  |-
 
  |-
  | music || 1
+
  | colspan="2"| State ID
 +
| colspan="2"| {{Type|VarInt}}
 +
| colspan="2"| The last received State ID from either a [[#Set Container Slot|Set Container Slot]] or a [[#Set Container Content|Set Container Content]] packet.
 
  |-
 
  |-
  | record || 2
+
  | colspan="2"| Slot
 +
| colspan="2"| {{Type|Short}}
 +
| colspan="2"| The clicked slot number, see below.
 
  |-
 
  |-
  | weather || 3
+
  | colspan="2"| Button
 +
| colspan="2"| {{Type|Byte}}
 +
| colspan="2"| The button used in the click, see below.
 
  |-
 
  |-
  | block || 4
+
  | colspan="2"| Mode
 +
| colspan="2"| {{Type|VarInt}} {{Type|Enum}}
 +
| colspan="2"| Inventory operation mode, see below.
 
  |-
 
  |-
  | hostile || 5
+
  | colspan="2"| Length of the array
 +
| colspan="2"| {{Type|VarInt}}
 +
| colspan="2"| Maximum value for Notchian server is 128 slots.
 
  |-
 
  |-
  | neutral || 6
+
  | rowspan="2"| Array of changed slots
 +
| Slot number
 +
| rowspan="2"| {{Type|Array}} (128)
 +
| {{Type|Short}}
 +
|
 
  |-
 
  |-
  | player || 7
+
  | Slot data
 +
| {{Type|Slot}}
 +
| New data for this slot, in the client's opinion; see below.
 
  |-
 
  |-
  | ambient || 8
+
  | colspan="2"| Carried item
  |-
+
  | colspan="2"| [[Slot Data|Slot]]
  | voice || 9
+
  | colspan="2"| Item carried by the cursor. Has to be empty (item ID = -1) for drop mode, otherwise nothing will happen.
 
  |}
 
  |}
  
==== Declare Recipes ====
+
See [[Inventory]] for further information about how slots are indexed.
  
{| class="wikitable"
+
After performing the action, the server compares the results to the slot change information included in the packet, as applied on top of the server's view of the container's state prior to the action. For any slots that do not match, it sends [[#Set Container Slot|Set Container Slot]] packets containing the correct results. If State ID does not match the last ID sent by the server, it will instead send a full [[#Set Container Content|Set Container Content]] to resynchronize the client.
! Packet ID
+
 
! State
+
When right-clicking on a stack of items, half the stack will be picked up and half left in the slot. If the stack is an odd number, the half left in the slot will be smaller of the amounts.
! Bound To
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
|-
 
|rowspan="4"| 0x53
 
|rowspan="4"| Play
 
|rowspan="4"| Client
 
|colspan="2"| Num Recipes
 
|colspan="2"| VarInt
 
| Number of elements in the following array
 
|-
 
|rowspan="3"| Recipe
 
| Recipe ID
 
|rowspan="3"| Array
 
| Identifier
 
|
 
|-
 
| Type
 
| String
 
| The recipe type, see below
 
|-
 
| Data
 
| Optional, varies
 
| Additional data for the recipe. For some types, there will be no data.
 
|}
 
  
Recipe types:
+
The distinct type of click performed by the client is determined by the combination of the Mode and Button fields.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Type
+
  ! Mode
  ! Description
+
  ! Button
  ! Data
+
  ! Slot
 +
! Trigger
 
  |-
 
  |-
  | <code>crafting_shapeless</code>
+
  ! rowspan="4"| 0
| Shapeless crafting recipe.  All items in the ingredient list must be present, but in any order/slot.
+
| 0
| As follows:
+
| Normal
  {| class="wikitable"
+
  | Left mouse click
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Group
 
    | String
 
    | Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
 
    |-
 
    | Ingredient count
 
    | VarInt
 
    | Number of elements in the following array
 
    |-
 
    | Ingredients
 
    | Array of Ingredient
 
    |
 
    |-
 
    | Result
 
    | [[Slot]]
 
    |
 
    |}
 
 
  |-
 
  |-
  | <code>crafting_shaped</code>
+
  | 1
  | Shaped crafting recipe.  All items must be present in the same pattern (which may be flipped horizontally or translated)
+
  | Normal
| As follows:
+
  | Right mouse click
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Width
 
    | VarInt
 
    |
 
    |-
 
    | Height
 
    | VarInt
 
    |
 
    |-
 
    | Group
 
    | String
 
    | Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
 
    |-
 
    | Ingredients
 
    | Array of Ingredient
 
    | Length is width * height.  Indexed by x + (y * width).
 
    |-
 
    | Result
 
    | [[Slot]]
 
    |
 
    |}
 
 
  |-
 
  |-
  | <code>crafting_special_armordye</code>
+
  | 0
  | Recipe for dying leather armor
+
  | -999
  | None
+
  | Left click outside inventory (drop cursor stack)
 
  |-
 
  |-
  | <code>crafting_special_bookcloning</code>
+
  | 1
  | Recipe for copying contents of written books
+
  | -999
  | None
+
  | Right click outside inventory (drop cursor single item)
 
  |-
 
  |-
  | <code>crafting_special_mapcloning</code>
+
  ! rowspan="2"| 1
  | Recipe for copying maps
+
  | 0
  | None
+
  | Normal
 +
| Shift + left mouse click
 
  |-
 
  |-
  | <code>crafting_special_mapextending</code>
+
  | 1
  | Recipe for adding paper to maps
+
  | Normal
  | None
+
  | Shift + right mouse click ''(identical behavior)''
 
  |-
 
  |-
  | <code>crafting_special_firework_rocket</code>
+
  ! rowspan="7"| 2
  | Recipe for making firework rockets
+
  | 0
  | None
+
  | Normal
 +
| Number key 1
 
  |-
 
  |-
  | <code>crafting_special_firework_star</code>
+
  | 1
  | Recipe for making firework stars
+
  | Normal
  | None
+
  | Number key 2
 
  |-
 
  |-
  | <code>crafting_special_firework_star_fade</code>
+
  | 2
  | Recipe for making firework stars fade between multiple colors
+
  | Normal
  | None
+
  | Number key 3
 
  |-
 
  |-
  | <code>crafting_special_repairitem</code>
+
  |
  | Recipe for repairing items via crafting
+
  |
  | None
+
  |
 
  |-
 
  |-
  | <code>crafting_special_tippedarrow</code>
+
  | 8
  | Recipe for crafting tipped arrows
+
  | Normal
  | None
+
  | Number key 9
 
  |-
 
  |-
  | <code>crafting_special_bannerduplicate</code>
+
  |
  | Recipe for copying banner patterns
+
  |
  | None
+
  | Button is used as the slot index (impossible in vanilla clients)
 
  |-
 
  |-
  | <code>crafting_special_banneraddpattern</code>
+
  | 40
  | Recipe for adding patterns to banners
+
  | Normal
  | None
+
  | Offhand swap key F
 
  |-
 
  |-
  | <code>crafting_special_shielddecoration</code>
+
! 3
  | Recipe for applying a banner's pattern to a shield
+
  | 2
  | None
+
  | Normal
 +
  | Middle click, only defined for creative players in non-player inventories.
 
  |-
 
  |-
  | <code>crafting_special_shulkerboxcoloring</code>
+
  ! rowspan="2"| 4
  | Recipe for recoloring a shulker box
+
  | 0
  | None
+
  | Normal*
 +
| Drop key (Q) (* Clicked item is always empty)
 
  |-
 
  |-
  | <code>smelting</code>
+
  | 1
  | Smelting recipe
+
  | Normal*
  | As follows:
+
  | Control + Drop key (Q) (* Clicked item is always empty)
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Group
 
    | String
 
    | Used to group similar recipes together in the recipe book.
 
    |-
 
    | Ingredient
 
    | Ingredient
 
    |
 
    |-
 
    | Result
 
    | [[Slot]]
 
    |
 
    |-
 
    | Experience
 
    | Float
 
    |
 
    |-
 
    | Cooking time
 
    | VarInt
 
    |
 
    |}
 
|}
 
 
 
Ingredient is defined as:
 
 
 
{| class="wikitable"
 
! Name
 
! Type
 
! Description
 
 
  |-
 
  |-
  | Count
+
  ! rowspan="9"| 5
  | VarInt
+
  | 0
  | Number of elements in the following array
+
  | -999
 +
| Starting left mouse drag
 
  |-
 
  |-
  | Items
+
  | 4
  | Array of [[Slot]]
+
  | -999
  | Any item in this array may be used for the recipe.  The count of each item should be 1.
+
  | Starting right mouse drag
|}
 
 
 
==== Tags ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x54
+
  | 8
|rowspan="3"| Play
+
  | -999
|rowspan="3"| Client
+
  | Starting middle mouse drag, only defined for creative players in non-player inventories.
| Block Tags
 
  | (See below)
 
  | IDs are block IDs
 
 
  |-
 
  |-
  | Item Tags
+
  | 1
  | (See below)
+
  | Normal
  | IDs are item IDs
+
  | Add slot for left-mouse drag
 
  |-
 
  |-
  | Fluid Tags
+
  | 5
  | (See below)
+
  | Normal
  | IDs are fluid IDs
+
  | Add slot for right-mouse drag
|}
 
 
 
Tags look like:
 
 
 
{| class="wikitable"
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
 
  |-
 
  |-
  |colspan="2"| Length
+
  | 9
  |colspan="2"| VarInt
+
  | Normal
  | Number of elements in the following array
+
  | Add slot for middle-mouse drag, only defined for creative players in non-player inventories.
 
  |-
 
  |-
  |rowspan="3"| Tags
+
  | 2
| Tag name
+
  | -999
|rowspan="3"| Array
+
  | Ending left mouse drag
  | Identifier
 
  |
 
 
  |-
 
  |-
  | Count
+
  | 6
  | VarInt
+
  | -999
  | Number of elements in the following array
+
  | Ending right mouse drag
 
  |-
 
  |-
  | Entries
+
  | 10
  | Array of VarInt
+
  | -999
  | Numeric ID of the block/item.
+
  | Ending middle mouse drag, only defined for creative players in non-player inventories.
|}
 
 
 
=== Serverbound ===
 
 
 
==== Tab-Complete (serverbound) ====
 
 
 
Sent when the client needs to tab-complete a <code>minecraft:ask_server</code> suggestion type.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| {{Change|0x01|0x04}}
+
  ! rowspan="2"| 6
  |rowspan="5"| Play
+
  | 0
  |rowspan="5"| Server
+
  | Normal
|{{Added}}| Transaction Id
+
  | Double click
  |{{Added}}| VarInt
 
|{{Added}}| The id received in the tab completion request packet, must match or the client will ignore this packet.  Client generates this and increments it each time it sends another tab completion that doesn't get a response.
 
 
  |-
 
  |-
  | Text
+
  | 1
  | String ({{change|32767|256}})
+
  | Normal
  | All text behind the cursor without the <code>/</code> (e.g. to the left of the cursor in left-to-right languages like English)
+
  | Pickup all but check items in reverse order (impossible in vanilla clients)
|- {{Removed}}
 
| Assume Command
 
| Boolean
 
| If true, the server will parse Text as a command even if it doesn't start with a <code>/</code>. Used in the command block GUI.
 
|- {{Removed}}
 
| Has Position
 
| Boolean
 
|
 
|- {{Removed}}
 
| Looked At Block
 
| Optional Position
 
| The position of the block being looked at. Only sent if Has Position is true.
 
 
  |}
 
  |}
  
==== Plugin Message (serverbound) ====
+
Starting from version 1.5, “painting mode” is available for use in inventory windows. It is done by picking up stack of something (more than 1 item), then holding mouse button (left, right or middle) and dragging held stack over empty (or same type in case of right button) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):
  
{{Main|Plugin channels}}
+
# packet with mode 5, slot -999, button (0 for left | 4 for right);
 +
# packet for every slot painted on, mode is still 5, button (1 | 5);
 +
# packet with mode 5, slot -999, button (2 | 6);
  
Mods and plugins can use this to send their data. Minecraft itself uses a number of [[plugin channel]]s. These internal channels are prefixed with <code>MC|</code>.
+
If any of the painting packets other than the “progress” ones are sent out of order (for example, a start, some slots, then another start; or a left-click in the middle) the painting status will be reset.
  
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
+
==== Close Container ====
  
Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.
+
This packet is sent by the client when closing a window.
 +
 
 +
Notchian clients send a Close Window packet with Window ID 0 to close their inventory even though there is never an [[#Open Screen|Open Screen]] packet for the inventory.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,867: Line 2,225:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x09
+
  | ''protocol:''<br/><code>{{change|0x0F|0x11}}</code><br/><br/>''resource:''<br/><code>container_close</code>
  |rowspan="2"| Play
+
  | Play
  |rowspan="2"| Server
+
  | Server
  | Channel
+
  | Window ID
  | {{Change|String (20)|Identifier}}
+
  | {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
| Name of the [[plugin channel]] used to send the data
+
  | This is the ID of the window that was closed. 0 for player inventory.
|-
 
  | Data
 
| Byte Array
 
| Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
 
 
  |}
 
  |}
  
 
==== Edit Book ====
 
==== Edit Book ====
  
{| class="wikitable" {{Added}}
+
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 2,889: Line 2,243:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0A
+
  | rowspan="5"| ''protocol:''<br/><code>{{change|0x14|0x16}}</code><br/><br/>''resource:''<br/><code>edit_book</code>
  |rowspan="2"| Play
+
  | rowspan="5"| Play
  |rowspan="2"| Server
+
  | rowspan="5"| Server
  | New book
+
  | Slot
  | [[Slot]]
+
| {{Type|VarInt}}
  |
+
| The hotbar slot where the written book is located
 +
|-
 +
| Count
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array. Maximum array size is {{change|200|100}}.
 +
  |-
 +
| Entries
 +
| {{Type|Array}} ({{change|200|100}}) of {{Type|String}} ({{change|8192|1024}})
 +
| Text from each page. Maximum string length is {{change|8192|1024}} chars.
 +
|-
 +
| Has title
 +
| {{Type|Boolean}}
 +
  | If true, the next field is present. true if book is being signed, false if book is being edited.
 
  |-
 
  |-
  | Is signing
+
  | Title
  | Boolean
+
  | {{Type|Optional}} {{Type|String}} ({{change|128|32}})
  | True if the player is signing the book; false if the player is saving a draft.
+
  | Title of book.
 
  |}
 
  |}
  
When editing a draft, the [[NBT]] section of the Slot contains this:
+
==== Set Player Position ====
 
 
<pre>
 
TAG_Compound(<nowiki>''</nowiki>): 1 entry
 
{
 
  TAG_List('pages'): 2 entries
 
  {
 
    TAG_String(0): 'Something on Page 1'
 
    TAG_String(1): 'Something on Page 2'
 
  }
 
}
 
</pre>
 
 
 
When signing the book, it instead looks like this:
 
 
 
<pre>
 
TAG_Compound(<nowiki>''</nowiki>): 3 entires
 
{
 
  TAG_String('author'): 'Steve'
 
  TAG_String('title'): 'A Wonderful Book'
 
  TAG_List('pages'): 2 entries
 
  {
 
    TAG_String(0): 'Something on Page 1'
 
    TAG_String(1): 'Something on Page 2'
 
  }
 
}
 
</pre>
 
 
 
  
==== Pick Item ====
+
Updates the player's XYZ position on the server.
  
Used to swap out an empty space on the hotbar with the item in the given inventory slot. The Notchain client uses this for pick block functionality (middle click) to retrieve items from the inventory.
+
If the player is in a vehicle, the position is ignored (but in case of [[#Set Player Position and Rotation|Set Player Position and Rotation]], the rotation is still used as normal). No validation steps other than value range clamping are performed in this case.
  
 +
If the player is sleeping, the position (or rotation) is not changed, and a [[#Synchronize Player Position|Synchronize Player Position]] is sent if the received position deviated from the server's view by more than a meter.
  
{| class="wikitable" {{Added}}
+
The Notchian server silently clamps the x and z coordinates between -30,000,000 and 30,000,000, and the y coordinate between -20,000,000 and 20,000,000. A similar condition has historically caused a kick for "Illegal position"; this is no longer the case. However, infinite or NaN coordinates (or angles) still result in a kick for <code>multiplayer.disconnect.invalid_player_movement</code>.
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="1"| 0x13
 
|rowspan="1"| Play
 
|rowspan="1"| Server
 
| Slot to use
 
| VarInt
 
| See [[Inventory]]
 
|}
 
  
The server will first search the player's hotbar for an empty slot, starting from the current slot and looping around to the slot before it. If there are no empty slots, it will start a second search from the current slot and find the first slot that does not contain an enchanted item. If there still are no slots that meet that criteria, then the server will use the currently selected slot.
+
As of 1.20.6, checking for moving too fast is achieved like this (sic):
  
After finding the appropriate slot, the server swaps the items and then send 3 packets:
+
* Each server tick, the player's current position is stored.
 +
* When the player moves, the offset from the stored position to the requested position is computed (&Delta;x, &Delta;y, &Delta;z).
 +
* The requested movement distance squared is computed as &Delta;x&sup2; + &Delta;y&sup2; + &Delta;z&sup2;.
 +
* The baseline expected movement distance squared is computed based on  the player's server-side velocity as Vx&sup2; + Vy&sup2; + Vz&sup2;. The player's server-side velocity is a somewhat ill-defined quantity that includes among other things gravity, jump velocity and knockback, but ''not'' regular horizontal movement. A proper description would bring much of Minecraft's physics engine with it. It is accessible as the <code>Motion</code> NBT tag on the player entity.
 +
* The maximum permitted movement distance squared is computed as 100 (300 if the player is using an elytra), multiplied by the number of movement packets received since the last tick, including this one, unless that value is greater than 5, in which case no multiplier is applied.
 +
* If the requested movement distance squared minus the baseline distance squared is more than the maximum squared, the player is moving too fast.
  
* [[Protocol#Set slot|Set Slot]], with window ID set to -2 and slot set to the newly chosen slot and the item set to the item that is now in that slot (which was previously at the slot the client requested)
+
If the player is moving too fast, it is logged that "<player> moved too quickly! " followed by the change in x, y, and z, and the player is teleported back to their current (before this packet) server-side position.
* Set Slot, with window ID set to -2 and slot set to the slot the player requested, with the item that is now in that slot and was previously on the hotbar slot
 
* [[Protocol#Held_Item_Change_.28clientbound.29|Held Item Change]], with the slot set to the newly chosen slot.
 
  
 +
Checking for block collisions is achieved like this:
  
==== Craft Recipe Request ====
+
* A temporary collision-checked move of the player is attempted from its current position to the requested one.
 +
* The offset from the resulting position to the requested position is computed. If the absolute value of the offset on the y axis is less than 0.5, it (only the y component) is rounded down to 0.
 +
* If the magnitude of the offset is greater than 0.25 and the player isn't in creative or spectator mode, it is logged that "<player> moved wrongly!", and the player is teleported back to their current (before this packet) server-side position.
 +
* In addition, if the player's hitbox stationary at the requested position would intersect with a block, and they aren't in spectator mode, they are teleported back without a log message.
  
A replacement for [[Protocol#Prepare Crafting Grid|Prepare Crafting Grid]].  It appears to behave more or less the same, but the client does not specify where to move the items.
+
Checking for illegal flight is achieved like this:
  
This packet is sent when a player clicks a recipe in the crafting book that is craftable (white border).
+
* When a movement packet is received, a flag indicating whether or not the player is floating mid-air is updated. The flag is set if the move test described above detected no collision below the player ''and'' the y component of the offset from the player's current position to the requested one is greater than -0.5, unless any of various conditions permitting flight (creative mode, elytra, levitation effect, etc., but not jumping) are met.
 +
* Each server tick, it is checked if the flag has been set for more than 80 consecutive ticks. If so, and the player isn't currently sleeping, dead or riding a vehicle, they are kicked for <code>multiplayer.disconnect.flying</code>.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,974: Line 2,308:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| {{Change|0x12|0x14}}
+
  | rowspan="5"| ''protocol:''<br/><code>{{change|0x1A|0x1C}}</code><br/><br/>''resource:''<br/><code>move_player_pos</code>
  |rowspan="3"| Play
+
  | rowspan="5"| Play
  |rowspan="3"| Server
+
  | rowspan="5"| Server
  | Window ID
+
  | X
  | Byte
+
  | {{Type|Double}}
  |
+
  | Absolute position.
 
  |-
 
  |-
  | Recipe
+
  | Feet Y
  | {{Change|VarInt|Identifier}}
+
  | {{Type|Double}}
  | A recipe ID
+
  | Absolute feet position, normally Head Y - 1.62.
 
  |-
 
  |-
  | Make all
+
  | Z
  | Boolean
+
  | {{Type|Double}}
  | Affects the amount of items processed; true if shift is down when clicked
+
| Absolute position.
 +
|- {{removed}}
 +
| On Ground
 +
| {{Type|Boolean}}
 +
  | True if the client is on the ground, false otherwise.
 +
|- {{added}}
 +
| Flags
 +
| {{Type|Byte}}
 +
| Bit field: 0x01: on ground, 0x02: pushing against wall.
 
  |}
 
  |}
  
==== Recipe Book Data ====
+
==== Set Player Position and Rotation ====
(previously known as Crafting Book Data)
+
 
 +
A combination of [[#Set Player Rotation|Move Player Rotation]] and [[#Set Player Position|Move Player Position]].
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,997: Line 2,340:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| {{Change|0x17|0x19}}
+
  | rowspan="7"| ''protocol:''<br/><code>{{change|0x1B|0x1D}}</code><br/><br/>''resource:''<br/><code>move_player_pos_rot</code>
  |rowspan="7"| Play
+
  | rowspan="7"| Play
  |rowspan="7"| Server
+
  | rowspan="7"| Server
  |colspan="2"| Type
+
  | X
| VarInt
+
| {{Type|Double}}
  | Determines the format of the rest of the packet
+
  | Absolute position.
 
  |-
 
  |-
  ! Type
+
  | Feet Y
  ! Field Name
+
  | {{Type|Double}}
!
+
  | Absolute feet position, normally Head Y - 1.62.
  !
 
 
  |-
 
  |-
  | 0: Displayed Recipe
+
  | Z
| Recipe ID
+
  | {{Type|Double}}
  | {{Change|Int|Identifer}}
+
  | Absolute position.
  | A recipe ID
 
 
  |-
 
  |-
  |rowspan="4"| 1: Recipe Book States
+
  | Yaw
  | Crafting Recipe Book Open
+
  | {{Type|Float}}
| Boolean
+
  | Absolute rotation on the X Axis, in degrees.
  | Whether the player has the crafting recipe book currently opened/active.
 
 
  |-
 
  |-
  | Crafting Recipe Filter Active
+
  | Pitch
  | Boolean
+
  | {{Type|Float}}
  | Whether the player has the crafting recipe book filter option currently active.
+
  | Absolute rotation on the Y Axis, in degrees.
  |- {{Added}}
+
  |- {{removed}}
  | Smelting Recipe Book Open
+
  | On Ground
  | Boolean
+
  | {{Type|Boolean}}
  | Whether the player has the smelting recipe book currently opened/active.
+
  | True if the client is on the ground, false otherwise.
  |- {{Added}}
+
  |- {{added}}
  | Smelting Recipe Filter Active
+
  | Flags
  | Boolean
+
  | {{Type|Byte}}
  | Whether the player has the smelting recipe book filter option currently active.
+
  | Bit field: 0x01: on ground, 0x02: pushing against wall.
 
  |}
 
  |}
  
The Recipe Book Status type is sent when one of the states changes.
+
==== Set Player Rotation ====
 +
[[File:Minecraft-trig-yaw.png|thumb|The unit circle for yaw]]
 +
[[File:Yaw.png|thumb|The unit circle of yaw, redrawn]]
  
 +
Updates the direction the player is looking in.
  
==== Name Item ====
+
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.
  
Sent as a player is renaming an item in an anvil (each keypress in the anvil UI sends a new {{Change|<code>MC{{!}}ItemName</code>|Name Item}} packet).  If the new name is empty, then the item loses its custom name (this is different from setting the custom name to the normal name of the item).  The item name may be no longer than 35 characters long, and if it is longer than that, then the rename is silently ignored.
+
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
  
{| class="wikitable" {{Added}}
+
The yaw and pitch of player (in degrees), standing at point (x0, y0, z0) and looking towards point (x, y, z) can be calculated with:
! Packet ID
+
 
  ! State
+
  dx = x-x0
  ! Bound To
+
  dy = y-y0
  ! Field Name
+
  dz = z-z0
  ! Field Type
+
  r = sqrt( dx*dx + dy*dy + dz*dz )
  ! Notes
+
  yaw = -atan2(dx,dz)/PI*180
|-
+
  if yaw < 0 then
  |rowspan="1"| 0x1A
+
    yaw = 360 + yaw
|rowspan="1"| Play
+
  pitch = -arcsin(dy/r)/PI*180
  |rowspan="1"| Server
 
| Item name
 
| String (32767)
 
| The new name of the item
 
|}
 
  
==== Select Trade ====
+
You can get a unit vector from a given yaw/pitch via:
  
When a player selects a specific trade offered by a villager NPC.
+
x = -cos(pitch) * sin(yaw)
 +
y = -sin(pitch)
 +
z =  cos(pitch) * cos(yaw)
  
{| class="wikitable" {{Added}}
+
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 3,071: Line 2,411:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x1D
+
  | rowspan="4"| ''protocol:''<br/><code>{{change|0x1C|0x1E}}</code><br/><br/>''resource:''<br/><code>move_player_rot</code>
  |rowspan="1"| Play
+
  | rowspan="4"| Play
  |rowspan="1"| Server
+
  | rowspan="4"| Server
  | Selected slot
+
  | Yaw
  | {{Change|Integer|VarInt}}
+
  | {{Type|Float}}
  | The selected slot int the players current (trading) inventory. (Was a full Integer for the plugin message)
+
| Absolute rotation on the X Axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
  | Absolute rotation on the Y Axis, in degrees.
 +
|- {{removed}}
 +
| On Ground
 +
| {{Type|Boolean}}
 +
| True if the client is on the ground, false otherwise.
 +
|- {{added}}
 +
| Flags
 +
| {{Type|Byte}}
 +
| Bit field: 0x01: on ground, 0x02: pushing against wall.
 
  |}
 
  |}
 +
{{Anchor|Set Player Movement Flags}}
 +
==== Set Player {{change|On Ground|Movement Flags}} ====
 +
 +
This packet as well as [[#Set Player Position|Set Player Position]], [[#Set Player Rotation|Set Player Rotation]], and [[#Set Player Position and Rotation|Set Player Position and Rotation]] are called the “serverbound movement packets”. Vanilla clients will send Move Player Position once every 20 ticks even for a stationary player.
  
==== Set Beacon Effect ====
+
This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).
  
Changes the effect of the current beacon.
+
When dropping from sufficient height, fall damage is applied when this state goes from false to true. The amount of damage applied is based on the point where it last changed from true to false. Note that there are several movement related packets containing this state.
  
{| class="wikitable" {{Added}}
+
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 3,091: Line 2,447:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x1E
+
  | rowspan="2"| ''protocol:''<br/><code>{{change|0x1D|0x1F}}</code><br/><br/>''resource:''<br/><code>move_player_status_only</code>
  |rowspan="2"| Play
+
  | rowspan="2"| Play
  |rowspan="2"| Server
+
  | rowspan="2"| Server
  | Primary Effect
+
  | {{removed}} | On Ground
  | {{Change|Integer|VarInt}}
+
  | {{removed}} | {{Type|Boolean}}
  | A [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]. (Was a full Integer for the plugin message)
+
  | {{removed}} | True if the client is on the ground, false otherwise.
  |-
+
  |- {{added}}
  | Secondary Effect
+
  | Flags
  | {{Change|Integer|VarInt}}
+
  | {{Type|Byte}}
  | A [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]. (Was a full Integer for the plugin message)
+
  | Bit field: 0x01: on ground, 0x02: pushing against wall.
 
  |}
 
  |}
  
==== Update Command Block ====
+
==== Place Recipe ====
 +
 
 +
This packet is sent when a player clicks a recipe in the crafting book that is craftable (white border).
  
{| class="wikitable" {{Added}}
+
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 3,113: Line 2,471:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="11"| 0x20
+
  | rowspan="3"| ''protocol:''<br/><code>{{change|0x22|0x24}}</code><br/><br/>''resource:''<br/><code>place_recipe</code>
  |rowspan="11"| Play
+
  | rowspan="3"| Play
  |rowspan="11"| Server
+
  | rowspan="3"| Server
  |- {{Removed}}
+
  | Window ID
  | X || Int ||
+
  | {{Type|Byte}}
|- {{Removed}}
 
| Y || Int ||
 
|- {{Removed}}
 
| Z || Int ||
 
|-
 
| Location
 
| Position
 
 
  |
 
  |
 
  |-
 
  |-
  | Command
+
  | Recipe{{change|| ID}}
  | String (32767)
+
  | {{change|{{Type|Identifier}}|{{Type|VarInt}}}}
|
+
  | {{change|A recipe ID.|ID of recipe previously defined in [[#Recipe Book Add|Recipe Book Add]].}}
|- {{Removed}}
 
  | Track output || Boolean || If false, the output of the previous command will not be stored within the command block.
 
 
  |-
 
  |-
  | Mode || {{Change|String|VarInt}} enum || One of "SEQUENCE" {{change||(0)}}, "AUTO" {{change||(1)}}, and "REDSTONE" {{change||(2)}} <!-- remove quotes when merging into release article -->
+
  | Make all
  |- {{Removed}}
+
  | {{Type|Boolean}}
| Is conditional || Boolean ||
+
  | Affects the amount of items processed; true if shift is down when clicked.
|- {{Removed}}
 
  | Automatic || Boolean ||
 
|-
 
| Flags
 
| Byte
 
| 0x01: Track Output (if false, the output of the previous command will not be stored within the command block); 0x02: Is conditional; 0x04: Automatic
 
 
  |}
 
  |}
  
==== Update Command Block Minecart ====
+
==== Player Input ====
  
{| class="wikitable" {{Added}}
+
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 3,154: Line 2,497:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x21
+
  | rowspan="3"| ''protocol:''<br/><code>{{change|0x26|0x28}}</code><br/><br/>''resource:''<br/><code>player_input</code>
  |rowspan="3"| Play
+
  | rowspan="3"| Play
  |rowspan="3"| Server
+
  | rowspan="3"| Server
  | Entity ID
+
  | {{removed}} | Sideways
  | {{Change|Int|VarInt}}
+
  | {{removed}} | {{Type|Float}}
  |
+
| {{removed}} | Positive to the left of the player.
 +
|- {{removed}}
 +
| Forward
 +
| {{Type|Float}}
 +
  | Positive forward.
 
  |-
 
  |-
  | Command
+
  | Flags
  | String
+
  | {{Type|Unsigned Byte}}
|
+
  | Bit mask{{change|. 0x1: jump, 0x2: unmount.|; see below.}}
  |-
 
| Track Output
 
| Boolean
 
| If false, the output of the previous command will not be stored within the command block.
 
 
  |}
 
  |}
  
==== Update Structure Block ====
+
The flags are as follows:
  
{| class="wikitable" {{Added}}
+
{| class="wikitable" {{added}}
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="22"| 0x23
+
  ! Hex Mask
  |rowspan="22"| Play
+
  ! Field
|rowspan="22"| Server
 
| {{Removed}}| X
 
| {{Removed}}| Int
 
| {{Removed}}| Tile entity location
 
|- {{Removed}}
 
| Y || Int || Tile entity location
 
|- {{Removed}}
 
| Z || Int || Tile entity location
 
 
  |-
 
  |-
  | Location
+
  | 0x01
  | Position
+
  | Forward
| Block entity location
 
 
  |-
 
  |-
  | Action
+
  | 0x02
  | {{Change|Byte|VarInt enum}}
+
  | Backward
| An additional action to perform beyond simply saving the given data; see below
 
 
  |-
 
  |-
  | Mode
+
  | 0x04
  | {{Change|String|VarInt}} enum
+
  | Left
| One of "SAVE" {{change||(0)}}, "LOAD" {{change||(1)}}, "CORNER" {{change||(2)}}, "DATA" {{change||(3)}}. <!-- when merging remove quotes -->
 
 
  |-
 
  |-
  | Name
+
  | 0x08
| String
+
  | Right
  |
 
 
  |-
 
  |-
  | Offset X || {{Change|Int|Byte}}
+
  | 0x10
  | Between -32 and 32
+
  | Jump
 
  |-
 
  |-
  | Offset Y || {{Change|Int|Byte}}
+
  | 0x20
  | Between -32 and 32
+
  | Sneak
 
  |-
 
  |-
  | Offset Z || {{Change|Int|Byte}}
+
  | 0x40
| Between -32 and 32
+
  | Sprint
|-
 
| Size X || {{Change|Int|Byte}}
 
| Between 0 and 32
 
|-
 
| Size Y || {{Change|Int|Byte}}
 
| Between 0 and 32
 
|-
 
| Size Z || {{Change|Int|Byte}}
 
| Between 0 and 32
 
|-
 
| Mirror
 
| {{Change|String|VarInt}} enum
 
| One of "NONE" {{change||(0)}}, "LEFT_RIGHT" {{change||(1)}}, "FRONT_BACK" {{change||(2)}}. <!-- remove quotes when merging -->
 
|-
 
| Rotation
 
| {{Change|String|VarInt}} enum
 
| One of "NONE" {{change||(0)}}, "CLOCKWISE_90" {{change||(1)}}, "CLOCKWISE_180" {{change||(2)}}, "COUNTERCLOCKWISE_90" {{change||(3)}}. <!-- remove quotes when merging -->
 
|-
 
| Metadata
 
| String
 
|
 
|- {{Removed}}
 
| Ignore entities
 
| Boolean
 
|
 
|- {{Removed}}
 
| Show air
 
| Boolean
 
 
|- {{Removed}}
 
| Show bounding box
 
| Boolean
 
|
 
|-
 
| Integrity
 
| Float
 
| Between 0 and 1
 
|-
 
|Seed
 
|VarLong
 
|
 
|-
 
| Flags
 
| Byte
 
  | 0x01: Ignore entities; 0x02: Show air; 0x04: Show bounding box
 
 
  |}
 
  |}
  
Possible actions:
+
==== Set Seen Recipe ====
 
 
* {{change|1|0}} - Update data
 
* {{change|2|1}} - Save the structure
 
* {{change|3|2}} - Load the structure
 
* {{change|4|3}} - Detect size
 
 
 
{{change|All other values are ignored.  }}The Notchian client uses {{change|1|update data}} to indicate no special action should be taken (i.e. the done button).
 
  
== Handshaking ==
+
Sent when recipe is first seen in recipe book. Replaces Recipe Book Data, type 0.
 
 
=== 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.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,291: Line 2,554:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x00
+
  | ''protocol:''<br/><code>{{change|0x29|0x2B}}</code><br/><br/>''resource:''<br/><code>recipe_book_seen_recipe</code>
|rowspan="4"| Handshaking
+
  | Play
|rowspan="4"| Server
+
  | Server
| Protocol Version
+
  | Recipe ID
| VarInt
+
  | {{change|{{Type|Identifier}}|{{Type|VarInt}}}}
| See [[protocol version numbers]] (currently {{change|340|387}})
+
  | ID of recipe previously defined in [[#Recipe Book Add|Recipe Book Add]].
  |-
 
  | 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|status]], 2 for [[#Login|login]]
 
 
  |}
 
  |}
  
== Status ==
+
==== Use Item On ====
 
 
=== Clientbound ===
 
 
 
No changes so far.
 
 
 
=== Serverbound ===
 
 
 
No changes so far.
 
 
 
== Login ==
 
 
 
=== Clientbound ===
 
 
 
==== Login Plugin Request ====
 
 
 
Used to implement a custom handshaking flow together with [[#Login_Plugin_Response | Login Plugin Response]].
 
 
 
Unlike plugin messages in "play" mode, these messages follow a lock-step request/response scheme, where the client is expected to respond to a request indicating whether it understood. The vanilla client always responds that it hasn't understood, and sends an empty payload.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
|-
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 3,339: Line 2,573:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x00
+
  | rowspan="9"| ''protocol:''<br/><code>{{change|0x38|0x3A}}</code><br/><br/>''resource:''<br/><code>use_item_on</code>
  |rowspan="3"| Play
+
  | rowspan="9"| Play
  |rowspan="3"| Client
+
  | rowspan="9"| Server
  | Message ID
+
  | Hand
  | VarInt
+
  | {{Type|VarInt}} {{Type|Enum}}
  | Generated by the server - should be unique to the connection.
+
  | The hand from which the block is placed; 0: main hand, 1: off hand.
 +
|-
 +
| Location
 +
| {{Type|Position}}
 +
| Block position.
 +
|-
 +
| Face
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| The face on which the block is placed (as documented at [[#Player Action|Player Action]]).
 
  |-
 
  |-
  | Channel
+
  | Cursor Position X
  | Identifier
+
  | {{Type|Float}}
  | Name of the [[plugin channel]] used to send the data
+
  | The position of the crosshair on the block, from 0 to 1 increasing from west to east.
 
  |-
 
  |-
  | Data
+
  | Cursor Position Y
  | Byte Array
+
  | {{Type|Float}}
  | Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
+
  | The position of the crosshair on the block, from 0 to 1 increasing from bottom to top.
|}
 
 
 
=== Serverbound ===
 
 
 
==== Login Plugin Response ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x00
+
  | Cursor Position Z
  |rowspan="3"| Play
+
  | {{Type|Float}}
  |rowspan="3"| Client
+
  | The position of the crosshair on the block, from 0 to 1 increasing from north to south.
| Message ID
 
| VarInt
 
| Should match ID from server.
 
 
  |-
 
  |-
  | Successful
+
  | Inside block
  | Boolean
+
  | {{Type|Boolean}}
  | <code>true</code> if the client understands the request, <code>false</code> otherwise. When <code>false</code>, no payload follows.
+
  | True when the player's head is inside of a block.
 +
|- {{added}}
 +
| World border hit
 +
| {{Type|Boolean}}
 +
| Seems to always be false, even when interacting with blocks around or outside the world border, or while the player is outside the border.
 
  |-
 
  |-
  | Data
+
  | Sequence
  | Optional Byte Array
+
  | {{Type|VarInt}}
  | Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
+
  | Block change sequence number (see [[#Acknowledge Block Change]]).
 
  |}
 
  |}
  
 +
Upon placing a block, this packet is sent once.
 +
 +
The Cursor Position X/Y/Z fields (also known as in-block coordinates) are calculated using raytracing. The unit corresponds to sixteen pixels in the default resource pack. For example, let's say a slab is being placed against the south face of a full block. The Cursor Position X will be higher if the player was pointing near the right (east) edge of the face, lower if pointing near the left. The Cursor Position Y will be used to determine whether it will appear as a bottom slab (values 0.0–0.5) or as a top slab (values 0.5-1.0). The Cursor Position Z should be 1.0 since the player was looking at the southernmost part of the block.
  
 +
Inside block is true when a player's head (specifically eyes) are inside of a block's collision. In 1.13 and later versions, collision is rather complicated and individual blocks can have multiple collision boxes. For instance, a ring of vines has a non-colliding hole in the middle. This value is only true when the player is directly in the box. In practice, though, this value is only used by scaffolding to place in front of the player when sneaking inside of it (other blocks will place behind when you intersect with them -- try with glass for instance).
  
 
[[Category:Minecraft Modern]]
 
[[Category:Minecraft Modern]]

Latest revision as of 11:58, 21 November 2024

This page documents the changes from release 1.21.1 (protocol 767) to the current release (1.21.3, protocol 768). The stable protocol documentation is currently lagging behind, and the changes documented here will be merged soon, once they are complete. The current pre-release (snapshot 24w44a) is not yet 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

Name Size (bytes) Encodes Notes
Teleport Flags 4 Bit field specifying how a teleportation is to be applied on each axis. See #Teleport Flags

Teleport Flags

A bit field represented as an Int, specifying how a teleportation is to be applied on each axis.

In the lower 8 bits of the bit field, a set bit means the teleportation on the corresponding axis is relative, and an unset bit that it is absolute.

Hex Mask Field
0x0001 Relative X
0x0002 Relative Y
0x0004 Relative Z
0x0008 Relative Yaw
0x0010 Relative Pitch
0x0020 Relative Velocity X
0x0040 Relative Velocity Y
0x0080 Relative Velocity Z
0x0100 Rotate velocity according to the change in rotation, before applying the velocity change in this packet. Combining this with absolute rotation works as expected—the difference in rotation is still used.

Packets

ID Packet name Documentation
Play clientbound
0x12 Close Container Current Pre
0x13 Set Container Content Current Pre
0x14 Set Container Property Current Pre
0x15 Set Container Slot Current Pre
0x17 Set Cooldown Current Pre
0x70 0x20 Teleport Entity Current Pre
0x20 0x21 Explosion Current Pre
0x23 0x24 Open Horse Screen Current Pre
0x2B 0x2C Login (play) Current Pre
0x31 Move Minecart Along Track Pre
0x37 0x39 Place Ghost Recipe Current Pre
0x3E 0x40 Player Info Update Current Pre
0x40 0x42 Synchronize Player Position Current Pre
0x41 Update Recipe Book Current
0x43 Player Rotation Pre
0x44 Recipe Book Add Pre
0x45 Recipe Book Remove Pre
0x46 Recipe Book Settings Pre
0x47 0x4C Respawn Current Pre
0x5a Set Cursor Item Pre
0x53 0x63 Set Held Item Current (unchanged)
0x66 Set Player Inventory Slot Pre
0x64 0x6b Update Time Current Pre
0x77 Synchronize Vehicle Position Pre
Play serverbound
0x02 Bundle Item Selected Pre
0x0b Client Tick End Pre
0x0E 0x10 Click Container Current Pre
0x0F 0x11 Close Container Current Pre
0x14 0x16 Edit Book Current Pre
0x1A 0x1C Set Player Position Current Pre
0x1B 0x1D Set Player Position and Rotation Current Pre
0x1C 0x1E Set Player Rotation Current Pre
0x1D Set Player On Ground Current
0x1F Set Player Movement Flags Pre
0x22 0x24 Place Recipe Current Pre
0x26 0x28 Player Input Current Pre
0x29 0x2B Set Seen Recipe Current Pre
0x38 0x3A Use Item On Current Pre

Entity Metadata

Entity Metadata Format

Painting Variant

See also: Registry Data#Painting Variant
Name Type Meaning
Width Int The width of the painting, in blocks.
Height Int The height of the painting, in blocks.
Asset ID Identifier The texture for the painting.

The Notchian client uses the corresponding asset located at textures/painting.

Has title Boolean
Title Optional Text Component The displayed title of the painting. Only present if Has title is true.
Has author Boolean
Author Optional Text Component The displayed author of the painting. Only present if Has author is true.

Registry Data

Painting Variant

The minecraft:painting_variant registry. It defines the textures and dimensions for the game's paintings.

Name Type Meaning Values
asset_id String Tag The texture for the painting.

The Notchian client uses the corresponding asset located at textures/painting.

Example: "minecraft:backyard".
height Int Tag The height of the painting, in blocks. Example: 2
width Int Tag The width of the painting, in blocks.
title Compound Tag or String Tag The displayed title of the painting. See Text formatting. Example: {"color": "gray", "translate": "painting.minecraft.skeleton.title"}
author Compound Tag or String Tag The displayed author of the painting. See Text formatting. Example: {"color": "gray", "translate": "painting.minecraft.skeleton.author"}

Slot Data

Structured components

Type Name Description Data
6 minecraft:item_model Item's model. As follows:
Name Type Description
Model Identifier
20 21 minecraft:food Makes the item consumable restore the player's hunger bar when consumed. As follows:
Name Type Description
Nutrition VarInt Non-negative
Saturation Modifier Float How much saturation will be given after consuming the item.
Can Always Eat Boolean Whether the item can always be eaten, even at full hunger.
Seconds To Eat Float How long it takes to consume the item.
Using converts to Slot Data This specifies the item produced after consuming the current item. In the Notchian server, this is used for stews, which turn into bowls. Set this to Air if the item should be consumed normally without leaving any other item after.
Number of effects VarInt Number of elements in the following array.
Effect Type ID Array Potion Effect The potion effect. See Potion Effect.
Probability Float The probability for this effect to be chosen.
22 minecraft:consumable Makes the item consumable. As follows:
Name Type Description
Consume seconds Float How long it takes to consume the item.
Animation VarInt Enum 0: none, 1: eat, 2: drink, 3: block, 4: bow, 5: spear, 6: crossbow, 7: spyglass, 8: toot_horn, 9: brush
Sound ID or Sound Event ID in the minecraft:sound_event registry, or an inline definition.
Has consume particles Boolean
Number of effects VarInt Number of elements in the following array.
Effects Array of Consume Effect Effects to apply on consumption. See Consume Effect.
23 minecraft:use_remainder This specifies the item produced after using the current item. In the Notchian server, this is used for stews, which turn into bowls. As follows:
Name Type Description
Remainder Slot
24 minecraft:use_cooldown Cooldown to apply on use of the item. As follows:
Name Type Description
Seconds Float
Cooldown group Optional Identifier Group of items to apply the cooldown to. Only present if Has cooldown group is true; otherwise defaults to the item's identifier.
21 25 minecraft:fire damage_resistant Marks this item as fire damage resistant.
The client won't render the item as being on-fire if this component is present.
None. As follows:
Name Type Description
Types Identifier Tag specifying damage types the item is immune to. Not prefixed by '#'!.
27 minecraft:enchantable Allows the item to be enchanted by an enchanting table. As follows:
Name Type Description
Value VarInt Opaque internal value controlling how expensive enchantments may be offered.
28 minecraft:equippable Allows the item to be equipped by the player. As follows:
Name Type Description
Slot VarInt Enum 0: mainhand, 1: feet, 2: legs, 3: chest, 4: head, 5: offhand, 6: body
Equip sound ID or Sound Event ID in the minecraft:sound_event registry, or an inline definition.
Has model Boolean
Model Optional Identifier Only present if Has model is true.
Has camera overlay Boolean
Camera overlay Optional Identifier Only present if Has camera overlay is true.
Has allowed entities Boolean
Allowed entities Optional ID Set IDs in the minecraft:entity_type registry. Only present if Has allowed entities is true.
Dispensable Boolean
Swappable Boolean
Damage on hurt Boolean
29 minecraft:repairable Items that can be combined with this item in an anvil to repair it. As follows:
Name Type Description
Items ID Set IDs in the minecraft:item registry.
30 minecraft:glider Makes the item function like elytra. None.
31 minecraft:tooltip_style Custom textures for the item tooltip. As follows:
Name Type Description
Style Identifier
32 minecraft:death_protection Makes the item function like a totem of undying. As follows:
Name Type Description
Number of effects VarInt Number of elements in the following array.
Effects Array of Consume Effect Effects to apply on consumption. See Consume Effect.
31 41 minecraft:potion_contents Visual and effects of a potion item. As follows:
Name Type Description
Has Potion ID Boolean Whether this potion has an ID in the potion registry. If true, it has the default effects associated with the potion type.
Potion ID Optional VarInt The ID of the potion type in the potion registry. Only present if Has Potion ID is true.
Has Custom Color Boolean Whether this potion has a custom color. If false, it uses the default color associated with the potion type.
Custom Color Optional Int The RGB components of the color, encoded as an integer. Only present if Has Custom Color is true.
Number Of Custom Effects VarInt The number of elements in the following array.
Custom Effects Array of Potion Effect Any custom effects the potion might have. See Potion Effect.
Custom Name String

Other types

Consume Effect

WIP

Instrument

Name Type Description
Sound Event Id or Sound Event The sound to be played.
Use duration VarInt Float The maximum range of the sound.
Range Float The range of the instrument.
Description Text Component Description shown in the item tooltip.

Particles

Particle Name Particle ID Data
minecraft:dust 13
Field Name Field Type Meaning
Red Float The red RGB value, between 0 and 1. Divide actual RGB value by 255.
Green Float The green RGB value, between 0 and 1. Divide actual RGB value by 255.
Blue Float The blue RGB value, between 0 and 1. Divide actual RGB value by 255.
Color Int The color, encoded as 0xRRGGBB; top bits are ignored.
Scale Float The scale, will be clamped between 0.01 and 4.
minecraft:dust_color_transition 14
Field Name Field Type Meaning
From Red Float The start red RGB value, between 0 and 1. Divide actual RGB value by 255.
From Green Float The start green RGB value, between 0 and 1. Divide actual RGB value by 255.
From Blue Float The start blue RGB value, between 0 and 1. Divide actual RGB value by 255.
From Color Int The start color, encoded as 0xRRGGBB; top bits are ignored.
To Red Float The end red RGB value, between 0 and 1. Divide actual RGB value by 255.
To Green Float The end green RGB value, between 0 and 1. Divide actual RGB value by 255.
To Blue Float The end blue RGB value, between 0 and 1. Divide actual RGB value by 255.
To Color Int The end color, encoded as 0xRRGGBB; top bits are ignored.
Scale Float The scale, will be clamped between 0.01 and 4.

Handshake

No changes so far.

Status

No changes so far.

Login

No changes so far.

Configuration

No changes so far.

Play

Clientbound

Close Container

This packet is sent from the server to the client when a window is forcibly closed, such as when a chest is destroyed while it's open. The notchian client disregards the provided window ID and closes any active window.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x12

resource:
container_close
Play Client Window ID Unsigned Byte VarInt This is the ID of the window that was closed. 0 for inventory.

Set Container Content

The inventory slots

Replaces the contents of a container window. Sent by the server upon initialization of a container window or the player's inventory, and in response to state ID mismatches (see #Click Container).

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x13

resource:
container_set_content
Play Client Window ID Unsigned Byte VarInt The ID of window which items are being sent for. 0 for player inventory. The client ignores any packets targeting a Window ID other than the current one. However, an exception is made for the player inventory, which may be targeted at any time. (The Notchian server does not appear to utilize this special case.)
State ID VarInt A server-managed sequence number used to avoid desynchronization; see #Click Container.
Count VarInt Number of elements in the following array.
Slot Data Array of Slot
Carried Item Slot Item being dragged with the mouse.

See inventory windows for further information about how slots are indexed. Use Open Screen to open the container on the client.

Set Container Property

This packet is used to inform the client that part of a GUI window should be updated.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x14

resource:
container_set_data
Play Client Window ID Unsigned Byte VarInt
Property Short The property to be updated, see below.
Value Short The new value for the property, see below.

The meaning of the Property field depends on the type of the window. The following table shows the known combinations of window type and property, and how the value is to be interpreted.

Window type Property Value
Furnace 0: Fire icon (fuel left) counting from fuel burn time down to 0 (in-game ticks)
1: Maximum fuel burn time fuel burn time or 0 (in-game ticks)
2: Progress arrow counting from 0 to maximum progress (in-game ticks)
3: Maximum progress always 200 on the notchian server
Enchantment Table 0: Level requirement for top enchantment slot The enchantment's xp level requirement
1: Level requirement for middle enchantment slot
2: Level requirement for bottom enchantment slot
3: The enchantment seed Used for drawing the enchantment names (in SGA) clientside. The same seed is used to calculate enchantments, but some of the data isn't sent to the client to prevent easily guessing the entire list (the seed value here is the regular seed bitwise and 0xFFFFFFF0).
4: Enchantment ID shown on mouse hover over top enchantment slot The enchantment id (set to -1 to hide it), see below for values
5: Enchantment ID shown on mouse hover over middle enchantment slot
6: Enchantment ID shown on mouse hover over bottom enchantment slot
7: Enchantment level shown on mouse hover over the top slot The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
8: Enchantment level shown on mouse hover over the middle slot
9: Enchantment level shown on mouse hover over the bottom slot
Beacon 0: Power level 0-4, controls what effect buttons are enabled
1: First potion effect Potion effect ID for the first effect, or -1 if no effect
2: Second potion effect Potion effect ID for the second effect, or -1 if no effect
Anvil 0: Repair cost The repair's cost in xp levels
Brewing Stand 0: Brew time 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
1: Fuel time 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
Stonecutter 0: Selected recipe The index of the selected recipe. -1 means none is selected.
Loom 0: Selected pattern The index of the selected pattern. 0 means none is selected, 0 is also the internal id of the "base" pattern.
Lectern 0: Page number The current page number, starting from 0.

For an enchanting table, the following numerical IDs are used:

Numerical ID Enchantment ID Enchantment Name
0 minecraft:protection Protection
1 minecraft:fire_protection Fire Protection
2 minecraft:feather_falling Feather Falling
3 minecraft:blast_protection Blast Protection
4 minecraft:projectile_protection Projectile Protection
5 minecraft:respiration Respiration
6 minecraft:aqua_affinity Aqua Affinity
7 minecraft:thorns Thorns
8 minecraft:depth_strider Depth Strider
9 minecraft:frost_walker Frost Walker
10 minecraft:binding_curse Curse of Binding
11 minecraft:soul_speed Soul Speed
12 minecraft:swift_sneak Swift Sneak
13 minecraft:sharpness Sharpness
14 minecraft:smite Smite
15 minecraft:bane_of_arthropods Bane of Arthropods
16 minecraft:knockback Knockback
17 minecraft:fire_aspect Fire Aspect
18 minecraft:looting Looting
19 minecraft:sweeping_edge Sweeping Edge
20 minecraft:efficiency Efficiency
21 minecraft:silk_touch Silk Touch
22 minecraft:unbreaking Unbreaking
23 minecraft:fortune Fortune
24 minecraft:power Power
25 minecraft:punch Punch
26 minecraft:flame Flame
27 minecraft:infinity Infinity
28 minecraft:luck_of_the_sea Luck of the Sea
29 minecraft:lure Lure
30 minecraft:loyalty Loyalty
31 minecraft:impaling Impaling
32 minecraft:riptide Riptide
33 minecraft:channeling Channeling
34 minecraft:multishot Multishot
35 minecraft:quick_charge Quick Charge
36 minecraft:piercing Piercing
37 minecraft:density Density
38 minecraft:breach Breach
39 minecraft:wind_burst Wind Burst
40 minecraft:mending Mending
41 minecraft:vanishing_curse Curse of Vanishing

Set Container Slot

Sent by the server when an item in a slot (in a window) is added/removed.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x15

resource:
container_set_slot
Play Client Window ID Unsigned Byte VarInt The window which is being updated. 0 for player inventory. The client ignores any packets targeting a Window ID other than the current one; see below for exceptions , unless it is 0 (see below).
State ID VarInt A server-managed sequence number used to avoid desynchronization; see #Click Container.
Slot Short The slot that should be updated.
Slot Data Slot

If Window ID is 0, the hotbar and offhand slots (slots 36 through 45) may be updated even when a different container window is open. (The Notchian server does not appear to utilize this special case.) Updates are also restricted to those slots when the player is looking at a creative inventory tab other than the survival inventory. (The Notchian server does not handle this restriction in any way, leading to MC-242392.)

If Window ID is -1, the item being dragged with the mouse is set. In this case, State ID and Slot are ignored.

If Window ID is -2, any slot in the player's inventory can be updated irrespective of the current container window. In this case, State ID is ignored, and the Notchian server uses a bogus value of 0. Used by the Notchian server to implement the #Pick Item functionality.

When a container window is open, the server never sends updates targeting Window ID 0—all of the window types include slots for the player inventory. The client must automatically apply changes targeting the inventory portion of a container window to the main inventory; the server does not resend them for ID 0 when the window is closed. However, since the armor and offhand slots are only present on ID 0, updates to those slots occurring while a window is open must be deferred by the server until the window's closure.

Set Cooldown

Applies a cooldown period to all items with the given type. Used by the Notchian server with enderpearls. This packet should be sent when the cooldown starts and also when the cooldown ends (to compensate for lag), although the client will end the cooldown automatically. Can be applied to any item, note that interactions still get sent to the server with the item but the client does not play the animation nor attempt to predict results (i.e block placing).

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x17

resource:
cooldown
Play Client Item ID Cooldown Group VarInt Identifier Numeric ID of the item Group of items to apply a cooldown to.
Cooldown Ticks VarInt Number of ticks to apply a cooldown for, or 0 to clear the cooldown.

Teleport Entity

Warning.png The Mojang-specified name of this packet was changed in 1.21.2 from teleport_entity to entity_position_sync. There is a new teleport_entity, which this document more appropriately calls Synchronize Vehicle Position. That packet has a different function and will lead to confusing results if used in place of this one.

This packet is sent by the server when an entity moves more than 8 blocks.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x70 0x20

resource:
teleport_entity entity_position_sync
Play Client Entity ID VarInt
X Double
Y Double
Z Double
Velocity X Double
Velocity Y Double
Velocity Z Double
Yaw Angle Float Rotation on the X axis, in degrees.
Pitch Angle Float Rotation on the Y axis, in degrees.
On Ground Boolean

Explosion

Sent when an explosion occurs (creepers, TNT, and ghast fireballs).

Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x20 0x21

resource:
explode
Play Client X Double
Y Double
Z Double
Strength Float If the strength is greater or equal to 2.0, or the block interaction is not 0 (keep), large explosion particles are used. Otherwise, small explosion particles are used.
Record Count VarInt Number of elements in the following array.
Records Array of (Byte, Byte, Byte) Each record is 3 signed bytes long; the 3 bytes are the XYZ (respectively) signed offsets of affected blocks.
Has Player Motion Boolean
Player Motion X Float Optional Double X velocity of the player being pushed by the explosion. Only present if Has Player Motion is true.
Player Motion Y Float Optional Double Y velocity of the player being pushed by the explosion. Only present if Has Player Motion is true.
Player Motion Z Float Optional Double Z velocity of the player being pushed by the explosion. Only present if Has Player Motion is true.
Block Interaction VarInt Enum 0 = keep, 1 = destroy, 2 = destroy_with_decay, 3 = trigger_block.
Small Explosion Particle ID VarInt The particle ID listed in Particles.
Small Explosion Particle Data Varies Particle data as specified in Particles.
Large Explosion Particle ID VarInt The particle ID listed in Particles.
Large Explosion Particle Data Varies Particle data as specified in Particles.
Explosion Sound ID or Sound Event ID in the minecraft:sound_event registry, or an inline definition.

Open Horse Screen

This packet is used exclusively for opening the horse GUI. Open Screen is used for all other GUIs. The client will not open the inventory if the Entity ID does not point to an horse-like animal.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x23

resource:
horse_screen_open
Play Client Window ID Unsigned Byte VarInt
Slot count VarInt
Entity ID Int

Login (play)

Huh.png The following information needs to be added to this page:
Although the number of portal cooldown ticks is included in this packet, the whole portal usage process is still dictated entirely by the server. What kind of effect does this value have on the client, if any?

See Protocol Encryption for information on logging in.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x2B 0x2C

resource:
login
Play Client Entity ID Int The player's Entity ID (EID).
Is hardcore Boolean
Dimension Count VarInt Size of the following array.
Dimension Names Array of Identifier Identifiers for all dimensions on the server.
Max Players VarInt Was once used by the client to draw the player list, but now is ignored.
View Distance VarInt Render distance (2-32).
Simulation Distance VarInt The distance that the client will process specific things, such as entities.
Reduced Debug Info Boolean If true, a Notchian client shows reduced information on the debug screen. For servers in development, this should almost always be false.
Enable respawn screen Boolean Set to false when the doImmediateRespawn gamerule is true.
Do limited crafting Boolean Whether players can only craft recipes they have already unlocked. Currently unused by the client.
Dimension Type VarInt The ID of the type of dimension in the minecraft:dimension_type registry, defined by the Registry Data packet.
Dimension Name Identifier Name of the dimension being spawned into.
Hashed seed Long First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
Game mode Unsigned Byte 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
Previous Game mode Byte -1: Undefined (null), 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. The previous game mode. Vanilla client uses this for the debug (F3 + N & F3 + F4) game mode switch. (More information needed)
Is Debug Boolean True if the world is a debug mode world; debug mode worlds cannot be modified and have predefined blocks.
Is Flat Boolean True if the world is a superflat world; flat worlds have different void fog and a horizon at y=0 instead of y=63.
Has death location Boolean If true, then the next two fields are present.
Death dimension name Optional Identifier Name of the dimension the player died in.
Death location Optional Position The location that the player died at.
Portal cooldown VarInt The number of ticks until the player can use the portal again.
Sea level VarInt
Enforces Secure Chat Boolean

Move Minecart Along Track

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x31

resource:
move_minecart_along_track
Play Client Entity ID VarInt
Step Count VarInt Number of elements in the following array.
Steps X Array Double
Y Double
Z Double
Velocity X Double
Velocity Y Double
Velocity Z Double
Yaw Angle
Pitch Angle
Weight Float

Player Info Update

Sent by the server to update the user list (<tab> in the client).

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x3E 0x40

resource:
player_info_update
Play Client Actions Byte Determines what actions are present.
Number Of Players VarInt Number of elements in the following array.
Players UUID Array UUID The player UUID
Player Actions Array of Player Actions The length of this array is determined by the number of Player Actions that give a non-zero value when applying its mask to the actions flag. For example given the decimal number 5, binary 00000101. The masks 0x01 and 0x04 would return a non-zero value, meaning the Player Actions array would include two actions: Add Player and Update Game Mode.
Player Actions
Action Mask Field Name Type Notes
Add Player 0x01 Name String (16)
Number Of Properties VarInt Number of elements in the following array.
Property Name Array String (32767)
Value String (32767)
Is Signed Boolean
Signature Optional String (32767) Only if Is Signed is true.
Initialize Chat 0x02 Has Signature Data Boolean
Chat session ID UUID Only sent if Has Signature Data is true.
Public key expiry time Long Key expiry time, as a UNIX timestamp in milliseconds. Only sent if Has Signature Data is true.
Encoded public key size VarInt Size of the following array. Only sent if Has Signature Data is true. Maximum length is 512 bytes.
Encoded public key Byte Array (512) The player's public key, in bytes. Only sent if Has Signature Data is true.
Public key signature size VarInt Size of the following array. Only sent if Has Signature Data is true. Maximum length is 4096 bytes.
Public key signature Byte Array (4096) The public key's digital signature. Only sent if Has Signature Data is true.
Update Game Mode 0x04 Game Mode VarInt
Update Listed 0x08 Listed Boolean Whether the player should be listed on the player list.
Update Latency 0x10 Ping VarInt Measured in milliseconds.
Update Display Name 0x20 Has Display Name Boolean
Display Name Optional Text Component Only sent if Has Display Name is true.
Update List Priority 0x40 Priority VarInt See below.

The properties included in this packet are the same as in Login Success, for the current player.

Ping values correspond with icons in the following way:

  • A ping that negative (i.e. not known to the server yet) will result in the no connection icon.
  • A ping under 150 milliseconds will result in 5 bars
  • A ping under 300 milliseconds will result in 4 bars
  • A ping under 600 milliseconds will result in 3 bars
  • A ping under 1000 milliseconds (1 second) will result in 2 bars
  • A ping greater than or equal to 1 second will result in 1 bar.

The order of players in the player list is determined as follows:

  • Players with higher priorities are sorted before those with lower priorities.
  • Among players of equal priorities, spectators are sorted after non-spectators.
  • Within each of those groups, players are sorted into teams. The teams are ordered case-sensitively by team name in ascending order. Players with no team are listed first.
  • The players of each team (and non-team) are sorted case-insensitively by name in ascending order.

Synchronize Player Position

Teleports the client, e.g. during login, when using an ender pearl, in response to invalid move packets, etc.

Due to latency, the server may receive outdated movement packets sent before the client was aware of the teleport. To account for this, the server ignores all movement packets from the client until a Confirm Teleportation packet with an ID matching the one sent in the teleport packet is received.

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 (see MC-90097).

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
protocol:
0x40 0x42

resource:
player_position
Play Client Teleport ID VarInt Client should confirm this packet with Confirm Teleportation containing the same Teleport ID.
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.
Velocity X Double
Velocity Y Double
Velocity Z Double
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 Teleport Flags Reference the Flags table below. When the value of the this byte masked is zero the field is absolute, otherwise relative.
Teleport ID VarInt Client should confirm this packet with Confirm Teleportation containing the same Teleport ID.

Player Rotation

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x43

resource:
player_rotation
Play Client Yaw Float Rotation on the X axis, in degrees.
Pitch Float Rotation on the Y axis, in degrees.

Place Ghost Recipe

Response to the serverbound packet (Place Recipe), with the same recipe ID. Appears to be used to notify the UI.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x37 0x39

resource:
place_ghost_recipe
Play Client Window ID Byte VarInt
Recipe Identifier A recipe ID.
Recipe Display ID VarInt ID in the minecraft:recipe_display registry.
Recipe Data Varies Depends on Recipe Type; see below.

below

Recipe Book Add

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x44

resource:
recipe_book_add
Play Client Recipe Count VarInt Number of elements in the following array.
Recipes Recipe ID Array VarInt ID to assign to the recipe.
Display ID VarInt ID in the minecraft:recipe_display registry.
Group ID VarInt
Category ID VarInt ID in the minecraft:recipe_book_category registry.
Has Ingredients Boolean
Ingredient Count Optional VarInt Number of elements in the following array. Only present if Has Ingredients is true.
Ingredients Optional Array of ID Set IDs in the minecraft:item registry, or an inline definition. Only present if Has Ingredients is true.
Flags Byte 0x01: show notification; 0x02: highlight as new
Replace Boolean Replace or Add to known recipes

Recipe Book Remove

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x45

resource:
recipe_book_remove
Play Client Recipe Count VarInt Number of elements in the following array.
Recipes Array of VarInt IDs of recipes to remove.

Recipe Book Settings

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x46

resource:
recipe_book_settings
Play Client Crafting Recipe Book Open Boolean If true, then the crafting recipe book will be open when the player opens its inventory.
Crafting Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.
Smelting Recipe Book Open Boolean If true, then the smelting recipe book will be open when the player opens its inventory.
Smelting Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.
Blast Furnace Recipe Book Open Boolean If true, then the blast furnace recipe book will be open when the player opens its inventory.
Blast Furnace Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.
Smoker Recipe Book Open Boolean If true, then the smoker recipe book will be open when the player opens its inventory.
Smoker Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.

Respawn

Huh.png The following information needs to be added to this page:
Although the number of portal cooldown ticks is included in this packet, the whole portal usage process is still dictated entirely by the server. What kind of effect does this value have on the client, if any?

To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x47 0x4C

resource:
respawn
Play Client Dimension Type VarInt The ID of type of dimension in the minecraft:dimension_type registry, defined by the Registry Data packet.
Dimension Name Identifier Name of the dimension being spawned into.
Hashed seed Long First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
Game mode Unsigned Byte 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
Previous Game mode Byte -1: Undefined (null), 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. The previous game mode. Vanilla client uses this for the debug (F3 + N & F3 + F4) game mode switch. (More information needed)
Is Debug Boolean True if the world is a debug mode world; debug mode worlds cannot be modified and have predefined blocks.
Is Flat Boolean True if the world is a superflat world; flat worlds have different void fog and a horizon at y=0 instead of y=63.
Has death location Boolean If true, then the next two fields are present.
Death dimension Name Optional Identifier Name of the dimension the player died in.
Death location Optional Position The location that the player died at.
Portal cooldown VarInt The number of ticks until the player can use the portal again.
Sea level VarInt
Data kept Byte Bit mask. 0x01: Keep attributes, 0x02: Keep metadata. Tells which data should be kept on the client side once the player has respawned.

In the Notchian implementation, this is context dependent:

  • normal respawns (after death) keep no data;
  • exiting the end poem/credits keeps the attributes;
  • other dimension changes (portals or teleports) keep all data.

Warning.png Avoid changing player's dimension to same dimension they were already in unless they are dead. If you change the dimension to one they are already in, weird bugs can occur, such as the player being unable to attack other players in new world (until they die and respawn).

Before 1.16, if you must respawn a player in the same dimension without killing them, send two respawn packets, one to a different world and then another to the world you want. You do not need to complete the first respawn; it only matters that you send two packets.

Set Cursor Item

Packet ID State Bound To Field Name Field Type Notes
0x5A Play Client Slot Data Slot

Update Time

Time is based on ticks, where 20 ticks happen every second. There are 24000 ticks in a day, making Minecraft days exactly 20 minutes long.

The time of day is based on the timestamp modulo 24000. 0 is sunrise, 6000 is noon, 12000 is sunset, and 18000 is midnight.

The default SMP server increments the time by 20 every second.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x64 0x6B

resource:
set_time
Play Client World Age Long In ticks; not changed by server commands.
Time of day Long The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time.
Time of day increasing Boolean If true, the client should automatically advance the time of day according to its ticking rate.

Set Player Inventory Slot

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x66

resource:
set_player_inventory
Play Client Slot VarInt
Slot Data Slot

Synchronize Vehicle Position

Teleports the entity on the client without changing the reference point of movement deltas in future Update Entity Position packets. Seems to be used to make relative adjustments to vehicle positions; more information needed.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x77

resource:
teleport_entity
Play Client Entity ID VarInt
X Double
Y Double
Z Double
Velocity X Double
Velocity Y Double
Velocity Z Double
Yaw Float Rotation on the Y axis, in degrees.
Pitch Float Rotation on the Y axis, in degrees.
Flags Teleport Flags
On Ground Boolean

Serverbound

Bundle Item Selected

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x02

resource:
bundle_item_selected
Play Server Slot of Bundle VarInt
Slot in Bundle VarInt

Client Tick End

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x0B

resource:
client_tick_end
Play Server no fields

Click Container

This packet is sent by the client when the player clicks on a slot in a window.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x0E 0x10

resource:
container_click
Play Server Window ID Unsigned Byte VarInt The ID of the window which was clicked. 0 for player inventory. The server ignores any packets targeting a Window ID other than the current one, including ignoring 0 when any other window is open.
State ID VarInt The last received State ID from either a Set Container Slot or a Set Container Content packet.
Slot Short The clicked slot number, see below.
Button Byte The button used in the click, see below.
Mode VarInt Enum Inventory operation mode, see below.
Length of the array VarInt Maximum value for Notchian server is 128 slots.
Array of changed slots Slot number Array (128) Short
Slot data Slot New data for this slot, in the client's opinion; see below.
Carried item Slot Item carried by the cursor. Has to be empty (item ID = -1) for drop mode, otherwise nothing will happen.

See Inventory for further information about how slots are indexed.

After performing the action, the server compares the results to the slot change information included in the packet, as applied on top of the server's view of the container's state prior to the action. For any slots that do not match, it sends Set Container Slot packets containing the correct results. If State ID does not match the last ID sent by the server, it will instead send a full Set Container Content to resynchronize the client.

When right-clicking on a stack of items, half the stack will be picked up and half left in the slot. If the stack is an odd number, the half left in the slot will be smaller of the amounts.

The distinct type of click performed by the client is determined by the combination of the Mode and Button fields.

Mode Button Slot Trigger
0 0 Normal Left mouse click
1 Normal Right mouse click
0 -999 Left click outside inventory (drop cursor stack)
1 -999 Right click outside inventory (drop cursor single item)
1 0 Normal Shift + left mouse click
1 Normal Shift + right mouse click (identical behavior)
2 0 Normal Number key 1
1 Normal Number key 2
2 Normal Number key 3
8 Normal Number key 9
Button is used as the slot index (impossible in vanilla clients)
40 Normal Offhand swap key F
3 2 Normal Middle click, only defined for creative players in non-player inventories.
4 0 Normal* Drop key (Q) (* Clicked item is always empty)
1 Normal* Control + Drop key (Q) (* Clicked item is always empty)
5 0 -999 Starting left mouse drag
4 -999 Starting right mouse drag
8 -999 Starting middle mouse drag, only defined for creative players in non-player inventories.
1 Normal Add slot for left-mouse drag
5 Normal Add slot for right-mouse drag
9 Normal Add slot for middle-mouse drag, only defined for creative players in non-player inventories.
2 -999 Ending left mouse drag
6 -999 Ending right mouse drag
10 -999 Ending middle mouse drag, only defined for creative players in non-player inventories.
6 0 Normal Double click
1 Normal Pickup all but check items in reverse order (impossible in vanilla clients)

Starting from version 1.5, “painting mode” is available for use in inventory windows. It is done by picking up stack of something (more than 1 item), then holding mouse button (left, right or middle) and dragging held stack over empty (or same type in case of right button) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):

  1. packet with mode 5, slot -999, button (0 for left | 4 for right);
  2. packet for every slot painted on, mode is still 5, button (1 | 5);
  3. packet with mode 5, slot -999, button (2 | 6);

If any of the painting packets other than the “progress” ones are sent out of order (for example, a start, some slots, then another start; or a left-click in the middle) the painting status will be reset.

Close Container

This packet is sent by the client when closing a window.

Notchian clients send a Close Window packet with Window ID 0 to close their inventory even though there is never an Open Screen packet for the inventory.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x0F 0x11

resource:
container_close
Play Server Window ID Unsigned Byte VarInt This is the ID of the window that was closed. 0 for player inventory.

Edit Book

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x14 0x16

resource:
edit_book
Play Server Slot VarInt The hotbar slot where the written book is located
Count VarInt Number of elements in the following array. Maximum array size is 200 100.
Entries Array (200 100) of String (8192 1024) Text from each page. Maximum string length is 8192 1024 chars.
Has title Boolean If true, the next field is present. true if book is being signed, false if book is being edited.
Title Optional String (128 32) Title of book.

Set Player Position

Updates the player's XYZ position on the server.

If the player is in a vehicle, the position is ignored (but in case of Set Player Position and Rotation, the rotation is still used as normal). No validation steps other than value range clamping are performed in this case.

If the player is sleeping, the position (or rotation) is not changed, and a Synchronize Player Position is sent if the received position deviated from the server's view by more than a meter.

The Notchian server silently clamps the x and z coordinates between -30,000,000 and 30,000,000, and the y coordinate between -20,000,000 and 20,000,000. A similar condition has historically caused a kick for "Illegal position"; this is no longer the case. However, infinite or NaN coordinates (or angles) still result in a kick for multiplayer.disconnect.invalid_player_movement.

As of 1.20.6, checking for moving too fast is achieved like this (sic):

  • Each server tick, the player's current position is stored.
  • When the player moves, the offset from the stored position to the requested position is computed (Δx, Δy, Δz).
  • The requested movement distance squared is computed as Δx² + Δy² + Δz².
  • The baseline expected movement distance squared is computed based on the player's server-side velocity as Vx² + Vy² + Vz². The player's server-side velocity is a somewhat ill-defined quantity that includes among other things gravity, jump velocity and knockback, but not regular horizontal movement. A proper description would bring much of Minecraft's physics engine with it. It is accessible as the Motion NBT tag on the player entity.
  • The maximum permitted movement distance squared is computed as 100 (300 if the player is using an elytra), multiplied by the number of movement packets received since the last tick, including this one, unless that value is greater than 5, in which case no multiplier is applied.
  • If the requested movement distance squared minus the baseline distance squared is more than the maximum squared, the player is moving too fast.

If the player is moving too fast, it is logged that "<player> moved too quickly! " followed by the change in x, y, and z, and the player is teleported back to their current (before this packet) server-side position.

Checking for block collisions is achieved like this:

  • A temporary collision-checked move of the player is attempted from its current position to the requested one.
  • The offset from the resulting position to the requested position is computed. If the absolute value of the offset on the y axis is less than 0.5, it (only the y component) is rounded down to 0.
  • If the magnitude of the offset is greater than 0.25 and the player isn't in creative or spectator mode, it is logged that "<player> moved wrongly!", and the player is teleported back to their current (before this packet) server-side position.
  • In addition, if the player's hitbox stationary at the requested position would intersect with a block, and they aren't in spectator mode, they are teleported back without a log message.

Checking for illegal flight is achieved like this:

  • When a movement packet is received, a flag indicating whether or not the player is floating mid-air is updated. The flag is set if the move test described above detected no collision below the player and the y component of the offset from the player's current position to the requested one is greater than -0.5, unless any of various conditions permitting flight (creative mode, elytra, levitation effect, etc., but not jumping) are met.
  • Each server tick, it is checked if the flag has been set for more than 80 consecutive ticks. If so, and the player isn't currently sleeping, dead or riding a vehicle, they are kicked for multiplayer.disconnect.flying.
Packet ID State Bound To Field Name Field Type Notes
protocol:
0x1A 0x1C

resource:
move_player_pos
Play Server X Double Absolute position.
Feet Y Double Absolute feet position, normally Head Y - 1.62.
Z Double Absolute position.
On Ground Boolean True if the client is on the ground, false otherwise.
Flags Byte Bit field: 0x01: on ground, 0x02: pushing against wall.

Set Player Position and Rotation

A combination of Move Player Rotation and Move Player Position.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x1B 0x1D

resource:
move_player_pos_rot
Play Server X Double Absolute position.
Feet Y Double Absolute feet position, normally Head Y - 1.62.
Z Double Absolute position.
Yaw Float Absolute rotation on the X Axis, in degrees.
Pitch Float Absolute rotation on the Y Axis, in degrees.
On Ground Boolean True if the client is on the ground, false otherwise.
Flags Byte Bit field: 0x01: on ground, 0x02: pushing against wall.

Set Player Rotation

The unit circle for yaw
The unit circle of yaw, redrawn

Updates the direction the player is looking in.

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.

The yaw and pitch of player (in degrees), standing at point (x0, y0, z0) and looking towards point (x, y, z) can be calculated with:

dx = x-x0
dy = y-y0
dz = z-z0
r = sqrt( dx*dx + dy*dy + dz*dz )
yaw = -atan2(dx,dz)/PI*180
if yaw < 0 then
    yaw = 360 + yaw
pitch = -arcsin(dy/r)/PI*180

You can get a unit vector from a given yaw/pitch via:

x = -cos(pitch) * sin(yaw)
y = -sin(pitch)
z =  cos(pitch) * cos(yaw)
Packet ID State Bound To Field Name Field Type Notes
protocol:
0x1C 0x1E

resource:
move_player_rot
Play Server Yaw Float Absolute rotation on the X Axis, in degrees.
Pitch Float Absolute rotation on the Y Axis, in degrees.
On Ground Boolean True if the client is on the ground, false otherwise.
Flags Byte Bit field: 0x01: on ground, 0x02: pushing against wall.

Set Player On Ground Movement Flags

This packet as well as Set Player Position, Set Player Rotation, and Set Player Position and Rotation are called the “serverbound movement packets”. Vanilla clients will send Move Player Position once every 20 ticks even for a stationary player.

This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).

When dropping from sufficient height, fall damage is applied when this state goes from false to true. The amount of damage applied is based on the point where it last changed from true to false. Note that there are several movement related packets containing this state.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x1D 0x1F

resource:
move_player_status_only
Play Server On Ground Boolean True if the client is on the ground, false otherwise.
Flags Byte Bit field: 0x01: on ground, 0x02: pushing against wall.

Place Recipe

This packet is sent when a player clicks a recipe in the crafting book that is craftable (white border).

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x22 0x24

resource:
place_recipe
Play Server Window ID Byte
Recipe ID Identifier VarInt A recipe ID. ID of recipe previously defined in Recipe Book Add.
Make all Boolean Affects the amount of items processed; true if shift is down when clicked.

Player Input

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x26 0x28

resource:
player_input
Play Server Sideways Float Positive to the left of the player.
Forward Float Positive forward.
Flags Unsigned Byte Bit mask. 0x1: jump, 0x2: unmount. ; see below.

The flags are as follows:

Hex Mask Field
0x01 Forward
0x02 Backward
0x04 Left
0x08 Right
0x10 Jump
0x20 Sneak
0x40 Sprint

Set Seen Recipe

Sent when recipe is first seen in recipe book. Replaces Recipe Book Data, type 0.

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x29 0x2B

resource:
recipe_book_seen_recipe
Play Server Recipe ID Identifier VarInt ID of recipe previously defined in Recipe Book Add.

Use Item On

Packet ID State Bound To Field Name Field Type Notes
protocol:
0x38 0x3A

resource:
use_item_on
Play Server Hand VarInt Enum The hand from which the block is placed; 0: main hand, 1: off hand.
Location Position Block position.
Face VarInt Enum The face on which the block is placed (as documented at Player Action).
Cursor Position X Float The position of the crosshair on the block, from 0 to 1 increasing from west to east.
Cursor Position Y Float The position of the crosshair on the block, from 0 to 1 increasing from bottom to top.
Cursor Position Z Float The position of the crosshair on the block, from 0 to 1 increasing from north to south.
Inside block Boolean True when the player's head is inside of a block.
World border hit Boolean Seems to always be false, even when interacting with blocks around or outside the world border, or while the player is outside the border.
Sequence VarInt Block change sequence number (see #Acknowledge Block Change).

Upon placing a block, this packet is sent once.

The Cursor Position X/Y/Z fields (also known as in-block coordinates) are calculated using raytracing. The unit corresponds to sixteen pixels in the default resource pack. For example, let's say a slab is being placed against the south face of a full block. The Cursor Position X will be higher if the player was pointing near the right (east) edge of the face, lower if pointing near the left. The Cursor Position Y will be used to determine whether it will appear as a bottom slab (values 0.0–0.5) or as a top slab (values 0.5-1.0). The Cursor Position Z should be 1.0 since the player was looking at the southernmost part of the block.

Inside block is true when a player's head (specifically eyes) are inside of a block's collision. In 1.13 and later versions, collision is rather complicated and individual blocks can have multiple collision boxes. For instance, a ring of vines has a non-colliding hole in the middle. This value is only true when the player is directly in the box. In practice, though, this value is only used by scaffolding to place in front of the player when sneaking inside of it (other blocks will place behind when you intersect with them -- try with glass for instance).