Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
(Add info about missing fields (more info is needed on the previous gamemode ones still).)
(moar stuff)
 
(253 intermediate revisions by 30 users not shown)
Line 1: Line 1:
This page documents the changes from the [[Protocol|last stable Minecraft release]] (currently [[Protocol version numbers|1.15.2, protocol 578]]) to the current pre-release (currently [[Protocol version numbers|1.16-rc1, protocol 734]]). 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 ===
  
The UUID type is now also sometimes encoded by the Notchian server as an array of four 32-bit integers, from most significant to least significant (matching the new format used on entity NBT)This representation is identical to using 16 bytes, two 64-bit integers, or one 128-bit integers.
+
{| 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]]
 +
|}
 +
 
 +
==== Teleport Flags ====
 +
 
 +
A bit field represented as an {{Type|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.
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Hex Mask
 +
! Field
 +
|-
 +
| 0x0001
 +
| Relative X
 +
|-
 +
| 0x0002
 +
| Relative Y
 +
|-
 +
| 0x0004
 +
| Relative Z
 +
|-
 +
| 0x0008
 +
| Relative Yaw
 +
|-
 +
| 0x0010
 +
| Relative Pitch
 +
|- {{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—the difference in rotation is still used.
 +
|}
  
 
=== Packets ===
 
=== Packets ===
Line 18: Line 68:
 
  !colspan="2"| Documentation
 
  !colspan="2"| Documentation
 
  |-
 
  |-
!colspan="4"| Handshaking serverbound
+
!colspan="4"| Play clientbound
{{PacketList|0x00|Handshake}}
+
{{PacketList|0x12|Close Container}}
 +
{{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}}
 
  |-
 
  |-
!colspan="4"| Play clientbound
+
!colspan="4"| Play serverbound
{{PacketList|0x02|Spawn Weather Entity|pre=removed}}
+
{{PacketList|0x02|Bundle Item Selected|rel=added}}
{{PacketList|{{change|0x03|0x02}}|Spawn Living Entity|pre=unchanged}}
+
{{PacketList|0x0b|Client Tick End|rel=added}}
{{PacketList|{{change|0x04|0x03}}|Spawn Painting|pre=unchanged}}
+
{{PacketList|{{change|0x0E|0x10}}|Click Container}}
{{PacketList|{{change|0x05|0x04}}|Spawn Player|pre=unchanged}}
+
{{PacketList|{{change|0x0F|0x11}}|Close Container}}
{{PacketList|{{change|0x06|0x05}}|Entity Animation (clientbound)|pre=unchanged}}
+
{{PacketList|{{change|0x14|0x16}}|Edit Book}}
{{PacketList|{{change|0x07|0x06}}|Statistics|pre=unchanged}}
+
{{PacketList|{{change|0x1A|0x1C}}|Set Player Position}}
{{PacketList|{{change|0x08|0x07}}|Acknowledge Player Digging|pre=unchanged}}
+
{{PacketList|{{change|0x1B|0x1D}}|Set Player Position and Rotation}}
{{PacketList|{{change|0x09|0x08}}|Block Break Animation|pre=unchanged}}
+
  {{PacketList|{{change|0x1C|0x1E}}|Set Player Rotation}}
{{PacketList|{{change|0x0A|0x09}}|Block Entity Data|pre=unchanged}}
+
{{PacketList|0x1D|Set Player On Ground|pre=removed}}
{{PacketList|{{change|0x0B|0x0A}}|Block Action|pre=unchanged}}
+
{{PacketList|0x1F|Set Player Movement Flags|rel=added}}
{{PacketList|{{change|0x0C|0x0B}}|Block Change|pre=unchanged}}
+
{{PacketList|{{change|0x22|0x24}}|Place Recipe}}
{{PacketList|{{change|0x0D|0x0C}}|Boss Bar|pre=unchanged}}
+
{{PacketList|{{change|0x26|0x28}}|Player Input}}
{{PacketList|{{change|0x0E|0x0D}}|Server Difficulty|pre=unchanged}}
+
{{PacketList|{{change|0x29|0x2B}}|Set Seen Recipe}}
{{PacketList|{{change|0x0F|0x0E}}|Chat Message (clientbound)}}
+
{{PacketList|{{change|0x38|0x3A}}|Use Item On}}
{{PacketList|{{change|0x10|0x0F}}|Multi Block Change|pre=unchanged}}
 
{{PacketList|{{change|0x11|0x10}}|Tab-Complete (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x12|0x11}}|Declare Commands|pre=unchanged}}
 
{{PacketList|{{change|0x13|0x12}}|Window Confirmation (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x14|0x13}}|Close Window (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x15|0x14}}|Window Items|pre=unchanged}}
 
{{PacketList|{{change|0x16|0x15}}|Window Property|pre=unchanged}}
 
{{PacketList|{{change|0x17|0x16}}|Set Slot|pre=unchanged}}
 
{{PacketList|{{change|0x18|0x17}}|Set Cooldown|pre=unchanged}}
 
{{PacketList|{{change|0x19|0x18}}|Plugin Message (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x1A|0x19}}|Named Sound Effect|pre=unchanged}}
 
{{PacketList|{{change|0x1B|0x1A}}|Disconnect (play)|pre=unchanged}}
 
{{PacketList|{{change|0x1C|0x1B}}|Entity Status|pre=unchanged}}
 
{{PacketList|{{change|0x1D|0x1C}}|Explosion|pre=unchanged}}
 
{{PacketList|{{change|0x1E|0x1D}}|Unload Chunk|pre=unchanged}}
 
{{PacketList|{{change|0x1F|0x1E}}|Change Game State|pre=unchanged}}
 
{{PacketList|{{change|0x20|0x1F}}|Open Horse Window|pre=unchanged}}
 
{{PacketList|{{change|0x21|0x20}}|Keep Alive (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x22|0x21}}|Chunk Data}}
 
{{PacketList|{{change|0x23|0x22}}|Effect|pre=unchanged}}
 
{{PacketList|{{change|0x24|0x23}}|Particle|pre=unchanged}}
 
{{PacketList|{{change|0x25|0x24}}|Update Light}}
 
{{PacketList|{{change|0x26|0x25}}|Join Game}}
 
{{PacketList|{{change|0x27|0x26}}|Map Data|pre=unchanged}}
 
{{PacketList|{{change|0x28|0x27}}|Trade List|pre=unchanged}}
 
{{PacketList|{{change|0x29|0x28}}|Entity Position|pre=unchanged}}
 
{{PacketList|{{change|0x2A|0x29}}|Entity Position and Rotation|pre=unchanged}}
 
{{PacketList|{{change|0x2B|0x2A}}|Entity Rotation|pre=unchanged}}
 
{{PacketList|{{change|0x2C|0x2B}}|Entity Movement|pre=unchanged}}
 
{{PacketList|{{change|0x2D|0x2C}}|Vehicle Move (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x2E|0x2D}}|Open Book|pre=unchanged}}
 
{{PacketList|{{change|0x2F|0x2E}}|Open Window|pre=unchanged}}
 
{{PacketList|{{change|0x30|0x2F}}|Open Sign Editor|pre=unchanged}}
 
{{PacketList|{{change|0x31|0x30}}|Craft Recipe Response|pre=unchanged}}
 
{{PacketList|{{change|0x32|0x31}}|Player Abilities (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x33|0x32}}|Combat Event|pre=unchanged}}
 
{{PacketList|{{change|0x34|0x33}}|Player Info|pre=unchanged}}
 
{{PacketList|{{change|0x35|0x34}}|Face Player|pre=unchanged}}
 
{{PacketList|{{change|0x36|0x35}}|Player Position And Look (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x37|0x36}}|Unlock Recipes|pre=unchanged}}
 
{{PacketList|{{change|0x38|0x37}}|Destroy Entities|pre=unchanged}}
 
{{PacketList|{{change|0x39|0x38}}|Remove Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x3A|0x39}}|Resource Pack Send|pre=unchanged}}
 
{{PacketList|{{change|0x3B|0x3A}}|Respawn}}
 
{{PacketList|{{change|0x3C|0x3B}}|Entity Head Look|pre=unchanged}}
 
{{PacketList|{{change|0x3D|0x3C}}|Select Advancement Tab|pre=unchanged}}
 
{{PacketList|{{change|0x3E|0x3D}}|World Border|pre=unchanged}}
 
{{PacketList|{{change|0x3F|0x3E}}|Camera|pre=unchanged}}
 
{{PacketList|{{change|0x40|0x3F}}|Held Item Change (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x41|0x40}}|Update View Position|pre=unchanged}}
 
{{PacketList|{{change|0x42|0x41}}|Update View Distance|pre=unchanged}}
 
{{PacketList|{{change|0x4E|0x42}}|Spawn Position|pre=unchanged}}
 
{{PacketList|{{change|0x4F|0x4E}}|Time Update|pre=unchanged}}
 
{{PacketList|{{change|0x50|0x4F}}|Title|pre=unchanged}}
 
{{PacketList|{{change|0x51|0x50}}|Entity Sound Effect|pre=unchanged}}
 
{{PacketList|{{change|0x52|0x51}}|Sound Effect|pre=unchanged}}
 
{{PacketList|{{change|0x53|0x52}}|Stop Sound|pre=unchanged}}
 
{{PacketList|{{change|0x54|0x53}}|Player List Header And Footer|pre=unchanged}}
 
{{PacketList|{{change|0x55|0x54}}|NBT Query Response|pre=unchanged}}
 
{{PacketList|{{change|0x56|0x55}}|Collect Item|pre=unchanged}}
 
{{PacketList|{{change|0x57|0x56}}|Entity Teleport|pre=unchanged}}
 
{{PacketList|{{change|0x58|0x57}}|Advancements|pre=unchanged}}
 
{{PacketList|{{change|0x59|0x58}}|Entity Properties}}
 
{{PacketList|{{change|0x5A|0x59}}|Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x5B|0x5A}}|Declare Recipes|pre=unchanged}}
 
