Difference between revisions of "Protocol"

From wiki.vg
Jump to navigation Jump to search
(Add information about vertical/horizontal entity head rotation)
(→‎Combat Event: More info about this; it's used to display the game over screen and has some odd history)
 
(48 intermediate revisions by 11 users not shown)
Line 5: Line 5:
 
   |ICON =  
 
   |ICON =  
 
   |HEADING = Heads up!
 
   |HEADING = Heads up!
   |CONTENT = This article is about the protocol for the latest '''stable''' release of Minecraft '''computer edition''' ([[Protocol version numbers|1.13.2, protocol 404]]). For the computer edition pre-releases, see [[Pre-release protocol]]. For Pocket Edition, see [[Pocket Edition Protocol Documentation]].
+
   |CONTENT = This article is about the protocol for the latest '''stable''' release of Minecraft '''computer edition''' ([[Protocol version numbers|1.15.2, protocol 578]]). For the computer edition pre-releases, see [[Pre-release protocol]]. For Pocket Edition, see [[Pocket Edition Protocol Documentation]].
 
}}
 
}}
  
Line 47: Line 47:
 
  |-
 
  |-
 
  | Global palette
 
  | Global palette
  | A table/dictionary/palette mapping nonnegative integers to block states. Block state IDs are created in a linear fashion based off of order of assignment.  One block state ID allocated for each unique block state for a block; if a block has multiple properties then the number of allocated states is the product of the number of values for each property.  A current list of properties and state ID ranges is found on [https://pokechu22.github.io/Burger/1.13.2.html burger].
+
  | A table/dictionary/palette mapping nonnegative integers to block states. Block state IDs are created in a linear fashion based off of order of assignment.  One block state ID allocated for each unique block state for a block; if a block has multiple properties then the number of allocated states is the product of the number of values for each property.  A current list of properties and state ID ranges is found on [https://pokechu22.github.io/Burger/1.15.2.html burger].
  
 
Alternatively, the vanilla server now includes an option to export the current block state ID mapping, by running <code>java -cp minecraft_server.jar net.minecraft.data.Main --reports</code>.  See [[Data Generators]] for more information.
 
Alternatively, the vanilla server now includes an option to export the current block state ID mapping, by running <code>java -cp minecraft_server.jar net.minecraft.data.Main --reports</code>.  See [[Data Generators]] for more information.
Line 66: Line 66:
 
  | Length
 
  | Length
 
  | VarInt
 
  | VarInt
  | Length of packet data + length of the packet ID
+
  | Length of Packet ID + Data
 
  |-
 
  |-
 
  | Packet ID
 
  | Packet ID
Line 111: Line 111:
 
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
 
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
  
If compressed, the uncompressed length of (Packet ID + Data) must be equal to or over the threshold set in the packet [[#Set Compression 2|Set Compression]], otherwise the receiving party will disconnect.
+
If compressed, the uncompressed length of (Packet ID + Data) must be equal to or over the threshold set in the packet [[#Set Compression|Set Compression]], otherwise the receiving party will disconnect.
  
 
Compression can be disabled by sending the packet [[#Set Compression|Set Compression]] with a negative Threshold, or not sending the Set Compression packet at all.
 
Compression can be disabled by sending the packet [[#Set Compression|Set Compression]] with a negative Threshold, or not sending the Set Compression packet at all.
Line 140: Line 140:
 
  | Protocol Version
 
  | Protocol Version
 
  | VarInt
 
  | VarInt
  | See [[protocol version numbers]] (currently 404 in Minecraft 1.13.2)
+
  | See [[protocol version numbers]] (currently 578 in Minecraft 1.15.2)
 
  |-
 
  |-
 
  | Server Address
 
  | Server Address
 
  | String (255)
 
  | String (255)
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information.
+
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
 
  |-  
 
  |-  
 
  | Server Port
 
  | Server Port
Line 179: Line 179:
 
See [[Server List Ping#1.6]] for the details of the protocol that follows this packet.
 
See [[Server List Ping#1.6]] for the details of the protocol that follows this packet.
  
== Play ==
+
== Status ==
 +
{{Main|Server List Ping}}
  
 
=== Clientbound ===
 
=== Clientbound ===
  
==== Spawn Object ====
+
==== Response ====
  
Sent by the server when a vehicle or other object is created.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x00
 +
|rowspan="1"| Status
 +
|rowspan="1"| Client
 +
| JSON Response
 +
| String (32767)
 +
| See [[Server List Ping#Response]]
 +
|}
 +
 
 +
==== Pong ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 195: Line 212:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="12"| 0x00
+
  |rowspan="1"| 0x01
  |rowspan="12"| Play
+
  |rowspan="1"| Status
  |rowspan="12"| Client
+
  |rowspan="1"| Client
  | Entity ID
+
  | Payload
  | VarInt
+
  | Long
  | EID of the object
+
  | Should be the same as sent by the client
 +
|}
 +
 
 +
=== Serverbound ===
 +
 
 +
==== Request ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Object UUID
+
  |rowspan="1"| 0x00
| UUID
+
  | Status
|
+
  | Server
|-
+
  |colspan="3"| ''no fields''
| Type
 
| Byte
 
| The type of object (see [[Entities#Objects]])
 
  |-
 
  | X
 
  | Double
 
|
 
|-
 
| Y
 
| Double
 
|
 
|-
 
| Z
 
| Double
 
|
 
|-
 
| Pitch
 
| Angle
 
|
 
|-
 
| Yaw
 
| Angle
 
|
 
|-
 
| Data
 
| Int
 
| Meaning dependent on the value of the Type field, see [[Object Data]] for details.
 
|-
 
| Velocity X
 
| Short
 
|rowspan="3"| Same units as [[#Entity Velocity|Entity Velocity]].  Always sent, but only used when Data is greater than 0 (except for some entities which always ignore it; see [[Object Data]] for details).
 
|-
 
| Velocity Y
 
| Short
 
|-
 
| Velocity Z
 
| Short
 
 
  |}
 
  |}
  
==== Spawn Experience Orb ====
+
==== Ping ====
 
 
Spawns one or more experience orbs.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 257: Line 248:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x01
+
  |rowspan="1"| 0x01
  |rowspan="5"| Play
+
  |rowspan="1"| Status
  |rowspan="5"| Client
+
  |rowspan="1"| Server
  | Entity ID
+
| Payload
  | VarInt
+
  | Long
  |  
+
  | May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.
 +
  |}
 +
 
 +
== Login ==
 +
 
 +
The login process is as follows:
 +
 
 +
# C→S: [[#Handshake|Handshake]] with Next State set to 2 (login)
 +
# C→S: [[#Login Start|Login Start]]
 +
# S→C: [[#Encryption Request|Encryption Request]]
 +
# Client auth
 +
# C→S: [[#Encryption Response|Encryption Response]]
 +
# Server auth, both enable encryption
 +
# S→C: [[#Set Compression|Set Compression]] (optional)
 +
# S→C: [[#Login Success|Login Success]]
 +
 
 +
Set Compression, if present, must be sent before Login Success. Note that anything sent after Set Compression must use the [[#With_compression|Post Compression packet format]].
 +
 
 +
For unauthenticated and localhost connections (either of the two conditions is enough for an unencrypted connection) there is no encryption. In that case [[#Login Start|Login Start]] is directly followed by [[#Login Success|Login Success]].
 +
 
 +
See [[Protocol Encryption]] for details.
 +
 
 +
=== Clientbound ===
 +
 
 +
==== Disconnect (login) ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | X
+
  |rowspan="1"| 0x00
  | Double
+
  |rowspan="1"| Login
  |  
+
  |rowspan="1"| Client
|-
+
  | Reason
  | Y
+
  | [[Chat]]
  | Double
 
 
  |  
 
  |  
|-
 
| Z
 
| Double
 
|
 
|-
 
| Count
 
| Short
 
| The amount of experience this orb will reward once collected
 
 
  |}
 
  |}
  
==== Spawn Global Entity ====
+
==== Encryption Request ====
 
 
With this packet, the server notifies the client of thunderbolts striking within a 512 block radius around the player. The coordinates specify where exactly the thunderbolt strikes.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 293: Line 305:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x02
+
  |rowspan="5"| 0x01
  |rowspan="5"| Play
+
  |rowspan="5"| Login
 
  |rowspan="5"| Client
 
  |rowspan="5"| Client
  | Entity ID
+
  | Server ID
 +
| String (20)
 +
| Appears to be empty
 +
|-
 +
| Public Key Length
 
  | VarInt
 
  | VarInt
  | The EID of the thunderbolt
+
  | Length of Public Key
 
  |-
 
  |-
  | Type
+
  | Public Key
  | Byte Enum
+
  | Byte Array
| The global entity type, currently always 1 for thunderbolt
 
|-
 
| X
 
| Double
 
 
  |  
 
  |  
 
  |-
 
  |-
  | Y
+
  | Verify Token Length
  | Double
+
  | VarInt
  |  
+
  | Length of Verify Token. Always 4 for Notchian servers.
 
  |-
 
  |-
  | Z
+
  | Verify Token
  | Double
+
  | Byte Array
  |  
+
  | A sequence of random bytes generated by the server
 
  |}
 
  |}
  
==== Spawn Mob ====
+
See [[Protocol Encryption]] for details.
  
Sent by the server when a mob entity is spawned.
+
==== Login Success ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 329: Line 341:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="13"| 0x03
+
  |rowspan="2"| 0x02
  |rowspan="13"| Play
+
  |rowspan="2"| Login
  |rowspan="13"| Client
+
  |rowspan="2"| Client
| Entity ID
 
| VarInt
 
|
 
|-
 
| Entity UUID
 
 
  | UUID
 
  | UUID
  |  
+
  | String (36)
 +
| Unlike in other packets, this field contains the UUID as a string with hyphens.
 
  |-
 
  |-
  | Type
+
  | Username
  | VarInt
+
  | String (16)
| The type of mob. See [[Entities#Mobs]]
 
|-
 
| X
 
| Double
 
|
 
|-
 
| Y
 
| Double
 
|
 
|-
 
| Z
 
| Double
 
|
 
|-
 
| Yaw
 
| Angle
 
|
 
|-
 
| Pitch
 
| Angle
 
|
 
|-
 
| Head Pitch
 
| Angle
 
|
 
|-
 
| Velocity X
 
| Short
 
| Same units as [[#Entity Velocity|Entity Velocity]]
 
|-
 
| Velocity Y
 
| Short
 
| Same units as [[#Entity Velocity|Entity Velocity]]
 
|-
 
| Velocity Z
 
| Short
 
| Same units as [[#Entity Velocity|Entity Velocity]]
 
|-
 
| Metadata
 
| [[Entities#Entity Metadata Format|Entity Metadata]]
 
 
  |  
 
  |  
 
  |}
 
  |}
  
==== Spawn Painting ====
+
This packet switches the connection state to [[#Play|play]].
 +
 
 +
==== Set Compression ====
  
This packet shows location, name, and type of painting.
+
Enables compression.  If compression is enabled, all following packets are encoded in the [[#With compression|compressed packet format]].  Negative values will disable compression, meaning the packet format should remain in the [[#Without compression|uncompressed packet format]].  However, this packet is entirely optional, and if not sent, compression will also not be enabled (the notchian server does not send the packet when compression is disabled).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 397: Line 367:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x04
+
  |rowspan="1"| 0x03
  |rowspan="5"| Play
+
  |rowspan="1"| Login
  |rowspan="5"| Client
+
  |rowspan="1"| Client
  | Entity ID
+
  | Threshold
 
  | VarInt
 
  | VarInt
  |  
+
  | Maximum size of a packet before it is compressed
 +
|}
 +
 
 +
==== Login Plugin Request ====
 +
 
 +
Used to implement a custom handshaking flow together with [[#Login_Plugin_Response | Login Plugin Response]].
 +
 
 +
Unlike plugin messages in "play" mode, these messages follow a lock-step request/response scheme, where the client is expected to respond to a request indicating whether it understood. The notchian client always responds that it hasn't understood, and sends an empty payload.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Entity UUID
+
  |rowspan="3"| 0x04
  | UUID
+
  |rowspan="3"| Login
  |  
+
  |rowspan="3"| Client
|-
+
  | Message ID
  | Motive
 
 
  | VarInt
 
  | VarInt
  | Panting's ID, see below
+
  | Generated by the server - should be unique to the connection.
 
  |-
 
  |-
  | Location
+
  | Channel
  | Position
+
  | Identifier
  | Center coordinates (see below)
+
  | Name of the [[plugin channel]] used to send the data
 
  |-
 
  |-
  | Direction
+
  | Data
  | Byte Enum
+
  | Byte Array
  | Direction the painting faces (North = 2, South = 0, West = 1, East = 3)
+
  | Any data, depending on the channel. The length of this array must be inferred from the packet length.
 
  |}
 
  |}
  
Calculating the center of an image: given a (width × height) grid of cells, with <code>(0, 0)</code> being the top left corner, the center is <code>(max(0, width / 2 - 1), height / 2)</code>. E.g. <code>(1, 0)</code> for a 2×1 painting, or <code>(1, 2)</code> for a 4×4 painting.
+
=== Serverbound ===
  
List of paintings by coordinates in <code>paintings_kristoffer_zetterstrand.png</code> (where x and y are in pixels from the top left and width and height are in pixels or 16ths of a block):
+
==== Login Start  ====
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Name
+
  ! Packet ID
  ! ID
+
  ! State
  ! x
+
  ! Bound To
  ! y
+
  ! Field Name
  ! width
+
  ! Field Type
  ! height
+
  ! Notes
 
  |-
 
  |-
  | <code>minecraft:kebab</code>
+
  |rowspan="1"| 0x00
  | 0
+
  |rowspan="1"| Login
  | 0
+
  |rowspan="1"| Server
  | 0
+
  | Name
  | 16
+
  | String (16)
  | 16
+
| Player's Username
 +
  |}
 +
 
 +
==== Encryption Response ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>minecraft:aztec</code>
+
  |rowspan="4"| 0x01
  | 1
+
  |rowspan="4"| Login
  | 16
+
  |rowspan="4"| Server
  | 0
+
  | Shared Secret Length
  | 16
+
  | VarInt
  | 16
+
  | Length of Shared Secret
 
  |-
 
  |-
  | <code>minecraft:alban</code>
+
  | Shared Secret
  | 2
+
  | Byte Array
  | 32
+
  |  
| 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | <code>minecraft:aztec2</code>
+
  | Verify Token Length
  | 3
+
  | VarInt
  | 48
+
  | Length of Verify Token
| 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | <code>minecraft:bomb</code>
+
  | Verify Token
  | 4
+
  | Byte Array
  | 64
+
  |  
  | 0
+
  |}
  | 16
+
 
  | 16
+
See [[Protocol Encryption]] for details.
 +
 
 +
==== Login Plugin Response ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | <code>minecraft:plant</code>
+
  |rowspan="3"| 0x02
  | 5
+
  |rowspan="3"| Login
  | 80
+
  |rowspan="3"| Server
  | 0
+
  | Message ID
  | 16
+
  | VarInt
  | 16
+
  | Should match ID from server.
 
  |-
 
  |-
  | <code>minecraft:wasteland</code>
+
  | Successful
| 6
+
| Boolean
| 96
+
| <code>true</code> if the client understands the request, <code>false</code> otherwise. When <code>false</code>, no payload follows.
| 0
 
| 16
 
| 16
 
 
  |-
 
  |-
  | <code>minecraft:pool</code>
+
  | Data
  | 7
+
  | Optional Byte Array
  | 0
+
  | Any data, depending on the channel. The length of this array must be inferred from the packet length.
  | 32
+
  |}
  | 32
+
 
  | 16
+
== Play ==
 +
 
 +
=== Clientbound ===
 +
 
 +
==== Spawn Entity ====
 +
 
 +
Sent by the server when a vehicle or other non-living entity is created.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | <code>minecraft:courbet</code>
+
  |rowspan="12"| 0x00
  | 8
+
  |rowspan="12"| Play
  | 32
+
  |rowspan="12"| Client
  | 32
+
  | Entity ID
  | 32
+
  | VarInt
  | 16
+
  | EID of the entity
 
  |-
 
  |-
  | <code>minecraft:sea</code>
+
  | Object UUID
  | 9
+
  | UUID
  | 64
+
  |  
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | <code>minecraft:sunset</code>
+
  | Type
  | 10
+
  | VarInt
  | 96
+
  | The type of entity (same as in [[#Spawn Mob|Spawn Mob]])
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | <code>minecraft:creebet</code>
+
  | X
  | 11
+
  | Double
  | 128
+
  |  
| 32
 
| 32
 
| 16
 
 
  |-
 
  |-
  | <code>minecraft:wanderer</code>
+
  | Y
  | 12
+
  | Double
  | 0
+
  |  
| 64
 
| 16
 
| 32
 
 
  |-
 
  |-
  | <code>minecraft:graham</code>
+
  | Z
  | 13
+
  | Double
  | 16
+
  |  
| 64
 
| 16
 
| 32
 
 
  |-
 
  |-
  | <code>minecraft:match</code>
+
  | Pitch
  | 14
+
  | Angle
  | 0
+
  |  
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>minecraft:bust</code>
+
  | Yaw
  | 15
+
  | Angle
  | 32
+
  |  
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>minecraft:stage</code>
+
  | Data
  | 16
+
  | Int
  | 64
+
  | Meaning dependent on the value of the Type field, see [[Object Data]] for details.
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>minecraft:void</code>
+
  | Velocity X
  | 17
+
  | Short
  | 96
+
  |rowspan="3"| Same units as [[#Entity Velocity|Entity Velocity]]. Always sent, but only used when Data is greater than 0 (except for some entities which always ignore it; see [[Object Data]] for details).
| 128
 
| 32
 
  | 32
 
 
  |-
 
  |-
  | <code>skull_and_roses</code>
+
  | Velocity Y
  | 18
+
  | Short
| 128
 
| 128
 
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>minecraft:wither</code>
+
  | Velocity Z
  | 19
+
  | Short
  | 160
+
  |}
  | 128
+
 
  | 32
+
==== Spawn Experience Orb ====
  | 32
+
 
 +
Spawns one or more experience orbs.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | <code>minecraft:fighters</code>
+
  |rowspan="5"| 0x01
  | 20
+
  |rowspan="5"| Play
  | 0
+
  |rowspan="5"| Client
  | 96
+
  | Entity ID
  | 64
+
  | VarInt
  | 32
+
  |  
 
  |-
 
  |-
  | <code>minecraft:pointer</code>
+
  | X
  | 21
+
  | Double
  | 0
+
  |  
| 192
 
| 64
 
| 64
 
 
  |-
 
  |-
  | <code>minecraft:pigscene</code>
+
  | Y
  | 22
+
  | Double
  | 64
+
  |  
| 192
 
| 64
 
| 64
 
 
  |-
 
  |-
  | <code>minecraft:burning_skull</code>
+
  | Z
  | 23
+
  | Double
  | 128
+
  |  
| 192
 
| 64
 
| 64
 
 
  |-
 
  |-
  | <code>minecraft:skeleton</code>
+
  | Count
  | 24
+
  | Short
  | 192
+
  | The amount of experience this orb will reward once collected
| 64
 
| 64
 
| 48
 
|-
 
| <code>minecraft:donkey_kong</code>
 
| 25
 
| 192
 
| 112
 
| 64
 
| 48
 
 
  |}
 
  |}
  
The {{Minecraft Wiki|Painting#Canvases|Minecraft Wiki article on paintings}} also provides a list of painting names to the actual images.
+
==== Spawn Weather Entity ====
  
==== Spawn Player ====
+
With this packet, the server notifies the client of thunderbolts striking within a 512 block radius around the player. The coordinates specify where exactly the thunderbolt strikes.
 
 
This packet is sent by the server when a player comes into visible range, ''not'' when a player joins.
 
 
 
This packet must be sent after the [[#Player Info|Player Info]] packet that adds the player data for the client to use when spawning a player. If the Player Info for the player spawned by this packet is not present when this packet arrives, Notchian clients will not spawn the player entity. The Player Info packet includes skin/cape data.
 
 
 
Servers can, however, safely spawn player entities for players not in visible range. The client appears to handle it correctly.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 634: Line 597:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x05
+
  |rowspan="5"| 0x02
  |rowspan="8"| Play
+
  |rowspan="5"| Play
  |rowspan="8"| Client
+
  |rowspan="5"| Client
 
  | Entity ID
 
  | Entity ID
 
  | VarInt
 
  | VarInt
  | Player's EID
+
  | The EID of the thunderbolt
 
  |-
 
  |-
  | Player UUID
+
  | Type
  | UUID
+
  | Byte Enum
  | See below for notes on {{Minecraft Wiki|Server.properties#online-mode|offline mode}} and NPCs
+
  | The global entity type, currently always 1 for thunderbolt
 
  |-
 
  |-
 
  | X
 
  | X
Line 656: Line 619:
 
  | Double
 
  | Double
 
  |  
 
  |  
|-
+
  |}
| Yaw
 
| Angle
 
|
 
|-
 
| Pitch
 
| Angle
 
|
 
|-
 
| Metadata
 
| [[Entities#Entity Metadata Format|Entity Metadata]]
 
|
 
  |}
 
  
When in {{Minecraft Wiki|Server.properties#online-mode|online mode}}, the UUIDs must be valid and have valid skin blobs.
+
==== Spawn Living Entity ====
  
In offline mode, [[Wikipedia:Universally unique identifier#Versions 3 and 5 (namespace name-based)|UUID v3]] is used with the String <code>OfflinePlayer:&lt;player name&gt;</code>, encoded in UTF-8 (and case-sensitive).
+
Sent by the server when a living entity is spawned.
 
 
For NPCs UUID v2 should be used. Note:
 
 
 
<+Grum> i will never confirm this as a feature you know that :)
 
 
 
In an example UUID, <code>xxxxxxxx-xxxx-Yxxx-xxxx-xxxxxxxxxxxx</code>, the UUID version is specified by <code>Y</code>. So, for UUID v3, <code>Y</code> will always be <code>3</code>, and for UUID v2, <code>Y</code> will always be <code>2</code>.
 
 
 
==== Animation (clientbound) ====
 
 
 
Sent whenever an entity should change animation.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 692: Line 633:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x06
+
  |rowspan="12"| 0x03
  |rowspan="2"| Play
+
  |rowspan="12"| Play
  |rowspan="2"| Client
+
  |rowspan="12"| Client
 
  | Entity ID
 
  | Entity ID
 
  | VarInt
 
  | VarInt
  | Player ID
+
  |  
 
  |-
 
  |-
  | Animation
+
  | Entity UUID
  | Unsigned Byte
+
  | UUID
  | Animation ID (see below)
+
  |  
|}
 
 
 
Animation can be one of the following values:
 
 
 
{| class="wikitable"
 
! ID
 
! Animation
 
 
  |-
 
  |-
  | 0
+
  | Type
  | Swing main arm
+
  | VarInt
 +
| The type of mob. See [[Entities#Mobs]]
 
  |-
 
  |-
  | 1
+
  | X
  | Take damage
+
| Double
 +
|
 +
|-
 +
| Y
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
  |  
 
  |-
 
  |-
  | 2
+
  | Yaw
  | Leave bed
+
| Angle
 +
|
 +
|-
 +
| Pitch
 +
| Angle
 +
|
 +
|-
 +
| Head Pitch
 +
| Angle
 +
  |  
 
  |-
 
  |-
  | 3
+
  | Velocity X
  | Swing offhand
+
  | Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]]
 
  |-
 
  |-
  | 4
+
  | Velocity Y
  | Critical effect
+
  | Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]]
 
  |-
 
  |-
  | 5
+
  | Velocity Z
  | Magic critical effect
+
  | Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]]
 
  |}
 
  |}
  
==== Statistics ====
+
==== Spawn Painting ====
  
Sent as a response to [[#Client_Status|Client Status 0x04]] (id 1).
+
This packet shows location, name, and type of painting.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
  ! Bound To  
+
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x07
+
  |rowspan="5"| 0x04
  |rowspan="4"| Play
+
  |rowspan="5"| Play
  |rowspan="4"| Client
+
  |rowspan="5"| Client
  |colspan="2"| Count
+
  | Entity ID
  |colspan="2"| VarInt
+
| VarInt
  | Number of elements in the following array
+
|
 +
|-
 +
  | Entity UUID
 +
| UUID
 +
  |  
 
  |-
 
  |-
  |rowspan="2"| Statistic
+
  | Motive
| Category ID
 
|rowspan="2"| Array
 
 
  | VarInt
 
  | VarInt
  | See below
+
  | Panting's ID, see below
 
  |-
 
  |-
  | Statistic ID
+
  | Location
  | VarInt
+
  | Position
  | See below
+
  | Center coordinates (see below)
 
  |-
 
  |-
  |colspan="2"| Value
+
  | Direction
  |colspan="2"| VarInt
+
| Byte Enum
| The amount to set it to
+
  | Direction the painting faces (North = 2, South = 0, West = 1, East = 3)
 
  |}
 
  |}
  
Categories (these are namespaced, but with <code>:</code> replaced with <code>.</code>):
+
Calculating the center of an image: given a (width × height) grid of cells, with <code>(0, 0)</code> being the top left corner, the center is <code>(max(0, width / 2 - 1), height / 2)</code>. E.g. <code>(1, 0)</code> for a 2×1 painting, or <code>(1, 2)</code> for a 4×4 painting.
 +
 
 +
List of paintings by coordinates in <code>paintings_kristoffer_zetterstrand.png</code> (where x and y are in pixels from the top left and width and height are in pixels or 16ths of a block):
  
 
{| class="wikitable"
 
{| class="wikitable"
 
  ! Name
 
  ! Name
 
  ! ID
 
  ! ID
  ! Registry
+
  ! x
 +
! y
 +
! width
 +
! height
 
  |-
 
  |-
  | <code>minecraft.mined</code>
+
  | <code>minecraft:kebab</code>
 +
| 0
 +
| 0
 
  | 0
 
  | 0
  | Blocks
+
  | 16
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.crafted</code>
+
  | <code>minecraft:aztec</code>
 
  | 1
 
  | 1
  | Items
+
  | 16
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.used</code>
+
  | <code>minecraft:alban</code>
 
  | 2
 
  | 2
  | Items
+
  | 32
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.broken</code>
+
  | <code>minecraft:aztec2</code>
 
  | 3
 
  | 3
  | Items
+
  | 48
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.picked_up</code>
+
  | <code>minecraft:bomb</code>
 
  | 4
 
  | 4
  | Items
+
  | 64
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.dropped</code>
+
  | <code>minecraft:plant</code>
 
  | 5
 
  | 5
  | Items
+
  | 80
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.killed</code>
+
  | <code>minecraft:wasteland</code>
 
  | 6
 
  | 6
  | Entities
+
  | 96
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.killed_by</code>
+
  | <code>minecraft:pool</code>
 
  | 7
 
  | 7
  | Entities
+
  | 0
 +
| 32
 +
| 32
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.custom</code>
+
  | <code>minecraft:courbet</code>
 
  | 8
 
  | 8
  | Custom
+
  | 32
  |}
+
  | 32
 
+
| 32
Blocks, Items, and Entities use block (not block state), item, and entity ids.
+
| 16
 
+
|-
Custom has the following (unit only matters for clients):
+
| <code>minecraft:sea</code>
 
+
| 9
{| class="wikitable"
+
| 64
  ! Name
+
  | 32
  ! ID
+
  | 32
  ! Unit
+
  | 16
 
  |-
 
  |-
  | <code>minecraft.leave_game</code>
+
  | <code>minecraft:sunset</code>
  | 0
+
  | 10
  | None
+
  | 96
 +
| 32
 +
| 32
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.play_one_minute</code>
+
  | <code>minecraft:creebet</code>
  | 1
+
  | 11
  | Time
+
  | 128
 +
| 32
 +
| 32
 +
| 16
 
  |-
 
  |-
  | <code>minecraft.time_since_death</code>
+
  | <code>minecraft:wanderer</code>
  | 2
+
  | 12
  | Time
+
  | 0
 +
| 64
 +
| 16
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.sneak_Time</code>
+
  | <code>minecraft:graham</code>
  | 3
+
  | 13
  | Time
+
  | 16
 +
| 64
 +
| 16
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.walk_one_cm</code>
+
  | <code>minecraft:match</code>
  | 4
+
  | 14
  | Distance
+
  | 0
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.crouch_one_cm</code>
+
  | <code>minecraft:bust</code>
  | 5
+
  | 15
  | Distance
+
  | 32
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.sprint_one_cm</code>
+
  | <code>minecraft:stage</code>
  | 6
+
  | 16
  | Distance
+
  | 64
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.swim_one_cm</code>
+
  | <code>minecraft:void</code>
  | 7
+
  | 17
  | Distance
+
  | 96
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.fall_one_cm</code>
+
  | <code>skull_and_roses</code>
  | 8
+
  | 18
  | Distance
+
  | 128
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.climb_one_cm</code>
+
  | <code>minecraft:wither</code>
  | 9
+
  | 19
  | Distance
+
  | 160
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.fly_one_cm</code>
+
  | <code>minecraft:fighters</code>
  | 10
+
  | 20
  | Distance
+
  | 0
 +
| 96
 +
| 64
 +
| 32
 
  |-
 
  |-
  | <code>minecraft.dive_one_cm</code>
+
  | <code>minecraft:pointer</code>
  | 11
+
  | 21
  | Distance
+
  | 0
 +
| 192
 +
| 64
 +
| 64
 
  |-
 
  |-
  | <code>minecraft.minecart_one_cm</code>
+
  | <code>minecraft:pigscene</code>
  | 12
+
  | 22
  | Distance
+
  | 64
 +
| 192
 +
| 64
 +
| 64
 
  |-
 
  |-
  | <code>minecraft.boat_one_cm</code>
+
  | <code>minecraft:burning_skull</code>
  | 13
+
  | 23
  | Distance
+
  | 128
 +
| 192
 +
| 64
 +
| 64
 
  |-
 
  |-
  | <code>minecraft.pig_one_cm</code>
+
  | <code>minecraft:skeleton</code>
  | 14
+
  | 24
  | Distance
+
  | 192
 +
| 64
 +
| 64
 +
| 48
 
  |-
 
  |-
  | <code>minecraft.horse_one_cm</code>
+
  | <code>minecraft:donkey_kong</code>
  | 15
+
  | 25
  | Distance
+
| 192
  |-
+
| 112
  | <code>minecraft.aviate_one_cm</code>
+
  | 64
  | 16
+
  | 48
  | Distance
+
  |}
 +
 
 +
The {{Minecraft Wiki|Painting#Canvases|Minecraft Wiki article on paintings}} also provides a list of painting names to the actual images.
 +
 
 +
==== Spawn Player ====
 +
 
 +
This packet is sent by the server when a player comes into visible range, ''not'' when a player joins.
 +
 
 +
This packet must be sent after the [[#Player Info|Player Info]] packet that adds the player data for the client to use when spawning a player. If the Player Info for the player spawned by this packet is not present when this packet arrives, Notchian clients will not spawn the player entity. The Player Info packet includes skin/cape data.
 +
 
 +
Servers can, however, safely spawn player entities for players not in visible range. The client appears to handle it correctly.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | <code>minecraft.jump</code>
+
  |rowspan="7"| 0x05
  | 17
+
|rowspan="7"| Play
  | None
+
|rowspan="7"| Client
 +
| Entity ID
 +
  | VarInt
 +
  | Player's EID
 
  |-
 
  |-
  | <code>minecraft.drop</code>
+
  | Player UUID
  | 18
+
  | UUID
  | None
+
  | See below for notes on {{Minecraft Wiki|Server.properties#online-mode|offline mode}} and NPCs
 
  |-
 
  |-
  | <code>minecraft.damage_dealt</code>
+
  | X
  | 19
+
  | Double
  | Damage
+
  |  
 
  |-
 
  |-
  | <code>minecraft.damage_taken</code>
+
  | Y
  | 20
+
  | Double
  | Damage
+
  |  
 
  |-
 
  |-
  | <code>minecraft.deaths</code>
+
  | Z
  | 21
+
  | Double
  | None
+
  |  
 
  |-
 
  |-
  | <code>minecraft.mob_kills</code>
+
  | Yaw
  | 22
+
  | Angle
  | None
+
  |  
 
  |-
 
  |-
  | <code>minecraft.animals_bred</code>
+
  | Pitch
  | 23
+
| Angle
  | None
+
|
 +
|}
 +
 
 +
When in {{Minecraft Wiki|Server.properties#online-mode|online mode}}, the UUIDs must be valid and have valid skin blobs.
 +
 
 +
In offline mode, [[Wikipedia:Universally unique identifier#Versions 3 and 5 (namespace name-based)|UUID v3]] is used with the String <code>OfflinePlayer:&lt;player name&gt;</code>, encoded in UTF-8 (and case-sensitive).
 +
 
 +
For NPCs UUID v2 should be used. Note:
 +
 
 +
<+Grum> i will never confirm this as a feature you know that :)
 +
 
 +
In an example UUID, <code>xxxxxxxx-xxxx-Yxxx-xxxx-xxxxxxxxxxxx</code>, the UUID version is specified by <code>Y</code>. So, for UUID v3, <code>Y</code> will always be <code>3</code>, and for UUID v2, <code>Y</code> will always be <code>2</code>.
 +
 
 +
==== Entity Animation (clientbound) ====
 +
 
 +
Sent whenever an entity should change animation.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
  ! Bound To
 +
! Field Name
 +
! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | <code>minecraft.player_kills</code>
+
  |rowspan="2"| 0x06
  | 24
+
|rowspan="2"| Play
  | None
+
|rowspan="2"| Client
 +
| Entity ID
 +
  | VarInt
 +
  | Player ID
 
  |-
 
  |-
  | <code>minecraft.fish_caught</code>
+
  | Animation
  | 25
+
  | Unsigned Byte
  | None
+
  | Animation ID (see below)
  |-
+
  |}
| <code>minecraft.talked_to_villager</code>
+
 
  | 26
+
Animation can be one of the following values:
  | None
+
 
 +
{| class="wikitable"
 +
  ! ID
 +
  ! Animation
 
  |-
 
  |-
  | <code>minecraft.traded_with_villager</code>
+
  | 0
  | 27
+
  | Swing main arm
| None
 
 
  |-
 
  |-
  | <code>minecraft.eat_cake_slice</code>
+
  | 1
  | 28
+
  | Take damage
| None
 
 
  |-
 
  |-
  | <code>minecraft.fill_cauldron</code>
+
  | 2
  | 29
+
  | Leave bed
| None
 
 
  |-
 
  |-
  | <code>minecraft.use_cauldron</code>
+
  | 3
  | 30
+
  | Swing offhand
| None
 
 
  |-
 
  |-
  | <code>minecraft.clean_armor</code>
+
  | 4
  | 31
+
  | Critical effect
| None
 
 
  |-
 
  |-
  | <code>minecraft.clean_banner</code>
+
  | 5
  | 32
+
| Magic critical effect
  | None
+
|}
 +
 
 +
==== Statistics ====
 +
 
 +
Sent as a response to [[#Client_Status|Client Status 0x04]] (id 1).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
  ! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
  !colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>minecraft.interact_with_brewingstand</code>
+
  |rowspan="4"| 0x07
  | 33
+
|rowspan="4"| Play
  | None
+
|rowspan="4"| Client
 +
  |colspan="2"| Count
 +
|colspan="2"| VarInt
 +
  | Number of elements in the following array
 
  |-
 
  |-
  | <code>minecraft.interact_with_beacon</code>
+
  |rowspan="2"| Statistic
  | 34
+
| Category ID
  | None
+
|rowspan="2"| Array
 +
  | VarInt
 +
  | See below
 
  |-
 
  |-
  | <code>minecraft.inspect_dropper</code>
+
  | Statistic ID
  | 35
+
  | VarInt
  | None
+
  | See below
 
  |-
 
  |-
  | <code>minecraft.inspect_hopper</code>
+
  |colspan="2"| Value
  | 36
+
|colspan="2"| VarInt
  | None
+
| The amount to set it to
 +
|}
 +
 
 +
Categories (these are namespaced, but with <code>:</code> replaced with <code>.</code>):
 +
 
 +
{| class="wikitable"
 +
! Name
 +
  ! ID
 +
  ! Registry
 
  |-
 
  |-
  | <code>minecraft.inspect_dispenser</code>
+
  | <code>minecraft.mined</code>
  | 37
+
  | 0
  | None
+
  | Blocks
 
  |-
 
  |-
  | <code>minecraft.play_noteblock</code>
+
  | <code>minecraft.crafted</code>
  | 38
+
  | 1
  | None
+
  | Items
 
  |-
 
  |-
  | <code>minecraft.tune_noteblock</code>
+
  | <code>minecraft.used</code>
  | 39
+
  | 2
  | None
+
  | Items
 
  |-
 
  |-
  | <code>minecraft.pot_flower</code>
+
  | <code>minecraft.broken</code>
  | 40
+
  | 3
  | None
+
  | Items
 
  |-
 
  |-
  | <code>minecraft.trigger_trapped_chest</code>
+
  | <code>minecraft.picked_up</code>
  | 41
+
  | 4
  | None
+
  | Items
 
  |-
 
  |-
  | <code>minecraft.open_enderchest</code>
+
  | <code>minecraft.dropped</code>
  | 42
+
  | 5
  | None
+
  | Items
 
  |-
 
  |-
  | <code>minecraft.enchant_item</code>
+
  | <code>minecraft.killed</code>
  | 43
+
  | 6
  | None
+
  | Entities
 
  |-
 
  |-
  | <code>minecraft.play_record</code>
+
  | <code>minecraft.killed_by</code>
  | 44
+
  | 7
  | None
+
  | Entities
 
  |-
 
  |-
  | <code>minecraft.interact_with_furnace</code>
+
  | <code>minecraft.custom</code>
  | 45
+
  | 8
  | None
+
  | Custom
 +
|}
 +
 
 +
Blocks, Items, and Entities use block (not block state), item, and entity ids.
 +
 
 +
Custom has the following (unit only matters for clients):
 +
 
 +
{| class="wikitable"
 +
! Name
 +
! ID
 +
! Unit
 
  |-
 
  |-
  | <code>minecraft.interact_with_crafting_table</code>
+
  | <code>minecraft.leave_game</code>
  | 46
+
  | 0
 
  | None
 
  | None
 
  |-
 
  |-
  | <code>minecraft.open_chest</code>
+
  | <code>minecraft.play_one_minute</code>
  | 47
+
  | 1
  | None
+
  | Time
 
  |-
 
  |-
  | <code>minecraft.sleep_in_bed</code>
+
  | <code>minecraft.time_since_death</code>
  | 48
+
  | 2
  | None
+
  | Time
 
  |-
 
  |-
  | <code>minecraft.open_shulker_box</code>
+
  | <code>minecraft.sneak_Time</code>
  | 49
+
  | 3
  | None
+
  | Time
|}
 
 
 
Units:
 
 
 
* None: just a normal number (formatted with 0 decimal places)
 
* Damage: value is 10 times the normal amount
 
* Distance: a distance in centimeters (hundredths of blocks)
 
* Time: a time span in ticks
 
 
 
==== Block Break Animation ====
 
 
 
0–9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
 
 
 
Block break animations can still be applied on air; the animation will remain visible although there is no block being broken.  However, if this is applied to a transparent block, odd graphical effects may happen, including water losing its transparency.  (An effect similar to this can be seen in normal gameplay when breaking ice blocks)
 
 
 
If you need to display several break animations at the same time you have to give each of them a unique Entity ID. The entity ID does not need to correspond to an actual entity on the client. It is valid to use a randomly generated number.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x08
+
  | <code>minecraft.walk_one_cm</code>
|rowspan="3"| Play
+
  | 4
|rowspan="3"| Client
+
  | Distance
| Entity ID
 
  | VarInt
 
  | Entity ID of the entity breaking the block
 
 
  |-
 
  |-
  | Location
+
  | <code>minecraft.crouch_one_cm</code>
  | Position
+
  | 5
  | Block Position
+
  | Distance
 
  |-
 
  |-
  | Destroy Stage
+
  | <code>minecraft.sprint_one_cm</code>
  | Byte
+
  | 6
  | 0–9 to set it, any other value to remove it
+
  | Distance
  |}
+
  |-
 
+
| <code>minecraft.swim_one_cm</code>
==== Update Block Entity ====
+
| 7
 
+
| Distance
Sets the block entity associated with the block at the given location.
+
|-
 
+
| <code>minecraft.fall_one_cm</code>
{| class="wikitable"
+
  | 8
  ! Packet ID
+
  | Distance
  ! State
+
  |-
  ! Bound To
+
  | <code>minecraft.climb_one_cm</code>
  ! Field Name
+
  | 9
  ! Field Type
+
  | Distance
  ! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x09
+
  | <code>minecraft.fly_one_cm</code>
|rowspan="3"| Play
+
  | 10
|rowspan="3"| Client
+
  | Distance
| Location
 
  | Position
 
  |  
 
 
  |-
 
  |-
  | Action
+
  | <code>minecraft.dive_one_cm</code>
  | Unsigned Byte
+
  | 11
  | The type of update to perform, see below
+
  | Distance
 
  |-
 
  |-
  | NBT Data
+
  | <code>minecraft.minecart_one_cm</code>
  | [[NBT|NBT Tag]]
+
  | 12
  | Data to set.  May be a TAG_END (0), in which case the block entity at the given location is removed (though this is not required since the client will remove the block entity automatically on chunk unload or block removal)
+
  | Distance
  |}
+
  |-
 
+
| <code>minecraft.boat_one_cm</code>
''Action'' field:
+
  | 13
 
+
  | Distance
* '''1''': Set data of a mob spawner (everything except for SpawnPotentials: current delay, min/max delay, mob to be spawned, spawn count, spawn range, etc.)
 
* '''2''': Set command block text (command and last execution status)
 
* '''3''': Set the level, primary, and secondary powers of a beacon
 
* '''4''': Set rotation and skin of mob head
 
* '''5''': Declare a conduit
 
* '''6''': Set base color and patterns on a banner
 
* '''7''': Set the data for a Structure tile entity
 
* '''8''': Set the destination for a end gateway
 
* '''9''': Set the text on a sign
 
* '''10''': Declare a shulker box, no data appears to be sent and the client seems to do fine without this packet. Perhaps it is a leftover from earlier versions?
 
* '''11''': Declare a bed
 
 
 
==== Block Action ====
 
 
 
This packet is used for a number of actions and animations performed by blocks, usually non-persistent.
 
 
 
See [[Block Actions]] for a list of values.
 
 
 
{{Warning2|This packet uses a block ID, not a block state. Unfortunately, block IDs are not directly included in the output from [[Data Generators]], but can manually be calculated.}}
 
 
 
{| class="wikitable"
 
  ! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x0A
+
  | <code>minecraft.pig_one_cm</code>
|rowspan="4"| Play
+
  | 14
|rowspan="4"| Client
+
  | Distance
| Location
 
  | Position
 
  | Block coordinates
 
 
  |-
 
  |-
  | Action ID (Byte 1)
+
  | <code>minecraft.horse_one_cm</code>
  | Unsigned Byte
+
  | 15
  | Varies depending on block — see [[Block Actions]]
+
  | Distance
 
  |-
 
  |-
  | Action Param (Byte 2)
+
  | <code>minecraft.aviate_one_cm</code>
  | Unsigned Byte
+
  | 16
  | Varies depending on block — see [[Block Actions]]
+
  | Distance
 
  |-
 
  |-
  | Block Type
+
  | <code>minecraft.jump</code>
| VarInt
+
  | 17
| The block type ID for the block.  This must match the block at the given coordinates.
+
  | None
  |}
 
 
 
==== Block Change ====
 
 
 
Fired whenever a block is changed within the render distance.
 
 
 
{{Warning2|Changing a block in a chunk that is not loaded is not a stable action.  The Notchian client currently uses a ''shared'' empty chunk which is modified for all block changes in unloaded chunks; while in 1.9 this chunk never renders in older versions the changed block will appear in all copies of the empty chunk. Servers should avoid sending block changes in unloaded chunks and clients should ignore such packets.}}
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x0B
+
  | <code>minecraft.drop</code>
|rowspan="2"| Play
+
  | 18
|rowspan="2"| Client
+
  | None
| Location
 
  | Position
 
  | Block Coordinates
 
 
  |-
 
  |-
  | Block ID
+
  | <code>minecraft.damage_dealt</code>
| VarInt
+
  | 19
| The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}}. See that section for more information.
+
  | Damage
  |}
 
 
 
==== Boss Bar ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
  !colspan="2"| Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="14"| 0x0C
+
  | <code>minecraft.damage_taken</code>
|rowspan="14"| Play
+
  | 20
|rowspan="14"| Client
+
  | Damage
|colspan="2"| UUID
 
  | UUID
 
  | Unique ID for this bar
 
 
  |-
 
  |-
  |colspan="2"| Action
+
  | <code>minecraft.deaths</code>
  | VarInt Enum
+
  | 21
  | Determines the layout of the remaining packet
+
  | None
 
  |-
 
  |-
  ! Action
+
  | <code>minecraft.mob_kills</code>
  ! Field Name
+
  | 22
  !
+
  | None
!
 
 
  |-
 
  |-
  |rowspan="5"| 0: add
+
  | <code>minecraft.animals_bred</code>
| Title
+
  | 23
  | [[Chat]]
+
  | None
  |  
 
 
  |-
 
  |-
  | Health
+
  | <code>minecraft.player_kills</code>
  | Float
+
  | 24
  | From 0 to 1. Values greater than 1 do not crash a Notchian client, and start [https://i.johni0702.de/nA.png rendering part of a second health bar] at around 1.5.
+
  | None
 
  |-
 
  |-
  | Color
+
  | <code>minecraft.fish_caught</code>
  | VarInt Enum
+
  | 25
  | Color ID (see below)
+
  | None
 
  |-
 
  |-
  | Division
+
  | <code>minecraft.talked_to_villager</code>
  | VarInt Enum
+
  | 26
  | Type of division (see below)
+
  | None
 
  |-
 
  |-
  | Flags
+
  | <code>minecraft.traded_with_villager</code>
  | Unsigned Byte
+
  | 27
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music), 0x04: create fog (previously was also controlled by 0x02)
+
  | None
 
  |-
 
  |-
  | 1: remove
+
  | <code>minecraft.eat_cake_slice</code>
  | ''no fields''
+
  | 28
  | ''no fields''
+
  | None
| Removes this boss bar
 
 
  |-
 
  |-
  | 2: update health
+
  | <code>minecraft.fill_cauldron</code>
  | Health
+
  | 29
  | Float
+
  | None
| as above
 
 
  |-
 
  |-
  | 3: update title
+
  | <code>minecraft.use_cauldron</code>
  | Title
+
  | 30
| [[Chat]]
+
  | None
  |  
 
 
  |-
 
  |-
  |rowspan="2"| 4: update style
+
  | <code>minecraft.clean_armor</code>
| Color
+
  | 31
  | VarInt Enum
+
  | None
  | Color ID (see below)
 
 
  |-
 
  |-
  | Dividers
+
  | <code>minecraft.clean_banner</code>
  | VarInt Enum
+
  | 32
  | as above
+
  | None
 
  |-
 
  |-
  | 5: update flags
+
  | <code>minecraft.interact_with_brewingstand</code>
  | Flags
+
  | 33
  | Unsigned Byte
+
  | None
| as above
 
 
  |-
 
  |-
  |}
+
  | <code>minecraft.interact_with_beacon</code>
 
+
| 34
{| class="wikitable"
+
  | None
  ! ID
 
! Color
 
 
  |-
 
  |-
  | 0
+
  | <code>minecraft.inspect_dropper</code>
  | Pink
+
  | 35
 +
| None
 
  |-
 
  |-
  | 1
+
  | <code>minecraft.inspect_hopper</code>
  | Blue
+
  | 36
 +
| None
 
  |-
 
  |-
  | 2
+
  | <code>minecraft.inspect_dispenser</code>
  | Red
+
  | 37
 +
| None
 
  |-
 
  |-
  | 3
+
  | <code>minecraft.play_noteblock</code>
  | Green
+
  | 38
 +
| None
 +
|-
 +
| <code>minecraft.tune_noteblock</code>
 +
| 39
 +
| None
 
  |-
 
  |-
  | 4
+
  | <code>minecraft.pot_flower</code>
  | Yellow
+
  | 40
 +
| None
 
  |-
 
  |-
  | 5
+
  | <code>minecraft.trigger_trapped_chest</code>
  | Purple
+
  | 41
 +
| None
 
  |-
 
  |-
  | 6
+
  | <code>minecraft.open_enderchest</code>
  | White
+
  | 42
  |}
+
  | None
 
 
{| class="wikitable"
 
! ID
 
! Type of division
 
 
  |-
 
  |-
  | 0
+
  | <code>minecraft.enchant_item</code>
  | No division
+
  | 43
 +
| None
 
  |-
 
  |-
  | 1
+
  | <code>minecraft.play_record</code>
  | 6 notches
+
  | 44
 +
| None
 
  |-
 
  |-
  | 2
+
  | <code>minecraft.interact_with_furnace</code>
  | 10 notches
+
  | 45
 +
| None
 
  |-
 
  |-
  | 3
+
  | <code>minecraft.interact_with_crafting_table</code>
  | 12 notches
+
  | 46
 +
| None
 
  |-
 
  |-
  | 4
+
  | <code>minecraft.open_chest</code>
  | 20 notches
+
  | 47
  |}
+
| None
 
+
|-
==== Server Difficulty ====
+
| <code>minecraft.sleep_in_bed</code>
 +
| 48
 +
| None
 +
|-
 +
| <code>minecraft.open_shulker_box</code>
 +
| 49
 +
| None
 +
  |}
 +
 
 +
Units:
 +
 
 +
* None: just a normal number (formatted with 0 decimal places)
 +
* Damage: value is 10 times the normal amount
 +
* Distance: a distance in centimeters (hundredths of blocks)
 +
* Time: a time span in ticks
  
Changes the difficulty setting in the client's option menu
+
==== Acknowledge Player Digging ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,296: Line 1,330:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x0D
+
  |rowspan="4"| 0x08
  |rowspan="1"| Play
+
  |rowspan="4"| Play
  |rowspan="1"| Client
+
  |rowspan="4"| Client
  | Difficulty
+
  | Location
  | Unsigned Byte
+
| Position
  | 0: peaceful, 1: easy, 2: normal, 3: hard
+
| Position where the digging was happening
 +
|-
 +
| Block
 +
| VarInt
 +
| Block state ID of the block that should be at that position now.
 +
|-
 +
  | Status
 +
  | VarInt enum
 +
| Same as Player Digging.  Only Started digging (0), Cancelled digging (1), and Finished digging (2) are used.
 +
|-
 +
| Successful
 +
| Boolean
 +
| True if the digging succeeded; false if the client should undo any changes it made locally.  (How does this work?)
 
  |}
 
  |}
  
==== Chat Message (clientbound) ====  
+
==== Block Break Animation ====
 +
 
 +
0–9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
  
Identifying the difference between Chat/System Message is important as it helps respect the user's chat visibility optionsSee [[Chat#Processing chat|processing chat]] for more info about these positions.
+
Block break animations can still be applied on air; the animation will remain visible although there is no block being brokenHowever, if this is applied to a transparent block, odd graphical effects may happen, including water losing its transparency. (An effect similar to this can be seen in normal gameplay when breaking ice blocks)
  
{{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.}}
+
If you need to display several break animations at the same time you have to give each of them a unique Entity ID. The entity ID does not need to correspond to an actual entity on the client. It is valid to use a randomly generated number.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,318: Line 1,366:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0E
+
  |rowspan="3"| 0x09
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | JSON Data
+
  | Entity ID
  | [[Chat]]
+
  | VarInt
  | Limited to 32767 bytes
+
  | Entity ID of the entity breaking the block
 
  |-
 
  |-
 +
| Location
 
  | Position
 
  | Position
 +
| Block Position
 +
|-
 +
| Destroy Stage
 
  | Byte
 
  | Byte
  | 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
+
  | 0–9 to set it, any other value to remove it
 
  |}
 
  |}
  
==== Multi Block Change ====
+
==== Block Entity Data ====
  
Fired whenever 2 or more blocks are changed within the same chunk on the same tick.
+
Sets the block entity associated with the block at the given location.
 
 
{{Warning|Changing blocks in chunks not loaded by the client is unsafe (see note on [[#Block Change|Block Change]]).}}
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,340: Line 1,390:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x0F
+
  |rowspan="3"| 0x0A
  |rowspan="6"| Play
+
  |rowspan="3"| Play
  |rowspan="6"| Client
+
  |rowspan="3"| Client
  |colspan="2"| Chunk X
+
  | Location
  |colspan="2"| Int
+
  | Position
  | Chunk X coordinate
+
  |  
 
  |-
 
  |-
  |colspan="2"| Chunk Z
+
  | Action
|colspan="2"| Int
 
| Chunk Z coordinate
 
|-
 
|colspan="2"| Record Count
 
|colspan="2"| VarInt
 
| Number of elements in the following array, i.e. the number of blocks affected
 
|-
 
|rowspan="3"| Record
 
| Horizontal Position
 
|rowspan="3"| Array
 
 
  | Unsigned Byte
 
  | Unsigned Byte
  | The 4 most significant bits (<code>0xF0</code>) encode the X coordinate, relative to the chunk. The 4 least significant bits (<code>0x0F</code>) encode the Z coordinate, relative to the chunk.
+
  | The type of update to perform, see below
 
  |-
 
  |-
  | Y Coordinate
+
  | NBT Data
  | Unsigned Byte
+
  | [[NBT|NBT Tag]]
  | Y coordinate of the block
+
  | Data to set.  May be a TAG_END (0), in which case the block entity at the given location is removed (though this is not required since the client will remove the block entity automatically on chunk unload or block removal)
  |-
+
  |}
| Block ID
+
 
| VarInt
+
''Action'' field:
| The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}}. See that section for more information.
+
 
|}
+
* '''1''': Set data of a mob spawner (everything except for SpawnPotentials: current delay, min/max delay, mob to be spawned, spawn count, spawn range, etc.)
 +
* '''2''': Set command block text (command and last execution status)
 +
* '''3''': Set the level, primary, and secondary powers of a beacon
 +
* '''4''': Set rotation and skin of mob head
 +
* '''5''': Declare a conduit
 +
* '''6''': Set base color and patterns on a banner
 +
* '''7''': Set the data for a Structure tile entity
 +
* '''8''': Set the destination for a end gateway
 +
* '''9''': Set the text on a sign
 +
* '''10''': Unused
 +
* '''11''': Declare a bed
 +
* '''12''': Set data of a jigsaw block
 +
* '''13''': Set items in a campfire
 +
* '''14''': Behive information
  
To decode the position into a world position:
+
==== Block Action ====
  
<syntaxhighlight lang="java">
+
This packet is used for a number of actions and animations performed by blocks, usually non-persistent.
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
 
worldY = vertPos;
 
worldZ = (horizPos & 15) + (chunkZ * 16);
 
</syntaxhighlight>
 
  
==== Tab-Complete (clientbound) ====
+
See [[Block Actions]] for a list of values.
  
The server responds with a list of auto-completions of the last word sent to it. In the case of regular chat, this is a player username. Command names and parameters are also supported. The client sorts these alphabetically before listing them.
+
{{Warning2|This packet uses a block ID, not a block state. Unfortunately, block IDs are not directly included in the output from [[Data Generators]], but can manually be calculated.}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,390: Line 1,439:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x10
+
  |rowspan="4"| 0x0B
  |rowspan="8"| Play
+
  |rowspan="4"| Play
  |rowspan="8"| Client
+
  |rowspan="4"| Client
 +
| Location
 +
| Position
 +
| Block coordinates
 
  |-
 
  |-
  |colspan="2"| ID
+
  | Action ID (Byte 1)
  |colspan="2"| VarInt
+
  | Unsigned Byte
  | Transaction ID
+
  | Varies depending on block — see [[Block Actions]]
 
  |-
 
  |-
  |colspan="2"| Start
+
  | Action Param (Byte 2)
  |colspan="2"| VarInt
+
  | Unsigned Byte
  | Start of the text to replace
+
  | Varies depending on block — see [[Block Actions]]
 
  |-
 
  |-
  |colspan="2"| Length
+
  | Block Type
  |colspan="2"| VarInt
+
  | VarInt
  | Length of the text to replace
+
  | The block type ID for the block. This must match the block at the given coordinates.
|-
 
|colspan="2"| Count
 
|colspan="2"| VarInt
 
  | Number of elements in the following array
 
|-
 
|rowspan="3"| Matches
 
| Match
 
|rowspan="3"| Array
 
| String (32767)
 
| One eligible value to insert, note that each command is sent separately instead of in a single string, hence the need for Count. Note that for instance this doesn't include a leading <code>/</code> on commands.
 
|-
 
| Has tooltip
 
| Boolean
 
| True if the following is present
 
|-
 
| Tooltip
 
| Optional [[Chat]]
 
| Tooltip to display; only present if previous boolean is true
 
 
  |}
 
  |}
  
==== Declare Commands ====
+
==== Block Change ====
  
Lists all of the commands on the server, and how they are parsed.
+
Fired whenever a block is changed within the render distance.
  
This is a directed graph, with one root nodeEach redirect or child node must refer only to nodes that have already been declared.
+
{{Warning2|Changing a block in a chunk that is not loaded is not a stable action.  The Notchian client currently uses a ''shared'' empty chunk which is modified for all block changes in unloaded chunks; while in 1.9 this chunk never renders in older versions the changed block will appear in all copies of the empty chunkServers should avoid sending block changes in unloaded chunks and clients should ignore such packets.}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,443: Line 1,477:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x11
+
  |rowspan="2"| 0x0C
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Client
+
  |rowspan="2"| Client
  | Count
+
  | Location
  | VarInt
+
  | Position
  | Number of elements in the following array
+
  | Block Coordinates
 
  |-
 
  |-
  | Nodes
+
  | Block ID
| Array of [[Command Data|Node]]
 
| An array of nodes
 
|-
 
| Root index
 
 
  | VarInt
 
  | VarInt
  | Index of the <code>root</code> node in the previous array
+
  | The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}}. See that section for more information.
 
  |}
 
  |}
  
For more information on this packet, see the [[Command Data]] article.
+
==== Boss Bar ====  
 
 
==== Confirm Transaction (clientbound) ====
 
 
 
A packet from the server indicating whether a request from the client was accepted, or whether there was a conflict (due to lag).  If the packet was not accepted, the client must respond with a [[#Confirm Transaction (serverbound)|serverbound confirm transaction]] packet.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,469: Line 1,495:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x12
+
  |rowspan="14"| 0x0D
  |rowspan="3"| Play
+
  |rowspan="14"| Play
  |rowspan="3"| Client
+
  |rowspan="14"| Client
  | Window ID
+
  |colspan="2"| UUID
  | Byte
+
  | UUID
  | The ID of the window that the action occurred in
+
  | Unique ID for this bar
 
  |-
 
  |-
  | Action Number
+
  |colspan="2"| Action
  | Short
+
  | VarInt Enum
  | Every action that is to be accepted has a unique number. This number is an incrementing integer (starting at 0) with separate counts for each window ID.
+
  | Determines the layout of the remaining packet
 
  |-
 
  |-
| Accepted
+
  ! Action
| Boolean
 
| Whether the action was accepted
 
|}
 
 
 
==== Close Window (clientbound) ====
 
 
 
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.
 
 
 
{| class="wikitable"
 
  ! Packet ID
 
! State
 
! Bound To
 
 
  ! Field Name
 
  ! Field Name
  ! Field Type
+
  !  
  ! Notes
+
  !  
 +
|-
 +
|rowspan="5"| 0: add
 +
| Title
 +
| [[Chat]]
 +
|
 +
|-
 +
| Health
 +
| Float
 +
| From 0 to 1. Values greater than 1 do not crash a Notchian client, and start [https://i.johni0702.de/nA.png rendering part of a second health bar] at around 1.5.
 
  |-
 
  |-
  | 0x13
+
  | Color
  | Play
+
  | VarInt Enum
  | Client
+
  | Color ID (see below)
  | Window ID
+
  |-
  | Unsigned Byte
+
  | Division
  | This is the ID of the window that was closed. 0 for inventory.
+
  | VarInt Enum
  |}
+
  | Type of division (see below)
 
 
==== Open Window ====
 
 
 
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| 0x14
+
  | Flags
|rowspan="5"| Play
 
|rowspan="5"| Client
 
| Window ID
 
 
  | Unsigned Byte
 
  | Unsigned Byte
  | A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
+
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music), 0x04: create fog (previously was also controlled by 0x02)
 +
|-
 +
| 1: remove
 +
| ''no fields''
 +
| ''no fields''
 +
| Removes this boss bar
 
  |-
 
  |-
  | Window Type
+
  | 2: update health
  | String (32)
+
  | Health
  | The window type to use for display. See [[Inventory]] for a list.
+
  | Float
 +
| as above
 
  |-
 
  |-
  | Window Title
+
  | 3: update title
 +
| Title
 
  | [[Chat]]
 
  | [[Chat]]
  | The title of the window
+
  |  
 +
|-
 +
|rowspan="2"| 4: update style
 +
| Color
 +
| VarInt Enum
 +
| Color ID (see below)
 +
|-
 +
| Dividers
 +
| VarInt Enum
 +
| as above
 
  |-
 
  |-
  | Number Of Slots
+
  | 5: update flags
 +
| Flags
 
  | Unsigned Byte
 
  | Unsigned Byte
  | Number of slots in the window (excluding the number of slots in the player inventory). Always 0 for non-storage windows (e.g. Workbench, Anvil).
+
  | as above
 
  |-
 
  |-
| Entity ID
 
| Optional Int
 
| EntityHorse's EID. Only sent when Window Type is “EntityHorse”
 
 
  |}
 
  |}
  
See [[Inventory]] for further information.
+
{| class="wikitable"
 
+
! ID
==== Window Items ====
+
! Color
[[File:Inventory-slots.png|thumb|The inventory slots]]
+
|-
 +
| 0
 +
| Pink
 +
|-
 +
| 1
 +
| Blue
 +
|-
 +
| 2
 +
| Red
 +
|-
 +
| 3
 +
| Green
 +
|-
 +
| 4
 +
| Yellow
 +
|-
 +
| 5
 +
| Purple
 +
|-
 +
| 6
 +
| White
 +
|}
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Type of division
 +
|-
 +
| 0
 +
| No division
 +
|-
 +
| 1
 +
| 6 notches
 +
|-
 +
| 2
 +
| 10 notches
 +
|-
 +
| 3
 +
| 12 notches
 +
|-
 +
| 4
 +
| 20 notches
 +
|}
 +
 
 +
==== Server Difficulty ====
  
Sent by the server when items in multiple slots (in a window) are added/removed. This includes the main inventory, equipped armour and crafting slots.
+
Changes the difficulty setting in the client's option menu
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,560: Line 1,625:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x15
+
  |rowspan="2"| 0x0E
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Client
+
  |rowspan="2"| Client
  | Window ID
+
  | Difficulty
 
  | Unsigned Byte
 
  | Unsigned Byte
  | The ID of window which items are being sent for. 0 for player inventory.
+
  | 0: peaceful, 1: easy, 2: normal, 3: hard
 
  |-
 
  |-
  | Count
+
  | Difficulty locked?
  | Short
+
  | Boolean
| Number of elements in the following array
+
  |
|-
 
| Slot Data
 
| Array of [[Slot Data|Slot]]
 
  |  
 
 
  |}
 
  |}
  
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
+
==== Chat Message (clientbound) ====
  
==== Window Property ====
+
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.
  
This packet is used to inform the client that part of a GUI window should be updated.
+
{{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.}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,590: Line 1,651:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x16
+
  |rowspan="2"| 0x0F
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Client
+
  |rowspan="2"| Client
  | Window ID
+
  | JSON Data
  | Unsigned Byte
+
  | [[Chat]]
  |  
+
  | Limited to 32767 bytes
 
  |-
 
  |-
  | Property
+
  | Position
  | Short
+
  | Byte
  | The property to be updated, see below
+
  | 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
|-
 
| 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.
+
==== Multi Block Change ====
 +
 
 +
Fired whenever 2 or more blocks are changed within the same chunk on the same tick.
 +
 
 +
{{Warning|Changing blocks in chunks not loaded by the client is unsafe (see note on [[#Block Change|Block Change]]).}}
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  ! Window type
+
  |rowspan="6"| 0x10
  ! Property
+
  |rowspan="6"| Play
  ! Value
+
  |rowspan="6"| Client
 +
|colspan="2"| Chunk X
 +
|colspan="2"| Int
 +
| Chunk X coordinate
 
  |-
 
  |-
  |rowspan="4"| Furnace
+
  |colspan="2"| Chunk Z
  | 0: Fire icon (fuel left)
+
  |colspan="2"| Int
  | counting from fuel burn time down to 0 (in-game ticks)
+
  | Chunk Z coordinate
 
  |-
 
  |-
  | 1: Maximum fuel burn time
+
  |colspan="2"| Record Count
  | fuel burn time or 0 (in-game ticks)
+
|colspan="2"| VarInt
 +
  | Number of elements in the following array, i.e. the number of blocks affected
 
  |-
 
  |-
  | 2: Progress arrow
+
  |rowspan="3"| Record
  | counting from 0 to maximum progress (in-game ticks)
+
| Horizontal Position
 +
|rowspan="3"| Array
 +
| Unsigned Byte
 +
  | The 4 most significant bits (<code>0xF0</code>) encode the X coordinate, relative to the chunk. The 4 least significant bits (<code>0x0F</code>) encode the Z coordinate, relative to the chunk.
 
  |-
 
  |-
  | 3: Maximum progress
+
  | Y Coordinate
  | always 200 on the notchian server
+
  | Unsigned Byte
 +
| Y coordinate of the block
 
  |-
 
  |-
  |rowspan="10"| Enchantment Table
+
  | Block ID
  | 0: Level requirement for top enchantment slot
+
  | VarInt
  |rowspan="3"| The enchantment's xp level requirement
+
  | The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}}. See that section for more information.
|-
+
  |}
| 1: Level requirement for middle enchantment slot
+
 
  |-
+
To decode the position into a world position:
| 2: Level requirement for bottom enchantment slot
+
 
|-
+
<syntaxhighlight lang="java">
| 3: The enchantment seed
+
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
| 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>).
+
worldY = vertPos;
|-
+
worldZ = (horizPos & 15) + (chunkZ * 16);
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
+
</syntaxhighlight>
  |rowspan="3"| The enchantment id (set to -1 to hide it), see below for values
+
 
 +
==== Tab-Complete (clientbound) ====
 +
 
 +
The server responds with a list of auto-completions of the last word sent to it. In the case of regular chat, this is a player username. Command names and parameters are also supported. The client sorts these alphabetically before listing them.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
  ! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
+
  |rowspan="8"| 0x11
 +
|rowspan="8"| Play
 +
|rowspan="8"| Client
 
  |-
 
  |-
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
+
  |colspan="2"| ID
 +
|colspan="2"| VarInt
 +
| Transaction ID
 
  |-
 
  |-
  | 7: Enchantment level shown on mouse hover over the top slot
+
  |colspan="2"| Start
  |rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
+
  |colspan="2"| VarInt
 +
| Start of the text to replace
 
  |-
 
  |-
  | 8: Enchantment level shown on mouse hover over the middle slot
+
  |colspan="2"| Length
 +
|colspan="2"| VarInt
 +
| Length of the text to replace
 
  |-
 
  |-
  | 9: Enchantment level shown on mouse hover over the bottom slot
+
  |colspan="2"| Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 
  |-
 
  |-
  |rowspan="3"| Beacon
+
  |rowspan="3"| Matches
  | 0: Power level
+
  | Match
  | 0-4, controls what effect buttons are enabled
+
  |rowspan="3"| Array
 +
| String (32767)
 +
| One eligible value to insert, note that each command is sent separately instead of in a single string, hence the need for Count.  Note that for instance this doesn't include a leading <code>/</code> on commands.
 
  |-
 
  |-
  | 1: First potion effect
+
  | Has tooltip
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
+
  | Boolean
 +
| True if the following is present
 
  |-
 
  |-
  | 2: Second potion effect
+
  | Tooltip
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
+
  | Optional [[Chat]]
 +
| Tooltip to display; only present if previous boolean is true
 +
|}
 +
 
 +
==== Declare Commands ====
 +
 
 +
Lists all of the commands on the server, and how they are parsed.
 +
 
 +
This is a directed graph, with one root node.  Each redirect or child node must refer only to nodes that have already been declared.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Anvil
+
  |rowspan="3"| 0x12
  | 0: Repair cost
+
|rowspan="3"| Play
  | The repair's cost in xp levels
+
|rowspan="3"| Client
 +
| Count
 +
  | VarInt
 +
  | Number of elements in the following array
 
  |-
 
  |-
  |rowspan="2"| Brewing Stand
+
  | Nodes
  | 0: Brew time
+
  | Array of [[Command Data|Node]]
  | 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
+
  | An array of nodes
 
  |-
 
  |-
  | 1: Fuel time
+
  | Root index
  | 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
+
  | VarInt
 +
| Index of the <code>root</code> node in the previous array
 
  |}
 
  |}
  
For an enchanting table, the following numerical IDs are used:
+
For more information on this packet, see the [[Command Data]] article.
 +
 
 +
==== Window Confirmation (clientbound) ====
 +
 
 +
A packet from the server indicating whether a request from the client was accepted, or whether there was a conflict (due to lag).  If the packet was not accepted, the client must respond with a [[#Window Confirmation (serverbound)|serverbound window confirmation]] packet.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Numerical ID
+
  ! Packet ID
  ! Enchantment ID
+
  ! State
  ! Enchantment Name
+
! Bound To
 +
  ! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  |rowspan="3"| 0x13
  | minecraft:protection
+
|rowspan="3"| Play
  | Protection
+
|rowspan="3"| Client
 +
| Window ID
 +
  | Byte
 +
  | The ID of the window that the action occurred in
 
  |-
 
  |-
  | 1
+
  | Action Number
  | minecraft:fire_protection
+
  | Short
  | Fire Protection
+
  | Every action that is to be accepted has a unique number. This number is an incrementing integer (starting at 0) with separate counts for each window ID.
 
  |-
 
  |-
  | 2
+
  | Accepted
  | minecraft:feather_falling
+
  | Boolean
  | Feather Falling
+
  | Whether the action was accepted
 +
|}
 +
 
 +
==== Close Window (clientbound) ====
 +
 
 +
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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 3
+
  | 0x14
  | minecraft:blast_protection
+
  | Play
  | Blast Protection
+
| Client
 +
| Window ID
 +
| Unsigned Byte
 +
| This is the ID of the window that was closed. 0 for inventory.
 +
|}
 +
 
 +
==== Window Items ====
 +
[[File:Inventory-slots.png|thumb|The inventory slots]]
 +
 
 +
Sent by the server when items in multiple slots (in a window) are added/removed. This includes the main inventory, equipped armour and crafting slots.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
  ! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 4
+
  |rowspan="3"| 0x15
  | minecraft:projectile_protection
+
|rowspan="3"| Play
  | Projectile Protection
+
|rowspan="3"| Client
 +
| Window ID
 +
  | Unsigned Byte
 +
  | The ID of window which items are being sent for. 0 for player inventory.
 
  |-
 
  |-
  | 5
+
  | Count
  | minecraft:respiration
+
  | Short
  | Respiration
+
  | Number of elements in the following array
 
  |-
 
  |-
  | 6
+
  | Slot Data
  | minecraft:aqua_affinity
+
| Array of [[Slot Data|Slot]]
  | Aqua Affinity
+
  |  
 +
  |}
 +
 
 +
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 +
 
 +
==== Window Property ====
 +
 
 +
This packet is used to inform the client that part of a GUI window should be updated.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 7
+
  |rowspan="3"| 0x16
  | minecraft:thorns
+
|rowspan="3"| Play
  | Thorns
+
|rowspan="3"| Client
 +
| Window ID
 +
  | Unsigned Byte
 +
  |  
 
  |-
 
  |-
  | 8
+
  | Property
  | minecraft:depth_strider
+
  | Short
  | Depth Strider
+
  | The property to be updated, see below
 
  |-
 
  |-
  | 9
+
  | Value
  | minecraft:frost_walker
+
  | Short
  | Frost Walker
+
  | 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.
 +
 
 +
{| class="wikitable"
 
  |-
 
  |-
  | 10
+
  ! Window type
  | minecraft:binding_curse
+
  ! Property
  | Curse of Binding
+
  ! Value
 
  |-
 
  |-
  | 11
+
  |rowspan="4"| Furnace
  | minecraft:sharpness
+
  | 0: Fire icon (fuel left)
  | Sharpness
+
  | counting from fuel burn time down to 0 (in-game ticks)
 
  |-
 
  |-
  | 12
+
  | 1: Maximum fuel burn time
| minecraft:smite
+
  | fuel burn time or 0 (in-game ticks)
  | Smite
 
 
  |-
 
  |-
  | 13
+
  | 2: Progress arrow
| minecraft:bane_of_arthropods
+
  | counting from 0 to maximum progress (in-game ticks)
  | Bane of Arthropods
 
 
  |-
 
  |-
  | 14
+
  | 3: Maximum progress
| minecraft:knockback
+
  | always 200 on the notchian server
  | Knockback
 
 
  |-
 
  |-
  | 15
+
  |rowspan="10"| Enchantment Table
  | minecraft:fire_aspect
+
  | 0: Level requirement for top enchantment slot
  | Fire Aspect
+
  |rowspan="3"| The enchantment's xp level requirement
 
  |-
 
  |-
  | 16
+
  | 1: Level requirement for middle enchantment slot
| minecraft:looting
 
| Looting
 
 
  |-
 
  |-
  | 17
+
  | 2: Level requirement for bottom enchantment slot
| minecraft:sweeping
 
| Sweeping Edge
 
 
  |-
 
  |-
  | 18
+
  | 3: The enchantment seed
  | minecraft:efficiency
+
  | 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>).
  | Efficiency
 
 
  |-
 
  |-
  | 19
+
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
  | minecraft:silk_touch
+
  |rowspan="3"| The enchantment id (set to -1 to hide it), see below for values
| Silk Touch
 
 
  |-
 
  |-
  | 20
+
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
| minecraft:unbreaking
 
| Unbreaking
 
 
  |-
 
  |-
  | 21
+
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
| minecraft:fortune
 
| Fortune
 
 
  |-
 
  |-
  | 22
+
  | 7: Enchantment level shown on mouse hover over the top slot
  | minecraft:power
+
  |rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
| Power
 
 
  |-
 
  |-
  | 23
+
  | 8: Enchantment level shown on mouse hover over the middle slot
| minecraft:punch
 
| Punch
 
 
  |-
 
  |-
  | 24
+
  | 9: Enchantment level shown on mouse hover over the bottom slot
| minecraft:flame
 
| Flame
 
 
  |-
 
  |-
  | 25
+
  |rowspan="3"| Beacon
  | minecraft:infinity
+
  | 0: Power level
  | Infinity
+
  | 0-4, controls what effect buttons are enabled
 
  |-
 
  |-
  | 26
+
  | 1: First potion effect
  | minecraft:luck_of_the_sea
+
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
| Luck of the Sea
 
 
  |-
 
  |-
  | 27
+
  | 2: Second potion effect
  | minecraft:lure
+
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
| Lure
 
 
  |-
 
  |-
  | 28
+
  | Anvil
  | minecraft:loyalty
+
  | 0: Repair cost
  | Loyalty
+
  | The repair's cost in xp levels
 
  |-
 
  |-
  | 29
+
  |rowspan="2"| Brewing Stand
  | minecraft:impaling
+
  | 0: Brew time
  | Impaling
+
  | 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
 
  |-
 
  |-
  | 30
+
  | 1: Fuel time
| minecraft:riptide
+
  | 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
| Riptide
 
|-
 
| 31
 
| minecraft:channeling
 
| Channeling
 
|-
 
| 32
 
| minecraft:mending
 
| Mending
 
  |-
 
| 33
 
| minecraft:vanishing_curse
 
| Curse of Vanishing
 
 
  |}
 
  |}
  
==== Set Slot ====
+
For an enchanting table, the following numerical IDs are used:
 
 
Sent by the server when an item in a slot (in a window) is added/removed.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Numerical ID
  ! State
+
  ! Enchantment ID
  ! Bound To
+
  ! Enchantment Name
  ! Field Name
+
|-
  ! Field Type
+
  | 0
  ! Notes
+
  | minecraft:protection
 +
  | Protection
 
  |-
 
  |-
  |rowspan="3"| 0x17
+
  | 1
|rowspan="3"| Play
+
  | minecraft:fire_protection
|rowspan="3"| Client
+
  | Fire Protection
| Window ID
 
  | Byte
 
  | The window which is being updated. 0 for player inventory. Note that all known window types include the player inventory. This packet will only be sent for the currently opened window while the player is performing actions, even if it affects the player inventory. After the window is closed, a number of these packets are sent to update the player's inventory window (0).
 
 
  |-
 
  |-
  | Slot
+
  | 2
  | Short
+
  | minecraft:feather_falling
  | The slot that should be updated
+
  | Feather Falling
 
  |-
 
  |-
  | Slot Data
+
  | 3
  | [[Slot Data|Slot]]
+
  | minecraft:blast_protection
|
+
  | Blast Protection
|}
 
 
 
To set the cursor (the item currently dragged with the mouse), use -1 as Window ID and as Slot.
 
 
 
This packet can only be used to edit the hotbar of the player's inventory if window ID is set to 0 (slots 36 through 44).  If the window ID is set to -2, then any slot in the inventory can be used but no add item animation will be played.
 
 
 
==== 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).
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x18
+
  | 4
|rowspan="2"| Play
+
  | minecraft:projectile_protection
|rowspan="2"| Client
+
  | Projectile Protection
| Item ID
 
  | VarInt
 
  | Numeric ID of the item to apply a cooldown to.
 
 
  |-
 
  |-
  | Cooldown Ticks
+
  | 5
  | VarInt
+
  | minecraft:respiration
| Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
+
| Respiration
|}
 
 
 
==== Plugin Message (clientbound) ====
 
 
 
{{Main|Plugin channels}}
 
 
 
Mods and plugins can use this to send their data. Minecraft itself uses several [[plugin channel]]s. These internal channels are in the <code>minecraft</code> namespace.
 
 
 
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x19
+
  | 6
|rowspan="2"| Play
+
  | minecraft:aqua_affinity
|rowspan="2"| Client
+
  | Aqua Affinity
| Channel
 
  | Identifier
 
  | Name of the [[plugin channel]] used to send the data
 
 
  |-
 
  |-
  | Data
+
  | 7
  | Byte Array
+
  | minecraft:thorns
| Any data, depending on the channel. <code>minecraft:</code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
+
  | Thorns
  |}
 
 
 
==== Named Sound Effect ====
 
{{See also|#Sound Effect}}
 
 
 
Used to play a sound effect on the client. Custom sounds may be added by resource packs.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="7"| 0x1A
+
  | 8
  |rowspan="7"| Play
+
  | minecraft:depth_strider
|rowspan="7"| Client
+
  | Depth Strider
| Sound Name
 
  | Identifier
 
| All sound effect names as of 1.13.2 can be seen [https://pokechu22.github.io/Burger/1.13.2.html#sounds here].
 
 
  |-
 
  |-
  | Sound Category
+
  | 9
  | VarInt Enum
+
  | minecraft:frost_walker
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
  | Frost Walker
 
  |-
 
  |-
  | Effect Position X
+
  | 10
  | Int
+
  | minecraft:binding_curse
  | Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Curse of Binding
 
  |-
 
  |-
  | Effect Position Y
+
  | 11
  | Int
+
  | minecraft:sharpness
  | Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Sharpness
 
  |-
 
  |-
  | Effect Position Z
+
  | 12
  | Int
+
  | minecraft:smite
  | Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Smite
 
  |-
 
  |-
  | Volume
+
  | 13
  | Float
+
  | minecraft:bane_of_arthropods
  | 1 is 100%, can be more
+
  | Bane of Arthropods
 
  |-
 
  |-
  | Pitch
+
  | 14
  | Float
+
  | minecraft:knockback
  | Float between 0.5 and 2.0 by Notchian clients
+
  | Knockback
|}
 
 
 
==== Disconnect (play) ====
 
 
 
Sent by the server before it disconnects a client. The client assumes that the server has already closed the connection by the time the packet arrives.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  | 0x1B
+
  | 15
  | Play
+
  | minecraft:fire_aspect
  | Client
+
  | Fire Aspect
| Reason
 
| [[Chat]]
 
| Displayed to the client when the connection terminates.
 
|}
 
 
 
==== Entity Status ====
 
 
 
Entity statuses generally trigger an animation for an entity.  The available statuses vary by the entity's type (and are available to subclasses of that type as well).
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x1C
+
  | 16
  |rowspan="2"| Play
+
| minecraft:looting
  |rowspan="2"| Client
+
| Looting
  | Entity ID
+
|-
  | Int
+
  | 17
  |  
+
| minecraft:sweeping
 +
  | Sweeping Edge
 +
|-
 +
  | 18
 +
  | minecraft:efficiency
 +
  | Efficiency
 
  |-
 
  |-
  | Entity Status
+
  | 19
  | Byte Enum
+
  | minecraft:silk_touch
  | See below
+
  | Silk Touch
|}
 
 
 
See [[Entity statuses]] for a list of which statuses are valid for each type of entity.
 
 
 
==== NBT Query Response ====
 
 
 
Sent in response to [[#Query Block NBT|Query Block NBT]] or [[#Query Entity NBT|Query Entity NBT]].
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x1D
+
  | 20
|rowspan="2"| Play
+
  | minecraft:unbreaking
|rowspan="2"| Client
+
  | Unbreaking
| Transaction ID
 
  | VarInt
 
  | Can be compared to the one sent in the original query packet.
 
 
  |-
 
  |-
  | NBT
+
  | 21
  | [[NBT|NBT Tag]]
+
  | minecraft:fortune
  | The NBT of the block or entity.  May be a TAG_END (0) in which case no NBT is present.
+
  | Fortune
|}
 
 
 
==== 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
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="9"| 0x1E
+
  | 22
|rowspan="9"| Play
+
  | minecraft:power
|rowspan="9"| Client
+
  | Power
| X
 
  | Float
 
  |  
 
 
  |-
 
  |-
  | Y
+
  | 23
  | Float
+
  | minecraft:punch
  |  
+
  | Punch
 
  |-
 
  |-
  | Z
+
  | 24
  | Float
+
  | minecraft:flame
  |  
+
  | Flame
 
  |-
 
  |-
  | Radius
+
  | 25
  | Float
+
  | minecraft:infinity
  | Currently unused in the client
+
  | Infinity
 
  |-
 
  |-
  | Record Count
+
  | 26
  | Int
+
  | minecraft:luck_of_the_sea
  | Number of elements in the following array
+
  | Luck of the Sea
 
  |-
 
  |-
  | Records
+
  | 27
  | Array of (Byte, Byte, Byte)
+
  | minecraft:lure
  | Each record is 3 signed bytes long, each bytes are the XYZ (respectively) offsets of affected blocks.
+
  | Lure
 
  |-
 
  |-
  | Player Motion X
+
  | 28
  | Float
+
  | minecraft:loyalty
  | X velocity of the player being pushed by the explosion
+
  | Loyalty
 +
|-
 +
| 29
 +
| minecraft:impaling
 +
| Impaling
 +
|-
 +
| 30
 +
| minecraft:riptide
 +
| Riptide
 +
|-
 +
| 31
 +
| minecraft:channeling
 +
| Channeling
 
  |-
 
  |-
  | Player Motion Y
+
  | 32
  | Float
+
  | minecraft:mending
  | Y velocity of the player being pushed by the explosion
+
  | Mending
 
  |-
 
  |-
  | Player Motion Z
+
  | 33
  | Float
+
  | minecraft:vanishing_curse
  | Z velocity of the player being pushed by the explosion
+
  | Curse of Vanishing
 
  |}
 
  |}
  
==== Unload Chunk ====
+
==== Set Slot ====
  
Tells the client to unload a chunk column.
+
Sent by the server when an item in a slot (in a window) is added/removed.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,083: Line 2,125:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x1F
+
  |rowspan="3"| 0x17
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | Chunk X
+
  | Window ID
  | Int
+
  | Byte
  | Block coordinate divided by 16, rounded down
+
  | The window which is being updated. 0 for player inventory. Note that all known window types include the player inventory. This packet will only be sent for the currently opened window while the player is performing actions, even if it affects the player inventory. After the window is closed, a number of these packets are sent to update the player's inventory window (0).
 +
|-
 +
| Slot
 +
| Short
 +
| The slot that should be updated
 
  |-
 
  |-
  | Chunk Z
+
  | Slot Data
  | Int
+
  | [[Slot Data|Slot]]
  | Block coordinate divided by 16, rounded down
+
  |  
 
  |}
 
  |}
  
It is legal to send this packet even if the given chunk is not currently loaded.
+
To set the cursor (the item currently dragged with the mouse), use -1 as Window ID and as Slot.
 +
 
 +
This packet can only be used to edit the hotbar of the player's inventory if window ID is set to 0 (slots 36 through 44).  If the window ID is set to -2, then any slot in the inventory can be used but no add item animation will be played.
  
==== Change Game State ====
+
==== Set Cooldown ====
  
Used for a wide variety of game state things, from whether to bed use to gamemode to demo messages.
+
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 2,109: Line 2,157:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x20
+
  |rowspan="2"| 0x18
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
 
  |rowspan="2"| Client
 
  |rowspan="2"| Client
  | Reason
+
  | Item ID
  | Unsigned Byte
+
  | VarInt
  | See below
+
  | Numeric ID of the item to apply a cooldown to.
 
  |-
 
  |-
  | Value
+
  | Cooldown Ticks
  | Float
+
  | VarInt
  | Depends on Reason
+
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
 
  |}
 
  |}
  
''Reason codes'':
+
==== Plugin Message (clientbound) ====
 +
 
 +
{{Main|Plugin channels}}
 +
 
 +
Mods and plugins can use this to send their data. Minecraft itself uses several [[plugin channel]]s. These internal channels are in the <code>minecraft</code> namespace.
 +
 
 +
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Reason
+
  ! Packet ID
  ! Effect
+
  ! State
  ! Value
+
  ! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  |rowspan="2"| 0x19
  | Invalid Bed
+
|rowspan="2"| Play
  | Would be used to switch between messages, but the only used message is 0 for invalid bed
+
|rowspan="2"| Client
 +
  | Channel
 +
  | Identifier
 +
| Name of the [[plugin channel]] used to send the data
 
  |-
 
  |-
  | 1
+
  | Data
  | End raining
+
  | Byte Array
  |  
+
  | Any data, depending on the channel. <code>minecraft:</code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
|-
 
| 2
 
| Begin raining
 
|
 
|-
 
| 3
 
| Change gamemode
 
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
 
|-
 
| 4
 
| Exit end
 
| 0: Immediately send Client Status of respawn without showing end credits; 1: Show end credits and respawn at the end (or when esc is pressed)1 is sent if the player has not yet received the "The end?" advancement, while if they do have it 0 is used.
 
|-
 
| 5
 
| Demo message
 
| 0: Show welcome to demo screen, 101: Tell movement controls, 102: Tell jump control, 103: Tell inventory control
 
|-
 
| 6
 
| Arrow hitting player
 
| Appears to be played when an arrow strikes another player in Multiplayer
 
|-
 
| 7
 
| Fade value
 
| The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
 
|-
 
| 8
 
| Fade time
 
| Time in ticks for the sky to fade
 
|-
 
| 9
 
| Play pufferfish sting sound
 
|-
 
| 10
 
| Play elder guardian mob appearance (effect and sound)
 
|
 
 
  |}
 
  |}
  
==== Keep Alive (clientbound) ====
+
==== Named Sound Effect ====
 +
{{See also|#Sound Effect}}
  
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same packet. If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.
+
Used to play a sound effect on the client. Custom sounds may be added by resource packs.
 
 
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,186: Line 2,210:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x21
+
  |rowspan="7"| 0x1A
  |rowspan="1"| Play
+
  |rowspan="7"| Play
  |rowspan="1"| Client
+
  |rowspan="7"| Client
  | Keep Alive ID
+
  | Sound Name
  | Long
+
| Identifier
  |  
+
| All sound effect names as of 1.15.2 can be seen [https://pokechu22.github.io/Burger/1.15.2.html#sounds here].
 +
|-
 +
| Sound Category
 +
| VarInt Enum
 +
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
 +
|-
 +
| Effect Position X
 +
| Int
 +
| Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Effect Position Y
 +
| Int
 +
| Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Effect Position Z
 +
| Int
 +
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Volume
 +
| Float
 +
| 1 is 100%, can be more
 +
|-
 +
| Pitch
 +
  | Float
 +
  | Float between 0.5 and 2.0 by Notchian clients
 
  |}
 
  |}
  
==== Chunk Data ====
+
==== Disconnect (play) ====
{{Main|Chunk Format}}
 
{{See also|#Unload Chunk}}
 
  
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimenison the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.  This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with [[#Update Block Entity|Update Block Entity]] later).
+
Sent by the server before it disconnects a client. The client assumes that the server has already closed the connection by the time the packet arrives.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,208: Line 2,254:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x22
+
  | 0x1B
  |rowspan="8"| Play
+
  | Play
  |rowspan="8"| Client
+
  | Client
  | Chunk X
+
| Reason
  | Int
+
  | [[Chat]]
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  | Displayed to the client when the connection terminates.
 +
  |}
 +
 
 +
==== Entity Status ====
 +
 
 +
Entity statuses generally trigger an animation for an entity.  The available statuses vary by the entity's type (and are available to subclasses of that type as well).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Chunk Z
+
  |rowspan="2"| 0x1C
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 
  | Int
 
  | Int
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  |  
 
  |-
 
  |-
  | Full chunk
+
  | Entity Status
| Boolean
+
  | Byte Enum
| See [[Chunk Format#Full chunk|Chunk Format]]
+
  | See below
|-
 
| Primary Bit Mask
 
| VarInt
 
| Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
 
|-
 
| Size
 
| VarInt
 
| Size of Data in bytes
 
|-
 
| Data
 
  | Byte array
 
  | 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.
 
 
  |}
 
  |}
  
==== Effect ====
+
See [[Entity statuses]] for a list of which statuses are valid for each type of entity.
 +
 
 +
==== Explosion ====
  
Sent when a client is to play a sound or particle effect.
+
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
  
By default, the Minecraft client adjusts the volume of sound effects based on distance. The final boolean field is used to disable this, and instead the effect is played from 2 blocks away in the correct direction. Currently this is only used for effect 1023 (wither spawn) and effect 1028 (enderdragon death); it is ignored on other effects.
+
Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,258: Line 2,302:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x23
+
  |rowspan="9"| 0x1D
  |rowspan="4"| Play
+
  |rowspan="9"| Play
  |rowspan="4"| Client
+
  |rowspan="9"| Client
  | Effect ID
+
  | X
  | Int
+
  | Float
  | The ID of the effect, see below
+
  |  
 
  |-
 
  |-
  | Location
+
  | Y
  | Position
+
  | Float
  | The location of the effect
+
  |  
 +
|-
 +
| Z
 +
| Float
 +
|
 +
|-
 +
| Strength
 +
| Float
 +
| A strength greater than or equal to 2.0 spawns a <code>minecraft:explosion_emitter</code> particle, while a lesser strength spawns a <code>minecraft:explosion</code> particle.
 
  |-
 
  |-
  | Data
+
  | Record Count
 
  | Int
 
  | Int
  | Extra data for certain effects, see below
+
  | 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.
 +
|-
 +
| Player Motion X
 +
| Float
 +
| X velocity of the player being pushed by the explosion
 +
|-
 +
| Player Motion Y
 +
| Float
 +
| Y velocity of the player being pushed by the explosion
 
  |-
 
  |-
  | Disable Relative Volume
+
  | Player Motion Z
  | Boolean
+
  | Float
  | See above
+
  | Z velocity of the player being pushed by the explosion
 
  |}
 
  |}
  
Effect IDs:
+
==== Unload Chunk ====
 +
 
 +
Tells the client to unload a chunk column.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Name
+
  ! State
  ! Data
+
! Bound To
 +
! Field Name
 +
  ! Field Type
 +
! Notes
 
  |-
 
  |-
  !colspan="3"| Sound
+
  |rowspan="2"| 0x1E
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Chunk X
 +
| Int
 +
| Block coordinate divided by 16, rounded down
 
  |-
 
  |-
  | 1000
+
  | Chunk Z
  | Dispenser dispenses
+
  | Int
  |  
+
  | Block coordinate divided by 16, rounded down
 +
|}
 +
 
 +
It is legal to send this packet even if the given chunk is not currently loaded.
 +
 
 +
==== Change Game State ====
 +
 
 +
Used for a wide variety of game state things, from whether to bed use to gamemode to demo messages.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x1F
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Reason
 +
| Unsigned Byte
 +
| See below
 +
|-
 +
| Value
 +
| Float
 +
| Depends on Reason
 +
|}
 +
 
 +
''Reason codes'':
 +
 
 +
{| class="wikitable"
 +
! Reason
 +
! Effect
 +
! Value
 
  |-
 
  |-
  | 1001
+
  | 0
  | Dispenser fails to dispense
+
  | Invalid Bed
  |  
+
  | Would be used to switch between messages, but the only used message is 0 for invalid bed
 
  |-
 
  |-
  | 1002
+
  | 1
  | Dispenser shoots
+
  | End raining
 
  |  
 
  |  
 
  |-
 
  |-
  | 1003
+
  | 2
  | Ender eye launched
+
  | Begin raining
 
  |  
 
  |  
 
  |-
 
  |-
  | 1004
+
  | 3
  | Firework shot
+
  | Change gamemode
  |  
+
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
 
  |-
 
  |-
  | 1005
+
  | 4
  | Iron door opened
+
  | Exit end
  |  
+
  | 0: Immediately send Client Status of respawn without showing end credits; 1: Show end credits and respawn at the end (or when esc is pressed).  1 is sent if the player has not yet received the "The end?" advancement, while if they do have it 0 is used.
 
  |-
 
  |-
  | 1006
+
  | 5
  | Wooden door opened
+
  | Demo message
  |  
+
  | 0: Show welcome to demo screen, 101: Tell movement controls, 102: Tell jump control, 103: Tell inventory control, 104: Tell that the demo is over and print a message about how to take a screenshot
 +
|-
 +
| 6
 +
| Arrow hitting player
 +
| Appears to be played when an arrow strikes another player in Multiplayer
 
  |-
 
  |-
  | 1007
+
  | 7
  | Wooden trapdoor opened
+
  | Fade value
  |  
+
  | The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
 
  |-
 
  |-
  | 1008
+
  | 8
  | Fence gate opened
+
  | Fade time
  |  
+
  | Time in ticks for the sky to fade
 
  |-
 
  |-
  | 1009
+
  | 9
| Fire extinguished
+
  | Play pufferfish sting sound
  |  
 
 
  |-
 
  |-
  | 1010
+
  | 10
  | Play record
+
  | Play elder guardian mob appearance (effect and sound)
| Special case, see below for more info
 
|-
 
| 1011
 
| Iron door closed
 
 
  |  
 
  |  
 
  |-
 
  |-
  | 1012
+
  | 11
  | Wooden door closed
+
  | Enable respawn screen
  |  
+
  | 0: Enable respawn screen, 1: Immediately respawn (sent when the doImmediateRespawn gamerule changes)
 +
|}
 +
 
 +
==== Open Horse Window ====
 +
 
 +
This packet is used exclusively for opening the horse GUI.  [[#Open Window|Open Window]] is used for all other GUIs.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1013
+
  |rowspan="3"| 0x20
  | Wooden trapdoor closed
+
|rowspan="3"| Play
  |  
+
|rowspan="3"| Client
 +
| Window ID?
 +
  | Byte
 +
  |
 
  |-
 
  |-
  | 1014
+
  | Number of slots?
  | Fence gate closed
+
  | VarInt
  |  
+
  |
 
  |-
 
  |-
  | 1015
+
  | Entity ID?
  | Ghast warns
+
  | Integer
  |  
+
  |
 +
|}
 +
 
 +
==== Keep Alive (clientbound) ====
 +
 
 +
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same packet. If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.
 +
 
 +
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1016
+
  |rowspan="1"| 0x21
| Ghast shoots
+
  |rowspan="1"| Play
|
+
  |rowspan="1"| Client
|-
+
  | Keep Alive ID
  | 1017
+
  | Long
| Enderdragon shoots
 
  |  
 
|-
 
  | 1018
 
  | Blaze shoots
 
 
  |  
 
  |  
 +
|}
 +
 +
==== Chunk Data ====
 +
{{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)}}
 +
 +
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).
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1019
+
  |rowspan="10"| 0x22
  | Zombie attacks wood door
+
|rowspan="10"| Play
  |  
+
|rowspan="10"| Client
 +
| Chunk X
 +
  | Int
 +
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | 1020
+
  | Chunk Z
  | Zombie attacks iron door
+
  | Int
  |  
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | 1021
+
  | Full chunk
  | Zombie breaks wood door
+
  | Boolean
  |
+
  | See [[Chunk Format#Full chunk|Chunk Format]]
 
  |-
 
  |-
  | 1022
+
  | Primary Bit Mask
  | Wither breaks block
+
  | VarInt
  |
+
  | Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
 
  |-
 
  |-
  | 1023
+
  | Heightmaps
  | Wither spawned
+
  | [[NBT]]
  |  
+
  | 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.
 
  |-
 
  |-
  | 1024
+
| Biomes
  | Wither shoots
+
| Optional array of Integer
  |
+
  | 1024 biome IDs, ordered by x then z then y, in 4&times;4&times;4 blocks.  Not present if full chunk is false.
 +
|-
 +
| Size
 +
  | VarInt
 +
  | Size of Data in bytes
 
  |-
 
  |-
  | 1025
+
  | Data
  | Bat takes off
+
  | Byte array
  |
+
  | See [[Chunk Format#Data structure|data structure]] in Chunk Format
 
  |-
 
  |-
  | 1026
+
  | Number of block entities
  | Zombie infects
+
  | VarInt
  |
+
  | Number of elements in the following array
 
  |-
 
  |-
  | 1027
+
  | Block entities
  | Zombie villager converted
+
  | 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.
 +
 
 +
==== Effect ====
 +
 
 +
Sent when a client is to play a sound or particle effect.
 +
 
 +
By default, the Minecraft client adjusts the volume of sound effects based on distance. The final boolean field is used to disable this, and instead the effect is played from 2 blocks away in the correct direction. Currently this is only used for effect 1023 (wither spawn) and effect 1028 (enderdragon death); it is ignored on other effects.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1028
+
  |rowspan="4"| 0x23
  | Ender dragon death
+
|rowspan="4"| Play
  |
+
|rowspan="4"| Client
 +
| Effect ID
 +
  | Int
 +
  | The ID of the effect, see below
 
  |-
 
  |-
  | 1029
+
  | Location
  | Anvil destroyed
+
  | Position
  |  
+
  | The location of the effect
 
  |-
 
  |-
  | 1030
+
  | Data
  | Anvil used
+
  | Int
  |  
+
  | Extra data for certain effects, see below
 +
|-
 +
| Disable Relative Volume
 +
| Boolean
 +
| See above
 +
|}
 +
 
 +
Effect IDs:
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Name
 +
! Data
 
  |-
 
  |-
  | 1031
+
  !colspan="3"| Sound
| Anvil landed
 
|
 
 
  |-
 
  |-
  | 1032
+
  | 1000
  | Portal travel
+
  | Dispenser dispenses
 
  |  
 
  |  
 
  |-
 
  |-
  | 1033
+
  | 1001
  | Chorus flower grown
+
  | Dispenser fails to dispense
  |
+
  |  
 
  |-
 
  |-
  | 1034
+
  | 1002
  | Chorus flower died
+
  | Dispenser shoots
 
  |  
 
  |  
 
  |-
 
  |-
  | 1035
+
  | 1003
  | Brewing stand brewed
+
  | Ender eye launched
  |
+
  |  
 
  |-
 
  |-
  | 1036
+
  | 1004
  | Iron trapdoor opened
+
  | Firework shot
 
  |  
 
  |  
 
  |-
 
  |-
  | 1037
+
  | 1005
  | Iron trapdoor closed
+
  | Iron door opened
  |
+
  |  
 
  |-
 
  |-
  !colspan="3"| Particle
+
  | 1006
 +
| Wooden door opened
 +
|
 
  |-
 
  |-
  | 2000
+
  | 1007
  | Spawns 10 smoke particles, e.g. from a fire
+
  | Wooden trapdoor opened
  | Direction, see below
+
|
 +
|-
 +
| 1008
 +
| Fence gate opened
 +
  |  
 
  |-
 
  |-
  | 2001
+
  | 1009
  | Block break + block break sound
+
  | Fire extinguished
  | Block state, as an index into the global palette
+
  |  
 
  |-
 
  |-
  | 2002
+
  | 1010
  | Splash potion. Particle effect + glass break sound.
+
  | Play record
  | [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
+
  | Special case, see below for more info
 
  |-
 
  |-
  | 2003
+
  | 1011
  | Eye of Ender entity break animation — particles and sound
+
  | Iron door closed
 
  |  
 
  |  
 
  |-
 
  |-
  | 2004
+
  | 1012
  | Mob spawn particle effect: smoke + flames
+
  | Wooden door closed
 
  |  
 
  |  
 
  |-
 
  |-
  | 2005
+
  | 1013
  | Bonemeal particles
+
  | Wooden trapdoor closed
  | How many particles to spawn (if set to 0, 15 are spawned)
+
  |  
 
  |-
 
  |-
  | 2006
+
  | 1014
  | Dragon breath
+
  | Fence gate closed
  |
+
  |  
 
  |-
 
  |-
  | 2007
+
  | 1015
  | Instant splash potion
+
  | Ghast warns
  | [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
+
  |  
 
  |-
 
  |-
  | 3000
+
  | 1016
  | End gateway spawn
+
  | Ghast shoots
 
  |  
 
  |  
 
  |-
 
  |-
  | 3001
+
  | 1017
  | Enderdragon growl
+
  | Enderdragon shoots
  |
+
  |  
|}
 
 
 
Smoke directions:
 
 
 
{| class="wikitable"
 
! ID
 
! Direction
 
 
  |-
 
  |-
  | 0
+
  | 1018
  | South-East
+
| Blaze shoots
 +
  |  
 
  |-
 
  |-
  | 1
+
  | 1019
  | South
+
| Zombie attacks wood door
 +
  |  
 
  |-
 
  |-
  | 2
+
  | 1020
  | South-West
+
| Zombie attacks iron door
 +
  |  
 
  |-
 
  |-
  | 3
+
  | 1021
  | East
+
| Zombie breaks wood door
 +
  |
 
  |-
 
  |-
  | 4
+
  | 1022
  | (Up or middle ?)
+
| Wither breaks block
 +
  |
 
  |-
 
  |-
  | 5
+
  | 1023
  | West
+
| Wither spawned
 +
  |  
 
  |-
 
  |-
  | 6
+
  | 1024
  | North-East
+
| Wither shoots
 +
  |
 
  |-
 
  |-
  | 7
+
  | 1025
  | North
+
| Bat takes off
 +
  |
 
  |-
 
  |-
  | 8
+
  | 1026
  | North-West
+
  | Zombie infects
  |}
+
  |
 
 
Play record: This is actually a special case within this packet. You can start/stop a record at a specific location. Use a valid {{Minecraft Wiki|Music Discs|Record ID}} to start a record (or overwrite a currently playing one), any other value will stop the record.  See [[Data Generators]] for information on item IDs.
 
 
 
==== Particle ====
 
 
 
Displays the named particle
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="11"| 0x24
+
  | 1027
  |rowspan="11"| Play
+
  | Zombie villager converted
  |rowspan="11"| Client
+
  |
| Particle ID
 
| Int
 
| The particle ID listed in [[#Particle|the particle data type]].
 
 
  |-
 
  |-
  | Long Distance
+
  | 1028
  | Boolean
+
  | Ender dragon death
  | If true, particle distance increases from 256 to 65536
+
  |
 
  |-
 
  |-
  | X
+
  | 1029
  | Float
+
  | Anvil destroyed
  | X position of the particle
+
  |  
 
  |-
 
  |-
  | Y
+
  | 1030
  | Float
+
  | Anvil used
  | Y position of the particle
+
  |  
 
  |-
 
  |-
  | Z
+
  | 1031
  | Float
+
  | Anvil landed
  | Z position of the particle
+
  |
 
  |-
 
  |-
  | Offset X
+
  | 1032
  | Float
+
  | Portal travel
  | This is added to the X position after being multiplied by random.nextGaussian()
+
|
 +
|-
 +
| 1033
 +
| Chorus flower grown
 +
  |
 
  |-
 
  |-
  | Offset Y
+
  | 1034
  | Float
+
  | Chorus flower died
  | This is added to the Y position after being multiplied by random.nextGaussian()
+
  |  
 
  |-
 
  |-
  | Offset Z
+
  | 1035
  | Float
+
  | Brewing stand brewed
  | This is added to the Z position after being multiplied by random.nextGaussian()
+
  |
 
  |-
 
  |-
  | Particle Data
+
  | 1036
  | Float
+
  | Iron trapdoor opened
  | The data of each particle
+
  |  
 
  |-
 
  |-
  | Particle Count
+
  | 1037
  | Int
+
  | Iron trapdoor closed
  | The number of particles to create
+
  |
 
  |-
 
  |-
  | Data
+
  !colspan="3"| Particle
| Varies
 
| The variable data listed in [[#Particle|the particle data type]].
 
|}
 
 
 
==== Join Game ====
 
 
 
See [[Protocol Encryption]] for information on logging in.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="7"| 0x25
+
  | 2000
  |rowspan="7"| Play
+
| Spawns 10 smoke particles, e.g. from a fire
  |rowspan="7"| Client
+
  | Direction, see below
  | Entity ID
+
|-
  | Int
+
  | 2001
  | The player's Entity ID (EID)
+
| Block break + block break sound
 +
  | Block state, as an index into the global palette
 +
|-
 +
| 2002
 +
| Splash potion. Particle effect + glass break sound.
 +
| [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
 +
|-
 +
| 2003
 +
  | Eye of Ender entity break animation — particles and sound
 +
  |  
 
  |-
 
  |-
  | Gamemode
+
  | 2004
  | Unsigned Byte
+
  | Mob spawn particle effect: smoke + flames
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. Bit 3 (0x8) is the hardcore flag.
+
  |  
 
  |-
 
  |-
  | Dimension
+
  | 2005
  | Int Enum
+
  | Bonemeal particles
  | -1: Nether, 0: Overworld, 1: End; also, note that this is not a VarInt but instead a regular int.
+
  | How many particles to spawn (if set to 0, 15 are spawned)
 
  |-
 
  |-
  | Difficulty
+
  | 2006
  | Unsigned Byte
+
  | Dragon breath
  | 0: peaceful, 1: easy, 2: normal, 3: hard
+
  |
 
  |-
 
  |-
  | Max Players
+
  | 2007
  | Unsigned Byte
+
  | Instant splash potion
  | Was once used by the client to draw the player list, but now is ignored
+
  | [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
 
  |-
 
  |-
  | Level Type
+
  | 3000
  | String Enum (16)
+
  | End gateway spawn
  | default, flat, largeBiomes, amplified, default_1_1
+
  |  
 
  |-
 
  |-
  | Reduced Debug Info
+
  | 3001
  | Boolean
+
  | Enderdragon growl
  | If true, a Notchian client shows reduced information on the {{Minecraft Wiki|debug screen}}.  For servers in development, this should almost always be false.
+
  |
 
  |}
 
  |}
  
==== Map Data ====
+
Smoke directions:
 
 
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Direction
! Bound To
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="16"| 0x26
+
  | 0
|rowspan="16"| Play
+
  | South-East
|rowspan="16"| Client
 
|colspan="2"| Map ID
 
|colspan="2"| VarInt
 
  | Map ID of the map being modified
 
 
  |-
 
  |-
  |colspan="2"| Scale
+
  | 1
|colspan="2"| Byte
+
  | South
| From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
 
|-
 
|colspan="2"| Tracking Position
 
|colspan="2"| Boolean
 
| Specifies whether player and item frame icons are shown
 
|-
 
|colspan="2"| Icon Count
 
|colspan="2"| VarInt
 
  | Number of elements in the following array
 
 
  |-
 
  |-
  |rowspan="6"| Icon
+
  | 2
| Type
+
  | South-West
|rowspan="6"| Array
 
| VarInt enum
 
  | See below
 
 
  |-
 
  |-
  | X
+
  | 3
  | Byte
+
  | East
| Map coordinates: -128 for furthest left, +127 for furthest right
 
 
  |-
 
  |-
  | Z
+
  | 4
  | Byte
+
  | (Up or middle ?)
| Map coordinates: -128 for highest, +127 for lowest
 
 
  |-
 
  |-
  | Direction
+
  | 5
  | Byte
+
  | West
| 0-15
 
 
  |-
 
  |-
  | Has Display Name
+
  | 6
| Boolean
+
  | North-East
  |
 
 
  |-
 
  |-
  | Display Name
+
  | 7
  | Optional [[Chat]]
+
  | North
| Only present if previous Boolean is true
 
|-
 
|colspan="2"| Columns
 
|colspan="2"| Byte
 
| Number of columns updated
 
 
  |-
 
  |-
  |colspan="2"| Rows
+
  | 8
|colspan="2"| Optional Byte
+
  | North-West
| Only if Columns is more than 0; number of rows updated
 
  |-
 
|colspan="2"| X
 
|colspan="2"| Optional Byte
 
| Only if Columns is more than 0; x offset of the westernmost column
 
|-
 
|colspan="2"| Z
 
|colspan="2"| Optional Byte
 
| Only if Columns is more than 0; z offset of the northernmost row
 
|-
 
|colspan="2"| Length
 
|colspan="2"| Optional VarInt
 
| Only if Columns is more than 0; length of the following array
 
|-
 
|colspan="2"| Data
 
|colspan="2"| Optional Array of Unsigned Byte
 
| Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
 
 
  |}
 
  |}
  
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
+
Play record: This is actually a special case within this packet. You can start/stop a record at a specific location. Use a valid {{Minecraft Wiki|Music Discs|Record ID}} to start a record (or overwrite a currently playing one), any other value will stop the record.  See [[Data Generators]] for information on item IDs.
 +
 
 +
==== Particle ====
  
Types are based off of rows and columns in <code>map_icons.png</code>:
+
Displays the named particle
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Icon type
+
  |rowspan="11"| 0x24
  ! Result
+
|rowspan="11"| Play
 +
|rowspan="11"| Client
 +
| Particle ID
 +
| Int
 +
  | The particle ID listed in [[#Particle|the particle data type]].
 
  |-
 
  |-
  | 0
+
  | Long Distance
  | White arrow (players)
+
  | Boolean
 +
| If true, particle distance increases from 256 to 65536
 
  |-
 
  |-
  | 1
+
  | X
  | Green arrow (item frames)
+
  | Double
 +
| X position of the particle
 
  |-
 
  |-
  | 2
+
  | Y
  | Red arrow
+
  | Double
 +
| Y position of the particle
 
  |-
 
  |-
  | 3
+
  | Z
  | Blue arrow
+
  | Double
 +
| Z position of the particle
 
  |-
 
  |-
  | 4
+
  | Offset X
  | White cross
+
  | Float
 +
| This is added to the X position after being multiplied by random.nextGaussian()
 
  |-
 
  |-
  | 5
+
  | Offset Y
  | Red pointer
+
  | Float
 +
| This is added to the Y position after being multiplied by random.nextGaussian()
 
  |-
 
  |-
  | 6
+
  | Offset Z
  | White circle (off-map players)
+
  | Float
 +
| This is added to the Z position after being multiplied by random.nextGaussian()
 
  |-
 
  |-
  | 7
+
  | Particle Data
  | Small white circle (far-off-map players)
+
  | Float
 +
| The data of each particle
 
  |-
 
  |-
  | 8
+
  | Particle Count
  | Mansion
+
  | Int
 +
| The number of particles to create
 
  |-
 
  |-
  | 9
+
  | Data
  | Temple
+
  | Varies
  |-
+
  | The variable data listed in [[#Particle|the particle data type]].
  | 10
+
  |}
  | White Banner
+
 
 +
==== Update Light ====
 +
 
 +
Updates light levels for a chunk.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | 11
+
  |rowspan="10"| 0x25
  | Orange Banner
+
|rowspan="10"| Play
 +
|rowspan="10"| Client
 +
|colspan="2"| Chunk X
 +
|colspan="2"| VarInt
 +
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | 12
+
  |colspan="2"| Chunk Z
  | Magenta Banner
+
|colspan="2"| VarInt
 +
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | 13
+
  |colspan="2"| Sky Light Mask
  | Light Blue Banner
+
  |colspan="2"| VarInt
 +
| Mask containing 18 bits, with the lowest bit corresponding to chunk section -1 (in the void, y=-16 to y=-1) and the highest bit for chunk section 16 (above the world, y=256 to y=271)
 
  |-
 
  |-
  | 14
+
  |colspan="2"| Block Light Mask
  | Yellow Banner
+
|colspan="2"| VarInt
 +
  | Mask containing 18 bits, with the same order as sky light
 
  |-
 
  |-
  | 15
+
  |colspan="2"| Empty Sky Light Mask
  | Lime Banner
+
  |colspan="2"| VarInt
 +
| Mask containing 18 bits, which indicates sections that have 0 for all their sky light values.  If a section is set in both this mask and the main sky light mask, it is ignored for this mask and it is included in the sky light arrays (the notchian server does not create such masks).  If it is only set in this mask, it is not included in the sky light arrays.
 
  |-
 
  |-
  | 16
+
  |colspan="2"| Empty Block Light Mask
  | Pink Banner
+
  |colspan="2"| 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.
 
  |-
 
  |-
  | 17
+
  |rowspan="2"| Sky Light arrays
  | Gray Banner
+
  | Length
  |-
+
  |rowspan="2"| Array
  | 18
+
  | VarInt
  | Light Gray Banner
+
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | 19
+
  | Sky Light array
  | Cyan Banner
+
  | Array of 2048 bytes
 +
| There is 1 array for each bit set to true in the sky light mask, starting with the lowest value.  Half a byte per light value.
 
  |-
 
  |-
  | 20
+
  |rowspan="2"| Block Light arrays
  | Purple Banner
+
| Length
 +
|rowspan="2"| Array
 +
| VarInt
 +
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | 21
+
  | Block Light array
  | Blue Banner
+
  | Array of 2048 bytes
  |-
+
  | There is 1 array for each bit set to true in the block light mask, starting with the lowest value. Half a byte per light value.
  | 22
+
  |}
  | Brown Banner
+
 
|-
+
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.
| 23
+
 
| Green Banner
+
==== Join Game ====
|-
 
| 24
 
| Red Banner
 
|-
 
| 25
 
| Black Banner
 
|-
 
| 26
 
| Treasure marker
 
|}
 
  
==== Entity ====
+
See [[Protocol Encryption]] for information on logging in.
 
 
This packet may be used to initialize an entity.
 
 
 
For player entities, either this packet or any move/look packet is sent every game tick. So the meaning of this packet is basically that the entity did not move/look since the last such packet.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,809: Line 2,967:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x27
+
  |rowspan="9"| 0x26
  |rowspan="1"| Play
+
  |rowspan="9"| Play
  |rowspan="1"| Client
+
  |rowspan="9"| Client
 
  | Entity ID
 
  | Entity ID
  | VarInt
+
  | Int
  |  
+
  | The player's Entity ID (EID)
|}
 
 
 
==== Entity Relative Move ====
 
 
 
This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks [[#Entity Teleport|Entity Teleport]] should be sent instead.
 
 
 
This packet allows at most 8 blocks movement in any direction, because short range is from -32768 to 32767. And <code>32768 / (128 * 32)</code> = 8.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| 0x28
+
  | Gamemode
|rowspan="5"| Play
+
  | Unsigned Byte
|rowspan="5"| Client
+
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. Bit 3 (0x8) is the hardcore flag.
| Entity ID
 
  | VarInt
 
  |  
 
 
  |-
 
  |-
  | Delta X
+
  | Dimension
  | Short
+
  | Int Enum
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
  | -1: Nether, 0: Overworld, 1: End; also, note that this is not a VarInt but instead a regular int.
 +
|-
 +
| Hashed seed
 +
| Long
 +
| First 8 bytes of the SHA-256 hash of the world's seed.
 +
|-
 +
| Max Players
 +
| Unsigned Byte
 +
| Was once used by the client to draw the player list, but now is ignored
 +
|-
 +
| Level Type
 +
| String Enum (16)
 +
| default, flat, largeBiomes, amplified, customized, buffet, default_1_1
 
  |-
 
  |-
  | Delta Y
+
  | View Distance
  | Short
+
  | VarInt
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
+
  | Render distance (2-32)
 
  |-
 
  |-
  | Delta Z
+
  | Reduced Debug Info
  | Short
+
  | Boolean
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
+
  | If true, a Notchian client shows reduced information on the {{Minecraft Wiki|debug screen}}.  For servers in development, this should almost always be false.
 
  |-
 
  |-
  | On Ground
+
  | Enable respawn screen
 
  | Boolean
 
  | Boolean
  |  
+
  | Set to false when the doImmediateRespawn gamerule is true
 
  |}
 
  |}
  
==== Entity Look And Relative Move ====
+
==== Map Data ====
  
This packet is sent by the server when an entity rotates and moves. Since a short range is limited from -32768 to 32767, and movement is offset of fixed-point numbers, this packet allows at most 8 blocks movement in any direction. (<code>-32768 / (32 * 128) == -8</code>)
+
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,863: Line 3,015:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x29
+
  |rowspan="17"| 0x27
  |rowspan="7"| Play
+
  |rowspan="17"| Play
  |rowspan="7"| Client
+
  |rowspan="17"| Client
  | Entity ID
+
  |colspan="2"| Map ID
  | VarInt
+
  |colspan="2"| VarInt
  |  
+
  | Map ID of the map being modified
 
  |-
 
  |-
  | Delta X
+
  |colspan="2"| Scale
  | Short
+
  |colspan="2"| Byte
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
  | From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
 +
|-
 +
|colspan="2"| Tracking Position
 +
|colspan="2"| Boolean
 +
| Specifies whether player and item frame icons are shown
 
  |-
 
  |-
  | Delta Y
+
  |colspan="2"| Locked
  | Short
+
  |colspan="2"| Boolean
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
+
  | True if the map has been locked in a cartography table
 +
|-
 +
|colspan="2"| Icon Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="6"| Icon
 +
| Type
 +
|rowspan="6"| Array
 +
| VarInt enum
 +
| See below
 
  |-
 
  |-
  | Delta Z
+
  | X
  | Short
+
  | Byte
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
+
  | Map coordinates: -128 for furthest left, +127 for furthest right
 
  |-
 
  |-
  | Yaw
+
  | Z
  | Angle
+
  | Byte
  | New angle, not a delta
+
  | Map coordinates: -128 for highest, +127 for lowest
 
  |-
 
  |-
  | Pitch
+
  | Direction
  | Angle
+
  | Byte
  | New angle, not a delta
+
  | 0-15
 
  |-
 
  |-
  | On Ground
+
  | Has Display Name
 
  | Boolean
 
  | Boolean
  |  
+
  |
|}
 
 
 
==== Entity Look ====
 
 
 
This packet is sent by the server when an entity rotates.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x2A
+
  | Display Name
  |rowspan="4"| Play
+
| Optional [[Chat]]
  |rowspan="4"| Client
+
| Only present if previous Boolean is true
  | Entity ID
+
|-
  | VarInt
+
|colspan="2"| Columns
  |  
+
  |colspan="2"| Unsigned Byte
 +
| Number of columns updated
 +
  |-
 +
|colspan="2"| Rows
 +
  |colspan="2"| Optional Byte
 +
| Only if Columns is more than 0; number of rows updated
 +
  |-
 +
|colspan="2"| X
 +
|colspan="2"| Optional Byte
 +
  | Only if Columns is more than 0; x offset of the westernmost column
 
  |-
 
  |-
  | Yaw
+
  |colspan="2"| Z
  | Angle
+
  |colspan="2"| Optional Byte
  | New angle, not a delta
+
  | Only if Columns is more than 0; z offset of the northernmost row
 
  |-
 
  |-
  | Pitch
+
  |colspan="2"| Length
  | Angle
+
  |colspan="2"| Optional VarInt
  | New angle, not a delta
+
  | Only if Columns is more than 0; length of the following array
 
  |-
 
  |-
  | On Ground
+
  |colspan="2"| Data
  | Boolean
+
  |colspan="2"| Optional Array of Unsigned Byte
  |  
+
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
 
  |}
 
  |}
  
==== Vehicle Move (clientbound) ====
+
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
  
Note that all fields use absolute positioning and do not allow for relative positioning.
+
Types are based off of rows and columns in <code>map_icons.png</code>:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| 0x2B
+
  ! Icon type
  |rowspan="5"| Play
+
  ! Result
|rowspan="5"| Client
 
| X
 
| Double
 
| Absolute position (X coordinate)
 
 
  |-
 
  |-
  | Y
+
  | 0
  | Double
+
  | White arrow (players)
| Absolute position (Y coordinate)
 
 
  |-
 
  |-
  | Z
+
  | 1
  | Double
+
  | Green arrow (item frames)
| Absolute position (Z coordinate)
 
 
  |-
 
  |-
  | Yaw
+
  | 2
  | Float
+
  | Red arrow
| Absolute rotation on the vertical axis, in degrees
 
 
  |-
 
  |-
  | Pitch
+
  | 3
  | Float
+
  | Blue arrow
| Absolute rotation on the horizontal axis, in degrees
 
|}
 
 
 
==== Open Sign Editor ====
 
 
 
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].  There must already be a sign at the given location (which the client does not do automatically) - send a [[#Block Change|Block Change]] first.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x2C
+
  | 4
|rowspan="1"| Play
+
  | White cross
|rowspan="1"| Client
 
| Location
 
| Position
 
  |  
 
|}
 
 
 
==== Craft Recipe Response ====
 
 
 
Response to the serverbound packet ([[#Craft Recipe Request|Craft Recipe Request]]), with the same recipe ID.  Appears to be used to notify the UI.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x2D
+
  | 5
|rowspan="2"| Play
+
  | Red pointer
|rowspan="2"| Client
 
| Window ID
 
| Byte
 
  |
 
 
  |-
 
  |-
  | Recipe
+
  | 6
  | Identifier
+
  | White circle (off-map players)
| A recipe ID
 
|}
 
 
 
==== Player Abilities (clientbound) ====
 
 
 
The latter 2 floats are used to indicate the field of view and flying speed respectively, while the first byte is used to determine the value of 4 booleans.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x2E
+
  | 7
|rowspan="3"| Play
+
  | Small white circle (far-off-map players)
|rowspan="3"| Client
 
| Flags
 
| Byte
 
  | Bit field, see below
 
 
  |-
 
  |-
  | Flying Speed
+
  | 8
  | Float
+
  | Mansion
| 0.05 by default
 
 
  |-
 
  |-
  | Field of View Modifier
+
  | 9
  | Float
+
  | Temple
| Modifies the field of view, like a speed potion. A Notchian server will use the same value as the movement speed sent in the [[Protocol#Entity_Properties|Entity Properties]] packet, which defaults to 0.1 for players.
 
|}
 
 
 
About the flags:
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Field
+
  | 10
  ! Bit
+
  | White Banner
 
  |-
 
  |-
  | Invulnerable
+
  | 11
  | 0x01
+
  | Orange Banner
 
  |-
 
  |-
  | Flying
+
  | 12
  | 0x02
+
  | Magenta Banner
 +
|-
 +
| 13
 +
| Light Blue Banner
 +
|-
 +
| 14
 +
| Yellow Banner
 +
|-
 +
| 15
 +
| Lime Banner
 +
|-
 +
| 16
 +
| Pink Banner
 +
|-
 +
| 17
 +
| Gray Banner
 +
|-
 +
| 18
 +
| Light Gray Banner
 +
|-
 +
| 19
 +
| Cyan Banner
 +
|-
 +
| 20
 +
| Purple Banner
 +
|-
 +
| 21
 +
| Blue Banner
 +
|-
 +
| 22
 +
| Brown Banner
 +
|-
 +
| 23
 +
| Green Banner
 +
|-
 +
| 24
 +
| Red Banner
 
  |-
 
  |-
  | Allow Flying
+
  | 25
  | 0x04
+
  | Black Banner
 
  |-
 
  |-
  | Creative Mode (Instant Break)
+
  | 26
  | 0x08
+
  | Treasure marker
 
  |}
 
  |}
  
==== Combat Event ====
+
==== Trade List ====
 +
 
 +
The list of trades a villager NPC is offering.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,066: Line 3,193:
 
  ! Bound To
 
  ! Bound To
 
  !colspan="2"| Field Name
 
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x2F
+
  |rowspan="18"| 0x28
  |rowspan="8"| Play
+
  |rowspan="18"| Play
  |rowspan="8"| Client
+
  |rowspan="18"| Client
|colspan="2"| Event
 
| VarInt Enum
 
| Determines the layout of the remaining packet
 
 
  |-
 
  |-
  ! Event
+
  | colspan="2" | Window ID
  ! Field Name
+
  | colspan="2" | VarInt
  !
+
  | The ID of the window that is open; this is an int rather than a byte.
!
 
 
  |-
 
  |-
  | 0: enter combat
+
  | colspan="2" | Size
  | ''no fields''
+
  | colspan="2" | Byte
| ''no fields''
+
  | The number of trades in the following array
  |  
 
 
  |-
 
  |-
  |rowspan="2"| 1: end combat
+
  | rowspan="11" | Trades
  | Duration
+
| Input item 1
  | VarInt
+
  | rowspan="11" | Array
  |  
+
  | [[Slot]]
 +
  | The first item the villager is buying
 
  |-
 
  |-
  | Entity ID
+
  | Output item
  | Int
+
  | [[Slot]]
  |  
+
  | The item the villager is selling
 
  |-
 
  |-
  |rowspan="3"| 2: entity dead
+
  | Has second item
| Player ID
+
  | Boolean
  | VarInt
+
  | Whether there is a second item
  |  
 
 
  |-
 
  |-
  | Entity ID
+
  | Input item 2
  | Int
+
  | Optional [[Slot]]
  |  
+
  | The second item the villager is buying; only present if they have a second item.
 
  |-
 
  |-
  | Message
+
  | Trade disabled
  | [[Chat]]
+
  | Boolean
  |  
+
  | True if the trade is disabled; false if the trade is enabled.
|}
 
 
 
==== Player Info ====
 
 
 
Sent by the server to update the user list (<tab> in the client).
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="4"| Field Name
 
!colspan="3"| Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="19"| 0x30
+
  | Number of trade uses
  |rowspan="19"| Play
+
  | Integer
  |rowspan="19"| Client
+
  | Number of times the trade has been used so far
|colspan="4"| Action
 
|colspan="3"| VarInt
 
| Determines the rest of the Player format after the UUID
 
 
  |-
 
  |-
  |colspan="4"| Number Of Players
+
  | Maximum number of trade uses
  |colspan="3"| VarInt
+
  | Integer
  | Number of elements in the following array
+
  | Number of times this trade can be used
 
  |-
 
  |-
  |rowspan="17"| Player
+
  | XP
|colspan="3"| UUID
+
  | Integer
  |rowspan="17"| Array
+
  |
|colspan="2"| UUID
 
  |  
 
 
  |-
 
  |-
  ! Action
+
  | Special Price
  !colspan="2"| Field Name
+
  | Integer
  !colspan="2"|  
+
  |
!
 
 
  |-
 
  |-
  |rowspan="10"| 0: add player
+
  | Price Multiplier
|colspan="2"| Name
+
  | Float
  |colspan="2"| String (16)
+
  |
  |  
 
 
  |-
 
  |-
  |colspan="2"| Number Of Properties
+
  | Demand
|colspan="2"| VarInt
+
  | Integer
| Number of elements in the following array
+
  |
|-
 
|rowspan="4"| Property
 
| Name
 
|rowspan="4"| Array
 
| String (32767)
 
|
 
|-
 
| Value
 
| String (32767)
 
|
 
|-
 
| Is Signed
 
  | Boolean
 
  |  
 
 
  |-
 
  |-
| Signature
+
  |colspan="2"| Villager level
| Optional String (32767)
 
| Only if Is Signed is true
 
|-
 
  |colspan="2"| Gamemode
 
 
  |colspan="2"| VarInt
 
  |colspan="2"| VarInt
  |  
+
  | Appears on the trade GUI; meaning comes from the translation key <code>merchant.level.</code> + level.
 +
1: Novice, 2: Apprentice, 3: Journeyman, 4: Expert, 5: Master
 
  |-
 
  |-
  |colspan="2"| Ping
+
  |colspan="2"| Experience
 
  |colspan="2"| VarInt
 
  |colspan="2"| VarInt
  | Measured in milliseconds
+
  | Total experience for this villager (always 0 for the wandering trader)
 
  |-
 
  |-
  |colspan="2"| Has Display Name
+
  |colspan="2"| Is regular villager
 
  |colspan="2"| Boolean
 
  |colspan="2"| Boolean
  |  
+
  | True if this is a regular villager; false for the wandering trader.  When false, hides the villager level and some other GUI elements.
 
  |-
 
  |-
  |colspan="2"| Display Name
+
  |colspan="2"| Can restock
|colspan="2"| Optional [[Chat]]
+
  |colspan="2"| Boolean
| Only if Has Display Name is true
+
  | True for regular villagers and false for the wandering trader. If true, the "Villagers restock up to two times per day." message is displayed when hovering over disabled trades.
|-
 
| 1: update gamemode
 
|colspan="2"| Gamemode
 
|colspan="2"| VarInt
 
|
 
|-
 
| 2: update latency
 
|colspan="2"| Ping
 
|colspan="2"| VarInt
 
| Measured in milliseconds
 
|-
 
|rowspan="2"| 3: update display name
 
|colspan="2"| Has Display Name
 
  |colspan="2"| Boolean
 
  |  
 
  |-
 
|colspan="2"| Display Name
 
|colspan="2"| Optional [[Chat]]
 
| Only send if Has Display Name is true
 
|-
 
| 4: remove player
 
|colspan="2"| ''no fields''
 
|colspan="2"| ''no fields''
 
|
 
 
  |}
 
  |}
  
The Property field looks as in the response of [[Mojang API#UUID -> Profile + Skin/Cape]], except of course using the protocol format instead of JSON. That is, each player will usually have one property with Name “textures” and Value being a base64-encoded JSON string as documented at [[Mojang API#UUID -> Profile + Skin/Cape]]. An empty properties array is also acceptable, and will cause clients to display the player with one of the two default skins depending on UUID.
+
[[File:1.14-merchant-slots.png|thumb|The merchant UI, for reference]]
 +
{{-}}
  
Ping values correspond with icons in the following way:
+
==== Entity Position ====
* 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.
 
  
==== Face Player ====
+
This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks [[#Entity Teleport|Entity Teleport]] should be sent instead.
  
Used to rotate the client player to face the given location or entity (for <code>/teleport [<targets>] <x> <y> <z> facing</code>).
+
This packet allows at most 8 blocks movement in any direction, because short range is from -32768 to 32767. And <code>32768 / (128 * 32)</code> = 8.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,233: Line 3,289:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x31
+
  |rowspan="5"| 0x29
  |rowspan="8"| Play
+
  |rowspan="5"| Play
  |rowspan="8"| Client
+
  |rowspan="5"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 
  |-
 
  |-
  | Feet/eyes
+
  | Delta X
  | VarInt enum
+
  | Short
  | Values are feet=0, eyes=1.  If set to eyes, aims using the head position; otherwise aims using the feet position.
+
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
 
  |-
 
  |-
  | Target x
+
  | Delta Y
  | Double
+
  | Short
  | x coordinate of the point to face towards
+
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
 
  |-
 
  |-
  | Target y
+
  | Delta Z
  | Double
+
  | Short
  | y coordinate of the point to face towards
+
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
 
  |-
 
  |-
  | Target z
+
  | On Ground
| Double
 
| z coordinate of the point to face towards
 
|-
 
| Is entity
 
 
  | Boolean
 
  | Boolean
  | If true, additional information about an entity is provided.
+
  |  
|-
 
| Entity ID
 
| Optional VarInt
 
| Only if is entity is true &mdash; the entity to face towards
 
|-
 
| Entity feet/eyes
 
| Optional VarInt enum
 
| Whether to look at the entity's eyes or feet.  Same values and meanings as before, just for the entity's head/feet.
 
 
  |}
 
  |}
  
If the entity given by entity ID cannot be found, this packet should be treated as if is entity was false.
+
==== Entity Position and Rotation ====
  
==== Player Position And Look (clientbound) ====
+
This packet is sent by the server when an entity rotates and moves. Since a short range is limited from -32768 to 32767, and movement is offset of fixed-point numbers, this packet allows at most 8 blocks movement in any direction. (<code>-32768 / (32 * 128) == -8</code>)
 
 
Updates the player's position on the server. This packet will also close the “Downloading Terrain” screen when joining/respawning.
 
 
 
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 meters, the client will be kicked for “You moved too quickly :( (Hacking?)”.
 
 
 
Also if the fixed-point number of X or Z is set greater than <code>3.2E7D</code> the client will be kicked for “Illegal position”.
 
 
 
Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0, -1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.
 
 
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,288: Line 3,325:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x32
+
  |rowspan="7"| 0x2A
 
  |rowspan="7"| Play
 
  |rowspan="7"| Play
 
  |rowspan="7"| Client
 
  |rowspan="7"| Client
  | X
+
  | Entity ID
  | Double
+
  | VarInt
  | Absolute or relative position, depending on Flags
+
  |  
 
  |-
 
  |-
  | Y
+
  | Delta X
  | Double
+
  | Short
  | Absolute or relative position, depending on Flags
+
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
 
  |-
 
  |-
  | Z
+
  | Delta Y
  | Double
+
| Short
  | Absolute or relative position, depending on Flags
+
| Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
 +
|-
 +
| Delta Z
 +
  | Short
 +
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
 
  |-
 
  |-
 
  | Yaw
 
  | Yaw
  | Float
+
  | Angle
  | Absolute or relative rotation on the X axis, in degrees
+
  | New angle, not a delta
 
  |-
 
  |-
 
  | Pitch
 
  | Pitch
  | Float
+
  | Angle
  | Absolute or relative rotation on the Y axis, in degrees
+
  | New angle, not a delta
 
  |-
 
  |-
  | Flags
+
  | On Ground
  | Byte
+
  | Boolean
  | Bit field, see below
+
  |  
|-
 
| Teleport ID
 
| VarInt
 
| Client should confirm this packet with [[#Teleport Confirm|Teleport Confirm]] containing the same Teleport ID
 
 
  |}
 
  |}
  
About the Flags field:
+
==== Entity Rotation ====
  
<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
+
This packet is sent by the server when an entity rotates.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Field
+
  |rowspan="4"| 0x2B
  ! Bit
+
  |rowspan="4"| Play
 +
|rowspan="4"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 
  |-
 
  |-
  | X
+
  | Yaw
  | 0x01
+
  | Angle
 +
| New angle, not a delta
 
  |-
 
  |-
  | Y
+
  | Pitch
  | 0x02
+
  | Angle
 +
| New angle, not a delta
 
  |-
 
  |-
  | Z
+
  | On Ground
  | 0x04
+
  | Boolean
  |-
+
  |  
| Y_ROT
 
| 0x08
 
|-
 
| X_ROT
 
| 0x10
 
 
  |}
 
  |}
  
==== Use Bed ====  
+
==== Entity Movement ====
  
This packet tells that a player goes to bed.
+
This packet may be used to initialize an entity.
  
The client with the matching Entity ID will go into bed mode.
+
For player entities, either this packet or any move/look packet is sent every game tick. So the meaning of this packet is basically that the entity did not move/look since the last such packet.
 
 
This Packet is sent to all nearby players including the one sent to bed.
 
 
 
Any packets sent with a location not currently occupied by a bed will be ignored by clients.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,363: Line 3,403:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x33
+
  |rowspan="1"| 0x2C
  |rowspan="2"| Play
+
  |rowspan="1"| Play
  |rowspan="2"| Client
+
  |rowspan="1"| Client
 
  | Entity ID
 
  | Entity ID
 
  | VarInt
 
  | VarInt
  | Sleeping player's EID
+
  |  
|-
 
| Location
 
| Position
 
| Block location of the head part of the bed
 
 
  |}
 
  |}
  
==== Unlock Recipes ====
+
==== Vehicle Move (clientbound) ====
 +
 
 +
Note that all fields use absolute positioning and do not allow for relative positioning.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,385: Line 3,423:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="10"| 0x34
+
  |rowspan="5"| 0x2D
  |rowspan="10"| Play
+
  |rowspan="5"| Play
  |rowspan="10"| Client
+
  |rowspan="5"| Client
 +
| X
 +
| Double
 +
| Absolute position (X coordinate)
 
  |-
 
  |-
  | Action
+
  | Y
  | VarInt
+
  | Double
  | 0: init, 1: add, 2: remove
+
  | Absolute position (Y coordinate)
 
  |-
 
  |-
  | Crafting Recipe Book Open
+
  | Z
  | Boolean
+
  | Double
  | If true, then the crafting recipe book will be open when the player opens its inventory.
+
  | Absolute position (Z coordinate)
 
  |-
 
  |-
  | Crafting Recipe Book Filter Active
+
  | Yaw
  | Boolean
+
  | Float
  | If true, then the filtering option is active when the players opens its inventory.
+
  | Absolute rotation on the vertical axis, in degrees
 
  |-
 
  |-
  | Smelting Recipe Book Open
+
  | Pitch
  | Boolean
+
  | Float
  | If true, then the smelting recipe book will be open when the player opens its inventory.
+
  | Absolute rotation on the horizontal axis, in degrees
|-
 
| Smelting Recipe Book Filter Active
 
| Boolean
 
| If true, then the filtering option is active when the players opens its inventory.
 
|-
 
| Array size 1
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Recipe IDs
 
| Array of Identifier
 
|
 
|-
 
| Array size 2
 
| Optional VarInt
 
| Number of elements in the following array, only present if mode is 0 (init)
 
|-
 
| Recipe IDs
 
| Optional Array of Identifier, only present if mode is 0 (init)
 
|
 
 
  |}
 
  |}