{{PacketList|{{change|0x5C|0x5B}}|Tags|pre=unchanged}}
 
  |-
 
!colspan="4"| Play serverbound
 
{{PacketList|0x0E|Interact Entity}}
 
{{PacketList|0x0F|Generate Structure|rel=added}}
 
{{PacketList|{{change|0x0F|0x10}}|Keep Alive (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x10|0x11}}|Lock Difficulty|pre=unchanged}}
 
{{PacketList|{{change|0x11|0x12}}|Player Position|pre=unchanged}}
 
{{PacketList|{{change|0x12|0x13}}|Player Position And Rotation (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x13|0x14}}|Player Rotation|pre=unchanged}}
 
{{PacketList|{{change|0x14|0x15}}|Player Movement|pre=unchanged}}
 
{{PacketList|{{change|0x15|0x16}}|Vehicle Move (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x16|0x17}}|Steer Boat|pre=unchanged}}
 
{{PacketList|{{change|0x17|0x18}}|Pick Item|pre=unchanged}}
 
{{PacketList|{{change|0x18|0x19}}|Craft Recipe Request|pre=unchanged}}
 
{{PacketList|{{change|0x19|0x1A}}|Player Abilities (serverbound)}}
 
{{PacketList|{{change|0x1A|0x1B}}|Player Digging|pre=unchanged}}
 
{{PacketList|{{change|0x1B|0x1C}}|Entity Action|pre=unchanged}}
 
{{PacketList|{{change|0x1C|0x1D}}|Steer Vehicle|pre=unchanged}}
 
{{PacketList|{{change|0x1D|0x1E}}|Recipe Book Data|pre=unchanged}}
 
{{PacketList|{{change|0x1E|0x1F}}|Name Item|pre=unchanged}}
 
{{PacketList|{{change|0x1F|0x20}}|Resource Pack Status|pre=unchanged}}
 
{{PacketList|{{change|0x20|0x21}}|Advancement Tab|pre=unchanged}}
 
{{PacketList|{{change|0x21|0x22}}|Select Trade|pre=unchanged}}
 
{{PacketList|{{change|0x22|0x23}}|Set Beacon Effect|pre=unchanged}}
 
{{PacketList|{{change|0x23|0x24}}|Held Item Change (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x24|0x25}}|Update Command Block|pre=unchanged}}
 
{{PacketList|{{change|0x25|0x26}}|Update Command Block Minecart|pre=unchanged}}
 
{{PacketList|{{change|0x26|0x27}}|Creative Inventory Action|pre=unchanged}}
 
{{PacketList|{{change|0x27|0x28}}|Update Jigsaw Block}}
 
{{PacketList|{{change|0x28|0x29}}|Update Structure Block|pre=unchanged}}
 
{{PacketList|{{change|0x29|0x2A}}|Update Sign|pre=unchanged}}
 
{{PacketList|{{change|0x2A|0x2B}}|Animation (serverbound)|pre=unchanged}}
 
{{PacketList|{{change|0x2B|0x2C}}|Spectate|pre=unchanged}}
 
{{PacketList|{{change|0x2C|0x2D}}|Player Block Placement|pre=unchanged}}
 
{{PacketList|{{change|0x2D|0x2E}}|Use Item|pre=unchanged}}
 
{{PacketList|0x47|Entity Equipment}}
 
|-
 
!colspan="4"| Login clientbound
 
{{PacketList|0x02|Login Success}}
 
 
  |}
 
  |}
 
== New/modified data types ==
 
 
No changes so far.
 
  
 
== Entity Metadata ==
 
== Entity Metadata ==
  
{{#vardefine:meta_prerelease|1}}
+
=== Entity Metadata Format ===
  
=== FishingHook ===
+
==== Painting Variant ====
  
{{Metadata inherit|FishingHook|inherits=Entity|start_at=7}}
+
{{See also|Registry Data#Painting Variant}}
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Index
+
  ! Name
 
  ! Type
 
  ! Type
  !style="width: 250px;" colspan="2"| Meaning
+
  ! Meaning
! Default
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
| Width
  | VarInt
+
  | {{Type|Int}}
  |colspan="2"| Hooked entity id + 1, or 0 if there is no hooked entity
+
  | The width of the painting, in blocks.
  | 0
+
|-
  |- {{Added}}
+
  | Height
  | {{Metadata id|added}}
+
| {{Type|Int}}
  | Boolean
+
| The height of the painting, in blocks.
  |colspan="2"| Is catchable
+
|-
  | False
+
| Asset ID
 +
| {{Type|Identifier}}
 +
| 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.
 
  |}
 
  |}
  
=== Abstract Arrow ===
+
== Registry Data ==
  
{{Metadata inherit|Abstract Arrow|inherits=Entity|start_at=7}}
+
=== Painting Variant ===
  
Abstract base class for [[#Tipped Arrow|Tipped Arrow]] (which is used for regular arrows as well as tipped ones) and [[#Spectral Arrow|Spectral Arrow]].
+
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="3" | {{Metadata id|}}
 
| rowspan="3" | Byte
 
! Bit mask
 
 
  ! Meaning
 
  ! Meaning
  | rowspan="3" | 0
+
  ! Values
 
  |-
 
  |-
  | 0x01
+
  | asset_id
  | Is critical
+
  | [[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
  | Is noclip (used by loyalty tridents when returning)
+
  | [[NBT#Specification:int_tag|Int Tag]]
|- {{removed}}
+
  | The height of the painting, in blocks.
| {{Metadata id|removed}}
+
  | Example: <code>2</code>
  | OptUUID
 
  |colspan="2"| Unused
 
| Empty
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | width
  | Byte
+
| [[NBT#Specification:int_tag|Int Tag]]
  |colspan="2"| Peircing level
+
| The width of the painting, in blocks.
  | 0
+
|
 +
|- {{added}}
 +
  | title
 +
  | [[NBT#Specification:compound_tag|Compound Tag]] or [[NBT#Specification:string_tag|String Tag]]
 +
| The displayed title of the painting. See [[Text formatting]].
 +
| Example: <code>{"color": "gray", "translate": "painting.minecraft.skeleton.title"}</code>
 +
|- {{added}}
 +
| author
 +
| [[NBT#Specification:compound_tag|Compound Tag]] or [[NBT#Specification:string_tag|String Tag]]
 +
| The displayed author of the painting. See [[Text formatting]].
 +
  | Example: <code>{"color": "gray", "translate": "painting.minecraft.skeleton.author"}</code>
 
  |}
 
  |}
  
=== Tipped Arrow ===
+
== Slot Data ==
 
 
{{Metadata inherit|Tipped Arrow|inherits=Abstract Arrow}}
 
  
Used for both tipped and regular arrows.  If not tipped, then color is set to -1 and no tipped arrow particles are used.
+
=== 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}}
 +
    |
 +
    |}
 +
|-
 +
| {{change|20|21}}
 +
| <code>minecraft:food</code>
 +
| Makes the item {{change|consumable|restore the player's hunger bar when consumed}}.
 +
| 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.
 +
    |}
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | {{change|21|25}}
  | VarInt
+
| <code>minecraft:{{change|fire|damage}}_resistant</code>
  |colspan="2"| Color (-1 for no particles)
+
| 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.
  | -1
+
  | {{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]].
 +
    |}
 +
  |-
 +
| {{change|31|41}}
 +
| <code>minecraft:potion_contents</code>
 +
| Visual and effects of a potion item.
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Has Potion ID
 +
    | {{Type|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
 +
    | {{Type|Optional}} {{Type|VarInt}}
 +
    | The ID of the potion type in the potion registry. Only present if Has Potion ID is true.
 +
    |-
 +
    | Has Custom Color
 +
    | {{Type|Boolean}}
 +
    | Whether this potion has a custom color. If false, it uses the default color associated with the potion type.
 +
    |-
 +
    | Custom Color
 +
    | {{Type|Optional}} {{Type|Int}}
 +
    | 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}}
 +
    |
 +
    |}
 
  |}
 
  |}
  
=== Spectral Arrow ===
+
=== Other types ===
  
{{Metadata inherit|Spectral Arrow|inherits=Abstract Arrow}}
+
==== Consume Effect ====
  
No additional metadata.
+
WIP
  
=== Trident ===
+
==== Instrument ====
 
 
{{Metadata inherit|Trident|inherits=Abstract Arrow}}
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Index
+
  ! Name
 
  ! Type
 
  ! Type
  !style="width: 250px;" colspan="2"| Meaning
+
  ! Description
! Default
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | Sound Event
  | VarInt
+
| {{Type|Id or}} {{Type|Sound Event}}
  |colspan="2"| Loyalty level (enchantment)
+
  | The sound to be played.
  | 0
+
|-
 +
  | Use duration
 +
| {{change|{{Type|VarInt}}|{{Type|Float}}}}
 +
  | The maximum range of the sound.
 
  |-
 
  |-
  | {{Metadata id|}}
+
| Range
  | Boolean
+
  | {{Type|Float}}
  |colspan="2"| Has enchantment glint
+
  | The range of the instrument.
  | False
+
  |- {{added}}
 +
| Description
 +
| {{Type|Text Component}}
 +
  | Description shown in the item tooltip.
 
  |}
 
  |}
  
=== Strider ===
+
== Particles ==
  
{{Metadata inherit|Strider|inherits=Animal|start_at=16}}
+
{| class="wikitable"
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
  ! Particle Name
  | VarInt
+
  ! Particle ID
  |colspan="2"| Total time to "boost" with warped fungus on a stick for
+
  ! Data
| 0
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | <code>minecraft:dust</code>
  | Boolean
+
| 13
  |colspan="2"| Should display name tag (true unless riding a vehicle or on or in a block tagged with strider_warm_blocks (default: lava))
+
  |
| false
+
  {| class="wikitable"
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Meaning
 +
  |- {{removed}}
 +
  | Red
 +
  | {{Type|Float}}
 +
  | The red RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{removed}}
 +
  | Green
 +
  | {{Type|Float}}
 +
  | The green RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{removed}}
 +
  | Blue
 +
  | {{Type|Float}}
 +
  | The blue RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{added}}
 +
  | Color
 +
  | {{Type|Int}}
 +
  | The color, encoded as 0xRRGGBB; top bits are ignored.
 +
  |-
 +
  | Scale
 +
  | {{Type|Float}}
 +
  | The scale, will be clamped between 0.01 and 4.
 +
  |}
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | <code>minecraft:dust_color_transition</code>
  | Boolean
+
| 14
  |colspan="2"| Has saddle
+
  |
| false
+
  {| class="wikitable"
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Meaning
 +
  |- {{removed}}
 +
  | From Red
 +
  | {{Type|Float}}
 +
  | The start red RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{removed}}
 +
  | From Green
 +
  | {{Type|Float}}
 +
  | The start green RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{removed}}
 +
  | From Blue
 +
  | {{Type|Float}}
 +
  | The start blue RGB value, between 0 and 1. Divide actual RGB value by 255.
 +
  |- {{added}}
 +
  | From Color
 +
  | {{Type|Int}}
 +
  | The start color, encoded as 0xRRGGBB; top bits are ignored.
 +
  |- {{removed}}
 +
  | 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.
 +
  |}
 
  |}
 
  |}
  
=== Hoglin ===
+
== Handshake ==
 +
 
 +
No changes so far.
 +
 
 +
== Status ==
 +
 
 +
No changes so far.
 +
 
 +
== Login ==
 +
 
 +
No changes so far.
  
{{Metadata inherit|Hoglin|inherits=Animal|start_at=16}}
+
== Configuration ==
  
{| class="wikitable" {{added}}
+
No changes so far.
! Index
+
 
! Type
+
== Play ==
!style="width: 250px;" colspan="2"| Meaning
+
 
! Default
+
=== Clientbound ===
|-
 
| {{Metadata id|}}
 
| Boolean
 
|colspan="2"| Is immune to zombification
 
| false
 
|}
 
  
=== Zoglin ===
+
==== Close Container ====
  
{{Metadata inherit|Hoglin|inherits=Monster|start_at=15}}
+
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.
  
{| class="wikitable" {{added}}
+
{| class="wikitable"
  ! Index
+
  ! Packet ID
  ! Type
+
  ! State
  !style="width: 250px;" colspan="2"| Meaning
+
! Bound To
  ! Default
+
! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | ''protocol:''<br/><code>0x12</code><br/><br/>''resource:''<br/><code>container_close</code>
  | Boolean
+
| Play
  |colspan="2"| Is baby
+
| Client
  | false
+
  | Window ID
 +
  | {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
 +
  | This is the ID of the window that was closed. 0 for inventory.
 
  |}
 
  |}
  
=== Piglin ===
+
==== Set Container Content ====
 +
[[File:Inventory-slots.png|thumb|The inventory slots]]
  
{{Metadata inherit|Piglin|inherits=Monster|start_at=15}}
+
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]]).
  