Action:
 
* 0 (init) = All the recipes in the list 2 will added to the recipe book. All the recipes in list 1 will be tagged as displayed, recipes that aren't tagged will be shown in the notification. VERIFY LIST ORDER?
 
* 1 (add) = All the recipes in the list are added and their icon will be shown in the notification.
 
* 2 (remove) = Remove all the recipes in the list. This allows them to re-displayed when they are readded.
 
  
==== Destroy Entities ====
+
==== Open Book ====
  
Sent by the server when a list of entities is to be destroyed on the client.
+
Sent when a player right clicks with a signed book. This tells the client to open the book GUI.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,442: Line 3,459:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x35
+
  |rowspan="1"| 0x2E
  |rowspan="2"| Play
+
  |rowspan="1"| Play
  |rowspan="2"| Client
+
  |rowspan="1"| Client
  | Count
+
  | Hand
  | VarInt
+
  | VarInt enum
  | Number of elements in the following array
+
  | 0: Main hand, 1: Off hand
|-
 
| Entity IDs
 
| Array of VarInt
 
| The list of entities of destroy
 
 
  |}
 
  |}
  
==== Remove Entity Effect ====
+
==== Open Window ====
 +
 
 +
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.  For horses, use [[#Open Horse Window|Open Horse Window]].
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,464: Line 3,479:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x36
+
  |rowspan="3"| 0x2F
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | Entity ID
+
  | Window ID
 +
| VarInt
 +
| A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
 +
|-
 +
| Window Type
 
  | VarInt
 
  | VarInt
 +
| The window type to use for display. Contained in the <code>minecraft:menu</code> regisry; see [[Inventory]] for the different values.
 +
|-
 +
| Window Title
 +
| [[Chat]]
 +
| The title of the window
 +
|}
 +
 +
==== Open Sign Editor ====
 +
 +
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].  There must already be a sign at the given location (which the client does not do automatically) - send a [[#Block Change|Block Change]] first.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x30
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Location
 +
| Position
 
  |  
 
  |  
|-
 
| Effect ID
 
| Byte
 
| See {{Minecraft Wiki|Status effect#List of effects|this table}}
 
 
  |}
 
  |}
  
==== Resource Pack Send ====  
+
==== Craft Recipe Response ====
 +
 
 +
Response to the serverbound packet ([[#Craft Recipe Request|Craft Recipe Request]]), with the same recipe ID.  Appears to be used to notify the UI.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,486: Line 3,527:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x37
+
  |rowspan="2"| 0x31
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
 
  |rowspan="2"| Client
 
  |rowspan="2"| Client
  | URL
+
  | Window ID
  | String (32767)
+
  | Byte
  | The URL to the resource pack.
+
  |
 
  |-
 
  |-
  | Hash
+
  | Recipe
  | String (40)
+
  | Identifier
  | A 40 character hexadecimal and lowercase [[wikipedia:SHA-1|SHA-1]] hash of the resource pack file. (must be lower case in order to work)<br />If it's not a 40 character hexadecimal string, the client will not use it for hash verification and likely waste bandwidth — but it will still treat it as a unique id
+
  | A recipe ID
 
  |}
 
  |}
  
==== Respawn ====
+
==== Player Abilities (clientbound) ====
  
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.
+
The latter 2 floats are used to indicate the field of view and flying speed respectively, while the first byte is used to determine the value of 4 booleans.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,510: Line 3,551:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x38
+
  |rowspan="3"| 0x32
  |rowspan="4"| Play
+
  |rowspan="3"| Play
  |rowspan="4"| Client
+
  |rowspan="3"| Client
  | Dimension
+
  | Flags
  | Int Enum
+
  | Byte
  | -1: The Nether, 0: The Overworld, 1: The End
+
  | Bit field, see below
 
  |-
 
  |-
  | Difficulty
+
  | Flying Speed
  | Unsigned Byte
+
  | Float
  | 0: Peaceful, 1: Easy, 2: Normal, 3: Hard
+
  | 0.05 by default
 
  |-
 
  |-
  | Gamemode
+
  | Field of View Modifier
  | Unsigned Byte
+
  | Float
  | 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
+
  | Modifies the field of view, like a speed potion. A Notchian server will use the same value as the movement speed sent in the [[Protocol#Entity_Properties|Entity Properties]] packet, which defaults to 0.1 for players.
|-
 
| Level Type
 
| String (16)
 
| Same as [[#Join Game|Join Game]]
 
 
  |}
 
  |}
  
{{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).
+
About the flags:
  
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.}}
+
{| class="wikitable"
 +
|-
 +
! Field
 +
! Bit
 +
|-
 +
| Invulnerable
 +
| 0x01
 +
|-
 +
| Flying
 +
| 0x02
 +
|-
 +
| Allow Flying
 +
| 0x04
 +
|-
 +
| Creative Mode (Instant Break)
 +
| 0x08
 +
|}
  
==== Entity Head Look ====
+
==== Combat Event ====
  
Changes the direction an entity's head is facing.
+
Originally used for metadata for twitch streaming circa 1.8. Now only used to display the game over screen (with enter combat and end combat completely ignored by the Notchain client)
 
 
While sending the Entity Look packet changes the vertical rotation of the head, sending this packet appears to be necessary to rotate the head horizontally.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,544: Line 3,595:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x39
+
  |rowspan="8"| 0x33
  |rowspan="2"| Play
+
  |rowspan="8"| Play
  |rowspan="2"| Client
+
|rowspan="8"| Client
 +
|colspan="2"| Event
 +
| VarInt Enum
 +
| Determines the layout of the remaining packet
 +
|-
 +
! Event
 +
! Field Name
 +
!
 +
!
 +
|-
 +
| 0: enter combat
 +
| ''no fields''
 +
| ''no fields''
 +
|
 +
|-
 +
  |rowspan="2"| 1: end combat
 +
| Duration
 +
| VarInt
 +
| Length of the combat in ticks.
 +
|-
 
  | Entity ID
 
  | Entity ID
 +
| Int
 +
| ID of the primary opponent of the ended combat, or -1 if there is no obvious primary opponent.
 +
|-
 +
|rowspan="3"| 2: entity dead
 +
| Player ID
 
  | VarInt
 
  | VarInt
  |  
+
  | Entity ID of the player that died (should match the client's entity ID).
 +
|-
 +
| Entity ID
 +
| Int
 +
| The killing entity's ID, or -1 if there is no obvious killer.
 
  |-
 
  |-
  | Head Yaw
+
  | Message
  | Angle
+
  | [[Chat]]
  | New angle, not a delta
+
  | The death message
 
  |}
 
  |}
  
==== Select Advancement Tab ====
+
==== Player Info ====
  
Sent by the server to indicate that the client should switch advancement tab. Sent either when the client switches tab in the GUI or when an advancement in another tab is made.
+
Sent by the server to update the user list (<tab> in the client).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,568: Line 3,647:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="4"| Field Name
  ! Field Type
+
  !colspan="3"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x3A
+
  |rowspan="19"| 0x34
  |rowspan="2"| Play
+
  |rowspan="19"| Play
  |rowspan="2"| Client
+
  |rowspan="19"| Client
  | Has id
+
  |colspan="4"| Action
  | Boolean
+
  |colspan="3"| VarInt
  | Indicates if the next field is present
+
  | Determines the rest of the Player format after the UUID
 
  |-
 
  |-
  | Optional Identifier
+
  |colspan="4"| Number Of Players
  | String (32767)
+
  |colspan="3"| VarInt
| See below
+
  | Number of elements in the following array
  |}
 
 
 
The Identifier can be one of the following:
 
 
 
{| class="wikitable"
 
! Optional Identifier
 
 
  |-
 
  |-
  | minecraft:story/root
+
  |rowspan="17"| Player
 +
|colspan="3"| UUID
 +
|rowspan="17"| Array
 +
|colspan="2"| UUID
 +
|
 
  |-
 
  |-
  | minecraft:nether/root
+
  ! Action
 +
!colspan="2"| Field Name
 +
!colspan="2"|
 +
!
 
  |-
 
  |-
  | minecraft:end/root
+
  |rowspan="10"| 0: add player
 +
|colspan="2"| Name
 +
|colspan="2"| String (16)
 +
|
 
  |-
 
  |-
  | minecraft:adventure/root
+
  |colspan="2"| Number Of Properties
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 
  |-
 
  |-
  | minecraft:husbandry/root
+
  |rowspan="4"| Property
|}
+
  | Name
 
+
  |rowspan="4"| Array
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
+
  | String (32767)
 
+
  |
==== World Border ====
 
 
 
{| class="wikitable"
 
  ! Packet ID
 
  ! State
 
! Bound To
 
!colspan="2"| Field Name
 
  ! Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="18"| 0x3B
+
  | Value
  |rowspan="18"| Play
+
| String (32767)
  |rowspan="18"| Client
+
  |  
  |colspan="2"| Action
+
  |-
  | VarInt Enum
+
  | Is Signed
  | Determines the format of the rest of the packet
+
  | Boolean
 +
  |  
 
  |-
 
  |-
  ! Action
+
  | Signature
  ! Field Name
+
  | Optional String (32767)
  !
+
  | Only if Is Signed is true
!
 
 
  |-
 
  |-
  | 0: set size
+
  |colspan="2"| Gamemode
  | Diameter
+
  |colspan="2"| VarInt
| Double
+
  |  
  | Length of a single side of the world border, in meters
 
 
  |-
 
  |-
  |rowspan="3"| 1: lerp size
+
  |colspan="2"| Ping
  | Old Diameter
+
  |colspan="2"| VarInt
| Double
+
  | Measured in milliseconds
  | Current length of a single side of the world border, in meters
 
 
  |-
 
  |-
  | New Diameter
+
  |colspan="2"| Has Display Name
  | Double
+
  |colspan="2"| Boolean
  | Target length of a single side of the world border, in meters
+
  |  
 
  |-
 
  |-
  | Speed
+
  |colspan="2"| Display Name
  | VarLong
+
  |colspan="2"| Optional [[Chat]]
  | Number of real-time ''milli''seconds until New Diameter is reached. It appears that Notchian server does not sync world border speed to game ticks, so it gets out of sync with server lag. If the world border is not moving, this is set to 0.
+
  | Only if Has Display Name is true
 
  |-
 
  |-
  |rowspan="2"| 2: set center
+
  | 1: update gamemode
  | X
+
|colspan="2"| Gamemode
| Double
+
  |colspan="2"| VarInt
 
  |  
 
  |  
 +
|-
 +
| 2: update latency
 +
|colspan="2"| Ping
 +
|colspan="2"| VarInt
 +
| Measured in milliseconds
 
  |-
 
  |-
  | Z
+
  |rowspan="2"| 3: update display name
  | Double
+
|colspan="2"| Has Display Name
 +
  |colspan="2"| Boolean
 
  |  
 
  |  
 
  |-
 
  |-
  |rowspan="8"| 3: initialize
+
  |colspan="2"| Display Name
  | X
+
|colspan="2"| Optional [[Chat]]
  | Double
+
| Only send if Has Display Name is true
 +
|-
 +
| 4: remove player
 +
  |colspan="2"| ''no fields''
 +
  |colspan="2"| ''no fields''
 
  |  
 
  |  
 +
|}
 +
 +
The Property field looks as in the response of [[Mojang API#UUID -> Profile + Skin/Cape]], except of course using the protocol format instead of JSON. That is, each player will usually have one property with Name “textures” and Value being a base64-encoded JSON string as documented at [[Mojang API#UUID -> Profile + Skin/Cape]]. An empty properties array is also acceptable, and will cause clients to display the player with one of the two default skins depending on UUID.
 +
 +
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.
 +
 +
==== Face Player ====
 +
 +
Used to rotate the client player to face the given location or entity (for <code>/teleport [<targets>] <x> <y> <z> facing</code>).
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="8"| 0x35
 +
|rowspan="8"| Play
 +
|rowspan="8"| Client
 
  |-
 
  |-
  | Z
+
  | Feet/eyes
  | Double
+
  | VarInt enum
  |  
+
  | Values are feet=0, eyes=1.  If set to eyes, aims using the head position; otherwise aims using the feet position.
 
  |-
 
  |-
  | Old Diameter
+
  | Target x
 
  | Double
 
  | Double
  | Current length of a single side of the world border, in meters
+
  | x coordinate of the point to face towards
 
  |-
 
  |-
  | New Diameter
+
  | Target y
 
  | Double
 
  | Double
  | Target length of a single side of the world border, in meters
+
  | y coordinate of the point to face towards
 
  |-
 
  |-
  | Speed
+
  | Target z
  | VarLong
+
  | Double
  | Number of real-time ''milli''seconds until New Diameter is reached. It appears that Notchian server does not sync world border speed to game ticks, so it gets out of sync with server lag. If the world border is not moving, this is set to 0.
+
  | z coordinate of the point to face towards
 
  |-
 
  |-
  | Portal Teleport Boundary
+
  | Is entity
  | VarInt
+
  | Boolean
  | Resulting coordinates from a portal teleport are limited to ±value. Usually 29999984.
+
  | If true, additional information about an entity is provided.
 
  |-
 
  |-
  | Warning Time
+
  | Entity ID
  | VarInt
+
  | Optional VarInt
  | In seconds as set by <code>/worldborder warning time</code>
+
  | Only if is entity is true &mdash; the entity to face towards
 
  |-
 
  |-
  | Warning Blocks
+
  | Entity feet/eyes
  | VarInt
+
  | Optional VarInt enum
  | In meters
+
  | Whether to look at the entity's eyes or feet. Same values and meanings as before, just for the entity's head/feet.
|-
 
|rowspan="1"| 4: set warning time
 
| Warning Time
 
  | VarInt
 
| In seconds as set by <code>/worldborder warning time</code>
 
|-
 
|rowspan="1"| 5: set warning blocks
 
| Warning Blocks
 
| VarInt
 
| In meters
 
 
  |}
 
  |}
  
The Notchian client determines how solid to display the warning by comparing to whichever is higher, the warning distance or whichever is lower, the distance from the current diameter to the target diameter or the place the border will be after warningTime seconds. In pseudocode:
+
If the entity given by entity ID cannot be found, this packet should be treated as if is entity was false.
  
<syntaxhighlight lang="java">
+
==== Player Position And Look (clientbound) ====
distance = max(min(resizeSpeed * 1000 * warningTime, abs(targetDiameter - currentDiameter)), warningDistance);
 
if (playerDistance < distance) {
 
    warning = 1.0 - playerDistance / distance;
 
} else {
 
    warning = 0.0;
 
}
 
</syntaxhighlight>
 
  
==== Camera ====
+
Updates the player's position on the server. This packet will also close the “Downloading Terrain” screen when joining/respawning.
  
Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.
+
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 meters, the client will be kicked for “You moved too quickly :( (Hacking?)”.
  
The player's camera will move with the entity and look where it is looking. The entity is often another player, but can be any type of entity.  The player is unable to move this entity (move packets will act as if they are coming from the other entity).
+
Also if the fixed-point number of X or Z is set greater than <code>3.2E7D</code> the client will be kicked for “Illegal position”.
  
If the given entity is not loaded by the player, this packet is ignored.  To return control to the player, send this packet with their entity ID.
+
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.
  
The Notchian server resets this (sends it back to the default entity) whenever the spectated entity is killed or the player sneaks, but only if they were spectating an entity. It also sends this packet whenever the player switches out of spectator mode (even if they weren't spectating an entity).
+
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 3,724: Line 3,818:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x3C
+
  |rowspan="7"| 0x36
  |rowspan="1"| Play
+
  |rowspan="7"| Play
  |rowspan="1"| Client
+
  |rowspan="7"| Client
  | Camera ID
+
  | X
 +
| Double
 +
| Absolute or relative position, depending on Flags
 +
|-
 +
| Y
 +
| Double