{| class="wikitable" {{added}}
+
{| class="wikitable"
  ! Index
+
  ! Packet ID
  ! Type
+
! State
  !style="width: 250px;" colspan="2"| Meaning
+
! Bound To
  ! Default
+
! Field Name
 +
  ! Field Type
 +
  ! Notes
 +
|-
 +
| rowspan="5"| ''protocol:''<br/><code>0x13</code><br/><br/>''resource:''<br/><code>container_set_content</code>
 +
| 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.)
 
  |-
 
  |-
  | {{Metadata id|}}
+
| State ID
  | Boolean
+
  | {{Type|VarInt}}
|colspan="2"| Is baby
+
  | A server-managed sequence number used to avoid desynchronization; see [[#Click Container]].
| false
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
| Count
  | Boolean
+
  | {{Type|VarInt}}
|colspan="2"| Is immune to zombification
+
  | Number of elements in the following array.
| false
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
| Slot Data
| Boolean
+
  | {{Type|Array}} of [[Slot Data|Slot]]
|colspan="2"| Is charging crossbow
 
| false
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
| Carried Item
  | Boolean
+
  | {{Type|Slot}}
|colspan="2"| Is dancing
+
  | Item being dragged with the mouse.
| false
 
 
  |}
 
  |}
  
=== Wolf ===
+
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.
  
{{Metadata inherit|Wolf|inherits=TameableAnimal|start_at=18}}
+
==== Set Container Property ====
 +
 
 +
This packet is used to inform the client that part of a GUI window should be updated.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Index
+
  ! Packet ID
  ! Type
+
  ! State
  !style="width: 250px;" colspan="2"| Meaning
+
! Bound To
  ! Default
+
! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | rowspan="3"| ''protocol:''<br/><code>0x14</code><br/><br/>''resource:''<br/><code>container_set_data</code>
  | Boolean
+
  | rowspan="3"| Play
  |colspan="2"| Is begging
+
  | rowspan="3"| Client
  | false
+
| Window ID
 +
| {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
 +
  |
 
  |-
 
  |-
  | {{Metadata id|}}
+
  | Property
  | VarInt
+
  | {{Type|Short}}
|colspan="2"| Collar color (values are those {{Minecraft Wiki|Data_values#Dyes|used with dyes}})
+
  | The property to be updated, see below.
  | 14 (Red)
 
 
  |-
 
  |-
  | {{Metadata id|}}
+
| Value
  | VarInt
+
  | {{Type|Short}}
|colspan="2"| Anger time
+
  | The new value for the property, see below.
| 0
 
 
  |}
 
  |}
  
 +
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.
  
=== {{Change|Zombie Pigman|Zombified Piglin}} ===
+
{| class="wikitable"
 +
|-
 +
! Window type
 +
! Property
 +
! Value
 +
|-
 +
| rowspan="4"| 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
 +
|-
 +
| rowspan="10"| Enchantment Table
 +
| 0: Level requirement for top enchantment slot
 +
| rowspan="3"| 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 [[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>).
 +
|-
 +
| 4: Enchantment ID shown on mouse hover over top enchantment slot
 +
| rowspan="3"| 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
 +
| rowspan="3"| 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
 +
|-
 +
| rowspan="3"| Beacon
 +
| 0: Power level
 +
| 0-4, controls what effect buttons are enabled
 +
|-
 +
| 1: First potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
 +
|-
 +
| 2: Second potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
 +
|-
 +
| Anvil
 +
| 0: Repair cost
 +
| The repair's cost in xp levels
 +
|-
 +
| rowspan="2"| 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.
 +
|}
  
{{Metadata inherit|{{Change|Zombie Pigman|Zombified Piglin}}|inherits=Zombie|start_at=18}}
+
For an enchanting table, the following numerical IDs are used:
  
No additional metadata.
+
{| class="wikitable"
 +
! 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
 +
|}
  
== Block Actions ==
+
==== Set Container Slot ====
  
No changes so far.
+
Sent by the server when an item in a slot (in a window) is added/removed.
  
== Inventories ==
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="4"| ''protocol:''<br/><code>0x15</code><br/><br/>''resource:''<br/><code>container_set_slot</code>
 +
| rowspan="4"| Play
 +
| rowspan="4"| Client
 +
| Window ID
 +
| {{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]].
 +
|-
 +
| Slot
 +
| {{Type|Short}}
 +
| The slot that should be updated.
 +
|-
 +
| Slot Data
 +
| {{Type|Slot}}
 +
|
 +
|}
  
No changes so far.
+
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].)
 
 
== Plugin Channels ==
 
 
 
No changes so far.
 
  
== Play ==
+
{{change|If Window ID is -1, the item being dragged with the mouse is set. In this case, State ID and Slot are ignored.|}}
  
=== Clientbound ===
+
{{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.|}}
  
==== Chat Message (clientbound) ====
+
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.
  
Identifying the difference between Chat/System Message is important as it helps respect the user's chat visibility options.  See [[Chat#Processing chat|processing chat]] for more info about these positions.
+
==== Set Cooldown ====
  
{{warning2|Game info accepts json formatting but does not display it, although the deprecated §-based formatting works.  This is not an issue when using the [[#Title|Title]] packet, so prefer that packet for displaying information in that slot.  See [https://bugs.mojang.com/browse/MC-119145 MC-119145] for more information.}}
+
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).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 403: 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="3"| {{change|0x0F|0x0E}}
+
  | Cooldown Ticks
  |rowspan="3"| Play
+
| {{Type|VarInt}}
|rowspan="3"| Client
+
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
| JSON Data
 
| [[Chat]]
 
| Limited to 32767 bytes
 
|-
 
| Position
 
| Byte
 
| 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
 
|- {{added}}
 
| Sender
 
| UUID
 
| Used by the Notchian client for the disableChat launch option. Setting both longs to 0 will always display the message regardless of the setting.
 
 
  |}
 
  |}
  
==== Chunk Data ====
+
==== Teleport Entity ====
{{Main|Chunk Format}}
 
{{See also|#Unload Chunk}}
 
  
{{Need Info|How do biomes work now?  The biome change happened at the same time as the seed change, but it's not clear how/if biomes could be computed given that it's not the actual seed...  ([https://www.reddit.com/r/Mojira/comments/e5at6i/a_discussion_for_the_changes_to_how_biomes_are/ /r/mojira discussion] which notes that it seems to be some kind of interpolation, and 3D biomes are only used in the nether)}}
+
{{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.}}}}
  
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).
+
This packet is sent by the server when an entity moves more than 8 blocks.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 436: Line 1,054:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="11"| {{change|0x22|0x21}}
+
  | rowspan="10"| ''protocol:''<br/><code>{{change|0x70|0x20}}</code><br/><br/>''resource:''<br/><code>{{change|teleport_entity|entity_position_sync}}</code>
  |rowspan="11"| Play
+
  | rowspan="10"| Play
  |rowspan="11"| Client
+
  | rowspan="10"| Client
  | Chunk X
+
  | Entity ID
  | Int
+
  | {{Type|VarInt}}
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  |
 
  |-
 
  |-
  | Chunk Z
+
  | X
  | Int
+
  | {{Type|Double}}
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  |  
 
  |-
 
  |-
  | Full chunk
+
  | Y
  | Boolean
+
  | {{Type|Double}}
| See [[Chunk Format#Full chunk|Chunk Format]]
+
  |
|- {{Added}}
 
  | Ignore old data
 
| Boolean
 
| If false, the client will recalculate lighting based on the old/new chunk data
 
 
  |-
 
  |-
  | Primary Bit Mask
+
  | Z
  | VarInt
+
  | {{Type|Double}}
  | 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).
+
|
 +
|- {{added}}
 +
| Velocity X
 +
| {{Type|Double}}
 +
|
 +
|- {{added}}
 +
| Velocity Y
 +
| {{Type|Double}}
 +
|
 +
|- {{added}}
 +
| Velocity Z
 +
| {{Type|Double}}
 +
  |
 
  |-
 
  |-
  | Heightmaps
+
  | Yaw
  | [[NBT]]
+
  | {{change|{{Type|Angle}}|{{Type|Float}}}}
  | Compound containing one long array named <code>MOTION_BLOCKING</code>, which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry totaling 36 longs). The Notchian server also adds a <code>WORLD_SURFACE</code> long array, the purpose of which is unknown, but it's not required for the chunk to be accepted.
+
  | Rotation on the X axis, in degrees.
 
  |-
 
  |-
  | Biomes
+
  | Pitch
  | Optional array of Integer
+
  | {{change|{{Type|Angle}}|{{Type|Float}}}}
| 1024 biome IDs, ordered by x then z then y, in 4&times;4&times;4 blocks.  Not present if full chunk is false.
+
  | Rotation on the Y axis, in degrees.
|-
 
| Size
 
| VarInt
 
  | Size of Data in bytes
 
 
  |-
 
  |-
  | Data
+
  | On Ground
  | Byte array
+
  | {{Type|Boolean}}
| See [[Chunk Format#Data structure|data structure]] in Chunk Format
+
  |
|-
+
|}
| Number of block entities
 
  | VarInt
 
| Number of elements in the following array
 
|-
 
| Block entities
 
| Array of [[NBT|NBT Tag]]
 
| All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 
|}
 
  
Note that the Notchian client requires an [[#Update View Position|Update View Position]] packet when it crosses a chunk border, otherwise it'll only display render distance + 2 chunks around the chunk it spawned in.
+
==== Explosion ====
  
{{Change||The compacted array format has been adjusted so that individual entries no longer span across multiple longs, affecting the main data array and heightmaps.}}
+
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
  
==== Update Light ====
+
{{change|Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x|}}
 
 
Updates light levels for a chunk.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 496: 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="11"| {{change|0x25|0x24}}
+
  | rowspan="16"| ''protocol:''<br/><code>{{change|0x20|0x21}}</code><br/><br/>''resource:''<br/><code>explode</code>
  |rowspan="11"| Play
+
  | rowspan="16"| Play
  |rowspan="11"| Client
+
  | rowspan="16"| Client
  |colspan="2"| Chunk X
+
  | X
  |colspan="2"| VarInt
+
| {{Type|Double}}
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
|
 +
|-
 +
| Y
 +
  | {{Type|Double}}
 +
  |
 
  |-
 
  |-
  |colspan="2"| Chunk Z
+
  | Z
  |colspan="2"| VarInt
+
| {{Type|Double}}
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
|
 +
|- {{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}}
 
  |- {{added}}
  |colspan="2"| Trust Edges
+
  | Has Player Motion
  |colspan="2"| Boolean
+
  | {{Type|Boolean}}
| If edges should be trusted for light updates.
 
 
  |
 
  |
 
  |-
 
  |-
  |colspan="2"| Sky Light Mask
+
  | Player Motion X
  |colspan="2"| VarInt
+
  | {{change|{{Type|Float}}|{{Type|Optional}} {{Type|Double}}}}
  | Mask containing 18 bits, with the lowest bit corresponding to chunk section -1 (in the void, y=-16 to y=-1) and the highest bit for chunk section 16 (above the world, y=256 to y=271)
+
  | X velocity of the player being pushed by the explosion.{{change|| Only present if Has Player Motion is true.}}
 
  |-
 
  |-
  |colspan="2"| Block Light Mask
+
  | Player Motion Y
  |colspan="2"| VarInt
+
  | {{change|{{Type|Float}}|{{Type|Optional}} {{Type|Double}}}}
  | Mask containing 18 bits, with the same order as sky light
+
  | Y velocity of the player being pushed by the explosion.{{change|| Only present if Has Player Motion is true.}}
 
  |-
 
  |-
  |colspan="2"| Empty Sky Light Mask
+
  | Player Motion Z
  |colspan="2"| VarInt
+
| {{change|{{Type|Float}}|{{Type|Optional}} {{Type|Double}}}}
  | Mask containing 18 bits, which indicates sections that have 0 for all their sky light values.  If a section is set in both this mask and the main sky light mask, it is ignored for this mask and it is included in the sky light arrays (the notchian server does not create such masks).  If it is only set in this mask, it is not included in the sky light arrays.
+
| 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.
 
  |-
 
  |-
  |colspan="2"| Empty Block Light Mask
+
  | {{change|Small |}}Explosion Particle ID
  |colspan="2"| VarInt
+
  | {{Type|VarInt}}
  | Mask containing 18 bits, which indicates sections that have 0 for all their block light values.  If a section is set in both this mask and the main block light mask, it is ignored for this mask and it is included in the block light arrays (the notchian server does not create such masks).  If it is only set in this mask, it is not included in the block light arrays.
+
  | The particle ID listed in [[Particles]].
 
  |-
 
  |-
  |rowspan="2"| Sky Light arrays
+
  | {{change|Small |}}Explosion Particle Data
  | Length
+
  | Varies
  |rowspan="2"| Array
+
  | Particle data as specified in [[Particles]].
  | VarInt
+
|- {{removed}}
  | Length of the following array in bytes (always 2048)
+
  | Large Explosion Particle ID
 +
| {{Type|VarInt}}
 +
| The particle ID listed in [[Particles]].
 +
|- {{removed}}
 +
| Large Explosion Particle Data
 +
| Varies
 +
  | Particle data as specified in [[Particles]].
 
  |-
 
  |-
  | Sky Light array
+
  | Explosion Sound
  | Array of 2048 bytes
+
  | {{Type|ID or}} {{Type|Sound Event}}
  | There is 1 array for each bit set to true in the sky light mask, starting with the lowest valueHalf a byte per light value.
+
  | ID in the <code>minecraft:sound_event</code> registry, or an inline definition.
 +
|}
 +
 
 +
==== Open Horse Screen ====
 +
 
 +
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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| ''protocol:''<br/><code>0x23</code><br/><br/>''resource:''<br/><code>horse_screen_open</code>
 +
| rowspan="3"| Play
 +
| rowspan="3"| Client
 +
| Window ID
 +
| {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
 +
|
 
  |-
 
  |-
  |rowspan="2"| Block Light arrays
+
  | Slot count
| Length
+
  | {{Type|VarInt}}
  |rowspan="2"| Array
+
  |
| VarInt
 
  | Length of the following array in bytes (always 2048)
 
 
  |-
 
  |-
  | Block Light array
+
  | Entity ID
  | Array of 2048 bytes
+
  | {{Type|Int}}
  | There is 1 array for each bit set to true in the block light mask, starting with the lowest value.  Half a byte per light value.
+
  |
 
  |}
 
  |}
  
Individual block or sky light arrays are is given for each block with increasing x coordinates, within rows of increasing z coordinates, within layers of increasing y coordinates. Even-indexed items (those with an even x coordinate, starting at 0) are packed into the low bits, odd-indexed into the high bits.
+
==== Login (play) ====
  
==== Join Game ====
+
{{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?}}
  
 
See [[Protocol Encryption]] for information on logging in.
 
See [[Protocol Encryption]] for information on logging in.
Line 567: Line 1,222:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="16"| {{change|0x26|0x25}}
+
  | rowspan="23"| ''protocol:''<br/><code>{{change|0x2B|0x2C}}</code><br/><br/>''resource:''<br/><code>login</code>
  |rowspan="16"| Play
+
  | rowspan="23"| Play
  |rowspan="16"| Client
+
  | rowspan="23"| Client
 
  | Entity ID
 
  | Entity ID
  | Int
+
  | {{Type|Int}}
  | The player's Entity ID (EID)
+
  | The player's Entity ID (EID).
 
  |-
 
  |-
  | Gamemode
+
  | Is hardcore
| Unsigned Byte
+
  | {{Type|Boolean}}
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. Bit 3 (0x8) is the hardcore flag.
+
  |
  |- {{Added}}
 
| Previous Gamemode
 
| Unsigned Byte
 
| 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included. The previous gamemode. (More information needed)
 
|- {{Added}}
 
  | World Count
 
| VarInt
 
| Size of the following array
 
|- {{Added}}
 
| World Names
 
| Array of Identifier
 
| Identifiers for all worlds on the server
 
|- {{Added}}
 
| Dimension Codec
 
| [[NBT|NBT Tag Compound]]
 
| This CompoundTag contains a ListTag named "dimension". The ListTag should contain CompoundTags with named StringTags "key" and "element". The full extent of these is still unknown, but the tag represents a dimension registry. See below for the vanilla default.
 
 
  |-
 
  |-
  | Dimension
+
  | Dimension Count
  | {{change|Int Enum|Identifier}}
+
  | {{Type|VarInt}}
| {{change|-1: The Nether, 0: The Overworld, 1: The End|Valid dimensions are defined per dimension registry sent before this}}
+
  | Size of the following array.
  |- {{Added}}
 
| World Name
 
| Identifier
 
| Name of the world being spawned into
 
 
  |-
 
  |-
  | Hashed seed
+
  | Dimension Names
  | Long
+
  | {{Type|Array}} of {{Type|Identifier}}
  | First 8 bytes of the SHA-256 hash of the world's seed.
+
  | Identifiers for all dimensions on the server.
 
  |-
 
  |-
 
  | Max Players
 
  | Max Players
  | Unsigned Byte
+
  | {{Type|VarInt}}
  | Was once used by the client to draw the player list, but now is ignored
+
  | Was once used by the client to draw the player list, but now is ignored.
|- {{Removed}}
 
| Level Type
 
| String Enum (16)
 
| default, flat, largeBiomes, amplified, customized, buffet, default_1_1
 
 
  |-
 
  |-
 
  | View Distance
 
  | View Distance
  | VarInt
+
  | {{Type|VarInt}}
  | Render distance (2-32)
+
  | Render distance (2-32).
 +
|-
 +
| Simulation Distance
 +
| {{Type|VarInt}}
 +
| The distance that the client will process specific things, such as entities.
 
  |-
 
  |-
 
  | Reduced Debug Info
 
  | Reduced Debug Info
  | Boolean
+
  | {{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.
 
  | 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
 
  | Enable respawn screen
  | Boolean
+
  | {{Type|Boolean}}
  | Set to false when the doImmediateRespawn gamerule is true
+
  | Set to false when the doImmediateRespawn gamerule is true.
  |- {{Added}}
+
|-
 +
| 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
 
  | Is Debug
  | Boolean
+
  | {{Type|Boolean}}
  | True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks
+
  | True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
  |- {{Added}}
+
  |-
 
  | Is Flat
 
  | Is Flat
  | Boolean
+
  | {{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
+
  | 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}}
 +
|
 
  |}
 
  |}
Example of Dimension codec CompoundTag sent by the server:
 
    ListTag (Type: CompoundTag) "dimension":
 
        CompoundTag:
 
            StringTag "name" value: 'minecraft:overworld'
 
            ByteTag "natural": 1
 
            Some more attributes ...
 
  
Known attributes :
+
==== Move Minecart Along Track ====
  
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! 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}}
 +
|
 +
|-
 +
| Y
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Velocity X
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Velocity Y
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Velocity Z
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Yaw
 +
| {{Type|Angle}}
 +
|
 +
|-
 +
| Pitch
 +
| {{Type|Angle}}
 +
|
 +
|-
 +
| Weight
 +
| {{Type|Float}}
 +
|}
 +
 +
==== Player Info Update ====
 +
 +
Sent by the server to update the user list (<tab> in the client).
 
{| class="wikitable"
 
{| class="wikitable"
  ! Name
+
  ! Packet ID
  ! Type
+
! State
  !style="width: 250px;" colspan="2"| Meaning
+
! Bound To
  ! Values
+
! colspan="2"| Field Name
 +
  ! 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
 +
|-
 +
| rowspan="6" | Add Player
 +
| rowspan="6" | 0x01
 +
| colspan="2" | Name
 +
| colspan="2" | {{Type|String}} (16)
 +
|-
 +
| 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)
 +
|
 
  |-
 
  |-
  | name
+
  | Is Signed
  | String
+
  | {{Type|Boolean}}
|colspan="2"| Dimension's name
+
  |
  | "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" or something else
 
 
  |-
 
  |-
  | natural
+
  | Signature
  | Byte
+
  | {{Type|Optional}} {{Type|String}} (32767)
|colspan="2"| Is it a standard overworld like dimension
+
  | Only if Is Signed is true.
  | 1: true, 0: false
 
 
  |-
 
  |-
  | ambient_light
+
  | rowspan="7" | Initialize Chat
  | Float
+
  | rowspan="7" | 0x02
  |colspan="2"| Ambient light
+
  | colspan="2" | Has Signature Data
  | 0.0 to 1.0
+
  | colspan="2" | {{Type|Boolean}}
 
  |-
 
  |-
  | has_ceiling
+
  | colspan="2" | Chat session ID
| Byte
+
  | colspan="2" | {{Type|UUID}}
  |colspan="2"| Does the dimension have blocks on top ? Like the nether
+
  | Only sent if Has Signature Data is true.
  | 1: true, 0: false
 
 
  |-
 
  |-
  | has_skylight
+
  | colspan="2" | Public key expiry time
| Byte
+
  | colspan="2" | {{Type|Long}}
  |colspan="2"| Does the dimension have natural sky light
+
  | Key expiry time, as a UNIX timestamp in milliseconds. Only sent if Has Signature Data is true.
  | 1: true, 0: false
 
 
  |-
 
  |-
  | fixed_time
+
  | colspan="2" | Encoded public key size
| Long
+
  | colspan="2" | {{Type|VarInt}}
  |colspan="2"| Set fixed minecraft clock time
+
  | Size of the following array. Only sent if Has Signature Data is true. Maximum length is 512 bytes.
  | 0 to 12000
 
 
  |-
 
  |-
  | shrunk
+
  | colspan="2" | Encoded public key
| Byte
+
  | colspan="2" | {{Type|Byte Array}} (512)
  |colspan="2"| ?
+
  | The player's public key, in bytes. Only sent if Has Signature Data is true.
  | 1: true, 0: false
 
 
  |-
 
  |-
  | ultrawarm
+
  | colspan="2" | Public key signature size
| Byte
+
  | colspan="2" | {{Type|VarInt}}
  |colspan="2"| ?
+
  | Size of the following array. Only sent if Has Signature Data is true. Maximum length is 4096 bytes.
  | 1: true, 0: false
 
 
  |-
 
  |-
  | has_raids
+
  | colspan="2" | Public key signature
| Byte
+
  | colspan="2" | {{Type|Byte Array}} (4096)
  |colspan="2"| ?
+
  | The public key's digital signature. Only sent if Has Signature Data is true.
  | 1: true, 0: false
 
 
  |-
 
  |-
  | respawn_anchor_works
+
  | Update Game Mode
  | Byte
+
  | 0x04
  |colspan="2"| Wether or not respawn anchor can be used
+
  | colspan="2" | Game Mode
  | 1: true, 0: false
+
  | colspan="2" | {{Type|VarInt}}
 
  |-
 
  |-
  | bed_works
+
  | Update Listed
  | Byte
+
  | 0x08
  |colspan="2"| Wether or not beds can be used
+
  | colspan="2" | Listed
  | 1: true, 0: false
+
| colspan="2" | {{Type|Boolean}}
 +
  | Whether the player should be listed on the player list.
 
  |-
 
  |-
  | piglin_safe
+
  | Update Latency
  | Byte
+
  | 0x10
  |colspan="2"| ?
+
  | colspan="2" | Ping
  | 1: true, 0: false
+
  | colspan="2" | {{Type|VarInt}}
 +
| Measured in milliseconds.
 
  |-
 
  |-
  | logical_height
+
  | rowspan="2" | Update Display Name
  | Byte / Int ?
+
  | rowspan="2" | 0x20
  |colspan="2"| Maybe the world's max height in blocks ?
+
  | colspan="2" | Has Display Name
  | ?
+
  | colspan="2" | {{Type|Boolean}}
 
  |-
 
  |-
  | infiniburn
+
  | colspan="2" | Display Name
  | String
+
| colspan="2" | {{Type|Optional}} {{Type|Text Component}}
  |colspan="2"| ?
+
  | Only sent if Has Display Name is true.
  | "" or minecraft resource "minecraft:..."
+
|- {{added}}
 +
| Update List Priority
 +
| 0x40
 +
  | colspan="2" | Priority
 +
  | colspan="2" | {{Type|VarInt}}
 +
| See below.
 
  |}
 
  |}
  
==== Respawn ====
+
The properties included in this packet are the same as in [[#Login Success|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:
 +
* {{change||Players with higher priorities are sorted before those with lower priorities.}}
 +
* {{change||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|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 [https://bugs.mojang.com/browse/MC-90097 MC-90097]).
  
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.
+
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 732: Line 1,541:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="9"| {{Change|0x3B|0x3A}}
+
  | rowspan="11"| ''protocol:''<br/><code>{{change|0x40|0x42}}</code><br/><br/>''resource:''<br/><code>player_position</code>
  |rowspan="9"| Play
+
  | rowspan="11"| Play
  |rowspan="9"| Client
+
  | rowspan="11"| Client
  | Dimension
+
  | {{added}} | Teleport ID
  | {{change|Int Enum|Identifier}}
+
  | {{added}} | {{Type|VarInt}}
| {{change|-1: The Nether, 0: The Overworld, 1: The End|Valid dimensions are defined per dimension registry sent in [[#Join Game|Join Game]]}}
+
  | {{added}} | Client should confirm this packet with [[#Confirm Teleportation|Confirm Teleportation]] containing the same Teleport ID.
  |- {{Added}}
 
| World Name
 
| Identifier
 
| Name of the world being spawned into
 
 
  |-
 
  |-
  | Hashed seed
+
  | X
  | Long
+
  | {{Type|Double}}
  | First 8 bytes of the SHA-256 hash of the world's seed.
+
| Absolute or relative position, depending on Flags.
 +
  |-
 +
| Y
 +
| {{Type|Double}}
 +
| Absolute or relative position, depending on Flags.
 
  |-
 
  |-
  | Gamemode
+
  | Z
  | Unsigned Byte
+
  | {{Type|Double}}
| 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
+
  | Absolute or relative position, depending on Flags.
|- {{Added}}
+
  |- {{added}}
  | Previous Gamemode
+
  | Velocity X
| Unsigned Byte
+
  | {{Type|Double}}
| 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included. The previous gamemode. (More information needed)
+
  |
  |- {{Removed}}
+
  |- {{added}}
  | Level Type
+
  | Velocity Y
| String (16)
+
  | {{Type|Double}}
  | Same as [[#Join Game|Join Game]]
+
|
|- {{Added}}
 
  | Is Debug
 
| Boolean
 
| True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks
 
  |- {{Added}}
 
  | Is Flat
 
  | 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
 
 
  |- {{added}}
 
  |- {{added}}
  | Copy metadata
+
  | Velocity Z
  | Boolean
+
  | {{Type|Double}}
  | If false, metadata is reset on the respawned player entitySet to true for dimension changes (including the dimension change triggered by sending client status perform respawn to exit the end poem/credits), and false for normal respawns.
+
|
 +
|-
 +
  | Yaw
 +
| {{Type|Float}}
 +
| Absolute or relative rotation on the X axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Absolute or relative rotation on the Y axis, in degrees.
 +
  |-
 +
| Flags
 +
| {{change|{{Type|Byte}}|{{Type|Teleport Flags}}}}
 +
| {{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.
 
  |}
 
  |}
  
{{Need Info|Does the new World Name field resolve this same-dimension issue?}}
+
==== Player Rotation ====
  
{{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).
+
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| ''protocol:''<br/><code>0x43</code><br/><br/>''resource:''<br/><code>player_rotation</code>
 +
| rowspan="2"| Play
 +
| rowspan="2"| Client
 +
| Yaw
 +
| {{Type|Float}}
 +
| Rotation on the X axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Rotation on the Y axis, in degrees.
 +
|}
  
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.}}
+
==== Place Ghost Recipe ====
  
==== Entity Properties ====
+
Response to the serverbound packet ([[#Place Recipe|Place Recipe]]), with the same recipe ID. Appears to be used to notify the UI.
 
 
Sets {{Minecraft Wiki|Attribute|attributes}} on the given entity.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 786: Line 1,619:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| {{change|0x59|0x58}}
+
  | rowspan="4"| ''protocol:''<br/><code>{{change|0x37|0x39}}</code><br/><br/>''resource:''<br/><code>place_ghost_recipe</code>
  |rowspan="6"| Play
+
  | rowspan="4"| Play
  |rowspan="6"| Client
+
  | rowspan="4"| Client
  |colspan="2"| Entity ID
+
  | Window ID
  |colspan="2"| VarInt
+
| {{change|{{Type|Byte}}|{{Type|VarInt}}}}
  |  
+
|
 +
|- {{removed}}
 +
| Recipe
 +
| {{Type|Identifier}}
 +
| A recipe ID.
 +
|- {{added}}
 +
| Recipe Display ID
 +
| {{Type|VarInt}}
 +
| ID in the <code>minecraft:recipe_display</code> registry.
 +
|- {{added}}
 +
| Recipe Data
 +
| Varies
 +
| Depends on Recipe Type; see below.
 +
|}
 +
 
 +
''below''
 +
 
 +
==== Recipe Book Add ====
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! colspan="2"| Notes
 +
|-
 +
| rowspan="10"| ''protocol:''<br/><code>0x44</code><br/><br/>''resource:''<br/><code>recipe_book_add</code>
 +
| rowspan="10"| Play
 +
| rowspan="10"| Client
 +
| colspan="2"| Recipe Count
 +
  | colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| rowspan="8"| Recipes
 +
| Recipe ID
 +
| rowspan="8"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
| ID to assign to the recipe.
 +
|-
 +
| Display ID
 +
| {{Type|VarInt}}
 +
| ID in the <code>minecraft:recipe_display</code> registry.
 +
|-
 +
| Group ID
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Category ID
 +
| {{Type|VarInt}}
 +
| ID in the <code>minecraft:recipe_book_category</code> registry.
 +
|-
 +
| Has Ingredients
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Ingredient Count
 +
| {{Type|Optional}} {{Type|VarInt}}
 +
  | Number of elements in the following array. Only present if Has Ingredients is true.
 
  |-
 
  |-
  |colspan="2"| Number Of Properties
+
  | Ingredients
  |colspan="2"| Int
+
  | {{Type|Optional}} {{Type|Array}} of {{Type|ID Set}}
  | Number of elements in the following array
+
  | IDs in the <code>minecraft:item</code> registry, or an inline definition. Only present if Has Ingredients is true.
 
  |-
 
  |-
  |rowspan="4"| Property
+
  | Flags
| Key
+
  | {{Type|Byte}}
|rowspan="4"| Array
+
  | 0x01: show notification; 0x02: highlight as new
  | {{Change|String (64)|Identifier}}
 
  | See below
 
 
  |-
 
  |-
  | Value
+
  | colspan="2"| Replace
  | Double
+
| colspan="2"| {{Type|Boolean}}
  | See below
+
  | Replace or Add to known recipes
 +
  |}
 +
 
 +
==== Recipe Book Remove ====
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Number Of Modifiers
+
  | rowspan="2"| ''protocol:''<br/><code>0x45</code><br/><br/>''resource:''<br/><code>recipe_book_remove</code>
  | VarInt
+
| rowspan="2"| Play
  | Number of elements in the following array
+
| rowspan="2"| Client
 +
| Recipe Count
 +
  | {{Type|VarInt}}
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  | Modifiers
+
  | Recipes
  | Array of Modifier Data
+
  | {{Type|Array}} of {{Type|VarInt}}
| See {{Minecraft Wiki|Attribute#Modifiers}}. Modifier Data defined below.
+
| IDs of recipes to remove.
 
  |}
 
  |}
  
Known Key values (see also {{Minecraft Wiki|Attribute#Modifiers}}):
+
==== Recipe Book Settings ====
  
{| class="wikitable"
+
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Key
+
  | rowspan="8"| ''protocol:''<br/><code>0x46</code><br/><br/>''resource:''<br/><code>recipe_book_settings</code>
  ! Default
+
  | rowspan="8"| Play
  ! Min
+
  | rowspan="8"| Client
  ! Max
+
  | Crafting Recipe Book Open
  ! Label
+
  | {{Type|Boolean}}
 +
| If true, then the crafting recipe book will be open when the player opens its inventory.
 
  |-
 
  |-
  | {{change|generic.maxHealth|generic.max_health}}
+
| Crafting Recipe Book Filter Active
  | 20.0
+
  | {{Type|Boolean}}
| 0.0
+
  | If true, then the filtering option is active when the players opens its inventory.
| 1024.0
 
| Max Health
 
 
  |-
 
  |-
  | {{change|generic.followRange|generic.follow_range}}
+
| Smelting Recipe Book Open
  | 32.0
+
  | {{Type|Boolean}}
| 0.0
+
  | If true, then the smelting recipe book will be open when the player opens its inventory.
| 2048.0
 
| Follow Range
 
 
  |-
 
  |-
  | {{change|generic.knockbackResistance|generic.knockback_resistance}}
+
| Smelting Recipe Book Filter Active
  | 0.0
+
  | {{Type|Boolean}}
| 0.0
+
  | If true, then the filtering option is active when the players opens its inventory.
| 1.0
 
| Knockback Resistance
 
 
  |-
 
  |-
  | {{change|generic.movementSpeed|generic.movement_speed}}
+
| Blast Furnace Recipe Book Open
  | 0.7
+
  | {{Type|Boolean}}
| 0.0
+
  | If true, then the blast furnace recipe book will be open when the player opens its inventory.
| 1024.0
 
| Movement Speed
 
 
  |-
 
  |-
  | {{change|generic.attackDamage|generic.attack_damage}}
+
| Blast Furnace Recipe Book Filter Active
  | 2.0
+
  | {{Type|Boolean}}
| 0.0
+
  | If true, then the filtering option is active when the players opens its inventory.
| 2048.0
 
| Attack Damage
 
 
  |-
 
  |-
  | {{change|generic.attackSpeed|generic.attack_speed}}
+
| Smoker Recipe Book Open
  | 4.0
+
  | {{Type|Boolean}}
| 0.0
+
  | If true, then the smoker recipe book will be open when the player opens its inventory.
| 1024.0
 
| Attack Speed
 
 
  |-
 
  |-
  | {{change|generic.flyingSpeed|generic.flying_speed}}
+
| Smoker Recipe Book Filter Active
  | 0.4
+
  | {{Type|Boolean}}
  | 0.0
+
| If true, then the filtering option is active when the players opens its inventory.
  | 1024.0
+
|}
  | Flying Speed
+
 
 +
==== Respawn ====
 +
 
 +
{{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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
  |-
 +
| rowspan="13"| ''protocol:''<br/><code>{{change|0x47|0x4C}}</code><br/><br/>''resource:''<br/><code>respawn</code>
 +
| rowspan="13"| Play
 +
| 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.
 +
  |-
 +
| Dimension Name
 +
  | {{Type|Identifier}}
 +
  | Name of the dimension being spawned into.
 
  |-
 
  |-
  | generic.armor
+
  | Hashed seed
  | 0.0
+
  | {{Type|Long}}
| 0.0
+
  | First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
  | 30.0
 
| Armor
 
 
  |-
 
  |-
  | {{change|generic.armorToughness|generic.armor_toughness}}
+
| Game mode
  | 0.0
+
  | {{Type|Unsigned Byte}}
| 0.0
+
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
| 20.0
 
| Armor Toughness
 
 
  |-
 
  |-
  | {{change|generic.attackKnockback|generic.attack_knockback}}
+
| Previous Game mode
  | 0.0
+
  | {{Type|Byte}}
| 0.0
+
  | -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)
| 5.0
 
| &mdash;
 
 
  |-
 
  |-
  | generic.luck
+
  | Is Debug
  | 0.0
+
  | {{Type|Boolean}}
  | -1024.0
+
  | True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
| 1024.0
 
| Luck
 
 
  |-
 
  |-
  | {{change|horse.jumpStrength|horse.jump_strength}}
+
| Is Flat
  | 0.7
+
  | {{Type|Boolean}}
| 0.0
+
  | 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.
| 2.0
 
| Jump Strength
 
 
  |-
 
  |-
  | {{change|zombie.spawnReinforcements|zombie.spawn_reinforcements}}
+
| Has death location
  | 0.0
+
  | {{Type|Boolean}}
| 0.0
+
  | If true, then the next two fields are present.
| 1.0
 
| Spawn Reinforcements Chance
 
 
  |-
 
  |-
  | generic.reachDistance
+
  | Death dimension Name
  | 5.0
+
  | {{Type|Optional}} {{Type|Identifier}}
| 0.0
+
  | Name of the dimension the player died in.
  | 1024.0
 
| Player Reach Distance (Forge only)
 
 
  |-
 
  |-
  | forge.swimSpeed
+
  | Death location
  | 1.0
+
| {{Type|Optional}} {{Type|Position}}
  | 0.0
+
| The location that the player died at.
  | 1024.0
+
  |-
  | Swimming Speed (Forge only)
+
| Portal cooldown
 +
| {{Type|VarInt}}
 +
| The number of ticks until the player can use the portal again.
 +
  |- {{added}}
 +
| Sea level
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Data kept
 +
  | {{Type|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.
 
  |}
 
  |}
  
Unknown attributes will cause a game crash ([https://bugs.mojang.com/browse/MC-150405 MC-150405]) due to the default minimum being larger than the default value.
+
{{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.}}
  
''Modifier Data'' structure:
+
==== Set Cursor Item ====
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x5A
 +
| Play
 +
| Client
 +
| Slot Data
 +
| {{Type|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 <code>20</code> every second.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
 +
| rowspan="3"| ''protocol:''<br/><code>{{change|0x64|0x6B}}</code><br/><br/>''resource:''<br/><code>set_time</code>
 +
| rowspan="3"| Play
 +
| rowspan="3"| Client
 +
| World Age
 +
| {{Type|Long}}
 +
| In ticks; not changed by server commands.
 +
|-
 +
| Time of day
 +
| {{Type|Long}}
 +
| 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 Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | UUID
+
  | rowspan="2"| ''protocol:''<br/><code>0x66</code><br/><br/>''resource:''<br/><code>set_player_inventory</code>
  | UUID
+
  | rowspan="2"| Play
  |  
+
| rowspan="2"| Client
 +
| Slot
 +
| {{Type|VarInt}}
 +
  |
 
  |-
 
  |-
  | Amount
+
  | Slot Data
  | Double
+
  | {{Type|Slot}}
| May be positive or negative
+
  |
|-
 
| Operation
 
| Byte
 
  | See below
 
 
  |}
 
  |}
  
The operation controls how the base value of the modifier is changed.
+
==== Synchronize Vehicle Position ====
  
* 0: Add/subtract amount
+
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.
* 1: Add/subtract amount percent of the current value
 
* 2: Multiply by amount percent
 
  
All of the 0's are applied first, and then the 1's, and then the 2's.
+
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="11"| ''protocol:''<br/><code>0x77</code><br/><br/>''resource:''<br/><code>teleport_entity</code>
 +
| rowspan="11"| Play
 +
| rowspan="11"| Client
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| X
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Y
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Velocity X
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Velocity Y
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Velocity Z
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Yaw
 +
| {{Type|Float}}
 +
| Rotation on the Y axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Rotation on the Y axis, in degrees.
 +
|- {{added}}
 +
| Flags
 +
| {{Type|Teleport Flags}}
 +
|
 +
|-
 +
| On Ground
 +
| {{Type|Boolean}}
 +
|
 +
|}
  
 
=== Serverbound ===
 
=== Serverbound ===
  
==== Interact Entity ====
+
==== Bundle Item Selected ====
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| ''protocol:''<br/><code>0x02</code><br/><br/>''resource:''<br/><code>bundle_item_selected</code>
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Slot of Bundle
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Slot in Bundle
 +
| {{Type|VarInt}}
 +
|
 +
|}
 +
 
 +
==== Client Tick End ====
  
This packet is sent from the client to the server when the client attacks or right-clicks another entity (a player, minecart, etc).
+
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| ''protocol:''<br/><code>0x0B</code><br/><br/>''resource:''<br/><code>client_tick_end</code>
 +
| Play
 +
| Server
 +
| colspan="3"| ''no fields''
 +
|}
  
A Notchian server only accepts this packet if the entity being attacked/used is visible without obstruction and within a 4-unit radius of the player's position.
+
==== Click Container ====
  
Note that middle-click in creative mode is interpreted by the client and sent as a [[#Creative Inventory Action|Creative Inventory Action]] packet instead.
+
This packet is sent by the client when the player clicks on a slot in a window.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 966: Line 2,027:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x0E
+
  | rowspan="9"| ''protocol:''<br/><code>{{change|0x0E|0x10}}</code><br/><br/>''resource:''<br/><code>container_click</code>
  |rowspan="7"| Play
+
  | rowspan="9"| Play
  |rowspan="7"| Server
+
  | rowspan="9"| Server
  | Entity ID
+
  | colspan="2"| Window ID
  | VarInt
+
  | colspan="2"| {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
  | The ID of the entity to interact
+
| 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.
 +
|-
 +
| 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.
 +
|-
 +
| colspan="2"| Slot
 +
| colspan="2"| {{Type|Short}}
 +
| colspan="2"| The clicked slot number, see below.
 +
|-
 +
| colspan="2"| Button
 +
  | colspan="2"| {{Type|Byte}}
 +
| colspan="2"| The button used in the click, see below.
 +
|-
 +
| colspan="2"| Mode
 +
| colspan="2"| {{Type|VarInt}} {{Type|Enum}}
 +
| colspan="2"| Inventory operation mode, see below.
 +
|-
 +
| colspan="2"| Length of the array
 +
| colspan="2"| {{Type|VarInt}}
 +
| colspan="2"| Maximum value for Notchian server is 128 slots.
 +
|-
 +
| rowspan="2"| Array of changed slots
 +
| Slot number
 +
| rowspan="2"| {{Type|Array}} (128)
 +
| {{Type|Short}}
 +
|
 +
|-
 +
| Slot data
 +
| {{Type|Slot}}
 +
| New data for this slot, in the client's opinion; see below.
 +
|-
 +
| colspan="2"| Carried item
 +
| colspan="2"| [[Slot Data|Slot]]
 +
| colspan="2"| 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|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.
 +
 
 +
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.
 +
 
 +
{| class="wikitable"
 +
! Mode
 +
! Button
 +
! Slot
 +
! Trigger
 +
|-
 +
! rowspan="4"| 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)
 +
|-
 +
! rowspan="2"| 1
 +
| 0
 +
| Normal
 +
| Shift + left mouse click
 +
|-
 +
| 1
 +
| Normal
 +
| Shift + right mouse click ''(identical behavior)''
 +
|-
 +
! rowspan="7"| 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.
 +
|-
 +
! rowspan="2"| 4
 +
| 0
 +
| Normal*
 +
| Drop key (Q) (* Clicked item is always empty)
 +
|-
 +
| 1
 +
| Normal*
 +
| Control + Drop key (Q) (* Clicked item is always empty)
 +
|-
 +
! rowspan="9"| 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.
 
  |-
 
  |-
  | Type
+
  | 2
  | VarInt Enum
+
  | -999
  | 0: interact, 1: attack, 2: interact at
+
  | Ending left mouse drag
 
  |-
 
  |-
  | Target X
+
  | 6
  | Optional Float
+
  | -999
  | Only if Type is interact at
+
  | Ending right mouse drag
 
  |-
 
  |-
  | Target Y
+
  | 10
  | Optional Float
+
  | -999
  | Only if Type is interact at
+
  | Ending middle mouse drag, only defined for creative players in non-player inventories.
 
  |-
 
  |-
  | Target Z
+
  ! rowspan="2"| 6
  | Optional Float
+
  | 0
  | Only if Type is interact at
+
  | Normal
 +
| Double click
 
  |-
 
  |-
  | Hand
+
  | 1
| Optional VarInt Enum
+
  | Normal
| Only if Type is interact or interact at; 0: main hand, 1: off hand
+
  | Pickup all but check items in reverse order (impossible in vanilla clients)
|- {{Added}}
 
| Sneaking
 
  | Boolean
 
  | If the client is sneaking.
 
 
  |}
 
  |}
  
==== Generate Structure ====
+
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):
  
Sent when Generate is pressed on the {{Minecraft Wiki|Jigsaw Block}} interface.
+
# 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);
  
{| class="wikitable" {{added}}
+
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|Open Screen]] packet for the inventory.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| ''protocol:''<br/><code>{{change|0x0F|0x11}}</code><br/><br/>''resource:''<br/><code>container_close</code>
 +
| Play
 +
| Server
 +
| Window ID
 +
| {{change|{{Type|Unsigned Byte}}|{{Type|VarInt}}}}
 +
| This is the ID of the window that was closed. 0 for player inventory.
 +
|}
 +
 
 +
==== Edit Book ====
 +
 
 +
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 1,014: Line 2,243:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x0F
+
  | rowspan="5"| ''protocol:''<br/><code>{{change|0x14|0x16}}</code><br/><br/>''resource:''<br/><code>edit_book</code>
  |rowspan="3"| Play
+
  | rowspan="5"| Play
  |rowspan="3"| Server
+
  | rowspan="5"| Server
  | Location
+
  | Slot
  | Position
+
| {{Type|VarInt}}
  | Block entity location
+
| 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.
 
  |-
 
  |-
  | Levels
+
  | Has title
  | VarInt
+
  | {{Type|Boolean}}
  | Value of the levels slider/max depth to generate
+
  | If true, the next field is present. true if book is being signed, false if book is being edited.
 
  |-
 
  |-
  | Keep Jigsaws
+
  | Title
  | Boolean
+
  | {{Type|Optional}} {{Type|String}} ({{change|128|32}})
  |
+
  | Title of book.
 
  |}
 
  |}
  
==== Player Abilities (serverbound) ====
+
==== 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|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.
 +
 
 +
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>.
 +
 
 +
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 (&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.
 +
 
 +
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.
  
{{change|The latter 2 fields are used to indicate the walking and flying speeds respectively, while the first field is used to determine the value of 4 booleans.}}
+
Checking for illegal flight is achieved like this:
  
The vanilla client sends this packet when the player starts/stops flying with the Flags parameter changed accordingly. {{change|All other parameters are ignored by the vanilla server.}}
+
* 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 1,044: Line 2,308:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| {{change|0x19|0x1A}}
+
  | 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
 +
| X
 +
| {{Type|Double}}
 +
| Absolute position.
 +
|-
 +
| Feet Y
 +
| {{Type|Double}}
 +
| Absolute feet position, normally Head Y - 1.62.
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
| Absolute position.
 +
|- {{removed}}
 +
| On Ground
 +
| {{Type|Boolean}}
 +
| True if the client is on the ground, false otherwise.
 +
|- {{added}}
 
  | Flags
 
  | Flags
  | Byte
+
  | {{Type|Byte}}
  | Bit mask. {{change|0x08: damage disabled (god mode), 0x04: can fly, }}0x02: is flying{{change|, 0x01: is Creative}}
+
  | Bit field: 0x01: on ground, 0x02: pushing against wall.
|- {{removed}}
 
| Flying Speed
 
| Float
 
|
 
|- {{removed}}
 
| Walking Speed
 
| Float
 
|
 
 
  |}
 
  |}
  
==== Update Jigsaw Block ====
+
==== Set Player Position and Rotation ====
  
Sent when Done is pressed on the {{Minecraft Wiki|Jigsaw Block}} interface.
+
A combination of [[#Set Player Rotation|Move Player Rotation]] and [[#Set Player Position|Move Player Position]].
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,072: Line 2,344:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| {{Change|0x27|0x28}}
+
  | 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
  | Location
+
  | X
  | Position
+
  | {{Type|Double}}
| Block entity location
+
  | Absolute position.
|- {{Removed}}
+
  |-
  | Attachment type
+
  | Feet Y
  | Identifier
+
  | {{Type|Double}}
  |  
+
  | Absolute feet position, normally Head Y - 1.62.
  |- {{Added}}
+
  |-
  | Name
+
  | Z
  | Identifier
+
  | {{Type|Double}}
  |  
+
  | Absolute position.
  |- {{Added}}
+
  |-
  | Target
+
  | Yaw
| Identifier
+
  | {{Type|Float}}
  |  
+
  | Absolute rotation on the X Axis, in degrees.
  |-
 
  | {{Change|Target pool|Pool}}
 
  | Identifier
 
|
 
 
  |-
 
  |-
  | Final state
+
  | Pitch
  | String
+
  | {{Type|Float}}
  | "Turns into" on the GUI, <code>final_state</code> in NBT
+
  | Absolute rotation on the Y Axis, in degrees.
  |- {{Added}}
+
  |- {{removed}}
  | Joint type
+
  | On Ground
  | String
+
  | {{Type|Boolean}}
  | <code>rollable</code> if the attached piece can be rotated, else <code>aligned</code>
+
  | True if the client is on the ground, false otherwise.
 +
|- {{added}}
 +
| Flags
 +
| {{Type|Byte}}
 +
| Bit field: 0x01: on ground, 0x02: pushing against wall.
 
  |}
 
  |}
  
==== Entity Equipment ====
+
==== 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.
 +
 
 +
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)
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,110: Line 2,407:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x47
+
  | rowspan="4"| ''protocol:''<br/><code>{{change|0x1C|0x1E}}</code><br/><br/>''resource:''<br/><code>move_player_rot</code>
|rowspan="5"| Play
+
  | rowspan="4"| Play
|rowspan="5"| Client
+
  | rowspan="4"| Server
|colspan="2"| Entity ID
+
  | Yaw
|colspan="2"| VarInt
+
  | {{Type|Float}}
| Entity's EID
+
  | Absolute rotation on the X Axis, in degrees.
|- {{Removed}}
 
  |colspan="2"| Slot
 
  |colspan="2"| VarInt Enum
 
  | Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet)
 
  |- {{Removed}}
 
  |colspan="2"| Item
 
|colspan="2"| [[Slot Data|Slot]]
 
|
 
 
  |-
 
  |-
  |rowspan="2"| Equipment
+
  | Pitch
  | Slot
+
| {{Type|Float}}
  |rowspan="2"| Array
+
  | Absolute rotation on the Y Axis, in degrees.
  | Byte Enum
+
  |- {{removed}}
  | Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet).  Also has the top bit set if another entry follows, and otherwise unset if this is the last item in the array.
+
| On Ground
  |-
+
  | {{Type|Boolean}}
  | Item
+
  | True if the client is on the ground, false otherwise.
  | [[Slot Data|Slot]]
+
  |- {{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}} ====
  
== Handshaking ==
+
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.
  
=== Clientbound ===
+
This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).
  
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.  
+
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.
  
=== Serverbound ===
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| ''protocol:''<br/><code>{{change|0x1D|0x1F}}</code><br/><br/>''resource:''<br/><code>move_player_status_only</code>
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| {{removed}} | On Ground
 +
| {{removed}} | {{Type|Boolean}}
 +
| {{removed}} | True if the client is on the ground, false otherwise.
 +
|- {{added}}
 +
| Flags
 +
| {{Type|Byte}}
 +
| Bit field: 0x01: on ground, 0x02: pushing against wall.
 +
|}
  
==== Handshake ====
+
==== Place Recipe ====
  
This causes the server to switch into the target state.
+
This packet is sent when a player clicks a recipe in the crafting book that is craftable (white border).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,160: Line 2,471:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x00
+
  | rowspan="3"| ''protocol:''<br/><code>{{change|0x22|0x24}}</code><br/><br/>''resource:''<br/><code>place_recipe</code>
  |rowspan="4"| Handshaking
+
  | rowspan="3"| Play
  |rowspan="4"| Server
+
  | rowspan="3"| Server
  | Protocol Version
+
  | Window ID
  | VarInt
+
  | {{Type|Byte}}
| See [[protocol version numbers]] (currently {{change|578|734}})
+
|
 
  |-
 
  |-
  | Server Address
+
  | Recipe{{change|| ID}}
  | String
+
  | {{change|{{Type|Identifier}}|{{Type|VarInt}}}}
| Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
+
  | {{change|A recipe ID.|ID of recipe previously defined in [[#Recipe Book Add|Recipe Book Add]].}}
|-
 
| Server Port
 
  | Unsigned Short
 
| Default is 25565. The Notchian server does not use this information.
 
 
  |-
 
  |-
  | Next State
+
  | Make all
  | VarInt Enum
+
  | {{Type|Boolean}}
  | 1 for [[#Status|status]], 2 for [[#Login|login]]
+
  | Affects the amount of items processed; true if shift is down when clicked.
 
  |}
 
  |}
  
== Status ==
+
==== Player Input ====
  
=== Clientbound ===
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| ''protocol:''<br/><code>{{change|0x26|0x28}}</code><br/><br/>''resource:''<br/><code>player_input</code>
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| {{removed}} | Sideways
 +
| {{removed}} | {{Type|Float}}
 +
| {{removed}} | Positive to the left of the player.
 +
|- {{removed}}
 +
| Forward
 +
| {{Type|Float}}
 +
| Positive forward.
 +
|-
 +
| Flags
 +
| {{Type|Unsigned Byte}}
 +
| Bit mask{{change|. 0x1: jump, 0x2: unmount.|; see below.}}
 +
|}
  
No changes so far.
+
The flags are as follows:
  
=== Serverbound ===
+
{| class="wikitable" {{added}}
 +
|-
 +
! Hex Mask
 +
! Field
 +
|-
 +
| 0x01
 +
| Forward
 +
|-
 +
| 0x02
 +
| Backward
 +
|-
 +
| 0x04
 +
| Left
 +
|-
 +
| 0x08
 +
| Right
 +
|-
 +
| 0x10
 +
| Jump
 +
|-
 +
| 0x20
 +
| Sneak
 +
|-
 +
| 0x40
 +
| Sprint
 +
|}
  
No changes so far.
+
==== Set Seen Recipe ====
  
== Login ==
+
Sent when recipe is first seen in recipe book. Replaces Recipe Book Data, type 0.
  
=== Clientbound ===
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| ''protocol:''<br/><code>{{change|0x29|0x2B}}</code><br/><br/>''resource:''<br/><code>recipe_book_seen_recipe</code>
 +
| Play
 +
| Server
 +
| Recipe ID
 +
| {{change|{{Type|Identifier}}|{{Type|VarInt}}}}
 +
| ID of recipe previously defined in [[#Recipe Book Add|Recipe Book Add]].
 +
|}
  
==== Login Success ====
+
==== Use Item On ====
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
|-
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 1,204: Line 2,573:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x02
+
  | rowspan="9"| ''protocol:''<br/><code>{{change|0x38|0x3A}}</code><br/><br/>''resource:''<br/><code>use_item_on</code>
  |rowspan="2"| Login
+
  | rowspan="9"| Play
  |rowspan="2"| Client
+
  | rowspan="9"| Server
  | UUID
+
  | Hand
  | {{Change|String (36)|UUID}}
+
  | {{Type|VarInt}} {{Type|Enum}}
  | {{Change|Unlike in other packets, this field contains the UUID as a string with hyphens}}.
+
| 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]]).
 +
|-
 +
| Cursor Position X
 +
| {{Type|Float}}
 +
| The position of the crosshair on the block, from 0 to 1 increasing from west to east.
 +
|-
 +
| Cursor Position Y
 +
| {{Type|Float}}
 +
| The position of the crosshair on the block, from 0 to 1 increasing from bottom to top.
 +
|-
 +
| Cursor Position Z
 +
  | {{Type|Float}}
 +
| The position of the crosshair on the block, from 0 to 1 increasing from north to south.
 +
|-
 +
| Inside block
 +
| {{Type|Boolean}}
 +
| 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.
 
  |-
 
  |-
  | Username
+
  | Sequence
  | String (16)
+
  | {{Type|VarInt}}
  |  
+
  | Block change sequence number (see [[#Acknowledge Block Change]]).
 
  |}
 
  |}
  
This packet switches the connection state to [[#Play|play]].
+
Upon placing a block, this packet is sent once.
  
=== Serverbound ===
+
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.
 
 
No changes so far.
 
  
 +
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).