Difference between revisions of "Protocol"

From wiki.vg
Jump to navigation Jump to search
(1.12.2)
m (Add missing Optional type.)
(694 intermediate revisions by more than 100 users not shown)
Line 3: Line 3:
 
   |BACKGROUND = #99CCFF
 
   |BACKGROUND = #99CCFF
 
   |WIDTH = 100%
 
   |WIDTH = 100%
   |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.12.2, protocol 340]]). 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 '''Java Edition''' ([[Protocol version numbers|1.20.4, protocol 765]]). For the Java Edition pre-releases, see [[Pre-release protocol]]. For the incomplete Bedrock Edition docs, see [[Bedrock Protocol]]. For the old Pocket Edition, see [[Pocket Edition Protocol Documentation]].
 
}}
 
}}
  
 
This page presents a dissection of the current '''[https://minecraft.net/ Minecraft] protocol'''.
 
This page presents a dissection of the current '''[https://minecraft.net/ Minecraft] protocol'''.
  
If you're having trouble, check out the [[Protocol FAQ|FAQ]] or ask for help in the IRC channel [irc://irc.freenode.net/mcdevs #mcdevs on chat.freenode.net] ([http://wiki.vg/MCDevs More Information]).
+
If you're having trouble, check out the [[Protocol FAQ|FAQ]] or ask for help in the IRC channel [ircs://irc.libera.chat:6697 #mcdevs on irc.libera.chat] ([https://wiki.vg/MCDevs More Information]).
  
'''Note:''' While you may use the contents of this page without restriction to create servers, clients, bots, etc… you still need to provide attribution to #mcdevs if you copy any of the contents of this page for publication elsewhere.
+
'''Note:''' While you may use the contents of this page without restriction to create servers, clients, bots, etc; substantial reproductions of this page must be attributed IAW [https://creativecommons.org/licenses/by-sa/4.0/ CC BY-SA 4.0].
  
 
The changes between versions may be viewed at [[Protocol History]].
 
The changes between versions may be viewed at [[Protocol History]].
Line 46: Line 46:
 
  | The meter is Minecraft's base unit of length, equal to the length of a vertex of a solid block. The term “block” may be used to mean “meter” or “cubic meter”.
 
  | The meter is Minecraft's base unit of length, equal to the length of a vertex of a solid block. The term “block” may be used to mean “meter” or “cubic meter”.
 
  |-
 
  |-
  | Global palette
+
  | Registry
  | A table/dictionary/palette mapping nonnegative integers to block states. The block state IDs can be constructed from {{Minecraft Wiki|Data values|this table}} by multiplying what the Minecraft Wiki calls “block IDs” by 16 and adding the metadata/damage value (or in most programming languages <code>block_id &lt;&lt; 4 <nowiki>|</nowiki> metadata</code>).
+
  | A table describing static, gameplay-related objects of some kind, such as the types of entities, block states or biomes. The entries of a registry are typically associated with textual or numeric identifiers, or both.
 +
 
 +
Minecraft has a unified registry system used to implement most of the registries, including blocks, items, entities, biomes and dimensions. These "ordinary" registries associate entries with both namespaced textual identifiers (see [[#Identifier]]), and signed (positive) 32-bit numeric identifiers. There is also a registry of registries listing all of the registries in the registry system. Some other registries, most notably the [[Chunk Format#Block state registry|block state registry]], are however implemented in a more ad-hoc fashion.
 +
 
 +
Some registries, such as biomes and dimensions, can be customized at runtime by the server (see [[Registry Data]]), while others, such as blocks, items and entities, are hardcoded. The contents of the hardcoded registries can be extracted via the built-in [[Data Generators]] system.
 +
|-
 +
| Block state
 +
| Each block in Minecraft has 0 or more properties, which in turn may have any number of possible values. These represent, for example, the orientations of blocks, poweredness states of redstone components, and so on. Each of the possible permutations of property values for a block is a distinct block state. The block state registry assigns a numeric identifier to every block state of every block.
 +
 
 +
A current list of properties and state ID ranges is found on [https://pokechu22.github.io/Burger/1.20.4.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.
 
  |-
 
  |-
 
  | Notchian
 
  | Notchian
 
  | The official implementation of vanilla Minecraft as developed and released by Mojang.
 
  | The official implementation of vanilla Minecraft as developed and released by Mojang.
 +
|-
 +
| Sequence
 +
| The action number counter for local block changes, incremented by one when clicking a block with a hand, right clicking an item, or starting or finishing digging a block. Counter handles latency to avoid applying outdated block changes to the local world.  Also is used to revert ghost blocks created when placing blocks, using buckets, or breaking blocks.
 
  |}
 
  |}
  
 
== Packet format ==
 
== Packet format ==
 +
 +
Packets cannot be larger than 2<sup>21</sup> &minus; 1 or 2097151 bytes (the maximum that can be sent in a 3-byte {{Type|VarInt}}). Moreover, the length field must not be longer than 3 bytes, even if the encoded value is within the limit. Unnecessarily long encodings at 3 bytes or below are still allowed.  For compressed packets, this applies to the Packet Length field, i.e. the compressed length.
  
 
=== Without compression ===
 
=== Without compression ===
Line 63: Line 79:
 
  |-
 
  |-
 
  | Length
 
  | Length
  | VarInt
+
  | {{Type|VarInt}}
  | Length of packet data + length of the packet ID
+
  | Length of Packet ID + Data
 
  |-
 
  |-
 
  | Packet ID
 
  | Packet ID
  | VarInt
+
  | {{Type|VarInt}}
  |  
+
  |
 
  |-
 
  |-
 
  | Data
 
  | Data
  | Byte Array
+
  | {{Type|Byte Array}}
 
  | Depends on the connection state and packet ID, see the sections below
 
  | Depends on the connection state and packet ID, see the sections below
 
  |}
 
  |}
Line 77: Line 93:
 
=== With compression ===
 
=== With compression ===
  
Once a [[#Set Compression|Set Compression]] packet (with a non-negative threshold) is sent, [[wikipedia:Zlib|zlib]] compression is enabled for all following packets. The format of a packet changes slighty to include the size of the uncompressed packet.
+
Once a [[#Set Compression|Set Compression]] packet (with a non-negative threshold) is sent, [[wikipedia:Zlib|zlib]] compression is enabled for all following packets. The format of a packet changes slightly to include the size of the uncompressed packet.
  
 
{| class=wikitable
 
{| class=wikitable
Line 87: Line 103:
 
  | No
 
  | No
 
  | Packet Length
 
  | Packet Length
  | VarInt
+
  | {{Type|VarInt}}
  | Length of Data Length + compressed length of (Packet ID + Data)
+
  | Length of (Data Length) + Compressed length of (Packet ID + Data)
 
  |-
 
  |-
 
  | No
 
  | No
 
  | Data Length
 
  | Data Length
  | VarInt
+
  | {{Type|VarInt}}
 
  | Length of uncompressed (Packet ID + Data) or 0
 
  | Length of uncompressed (Packet ID + Data) or 0
 
  |-
 
  |-
  |rowspan="2"| Yes
+
  | rowspan="2"| Yes
 
  | Packet ID
 
  | Packet ID
  | Varint
+
  | {{Type|VarInt}}
 
  | zlib compressed packet ID (see the sections below)
 
  | zlib compressed packet ID (see the sections below)
 
  |-
 
  |-
 
  | Data
 
  | Data
  | Byte Array
+
  | {{Type|Byte Array}}
 
  | zlib compressed packet data (see the sections below)
 
  | zlib compressed packet data (see the sections below)
 
  |}
 
  |}
  
The length given by the Packet Length field is the number of bytes that remain in that packet, including the Data Length field.
+
For serverbound packets, the uncompressed length of (Packet ID + Data) must not be greater than 2<sup>23</sup> or 8388608 bytes. Not that a length equal to 2<sup>23</sup> is permitted, which differs from the compressed length limit. The Notchian client, on the other hand, has no limit for the uncompressed length of incoming compressed packets.
 +
 
 +
If the size of the buffer containing the packet data and ID (as a {{Type|VarInt}}) is smaller than the threshold specified in the packet [[#Set Compression|Set Compression]]. It will be sent as uncompressed. This is done by setting the data length as 0. (Comparable to sending a non-compressed format with an extra 0 between the length, and packet data).
  
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
+
If it's larger than or equal to the threshold, then it follows the regular compressed protocol format.
  
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.
+
The Notchian server (but not client) rejects compressed packets smaller than the threshold. Uncompressed packets exceeding the threshold, however, are accepted.
  
 
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 133: Line 151:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x00
+
  | rowspan="4"| 0x00
  |rowspan="4"| Handshaking
+
  | rowspan="4"| Handshaking
  |rowspan="4"| Server
+
  | rowspan="4"| Server
 
  | Protocol Version
 
  | Protocol Version
  | VarInt
+
  | {{Type|VarInt}}
  | See [[protocol version numbers]] (currently 340 in Minecraft 1.12.2)
+
  | See [[protocol version numbers]] (currently 765 in Minecraft 1.20.4).
 
  |-
 
  |-
 
  | Server Address
 
  | Server Address
  | String (255)
+
  | {{Type|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 simple redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide example.org as server address in addition to connecting to it.
  |-  
+
  |-
 
  | Server Port
 
  | Server Port
  | Unsigned Short
+
  | {{Type|Unsigned Short}}
  | Default is 25565. The Notchian server does not use this information.
+
  | Default is 25565. The Notchian server does not use this information.
 
  |-
 
  |-
 
  | Next State
 
  | Next State
  | VarInt Enum
+
  | {{Type|VarInt}} {{Type|Enum}}
  | 1 for [[#Status|status]], 2 for [[#Login|login]]
+
  | 1 for [[#Status|Status]], 2 for [[#Login|Login]].
 
  |}
 
  |}
  
 
==== Legacy Server List Ping ====
 
==== Legacy Server List Ping ====
  
{{Warning|This packet uses a nonstandard format. It is never length-prefixed, and the packet ID is an Unsigned Byte instead of a VarInt.}}
+
{{Warning|This packet uses a nonstandard format. It is never length-prefixed, and the packet ID is an {{Type|Unsigned Byte}} instead of a {{Type|VarInt}}.}}
  
 
While not technically part of the current protocol, legacy clients may send this packet to initiate [[Server List Ping]], and modern servers should handle it correctly.
 
While not technically part of the current protocol, legacy clients may send this packet to initiate [[Server List Ping]], and modern servers should handle it correctly.
 +
The format of this packet is a remnant of the pre-Netty age, before the switch to Netty in 1.7 brought the standard format that is recognized now. This packet merely exists to inform legacy clients that they can't join our modern server.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 171: Line 190:
 
  | Server
 
  | Server
 
  | Payload
 
  | Payload
  | Unsigned Byte
+
  | {{Type|Unsigned Byte}}
  | always 1 (<code>0x01</code>)
+
  | always 1 (<code>0x01</code>).
 
  |}
 
  |}
  
 
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 ====
+
==== Status Response ====
 
 
Sent by the server when a vehicle or other object is created.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 193: Line 211:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="12"| 0x00
+
  | rowspan="2"| 0x00
  |rowspan="12"| Play
+
  | rowspan="2"| Status
  |rowspan="12"| Client
+
  | rowspan="2"| Client
| Entity ID
 
| VarInt
 
| EID of the object
 
 
  |-
 
  |-
  | Object UUID
+
  | JSON Response
  | UUID
+
  | {{Type|String}} (32767)
  |  
+
| See [[Server List Ping#Status Response]]; as with all strings this is prefixed by its length as a {{Type|VarInt}}.
 +
  |}
 +
 
 +
==== Ping Response (status) ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Type
+
  | 0x01
  | Byte
+
  | Status
  | The type of object (see [[Entities#Objects]])
+
  | Client
  |-
+
  | Payload
  | X
+
  | {{Type|Long}}
| Double
+
  | Should be the same as sent by the client.
|
+
  |}
|-
+
 
| Y
+
=== Serverbound ===
  | Double
+
 
|
+
==== Status Request ====
|-
+
 
| Z
+
The status can only be requested once immediately after the handshake, before any ping. The server won't respond otherwise.
| 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 ====
 
 
 
Spawns one or more experience orbs.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 255: Line 252:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x01
+
  | 0x00
  |rowspan="5"| Play
+
| Status
  |rowspan="5"| Client
+
  | Server
| Entity ID
+
  | colspan="3"| ''no fields''
| VarInt
 
|
 
|-
 
| X
 
| Double
 
|
 
|-
 
| Y
 
| Double
 
|
 
|-
 
| Z
 
| Double
 
|
 
|-
 
| Count
 
| Short
 
| The amount of experience this orb will reward once collected
 
 
  |}
 
  |}
  
==== Spawn Global Entity ====
+
==== Ping Request (status) ====
 
 
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 291: Line 268:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x02
+
  | 0x01
|rowspan="5"| Play
+
  | Status
|rowspan="5"| Client
+
  | Server
  | Entity ID
+
  | Payload
  | VarInt
+
  | {{Type|Long}}
  | The EID of the thunderbolt
+
  | May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.
|-
 
  | Type
 
| Byte Enum
 
| The global entity type, currently always 1 for thunderbolt
 
  |-
 
| X
 
| Double
 
|
 
|-
 
| Y
 
| Double
 
|
 
|-
 
| Z
 
| Double
 
|
 
 
  |}
 
  |}
  
==== Spawn Mob ====
+
== Login ==
  
Sent by the server when a mob entity is spawned.
+
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]]
 +
# C→S: [[#Login Acknowledged|Login Acknowledged]]
 +
 
 +
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 ("cracked"/offline-mode) and integrated servers (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]]. The Notchian server uses UUID v3 for offline player UUIDs, with the namespace “OfflinePlayer” and the value as the player’s username. For example, Notch’s offline UUID would be derived from the string “OfflinePlayer:Notch”. This is not a requirement however, the UUID may be anything.
 +
 
 +
See [[Protocol Encryption]] for details.
 +
 
 +
=== Clientbound ===
 +
 
 +
==== Disconnect (login) ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 327: Line 308:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="13"| 0x03
+
  | 0x00
  |rowspan="13"| Play
+
| Login
  |rowspan="13"| Client
+
  | Client
  | Entity ID
+
| Reason
  | VarInt
+
  | {{Type|JSON Text Component}}
  |
+
  | The reason why the player was disconnected.
  |-
+
  |}
  | Entity UUID
+
 
  | UUID
+
==== Encryption Request ====
  |
+
 
 +
{| class="wikitable"
 +
! Packet ID
 +
  ! State
 +
  ! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | Type
+
  | rowspan="5"| 0x01
  | VarInt
+
| rowspan="5"| Login
  | The type of mob. See [[Entities#Mobs]]
+
| rowspan="5"| Client
 +
| Server ID
 +
  | {{Type|String}} (20)
 +
  | Appears to be empty.
 
  |-
 
  |-
  | X
+
  | Public Key Length
  | Double
+
  | {{Type|VarInt}}
  |  
+
  | Length of Public Key.
 
  |-
 
  |-
  | Y
+
  | Public Key
  | Double
+
  | {{Type|Byte Array}}
  |  
+
  | The server's public key, in bytes.
 
  |-
 
  |-
  | Z
+
  | Verify Token Length
  | Double
+
  | {{Type|VarInt}}
  |  
+
  | Length of Verify Token. Always 4 for Notchian servers.
 
  |-
 
  |-
  | Yaw
+
  | Verify Token
  | Angle
+
  | {{Type|Byte Array}}
|
+
  | A sequence of random bytes generated by the server.
|-
 
| 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 ====
+
See [[Protocol Encryption]] for details.
  
This packet shows location, name, and type of painting.
+
==== Login Success ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 391: Line 358:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x04
+
  | rowspan="7"| 0x02
  |rowspan="5"| Play
+
  | rowspan="7"| Login
  |rowspan="5"| Client
+
  | rowspan="7"| Client
  | Entity ID
+
  | colspan="2"| UUID
  | VarInt
+
| colspan="2"| {{Type|UUID}}
  |  
+
| colspan="2"|
 +
|-
 +
  | colspan="2"| Username
 +
| colspan="2"| {{Type|String}} (16)
 +
| colspan="2"|
 +
|-
 +
| colspan="2"| Number Of Properties
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| rowspan="4"| Property
 +
| Name
 +
  | rowspan="4"| {{Type|Array}}
 +
| {{Type|String}} (32767)
 +
| colspan="2"|
 
  |-
 
  |-
  | Entity UUID
+
  | Value
  | UUID
+
  | {{Type|String}} (32767)
  |  
+
  | colspan="1"|
 
  |-
 
  |-
  | Title
+
  | Is Signed
  | String (13)
+
  | {{Type|Boolean}}
  | Name of the painting. Max length 13
+
  | colspan="2"|
 
  |-
 
  |-
  | Location
+
  | Signature
  | Position
+
  | {{Type|Optional}} {{Type|String}} (32767)
  | Center coordinates (see below)
+
  | Only if Is Signed is true.
 +
|}
 +
 
 +
The properties included in this packet are the same as in [[#Player Info Update|Player Info Update]], for the current player.
 +
 
 +
==== Set Compression ====
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Direction
+
  | 0x03
  | Byte Enum
+
  | Login
  | Direction the painting faces (North = 2, South = 0, West = 1, East = 3)
+
  | Client
 +
| Threshold
 +
| {{Type|VarInt}}
 +
| Maximum size of a packet before it is compressed.
 
  |}
 
  |}
  
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.
+
==== Login Plugin Request ====
  
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):
+
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"
 
{| class="wikitable"
  ! Name
+
  ! Packet ID
  ! x
+
! State
  ! y
+
  ! Bound To
  ! width
+
  ! Field Name
  ! height
+
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | <code>Kebab</code>
+
  | rowspan="3"| 0x04
  | 0
+
  | rowspan="3"| Login
  | 0
+
  | rowspan="3"| Client
  | 16
+
  | Message ID
  | 16
+
| {{Type|VarInt}}
 +
  | Generated by the server - should be unique to the connection.
 
  |-
 
  |-
  | <code>Aztec</code>
+
  | Channel
  | 16
+
  | {{Type|Identifier}}
| 0
+
  | Name of the [[plugin channel]] used to send the data.
| 16
 
  | 16
 
 
  |-
 
  |-
  | <code>Alban</code>
+
  | Data
  | 32
+
  | {{Type|Byte Array}} (1048576)
  | 0
+
  | Any data, depending on the channel. The length of this array must be inferred from the packet length.
  | 16
+
  |}
  | 16
+
 
 +
In Notchian client, the maximum data length is 1048576 bytes.
 +
 
 +
=== Serverbound ===
 +
 
 +
==== Login Start ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>Aztec2</code>
+
  | rowspan="2"| 0x00
  | 48
+
| rowspan="2"| Login
  | 0
+
  | rowspan="2"| Server
  | 16
+
  | Name
  | 16
+
  | {{Type|String}} (16)
 +
  | Player's Username.
 
  |-
 
  |-
  | <code>Bomb</code>
+
  | Player UUID
  | 64
+
  | {{Type|UUID}}
  | 0
+
  | The {{Type|UUID}} of the player logging in. Unused by the Notchian server.
  | 16
+
  |}
  | 16
+
 
 +
==== Encryption Response ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
  ! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>Plant</code>
+
  | rowspan="4"| 0x01
  | 80
+
  | rowspan="4"| Login
  | 0
+
  | rowspan="4"| Server
  | 16
+
  | Shared Secret Length
  | 16
+
| {{Type|VarInt}}
 +
  | Length of Shared Secret.
 
  |-
 
  |-
  | <code>Wasteland</code>
+
  | Shared Secret
  | 96
+
  | {{Type|Byte Array}}
| 0
+
  | Shared Secret value, encrypted with the server's public key.
| 16
 
  | 16
 
 
  |-
 
  |-
  | <code>Pool</code>
+
  | Verify Token Length
  | 0
+
  | {{Type|VarInt}}
| 32
+
  | Length of Verify Token.
| 32
 
  | 16
 
 
  |-
 
  |-
  | <code>Courbet</code>
+
  | Verify Token
  | 32
+
  | {{Type|Byte Array}}
  | 32
+
  | Verify Token value, encrypted with the same public key as the shared secret.
  | 32
+
  |}
  | 16
+
 
 +
See [[Protocol Encryption]] for details.
 +
 
 +
==== Login Plugin Response ====
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>Sea</code>
+
  | rowspan="3"| 0x02
| 64
+
  | rowspan="3"| Login
  | 32
+
  | rowspan="3"| Server
| 32
+
  | Message ID
  | 16
+
  | {{Type|VarInt}}
|-
+
  | Should match ID from server.
  | <code>Sunset</code>
 
  | 96
 
| 32
 
| 32
 
  | 16
 
 
  |-
 
  |-
  | <code>Creebet</code>
+
| Successful
| 128
+
| {{Type|Boolean}}
| 32
+
  | <code>true</code> if the client understood the request, <code>false</code> otherwise. When <code>false</code>, no payload follows.
| 32
 
| 16
 
 
  |-
 
  |-
  | <code>Wanderer</code>
+
  | Data
  | 0
+
  | {{Type|Optional}} {{Type|Byte Array}} (1048576)
  | 64
+
  | Any data, depending on the channel. The length of this array must be inferred from the packet length.
  | 16
+
  |}
  | 32
+
 
 +
In Notchian server, the maximum data length is 1048576 bytes.
 +
 
 +
==== Login Acknowledged ====
 +
 
 +
Acknowledgement to the [[Protocol#Login_Success|Login Success]] packet sent by the server.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>Graham</code>
+
  | 0x03
  | 16
+
| Login
  | 64
+
| Server
  | 16
+
| colspan="3"| ''no fields''
  | 32
+
|}
 +
 
 +
This packet switches the connection state to [[#Configuration|configuration]].
 +
 
 +
== Configuration ==
 +
 
 +
=== Clientbound ===
 +
 
 +
==== Clientbound Plugin Message (configuration) ====
 +
 
 +
{{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 information on how it works on [https://web.archive.org/web/20220831140929/https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ Dinnerbone's blog]. More documentation about internal and popular registered channels are [[plugin channel|here]].
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | <code>Match</code>
+
  | rowspan="2"| 0x00
  | 0
+
  | rowspan="2"| Configuration
  | 128
+
  | rowspan="2"| Client
  | 32
+
  | Channel
  | 32
+
| {{Type|Identifier}}
 +
  | Name of the [[plugin channel]] used to send the data.
 
  |-
 
  |-
  | <code>Bust</code>
+
  | Data
  | 32
+
  | {{Type|Byte Array}} (1048576)
| 128
+
  | Any data. The length of this array must be inferred from the packet length.
  | 32
+
  |}
| 32
+
 
|-
+
In Notchian client, the maximum data length is 1048576 bytes.
| <code>Stage</code>
+
 
| 64
+
==== Disconnect (configuration) ====
| 128
 
| 32
 
| 32
 
|-
 
| <code>Void</code>
 
| 96
 
| 128
 
| 32
 
| 32
 
|-
 
| <code>SkullAndRoses</code>
 
| 128
 
| 128
 
| 32
 
| 32
 
|-
 
| <code>Wither</code>
 
| 160
 
| 128
 
| 32
 
| 32
 
|-
 
| <code>Fighters</code>
 
| 0
 
| 96
 
| 64
 
| 32
 
|-
 
| <code>Pointer</code>
 
| 0
 
| 192
 
| 64
 
| 64
 
|-
 
| <code>Pigscene</code>
 
| 64
 
| 192
 
| 64
 
| 64
 
|-
 
| <code>BurningSkull</code>
 
| 128
 
| 192
 
| 64
 
| 64
 
|-
 
| <code>Skeleton</code>
 
| 192
 
| 64
 
| 64
 
| 48
 
|-
 
| <code>DonkeyKong</code>
 
| 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 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 List Item|Player List Item]] packet that adds the player data for the client to use when spawning a player. If the Player List Item for the player spawned by this packet is not present when this packet arrives, Notchian clients will not spawn the player entity. The Player List Item 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 605: Line 598:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x05
+
  | 0x01
  |rowspan="8"| Play
+
  | Configuration
  |rowspan="8"| Client
+
  | Client
  | Entity ID
+
  | Reason
| VarInt
+
  | {{Type|Text Component}}
| Player's EID
+
  | The reason why the player was disconnected.
  |-
 
| Player UUID
 
| UUID
 
| See below for notes on {{Minecraft Wiki|Server.properties#online-mode|offline mode}} and NPCs
 
|-
 
| X
 
| Double
 
|
 
|-
 
| Y
 
| Double
 
|
 
|-
 
| Z
 
| 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.
+
==== Finish Configuration ====
  
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 to notify the client that the configuration process has finished. The client answers with [[#Acknowledge_Finish_Configuration|Acknowledge Finish Configuration]] whenever it is ready to continue.
  
For NPCs UUID v2 should be used. Note:
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x02
 +
| rowspan="1"| Configuration
 +
| rowspan="1"| Client
 +
| colspan="3"| ''no fields''
 +
|}
  
<+Grum> i will never confirm this as a feature you know that :)
+
This packet switches the connection state to [[#Play|play]].
  
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>.
+
==== Clientbound Keep Alive (configuration) ====
  
==== Animation (clientbound) ====
+
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same payload (see [[#Serverbound Keep Alive (configuration)|Serverbound Keep Alive]]). If the client does not respond to a Keep Alive packet within 15 seconds after it was sent, 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.
  
Sent whenever an entity should change animation.
+
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 663: Line 640:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x06
+
  | 0x03
  |rowspan="2"| Play
+
  | Configuration
  |rowspan="2"| Client
+
  | Client
  | Entity ID
+
  | Keep Alive ID
| VarInt
+
  | {{Type|Long}}
| Player ID
+
  |
  |-
 
| Animation
 
| Unsigned Byte
 
  | Animation ID (see below)
 
 
  |}
 
  |}
  
Animation can be one of the following values:
+
==== Ping (configuration) ====
 +
 
 +
Packet is not used by the Notchian server. When sent to the client, client responds with a [[#Pong (configuration)|Pong]] packet with the same id.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Animation
+
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  | 0x04
  | Swing main arm
+
  | Configuration
  |-
+
  | Client
  | 1
+
  | ID
  | Take damage
+
  | {{Type|Int}}
|-
+
  |
| 2
 
| Leave bed
 
|-
 
| 3
 
| Swing offhand
 
|-
 
| 4
 
| Critical effect
 
|-
 
| 5
 
  | Magic critical effect
 
 
  |}
 
  |}
  
==== Statistics ====
+
==== Registry Data ====
  
Sent as a response to [[#Client_Status|Client Status 0x04]] (id 1).
+
Represents certain registries that are sent from the server and are applied on the client.
  
 
{| 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="3"| 0x07
+
  | rowspan="1"| 0x05
  |rowspan="3"| Play
+
  | rowspan="1"| Configuration
  |rowspan="3"| Client
+
  | rowspan="1"| Client
  |colspan="2"| Count
+
  | Registry Codec
|colspan="2"| VarInt
+
  | {{Type|NBT}} (Compound)
| Number of elements in the following array
+
  | See [[Registry Data]].
|-
 
|rowspan="2"| Statistic
 
| Name
 
  |rowspan="2"| Array
 
| String (32767)
 
  | [https://gist.github.com/Alvin-LB/8d0d13db00b3c00fd0e822a562025eff https://gist.github.com/Alvin-LB/8d0d13db00b3c00fd0e822a562025eff]
 
|-
 
| Value
 
| VarInt
 
| The amount to set it to
 
 
  |}
 
  |}
  
==== Block Break Animation ====
+
==== Remove Resource Pack (configuration) ====
 
 
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.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 746: Line 698:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x08
+
  | rowspan="2"| 0x06
  |rowspan="3"| Play
+
  | rowspan="2"| Configuration
  |rowspan="3"| Client
+
  | rowspan="2"| Client
  | Entity ID
+
  | Has UUID
  | VarInt
+
  | {{Type|Boolean}}
  | Entity ID of the entity breaking the block
+
  | Whether a specific resource pack should be removed, or all of them.
 
  |-
 
  |-
  | Location
+
  | UUID
  | Position
+
  | {{Type|Optional}} {{Type|UUID}}
| Block Position
+
  | The {{Type|UUID}} of the resource pack to be removed. Only present if the previous field is true.
|-
 
| Destroy Stage
 
  | Byte
 
| 0–9 to set it, any other value to remove it
 
 
  |}
 
  |}
  
==== Update Block Entity ====
+
==== Add Resource Pack (configuration) ====
 
 
Sets tile entity associated with the block at the given location.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 774: Line 720:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x09
+
  | rowspan="6"| 0x07
  |rowspan="3"| Play
+
  | rowspan="6"| Configuration
  |rowspan="3"| Client
+
  | rowspan="6"| Client
  | Location
+
  | UUID
  | Position
+
  | {{Type|UUID}}
  |  
+
| The unique identifier of the resource pack.
 +
|-
 +
| URL
 +
| {{Type|String}} (32767)
 +
| The URL to the resource pack.
 +
|-
 +
| Hash
 +
| {{Type|String}} (40)
 +
| A 40 character hexadecimal, case-insensitive [[wikipedia:SHA-1|SHA-1]] hash of the resource pack file.<br />If it's not a 40 character hexadecimal string, the client will not use it for hash verification and likely waste bandwidth.
 +
|-
 +
| Forced
 +
| {{Type|Boolean}}
 +
  | The Notchian client will be forced to use the resource pack from the server. If they decline they will be kicked from the server.
 
  |-
 
  |-
  | Action
+
  | Has Prompt Message
  | Unsigned Byte
+
  | {{Type|Boolean}}
  | The type of update to perform, see below
+
  | Whether a custom message should be used on the resource pack prompt.
 
  |-
 
  |-
  | NBT Data
+
  | Prompt Message
  | [[NBT|NBT Tag]]
+
  | {{Type|Optional}} {{Type|Text Component}}
  | 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)
+
  | This is shown in the prompt making the client accept or decline the resource pack. Only present if the previous field is true.
 
  |}
 
  |}
  
''Action'' field:
+
==== Feature Flags ====
  
* '''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.)
+
Used to enable and disable features, generally experimental ones, on the client.
* '''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''': Set type of flower in flower pot
 
* '''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''': Set the color of 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.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 818: Line 760:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x0A
+
  | rowspan="2"| 0x08
  |rowspan="4"| Play
+
  | rowspan="2"| Configuration
  |rowspan="4"| Client
+
  | rowspan="2"| Client
  | Location
+
  | Total Features
  | Position
+
  | {{Type|VarInt}}
  | Block coordinates
+
  | Number of features that appear in the array below.
 
  |-
 
  |-
  | Action ID (Byte 1)
+
  | Feature Flags
  | Unsigned Byte
+
  | Array of {{Type|Identifier}}
| Varies depending on block — see [[Block Actions]]
+
  |
|-
 
| Action Param (Byte 2)
 
| Unsigned Byte
 
| Varies depending on block — see [[Block Actions]]
 
|-
 
| Block Type
 
| VarInt
 
  | The block type ID for the block, not including metadata/damage value.  This must match the block at the given coordinates.
 
 
  |}
 
  |}
  
==== Block Change ====
+
As of 1.20.4, the following feature flags are available:
  
Fired whenever a block is changed within the render distance.
+
* minecraft:vanilla - enables vanilla features</li>
 +
* minecraft:bundle - enables support for the bundle</li>
 +
* minecraft:trade_rebalance - enables support for the rebalanced villager trades</li>
 +
* minecraft:update_1_21 - enables support for 1.21 features</li>
  
{{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.}}
+
==== Update Tags (configuration) ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 848: Line 785:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0B
+
  | rowspan="3"| 0x09
  |rowspan="2"| Play
+
| rowspan="3"| Configuration
  |rowspan="2"| Client
+
| rowspan="3"| Client
  | Location
+
| colspan="2"| Length of the array
  | Position
+
  | colspan="2"| {{Type|VarInt}}
  | Block Coordinates
+
|
 +
|-
 +
  | rowspan="2"| Array of tags
 +
| Registry
 +
  | rowspan="2"| {{Type|Array}}
 +
  | {{Type|Identifier}}
 +
  | Registry identifier (Vanilla expects tags for the registries <code>minecraft:block</code>, <code>minecraft:item</code>, <code>minecraft:fluid</code>, <code>minecraft:entity_type</code>, and <code>minecraft:game_event</code>)
 
  |-
 
  |-
  | Block ID
+
  | Array of Tag
  | VarInt
+
  | (See below)
  | The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}} (When reading data: <code>type = id &gt;&gt; 4</code>, <code>meta = id & 15</code>, when writing data: <code>id = type &lt;&lt; 4 &#124; (meta &amp; 15)</code>)
+
  |
 
  |}
 
  |}
  
==== Boss Bar ====
+
Tag arrays look like:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID
+
  ! colspan="2"| Field Name
! State
+
  ! colspan="2"| Field Type
! Bound To
 
  !colspan="2"| Field Name
 
  ! Field Type
 
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="15"| 0x0C
+
  | colspan="2"| Length
|rowspan="15"| Play
+
  | colspan="2"| {{Type|VarInt}}
|rowspan="15"| Client
+
  | Number of elements in the following array
  |colspan="2"| UUID
 
| UUID
 
  | Unique ID for this bar
 
 
  |-
 
  |-
  |colspan="2"| Action
+
  | rowspan="3"| Tags
  | VarInt Enum
+
  | Tag name
  | Determines the layout of the remaining packet
+
| rowspan="3"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
  |
 
  |-
 
  |-
  ! Action
+
| Count
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array
 +
|-
 +
| Entries
 +
| {{Type|Array}} of {{Type|VarInt}}
 +
| Numeric IDs of the given type (block, item, etc.). This list replaces the previous list of IDs for the given tag. If some preexisting tags are left unmentioned, a warning is printed.
 +
|}
 +
 
 +
See {{Minecraft Wiki|Tag}} on the Minecraft Wiki for more information, including a list of vanilla tags.
 +
 
 +
=== Serverbound ===
 +
 
 +
==== Client Information (configuration) ====
 +
 
 +
Sent when the player connects, or when settings are changed.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 
  ! Field Name
 
  ! Field Name
  !  
+
  ! Field Type
  !  
+
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0: add
+
  | rowspan="8"| 0x00
  | Title
+
  | rowspan="8"| Configuration
  | [[Chat]]
+
  | rowspan="8"| Server
  |  
+
| Locale
 +
| {{Type|String}} (16)
 +
  | e.g. <code>en_GB</code>.
 
  |-
 
  |-
  | Health
+
  | View Distance
  | Float
+
  | {{Type|Byte}}
  | 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.
+
  | Client-side render distance, in chunks.
 
  |-
 
  |-
  | Color
+
  | Chat Mode
  | VarInt Enum
+
  | {{Type|VarInt}} {{Type|Enum}}
  | Color ID (see below)
+
  | 0: enabled, 1: commands only, 2: hidden.  See [[Chat#Client chat mode]] for more information.
 
  |-
 
  |-
  | Division
+
  | Chat Colors
  | VarInt Enum
+
  | {{Type|Boolean}}
  | Type of division (see below)
+
  | “Colors” multiplayer setting. Can the chat be colored?
 
  |-
 
  |-
  | Flags
+
  | Displayed Skin Parts
  | Unsigned Byte
+
  | {{Type|Unsigned Byte}}
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music)
+
  | Bit mask, see below.
 
  |-
 
  |-
  | 1: remove
+
  | Main Hand
  | ''no fields''
+
  | {{Type|VarInt}} {{Type|Enum}}
| ''no fields''
+
  | 0: Left, 1: Right.
  | Removes this boss bar
 
 
  |-
 
  |-
  | 2: update health
+
  | Enable text filtering
  | Health
+
  | {{Type|Boolean}}
| Float
+
  | Enables filtering of text on signs and written book titles. Currently always false (i.e. the filtering is disabled)
  | as above
 
 
  |-
 
  |-
  | 3: update title
+
  | Allow server listings
  | Title
+
| {{Type|Boolean}}
  | [[Chat]]
+
  | Servers usually list online players, this option should let you not show up in that list.
|
+
  |}
|-
+
 
|rowspan="2"| 4: update style
+
''Displayed Skin Parts'' flags:
  | Color
+
 
  | VarInt Enum
+
* Bit 0 (0x01): Cape enabled
  | Color ID (see below)
+
* Bit 1 (0x02): Jacket enabled
 +
* Bit 2 (0x04): Left Sleeve enabled
 +
* Bit 3 (0x08): Right Sleeve enabled
 +
* Bit 4 (0x10): Left Pants Leg enabled
 +
* Bit 5 (0x20): Right Pants Leg enabled
 +
* Bit 6 (0x40): Hat enabled
 +
 
 +
The most significant bit (bit 7, 0x80) appears to be unused.
 +
 
 +
==== Serverbound Plugin Message (configuration) ====
 +
 
 +
{{Main|Plugin channels}}
 +
 
 +
Mods and plugins can use this to send their data. Minecraft itself uses some [[plugin channel]]s. These internal channels are in the <code>minecraft</code> namespace.
 +
 
 +
More documentation on this: [https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 +
 
 +
Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | Dividers
+
  | rowspan="2"| 0x01
  | VarInt Enum
+
  | rowspan="2"| Configuration
  | as above
+
  | rowspan="2"| Server
|-
+
  | Channel
  | 5: update flags
+
  | {{Type|Identifier}}
  | Flags
+
  | Name of the [[plugin channel]] used to send the data.
| Unsigned Byte
 
  | as above
 
 
  |-
 
  |-
 +
| Data
 +
| {{Type|Byte Array}} (32767)
 +
| 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.
 
  |}
 
  |}
 +
 +
In Notchian server, the maximum data length is 32767 bytes.
 +
 +
==== Acknowledge Finish Configuration ====
 +
 +
Sent by the client to notify the server that the configuration process has finished. It is sent in response to the server's [[#Finish_Configuration|Finish Configuration]].
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Color
+
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  | rowspan="1"| 0x02
| Pink
+
  | rowspan="1"| Configuration
|-
+
  | rowspan="1"| Server
  | 1
+
  | colspan="3"| ''no fields''
| Blue
+
  |}
  |-
+
 
| 2
+
This packet switches the connection state to [[#Play|play]].
| Red
 
|-
 
  | 3
 
| Green
 
  |-
 
| 4
 
| Yellow
 
|-
 
| 5
 
| Purple
 
|-
 
| 6
 
| White
 
|}
 
  
{| class="wikitable"
+
==== Serverbound Keep Alive (configuration) ====
! ID
 
! Type of division
 
|-
 
| 0
 
| No division
 
|-
 
| 1
 
| 6 notches
 
|-
 
| 2
 
| 10 notches
 
|-
 
| 3
 
| 12 notches
 
|-
 
| 4
 
| 20 notches
 
|}
 
  
==== Server Difficulty ====
+
The server will frequently send out a keep-alive (see [[#Clientbound Keep Alive (configuration)|Clientbound Keep Alive]]), each containing a random ID. The client must respond with the same packet.
 
 
Changes the difficulty setting in the client's option menu
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,000: Line 961:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x0D
+
  | 0x03
  |rowspan="1"| Play
+
  | Configuration
  |rowspan="1"| Client
+
  | Server
  | Difficulty
+
  | Keep Alive ID
  | Unsigned Byte
+
  | {{Type|Long}}
  | 0: peaceful, 1: easy, 2: normal, 3: hard
+
  |
 
  |}
 
  |}
  
==== Tab-Complete (clientbound) ====
+
==== Pong (configuration) ====
  
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.
+
Response to the clientbound packet ([[#Ping (configuration)|Ping]]) with the same id.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,020: Line 981:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0E
+
  | 0x04
|rowspan="2"| Play
+
  | Configuration
|rowspan="2"| Client
+
  | Server
| Count
+
  | ID
  | VarInt
+
  | {{Type|Int}}
  | Number of elements in the following array
+
  | id is the same as the ping packet
  |-
 
  | Matches
 
| Array of String (32767)
 
  | One eligible command, note that each command is sent separately instead of in a single string, hence the need for Count
 
 
  |}
 
  |}
  
==== Chat Message (clientbound) ====  
+
==== Resource Pack Response (configuration) ====
 
 
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.
 
 
 
{{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,046: Line 999:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0F
+
  | rowspan="3" | 0x05
  |rowspan="2"| Play
+
  | rowspan="3" | Configuration
  |rowspan="2"| Client
+
  | rowspan="3" | Server
  | JSON Data
+
  |-
  | [[Chat]]
+
  | UUID
| Limited to 32767 bytes
+
| {{Type|UUID}}
 +
| The unique identifier of the resource pack received in the [[#Add_Resource_Pack_(configuration)|Add Resource Pack (configuration)]] request.
 
  |-
 
  |-
  | Position
+
  | Result
  | Byte
+
  | {{Type|VarInt}} {{Type|Enum}}
  | 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
+
  | Result ID (see below).
 
  |}
 
  |}
  
==== Multi Block Change ====
+
Result can be one of the following values:
 
 
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
+
  ! ID
  ! State
+
  ! Result
  ! Bound To
+
  |-
  !colspan="2"| Field Name
+
| 0
  !colspan="2"| Field Type
+
| Successfully downloaded
  ! Notes
+
  |-
 +
  | 1
 +
  | Declined
 
  |-
 
  |-
  |rowspan="6"| 0x10
+
  | 2
|rowspan="6"| Play
+
  | Failed to download
|rowspan="6"| Client
 
|colspan="2"| Chunk X
 
|colspan="2"| Int
 
  | Chunk X coordinate
 
 
  |-
 
  |-
  |colspan="2"| Chunk Z
+
  | 3
|colspan="2"| Int
+
  | Accepted
  | Chunk Z coordinate
 
 
  |-
 
  |-
  |colspan="2"| Record Count
+
  | 4
|colspan="2"| VarInt
+
  | Downloaded
  | Number of elements in the following array, i.e. the number of blocks affected
 
 
  |-
 
  |-
  |rowspan="3"| Record
+
  | 5
| Horizontal Position
+
  | Invalid URL
|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.
 
 
  |-
 
  |-
  | Y Coordinate
+
  | 6
  | Unsigned Byte
+
  | Failed to reload
| Y coordinate of the block
 
 
  |-
 
  |-
  | Block ID
+
  | 7
  | VarInt
+
  | Discarded
| The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}} (When reading data: <code>type = id &gt;&gt; 4</code>, <code>meta = id & 15</code>, when writing data: <code>id = type &lt;&lt; 4 &#124; (meta &amp; 15)</code>)
 
 
  |}
 
  |}
  
To decode the position into a world position:
+
== Play ==
 +
 
 +
=== Clientbound ===
  
<syntaxhighlight lang="java">
+
==== Bundle Delimiter ====
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
 
worldY = vertPos;
 
worldZ = (horizPos & 15) + (chunkZ * 16);
 
</syntaxhighlight>
 
  
==== Confirm Transaction (clientbound) ====
+
The delimiter for a bundle of packets. When received, the client should store every subsequent packet it receives, and wait until another delimiter is received. Once that happens, the client is guaranteed to process every packet in the bundle on the same tick, and the client should stop storing packets. For example, this is used to ensure [[#Spawn_Entity|Spawn Entity]] and [[#Set_Entity_Metadata|Set Entity Metadata]] happen on the same tick.
  
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.
+
The Notchian client doesn't allow more than 4096 packets in the same bundle.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,122: Line 1,061:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x11
+
  | 0x00
  |rowspan="3"| Play
+
| Play
  |rowspan="3"| Client
+
  | Client
| Window ID
+
  | colspan="3"| ''no fields''
| Byte
 
| The ID of the window that the action occurred in
 
|-
 
| Action Number
 
| Short
 
| 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.
 
|-
 
| Accepted
 
| Boolean
 
| Whether the action was accepted
 
 
  |}
 
  |}
  
==== Close Window (clientbound) ====
+
==== Spawn Entity ====
  
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.
+
Sent by the server when an entity (aside from [[#Spawn_Experience_Orb|Experince Orb]]) is created.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,150: Line 1,079:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x12
+
  | rowspan="13"| 0x01
  | Play
+
  | rowspan="13"| Play
  | Client
+
  | rowspan="13"| Client
  | Window ID
+
  | Entity ID
  | Unsigned Byte
+
  | {{Type|VarInt}}
  | This is the ID of the window that was closed. 0 for inventory.
+
| A unique integer ID mostly used in the protocol to identify the entity.
 +
  |-
 +
| Entity UUID
 +
| {{Type|UUID}}
 +
| A unique identifier that is mostly used in persistence and places where the uniqueness matters more.
 +
|-
 +
| Type
 +
| {{Type|VarInt}}
 +
| ID in the <code>minecraft:entity_type</code> registry (see "type" field in [[Entity metadata#Entities]]).
 +
|-
 +
| X
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Y
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Pitch
 +
| {{Type|Angle}}
 +
| To get the real pitch, you must divide this by (256.0F / 360.0F)
 +
|-
 +
| Yaw
 +
| {{Type|Angle}}
 +
| To get the real yaw, you must divide this by (256.0F / 360.0F)
 +
|-
 +
| Head Yaw
 +
| {{Type|Angle}}
 +
| Only used by living entities, where the head of the entity may differ from the general body rotation.
 +
|-
 +
| Data
 +
| {{Type|VarInt}}
 +
| Meaning dependent on the value of the Type field, see [[Object Data]] for details.
 +
|-
 +
| Velocity X
 +
| {{Type|Short}}
 +
| rowspan="3"| Same units as [[#Set Entity Velocity|Set Entity Velocity]].
 +
|-
 +
| Velocity Y
 +
| {{Type|Short}}
 +
|-
 +
| Velocity Z
 +
| {{Type|Short}}
 
  |}
 
  |}
  
==== Open Window ====
+
{{Warning2|The points listed below should be considered when this packet is used to spawn a player entity.}}
 +
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). The Notchian server uses <code>UUID.nameUUIDFromBytes</code>, implemented by OpenJDK [https://github.com/AdoptOpenJDK/openjdk-jdk8u/blob/9a91972c76ddda5c1ce28b50ca38cbd8a30b7a72/jdk/src/share/classes/java/util/UUID.java#L153-L175 here].
 +
 
 +
For NPCs UUID v2 should be used. Note:
 +
 
 +
<+Grum> i will never confirm this as a feature you know that :)
  
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.
+
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>.
 +
 
 +
==== Spawn Experience Orb ====
 +
 
 +
Spawns one or more experience orbs.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,170: Line 1,155:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x13
+
  | rowspan="5"| 0x02
  |rowspan="5"| Play
+
  | rowspan="5"| Play
  |rowspan="5"| Client
+
  | rowspan="5"| Client
  | Window ID
+
  | Entity ID
  | Unsigned Byte
+
  | {{Type|VarInt}}
  | A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
+
  |
 
  |-
 
  |-
  | Window Type
+
  | X
  | String (32)
+
  | {{Type|Double}}
  | The window type to use for display. See [[Inventory]] for a list.
+
  |
 
  |-
 
  |-
  | Window Title
+
  | Y
  | [[Chat]]
+
  | {{Type|Double}}
  | The title of the window
+
  |
 
  |-
 
  |-
  | Number Of Slots
+
  | Z
  | Unsigned Byte
+
  | {{Type|Double}}
  | 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).
+
  |
 
  |-
 
  |-
  | Entity ID
+
  | Count
  | Optional Int
+
  | {{Type|Short}}
  | EntityHorse's EID. Only sent when Window Type is “EntityHorse”
+
  | The amount of experience this orb will reward once collected.
 
  |}
 
  |}
  
See [[Inventory]] for further information.
+
==== Entity Animation ====
  
==== Window Items ====
+
Sent whenever an entity should change animation.
[[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"
 
{| class="wikitable"
Line 1,209: Line 1,191:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x14
+
  | rowspan="2"| 0x03
  |rowspan="3"| Play
+
  | rowspan="2"| Play
  |rowspan="3"| Client
+
  | rowspan="2"| Client
  | Window ID
+
  | Entity ID
  | Unsigned Byte
+
  | {{Type|VarInt}}
  | The ID of window which items are being sent for. 0 for player inventory.
+
  | Player ID.
 
  |-
 
  |-
  | Count
+
  | Animation
  | Short
+
  | {{Type|Unsigned Byte}}
| Number of elements in the following array
+
  | Animation ID (see below).
|-
 
| Slot Data
 
| Array of [[Slot Data|Slot]]
 
  |  
 
 
  |}
 
  |}
  
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
+
Animation can be one of the following values:
 
 
==== Window Property ====
 
 
 
This packet is used to inform the client that part of a GUI window should be updated.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Animation
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x15
+
  | 0
|rowspan="3"| Play
+
  | Swing main arm
|rowspan="3"| Client
 
| Window ID
 
| Unsigned Byte
 
  |  
 
 
  |-
 
  |-
  | Property
+
  | 2
  | Short
+
  | Leave bed
| The property to be updated, see below
 
 
  |-
 
  |-
  | Value
+
  | 3
  | Short
+
  | Swing offhand
  | The new value for the property, see below
+
  |-
 +
| 4
 +
| Critical effect
 +
|-
 +
| 5
 +
| Magic critical effect
 
  |}
 
  |}
  
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.
+
==== Award Statistics ====
 +
 
 +
Sent as a response to [[#Client Command|Client Command]] (id 1). Will only send the changed values if previously requested.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  ! Window type
+
  | rowspan="4"| 0x04
  ! Property
+
  | rowspan="4"| Play
  ! Value
+
  | rowspan="4"| Client
 +
| colspan="2"| Count
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 
  |-
 
  |-
  |rowspan="4"| Furnace
+
  | rowspan="3"| Statistic
  | 0: Fire icon (fuel left)
+
  | Category ID
  | counting from fuel burn time down to 0 (in-game ticks)
+
  | rowspan="3"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
| See below.
 
  |-
 
  |-
  | 1: Maximum fuel burn time
+
  | Statistic ID
  | fuel burn time or 0 (in-game ticks)
+
  | {{Type|VarInt}}
 +
| See below.
 
  |-
 
  |-
  | 2: Progress arrow
+
  | Value
  | counting from 0 to maximum progress (in-game ticks)
+
| {{Type|VarInt}}
 +
  | The amount to set it to.
 +
|}
 +
 
 +
Categories (these are namespaced, but with <code>:</code> replaced with <code>.</code>):
 +
 
 +
{| class="wikitable"
 +
! Name
 +
! ID
 +
! Registry
 
  |-
 
  |-
  | 3: Maximum progress
+
  | <code>minecraft.mined</code>
  | always 200 on the notchian server
+
  | 0
 +
| Blocks
 
  |-
 
  |-
  |rowspan="10"| Enchantment Table
+
  | <code>minecraft.crafted</code>
  | 0: Level requirement for top enchantment slot
+
  | 1
  |rowspan="3"| The enchantment's xp level requirement
+
  | Items
 
  |-
 
  |-
  | 1: Level requirement for middle enchantment slot
+
  | <code>minecraft.used</code>
 +
| 2
 +
| Items
 
  |-
 
  |-
  | 2: Level requirement for bottom enchantment slot
+
  | <code>minecraft.broken</code>
 +
| 3
 +
| Items
 
  |-
 
  |-
  | 3: The enchantment seed
+
  | <code>minecraft.picked_up</code>
| Used for drawing the enchantment names (in [[Wikipedia:Standard Galactic Alphabet|SGA]]) clientside.  The same seed ''is'' used to calculate enchantments, but some of the data isn't sent to the client to prevent easily guessing the entire list (the seed value here is the regular seed bitwise and <code>0xFFFFFFF0</code>).
+
| 4
 +
| Items
 
  |-
 
  |-
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
+
  | <code>minecraft.dropped</code>
  |rowspan="3"| The enchantment id (set to -1 to hide it)
+
  | 5
 +
| Items
 
  |-
 
  |-
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
+
  | <code>minecraft.killed</code>
 +
| 6
 +
| Entities
 +
|-
 +
| <code>minecraft.killed_by</code>
 +
| 7
 +
| Entities
 +
|-
 +
| <code>minecraft.custom</code>
 +
| 8
 +
| 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
 
  |-
 
  |-
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
+
  | <code>minecraft.leave_game</code>
 +
| 0
 +
| None
 
  |-
 
  |-
  | 7: Enchantment level shown on mouse hover over the top slot
+
  | <code>minecraft.play_one_minute</code>
  |rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
+
  | 1
 +
| Time
 
  |-
 
  |-
  | 8: Enchantment level shown on mouse hover over the middle slot
+
  | <code>minecraft.time_since_death</code>
 +
| 2
 +
| Time
 
  |-
 
  |-
  | 9: Enchantment level shown on mouse hover over the bottom slot
+
  | <code>minecraft.time_since_rest</code>
 +
| 3
 +
| Time
 
  |-
 
  |-
  |rowspan="3"| Beacon
+
  | <code>minecraft.sneak_time</code>
  | 0: Power level
+
  | 4
  | 0-4, controls what effect buttons are enabled
+
  | Time
 
  |-
 
  |-
  | 1: First potion effect
+
  | <code>minecraft.walk_one_cm</code>
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
+
  | 5
 +
| Distance
 
  |-
 
  |-
  | 2: Second potion effect
+
  | <code>minecraft.crouch_one_cm</code>
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
+
  | 6
 +
| Distance
 
  |-
 
  |-
  | Anvil
+
  | <code>minecraft.sprint_one_cm</code>
  | 0: Repair cost
+
  | 7
  | The repair's cost in xp levels
+
  | Distance
 
  |-
 
  |-
  |rowspan="2"| Brewing Stand
+
  | <code>minecraft.walk_on_water_one_cm</code>
  | 0: Brew time
+
  | 8
  | 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
+
  | Distance
 
  |-
 
  |-
  | 1: Fuel time
+
  | <code>minecraft.fall_one_cm</code>
  | 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
+
  | 9
  |}
+
  | Distance
 
+
|-
==== Set Slot ====
+
| <code>minecraft.climb_one_cm</code>
 
+
| 10
Sent by the server when an item in a slot (in a window) is added/removed.
+
| Distance
 
+
|-
{| class="wikitable"
+
| <code>minecraft.fly_one_cm</code>
  ! Packet ID
+
  | 11
  ! State
+
  | Distance
  ! Bound To
+
  |-
  ! Field Name
+
  | <code>minecraft.walk_under_water_one_cm</code>
  ! Field Type
+
  | 12
  ! Notes
+
  | Distance
 
  |-
 
  |-
  |rowspan="3"| 0x16
+
  | <code>minecraft.minecart_one_cm</code>
|rowspan="3"| Play
+
  | 13
|rowspan="3"| Client
+
  | Distance
  | 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
+
  | <code>minecraft.boat_one_cm</code>
  | Short
+
  | 14
  | The slot that should be updated
+
  | Distance
 
  |-
 
  |-
  | Slot Data
+
  | <code>minecraft.pig_one_cm</code>
| [[Slot Data|Slot]]
+
  | 15
  |  
+
  | Distance
  |}
 
 
 
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.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x17
+
  | <code>minecraft.horse_one_cm</code>
|rowspan="2"| Play
+
  | 16
|rowspan="2"| Client
+
  | Distance
  | Item ID
 
  | VarInt
 
| Numeric ID of the item to apply a cooldown to.
 
 
  |-
 
  |-
  | Cooldown Ticks
+
  | <code>minecraft.aviate_one_cm</code>
  | VarInt
+
  | 17
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
+
  | Distance
  |}
+
  |-
 
+
| <code>minecraft.swim_one_cm</code>
==== Plugin Message (clientbound) ====
+
| 18
 
+
  | Distance
{{Main|Plugin channels}}
+
  |-
 
+
  | <code>minecraft.strider_one_cm</code>
Mods and plugins can use this to send their data. Minecraft itself uses a number of [[plugin channel]]s. These internal channels are prefixed with <code>MC|</code>.
+
  | 19
 
+
  | Distance
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"| 0x18
+
  | <code>minecraft.jump</code>
|rowspan="2"| Play
+
  | 20
|rowspan="2"| Client
+
  | None
| Channel
 
  | String (20)
 
  | Name of the [[plugin channel]] used to send the data
 
 
  |-
 
  |-
  | Data
+
  | <code>minecraft.drop</code>
| Byte Array
+
  | 21
| Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
+
| None
  |}
 
 
 
==== 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"| 0x19
+
  | <code>minecraft.damage_dealt</code>
|rowspan="7"| Play
+
  | 22
|rowspan="7"| Client
+
  | Damage
| Sound Name
 
  | String (256)
 
  | All sound effect names as of 1.12.2 can be seen [http://pokechu22.github.io/Burger/1.12.2.html#sounds here].
 
 
  |-
 
  |-
  | Sound Category
+
  | <code>minecraft.damage_dealt_absorbed</code>
  | VarInt Enum
+
  | 23
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
  | Damage
 
  |-
 
  |-
  | Effect Position X
+
  | <code>minecraft.damage_dealt_resisted</code>
  | Int
+
  | 24
  | Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Damage
 
  |-
 
  |-
  | Effect Position Y
+
  | <code>minecraft.damage_taken</code>
  | Int
+
  | 25
  | Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Damage
 
  |-
 
  |-
  | Effect Position Z
+
  | <code>minecraft.damage_blocked_by_shield</code>
  | Int
+
  | 26
  | Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Damage
 
  |-
 
  |-
  | Volume
+
  | <code>minecraft.damage_absorbed</code>
  | Float
+
  | 27
  | 1 is 100%, can be more
+
  | Damage
 
  |-
 
  |-
  | Pitch
+
  | <code>minecraft.damage_resisted</code>
  | Float
+
  | 28
  | Float between 0.5 and 2.0 by Notchian clients
+
  | Damage
  |}
+
  |-
 
+
| <code>minecraft.deaths</code>
==== Disconnect (play) ====
+
| 29
 
+
| None
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.
+
|-
 
+
| <code>minecraft.mob_kills</code>
{| class="wikitable"
+
  | 30
  ! Packet ID
+
  | None
  ! State
+
  |-
  ! Bound To
+
  | <code>minecraft.animals_bred</code>
  ! Field Name
+
  | 31
  ! Field Type
+
  | None
  ! Notes
 
 
  |-
 
  |-
  | 0x1A
+
  | <code>minecraft.player_kills</code>
| Play
+
  | 32
| Client
+
  | None
| 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"| 0x1B
+
  | <code>minecraft.fish_caught</code>
|rowspan="2"| Play
+
  | 33
|rowspan="2"| Client
+
  | None
| Entity ID
 
  | Int
 
  |  
 
 
  |-
 
  |-
  | Entity Status
+
  | <code>minecraft.talked_to_villager</code>
| Byte Enum
+
  | 34
  | See below
+
  | None
  |}
 
 
 
See [[entities]] for a list of which statuses are valid for each type of entity.
 
 
 
==== 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"| 0x1C
+
  | <code>minecraft.traded_with_villager</code>
|rowspan="9"| Play
+
  | 35
|rowspan="9"| Client
+
  | None
| X
 
  | Float
 
  |  
 
 
  |-
 
  |-
  | Y
+
  | <code>minecraft.eat_cake_slice</code>
  | Float
+
  | 36
  |  
+
  | None
 
  |-
 
  |-
  | Z
+
  | <code>minecraft.fill_cauldron</code>
  | Float
+
  | 37
  |  
+
  | None
 
  |-
 
  |-
  | Radius
+
  | <code>minecraft.use_cauldron</code>
  | Float
+
  | 38
  | Currently unused in the client
+
  | None
 
  |-
 
  |-
  | Record Count
+
  | <code>minecraft.clean_armor</code>
  | Int
+
  | 39
  | Number of elements in the following array
+
  | None
 
  |-
 
  |-
  | Records
+
  | <code>minecraft.clean_banner</code>
  | Array of (Byte, Byte, Byte)
+
  | 40
  | Each record is 3 signed bytes long, each bytes are the XYZ (respectively) offsets of affected blocks.
+
  | None
 
  |-
 
  |-
  | Player Motion X
+
  | <code>minecraft.clean_shulker_box</code>
  | Float
+
  | 41
  | X velocity of the player being pushed by the explosion
+
  | None
 
  |-
 
  |-
  | Player Motion Y
+
  | <code>minecraft.interact_with_brewingstand</code>
  | Float
+
  | 42
  | Y velocity of the player being pushed by the explosion
+
  | None
 
  |-
 
  |-
  | Player Motion Z
+
  | <code>minecraft.interact_with_beacon</code>
| Float
+
  | 43
  | Z velocity of the player being pushed by the explosion
+
  | None
  |}
 
 
 
==== Unload Chunk ====
 
 
 
Tells the client to unload a chunk column.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x1D
+
  | <code>minecraft.inspect_dropper</code>
|rowspan="2"| Play
+
  | 44
|rowspan="2"| Client
+
  | None
| Chunk X
 
  | Int
 
  | Block coordinate divided by 16, rounded down
 
 
  |-
 
  |-
  | Chunk Z
+
  | <code>minecraft.inspect_hopper</code>
  | Int
+
  | 45
  | Block coordinate divided by 16, rounded down
+
  | None
 +
|-
 +
| <code>minecraft.inspect_dispenser</code>
 +
| 46
 +
| None
 +
|-
 +
| <code>minecraft.play_noteblock</code>
 +
| 47
 +
| None
 +
|-
 +
| <code>minecraft.tune_noteblock</code>
 +
| 48
 +
| None
 +
|-
 +
| <code>minecraft.pot_flower</code>
 +
| 49
 +
| None
 +
|-
 +
| <code>minecraft.trigger_trapped_chest</code>
 +
| 50
 +
| None
 +
|-
 +
| <code>minecraft.open_enderchest</code>
 +
| 51
 +
| None
 +
|-
 +
| <code>minecraft.enchant_item</code>
 +
| 52
 +
| None
 +
|-
 +
| <code>minecraft.play_record</code>
 +
| 53
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_furnace</code>
 +
| 54
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_crafting_table</code>
 +
| 55
 +
| None
 +
|-
 +
| <code>minecraft.open_chest</code>
 +
| 56
 +
| None
 +
|-
 +
| <code>minecraft.sleep_in_bed</code>
 +
| 57
 +
| None
 +
|-
 +
| <code>minecraft.open_shulker_box</code>
 +
| 58
 +
| None
 +
|-
 +
| <code>minecraft.open_barrel</code>
 +
| 59
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_blast_furnace</code>
 +
| 60
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_smoker</code>
 +
| 61
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_lectern</code>
 +
| 62
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_campfire</code>
 +
| 63
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_cartography_table</code>
 +
| 64
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_loom</code>
 +
| 65
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_stonecutter</code>
 +
| 66
 +
| None
 +
|-
 +
| <code>minecraft.bell_ring</code>
 +
| 67
 +
| None
 +
|-
 +
| <code>minecraft.raid_trigger</code>
 +
| 68
 +
| None
 +
|-
 +
| <code>minecraft.raid_win</code>
 +
| 69
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_anvil</code>
 +
| 70
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_grindstone</code>
 +
| 71
 +
| None
 +
|-
 +
| <code>minecraft.target_hit</code>
 +
| 72
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_smithing_table</code>
 +
| 73
 +
| None
 
  |}
 
  |}
  
It is legal to send this packet even if the given chunk is not currently loaded.
+
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
  
==== Change Game State ====
+
==== Acknowledge Block Change ====
  
Used for a wide variety of game state things, from whether to bed use to gamemode to demo messages.
+
Acknowledges a user-initiated block change. After receiving this packet, the client will display the block state sent by the server instead of the one predicted by the client.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,590: Line 1,628:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x1E
+
  | rowspan="1"| 0x05
  |rowspan="2"| Play
+
  | rowspan="1"| Play
  |rowspan="2"| Client
+
  | rowspan="1"| Client
  | Reason
+
  | Sequence ID
  | Unsigned Byte
+
  | {{Type|VarInt}}
| See below
+
  | Represents the sequence to acknowledge, this is used for properly syncing block changes to the client after interactions.
|-
 
| Value
 
| Float
 
  | Depends on Reason
 
 
  |}
 
  |}
  
''Reason codes'':
+
==== Set Block Destroy Stage ====
 +
 
 +
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"
 
{| class="wikitable"
  ! Reason
+
  ! Packet ID
  ! Effect
+
  ! State
  ! Value
+
  ! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  | rowspan="3"| 0x06
  | Invalid Bed
+
| rowspan="3"| Play
  | Would be used to switch between messages, but the only used message is 0 for invalid bed
+
| rowspan="3"| Client
 +
  | Entity ID
 +
  | {{Type|VarInt}}
 +
| The ID of the entity breaking the block.
 
  |-
 
  |-
  | 1
+
  | Location
  | End raining
+
  | {{Type|Position}}
  |  
+
  | Block Position.
 
  |-
 
  |-
  | 2
+
  | Destroy Stage
  | Begin raining
+
  | {{Type|Byte}}
|  
+
  | 0–9 to set it, any other value to remove it.
  |-
 
| 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?" achievement, 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
 
|-
 
| 10
 
| Play elder guardian mob appearance (effect and sound)
 
|
 
 
  |}
 
  |}
  
==== Keep Alive (clientbound) ====
+
==== Block Entity Data ====
  
{{Need Info|"random ID" and such seem to no longer actually be the case.  For the client, this doesn't matter (just parrot back the same data), but what the numbers actually mean and how the server uses them seem to be different now.}}
+
Sets the block entity associated with the block at the given location.
 
 
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.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,664: Line 1,680:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x1F
+
  | rowspan="3"| 0x07
  |rowspan="1"| Play
+
  | rowspan="3"| Play
  |rowspan="1"| Client
+
  | rowspan="3"| Client
  | Keep Alive ID
+
  | Location
  | Long
+
  | {{Type|Position}}
  |  
+
|
 +
|-
 +
| Type
 +
| {{Type|VarInt}}
 +
| The type of the block entity
 +
|-
 +
| NBT Data
 +
  | {{Type|NBT}}
 +
| 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).
 
  |}
 
  |}
  
==== Chunk Data ====
+
==== Block Action ====
{{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).
+
This packet is used for a number of actions and animations performed by blocks, usually non-persistent.  The client ignores the provided block type and instead uses the block state in their world.
  
{| class="wikitable"
+
See [[Block Actions]] for a list of values.
 +
 
 +
{{Warning2|This packet uses a block ID from the <code>minecraft:block</code> registry, not a block state.}}
 +
 
 +
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 1,686: Line 1,712:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="9"| 0x20
+
  | rowspan="4"| 0x08
  |rowspan="9"| Play
+
  | rowspan="4"| Play
  |rowspan="9"| Client
+
  | rowspan="4"| Client
  | Chunk X
+
  | Location
  | Int
+
  | {{Type|Position}}
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  | Block coordinates.
 
  |-
 
  |-
  | Chunk Z
+
  | Action ID (Byte 1)
  | Int
+
  | {{Type|Unsigned Byte}}
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  | Varies depending on block — see [[Block Actions]].
 
  |-
 
  |-
  | Ground-Up Continuous
+
  | Action Parameter (Byte 2)
  | Boolean
+
  | {{Type|Unsigned Byte}}
  | See [[Chunk Format#Ground-up continuous|Chunk Format]]
+
  | Varies depending on block — see [[Block Actions]].
 
  |-
 
  |-
  | Primary Bit Mask
+
  | Block Type
  | VarInt
+
  | {{Type|VarInt}}
  | Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
+
  | The block type ID for the block. This value is unused by the Notchian client, as it will infer the type of block based on the given position.
|-
 
| 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
 
| Length of 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 ====
+
==== Block Update ====
  
Sent when a client is to play a sound or particle effect.
+
Fired whenever a block is changed within the render distance.
  
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.
+
{{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"
 
{| class="wikitable"
Line 1,736: Line 1,746:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x21
+
  | rowspan="2"| 0x09
  |rowspan="4"| Play
+
  | rowspan="2"| Play
  |rowspan="4"| Client
+
  | rowspan="2"| Client
| Effect ID
 
| Int
 
| The ID of the effect, see below
 
|-
 
 
  | Location
 
  | Location
  | Position
+
  | {{Type|Position}}
  | The location of the effect
+
  | Block Coordinates.
 
  |-
 
  |-
  | Data
+
  | Block ID
  | Int
+
  | {{Type|VarInt}}
  | Extra data for certain effects, see below
+
  | The new block state ID for the block as given in the [[Chunk Format#Block state registry|block state registry]].
|-
 
| Disable Relative Volume
 
| Boolean
 
| See above
 
 
  |}
 
  |}
  
Effect IDs:
+
==== Boss Bar ====
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Name
+
  ! State
  ! Data
+
! Bound To
 +
! colspan="2"| Field Name
 +
  ! Field Type
 +
! Notes
 
  |-
 
  |-
  !colspan="3"| Sound
+
  | rowspan="14"| 0x0A
 +
| rowspan="14"| Play
 +
| rowspan="14"| Client
 +
| colspan="2"| UUID
 +
| {{Type|UUID}}
 +
| Unique ID for this bar.
 
  |-
 
  |-
  | 1000
+
  | colspan="2"| Action
  | Dispenser dispenses
+
  | {{Type|VarInt}} {{Type|Enum}}
  |  
+
  | Determines the layout of the remaining packet.
 
  |-
 
  |-
  | 1001
+
  ! Action
  | Dispenser fails to dispense
+
  ! Field Name
  |
+
  !
 +
!
 
  |-
 
  |-
  | 1002
+
  | rowspan="5"| 0: add
  | Dispenser shoots
+
  | Title
  |  
+
| {{Type|Text Component}}
 +
  |
 
  |-
 
  |-
  | 1003
+
  | Health
  | Ender eye launched
+
  | {{Type|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.
 
  |-
 
  |-
  | 1004
+
  | Color
  | Firework shot
+
  | {{Type|VarInt}} {{Type|Enum}}
  |  
+
  | Color ID (see below).
 
  |-
 
  |-
  | 1005
+
  | Division
  | Iron door opened
+
  | {{Type|VarInt}} {{Type|Enum}}
  |  
+
  | Type of division (see below).
 
  |-
 
  |-
  | 1006
+
  | Flags
  | Wooden door opened
+
  | {{Type|Unsigned Byte}}
  |  
+
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music), 0x04: create fog (previously was also controlled by 0x02).
 
  |-
 
  |-
  | 1007
+
  | 1: remove
  | Wooden trapdoor opened
+
  | ''no fields''
  |  
+
  | ''no fields''
 +
| Removes this boss bar.
 
  |-
 
  |-
  | 1008
+
  | 2: update health
  | Fence gate opened
+
  | Health
  |  
+
  | {{Type|Float}}
 +
| ''as above''
 
  |-
 
  |-
  | 1009
+
  | 3: update title
  | Fire extinguished
+
  | Title
  |  
+
| {{Type|Text Component}}
 +
  |
 
  |-
 
  |-
  | 1010
+
  | rowspan="2"| 4: update style
  | Play record
+
| Color
  | Special case, see below for more info
+
  | {{Type|VarInt}} {{Type|Enum}}
 +
  | Color ID (see below).
 
  |-
 
  |-
  | 1011
+
  | Dividers
  | Iron door closed
+
  | {{Type|VarInt}} {{Type|Enum}}
  |  
+
  | ''as above''
 
  |-
 
  |-
  | 1012
+
  | 5: update flags
  | Wooden door closed
+
  | Flags
  |  
+
  | {{Type|Unsigned Byte}}
 +
| ''as above''
 +
|}
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Color
 
  |-
 
  |-
  | 1013
+
  | 0
| Wooden trapdoor closed
+
  | Pink
  |  
 
 
  |-
 
  |-
  | 1014
+
  | 1
| Fence gate closed
+
  | Blue
  |  
 
 
  |-
 
  |-
  | 1015
+
  | 2
| Ghast warns
+
  | Red
  |  
 
 
  |-
 
  |-
  | 1016
+
  | 3
| Ghast shoots
+
  | Green
  |  
 
 
  |-
 
  |-
  | 1017
+
  | 4
| Enderdragon shoots
+
  | Yellow
  |  
 
 
  |-
 
  |-
  | 1018
+
  | 5
| Blaze shoots
+
  | Purple
  |  
 
 
  |-
 
  |-
  | 1019
+
  | 6
  | Zombie attacks wood door
+
  | White
  |  
+
  |}
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Type of division
 
  |-
 
  |-
  | 1020
+
  | 0
| Zombie attacks iron door
+
  | No division
  |  
 
 
  |-
 
  |-
  | 1021
+
  | 1
| Zombie breaks wood door
+
  | 6 notches
  |
 
 
  |-
 
  |-
  | 1022
+
  | 2
| Wither breaks block
+
  | 10 notches
  |
 
 
  |-
 
  |-
  | 1023
+
  | 3
| Wither spawned
+
  | 12 notches
  |  
 
 
  |-
 
  |-
  | 1024
+
  | 4
  | Wither shoots
+
  | 20 notches
  |
+
  |}
 +
 
 +
==== Change Difficulty ====
 +
 
 +
Changes the difficulty setting in the client's option menu
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1025
+
  | rowspan="2"| 0x0B
  | Bat takes off
+
  | rowspan="2"| Play
  |
+
| rowspan="2"| Client
 +
| Difficulty
 +
| {{Type|Unsigned Byte}}
 +
  | 0: peaceful, 1: easy, 2: normal, 3: hard.
 
  |-
 
  |-
  | 1026
+
  | Difficulty locked?
  | Zombie infects
+
  | {{Type|Boolean}}
 
  |
 
  |
 +
|}
 +
 +
==== Chunk Batch Finished ====
 +
 +
Marks the end of a chunk batch. The Notchian client marks the time it receives this packet and calculates the elapsed duration since the [[#Chunk Batch Start|beginning of the chunk batch]]. The server uses this duration and the batch size received in this packet to estimate the number of milliseconds elapsed per chunk received. This value is then used to calculate the desired number of chunks per tick through the formula <code>25 / millisPerChunk</code>, which is reported to the server through [[#Chunk Batch Received|Chunk Batch Received]]. This likely uses <code>25</code> instead of the normal tick duration of <code>50</code> so chunk processing will only use half of the client's and network's bandwidth.
 +
 +
The Notchian client uses the samples from the latest 15 batches to estimate the milliseconds per chunk number.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1027
+
  | rowspan="1"| 0x0C
  | Zombie villager converted
+
| rowspan="1"| Play
  |
+
| rowspan="1"| Client
 +
  | Batch size
 +
  | {{Type|VarInt}}
 +
| Number of chunks.
 +
|}
 +
 
 +
==== Chunk Batch Start ====
 +
 
 +
Marks the start of a chunk batch. The Notchian client marks and stores the time it receives this packet.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1028
+
  | 0x0D
  | Ender dragon death
+
  | Play
  |
+
  | Client
 +
| colspan="3"| ''no fields''
 +
|}
 +
 
 +
==== Chunk Biomes ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | 1029
+
  | rowspan="6"| 0x0E
  | Anvil destroyed
+
  | rowspan="6"| Play
  |  
+
  | rowspan="6"| Client
 
  |-
 
  |-
  | 1030
+
  | colspan="2"| Number of chunks
  | Anvil used
+
  | colspan="2"| {{Type|VarInt}}
  |  
+
  | Number of elements in the following array
 
  |-
 
  |-
  | 1031
+
  | rowspan="4"| Chunk biome data
  | Anvil landed
+
| Chunk Z
  |
+
| rowspan="4"| {{Type|Array}}
 +
  | {{Type|Int}}
 +
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | 1032
+
  | Chunk X
  | Portal travel
+
  | {{Type|Int}}
  |  
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | 1033
+
  | Size
  | Chorus flower grown
+
  | {{Type|VarInt}}
  |
+
  | Size of Data in bytes
 
  |-
 
  |-
  | 1034
+
  | Data
  | Chorus flower died
+
  | {{Type|Byte Array}}
  |  
+
  | Chunk [[Chunk Format#Data structure|data structure]], with [[Chunk Format#Chunk_Section|sections]] containing only the <code>Biomes</code> field
 +
|}
 +
 
 +
Note: The order of X and Z is inverted, because the client reads them as one big-endian {{Type|Long}}, with Z being the upper 32 bits.
 +
 
 +
==== Clear Titles ====
 +
 
 +
Clear the client's current title information, with the option to also reset it.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1035
+
  | rowspan="1"| 0x0F
  | Brewing stand brewed
+
  | rowspan="1"| Play
 +
| rowspan="1"| Client
 +
| Reset
 +
| {{Type|Boolean}}
 
  |
 
  |
 +
|}
 +
 +
==== Command Suggestions Response ====
 +
 +
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
 
  |-
 
  |-
  | 1036
+
  | rowspan="8"| 0x10
  | Iron trapdoor opened
+
  | rowspan="8"| Play
  |  
+
  | rowspan="8"| Client
 
  |-
 
  |-
  | 1037
+
  | colspan="2"| ID
  | Iron trapdoor closed
+
  | colspan="2"| {{Type|VarInt}}
  |
+
  | Transaction ID.
 
  |-
 
  |-
  !colspan="3"| Particle
+
  | colspan="2"| Start
 +
| colspan="2"| {{Type|VarInt}}
 +
| Start of the text to replace.
 
  |-
 
  |-
  | 2000
+
  | colspan="2"| Length
  | Spawns 10 smoke particles, e.g. from a fire
+
  | colspan="2"| {{Type|VarInt}}
  | Direction, see below
+
  | Length of the text to replace.
 
  |-
 
  |-
  | 2001
+
  | colspan="2"| Count
  | Block break + block break sound
+
  | colspan="2"| {{Type|VarInt}}
| {{Minecraft Wiki|Data values|Block ID}}
+
| Number of elements in the following array.
 
  |-
 
  |-
  | 2002
+
  | rowspan="3"| Matches
  | Splash potion. Particle effect + glass break sound.
+
| Match
  | [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
+
| rowspan="3"| {{Type|Array}}
 +
  | {{Type|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.
 
  |-
 
  |-
  | 2003
+
  | Has tooltip
  | Eye of Ender entity break animation — particles and sound
+
  | {{Type|Boolean}}
  |  
+
  | True if the following is present.
 
  |-
 
  |-
  | 2004
+
  | Tooltip
  | Mob spawn particle effect: smoke + flames
+
  | {{Type|Optional}} {{Type|Text Component}}
  |  
+
  | Tooltip to display; only present if previous boolean is true.
 +
|}
 +
 
 +
==== 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
 
  |-
 
  |-
  | 2005
+
  | rowspan="3"| 0x11
  | Bonemeal particles
+
  | rowspan="3"| Play
  | How many particles to spawn (if set to 0, 15 are spawned)
+
| rowspan="3"| Client
 +
| Count
 +
| {{Type|VarInt}}
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  | 2006
+
  | Nodes
  | Dragon breath
+
  | {{Type|Array}} of [[Command Data|Node]]
  |
+
  | An array of nodes.
 
  |-
 
  |-
  | 2007
+
  | Root index
  | Instant splash potion
+
  | {{Type|VarInt}}
  | [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
+
  | Index of the <code>root</code> node in the previous array.
|-
 
| 3000
 
| End gateway spawn
 
|
 
|-
 
| 3001
 
| Enderdragon growl
 
|
 
 
  |}
 
  |}
  
Smoke directions:
+
For more information on this packet, see the [[Command Data]] article.
 +
 
 +
==== Close Container ====
 +
 
 +
This packet is sent from the server to the client when a window is forcibly closed, such as when a chest is destroyed while it's open. The notchian client disregards the provided window ID and closes any active window.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Direction
+
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  | 0x12
  | South-East
+
| Play
  |-
+
| Client
  | 1
+
  | Window ID
  | South
+
  | {{Type|Unsigned Byte}}
 +
  | This is the ID of the window that was closed. 0 for inventory.
 +
  |}
 +
 
 +
==== Set Container Content ====
 +
[[File:Inventory-slots.png|thumb|The inventory slots]]
 +
 
 +
Replaces the contents of a container window. Sent by the server upon initialization of a container window or the player's inventory, and in response to state ID mismatches (see [[#Click Container]]).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 2
+
  | rowspan="5"| 0x13
  | South-West
+
| rowspan="5"| Play
 +
| rowspan="5"| Client
 +
| Window ID
 +
| {{Type|Unsigned Byte}}
 +
  | The ID of window which items are being sent for. 0 for player inventory. The client ignores any packets targeting a Window ID other than the current one. However, an exception is made for the player inventory, which may be targeted at any time. (The Notchian server does not appear to utilize this special case.)
 
  |-
 
  |-
  | 3
+
  | State ID
  | East
+
  | {{Type|VarInt}}
 +
| A server-managed sequence number used to avoid desynchronization; see [[#Click Container]].
 
  |-
 
  |-
  | 4
+
  | Count
  | (Up or middle ?)
+
  | {{Type|VarInt}}
 +
| Number of elements in the following array.
 
  |-
 
  |-
  | 5
+
  | Slot Data
  | West
+
  | {{Type|Array}} of [[Slot Data|Slot]]
|-
 
| 6
 
| North-East
 
 
  |-
 
  |-
  | 7
+
  | Carried Item
  | North
+
  | {{Type|Slot}}
|-
+
  | Item being dragged with the mouse.
| 8
 
  | North-West
 
 
  |}
 
  |}
  
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 [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 +
Use [[#Open Screen|Open Screen]] to open the container on the client.
  
==== Particle ====
+
==== Set Container Property ====
  
Displays the named particle
+
This packet is used to inform the client that part of a GUI window should be updated.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,008: Line 2,154:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="11"| 0x22
+
  | rowspan="3"| 0x14
  |rowspan="11"| Play
+
  | rowspan="3"| Play
  |rowspan="11"| Client
+
  | rowspan="3"| Client
  | Particle ID
+
  | Window ID
  | Int
+
  | {{Type|Unsigned Byte}}
  | See below
+
  |
 
  |-
 
  |-
  | Long Distance
+
  | Property
  | Boolean
+
  | {{Type|Short}}
  | If true, particle distance increases from 256 to 65536
+
  | The property to be updated, see below.
 
  |-
 
  |-
  | X
+
  | Value
  | Float
+
  | {{Type|Short}}
  | X position of the particle
+
| 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"
 
  |-
 
  |-
  | Y
+
  ! Window type
  | Float
+
  ! Property
  | Y position of the particle
+
  ! Value
 
  |-
 
  |-
  | Z
+
  | rowspan="4"| Furnace
  | Float
+
  | 0: Fire icon (fuel left)
  | Z position of the particle
+
  | counting from fuel burn time down to 0 (in-game ticks)
 
  |-
 
  |-
  | Offset X
+
  | 1: Maximum fuel burn time
  | Float
+
  | fuel burn time or 0 (in-game ticks)
| This is added to the X position after being multiplied by random.nextGaussian()
 
 
  |-
 
  |-
  | Offset Y
+
  | 2: Progress arrow
  | Float
+
  | counting from 0 to maximum progress (in-game ticks)
| This is added to the Y position after being multiplied by random.nextGaussian()
 
 
  |-
 
  |-
  | Offset Z
+
  | 3: Maximum progress
  | Float
+
  | always 200 on the notchian server
| This is added to the Z position after being multiplied by random.nextGaussian()
 
 
  |-
 
  |-
  | Particle Data
+
  | rowspan="10"| Enchantment Table
  | Float
+
  | 0: Level requirement for top enchantment slot
  | The data of each particle
+
  | rowspan="3"| The enchantment's xp level requirement
 
  |-
 
  |-
  | Particle Count
+
  | 1: Level requirement for middle enchantment slot
| Int
 
| The number of particles to create
 
 
  |-
 
  |-
  | Data
+
  | 2: Level requirement for bottom enchantment slot
| Array of VarInt
 
| Length depends on particle. "iconcrack" has length of 2, "blockcrack", and "blockdust" have lengths of 1, the rest have 0.
 
|}
 
 
 
Particle IDs:
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Particle Name
+
  | 3: The enchantment seed
  ! Particle ID
+
  | 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>).
 
  |-
 
  |-
  | explode
+
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
  | 0
+
  | rowspan="3"| The enchantment id (set to -1 to hide it), see below for values
 
  |-
 
  |-
  | largeexplode
+
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
| 1
 
 
  |-
 
  |-
  | hugeexplosion
+
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
| 2
 
 
  |-
 
  |-
  | fireworksSpark
+
  | 7: Enchantment level shown on mouse hover over the top slot
  | 3
+
  | rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
 
  |-
 
  |-
  | bubble
+
  | 8: Enchantment level shown on mouse hover over the middle slot
| 4
 
 
  |-
 
  |-
  | splash
+
  | 9: Enchantment level shown on mouse hover over the bottom slot
| 5
 
 
  |-
 
  |-
  | wake
+
  | rowspan="3"| Beacon
  | 6
+
| 0: Power level
 +
| 0-4, controls what effect buttons are enabled
 +
|-
 +
| 1: First potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
 +
|-
 +
| 2: Second potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
 +
|-
 +
| Anvil
 +
| 0: Repair cost
 +
| The repair's cost in xp levels
 +
|-
 +
| rowspan="2"| Brewing Stand
 +
| 0: Brew time
 +
| 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
 +
|-
 +
| 1: Fuel time
 +
| 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
 +
|-
 +
| Stonecutter
 +
| 0: Selected recipe
 +
| The index of the selected recipe. -1 means none is selected.
 +
|-
 +
| Loom
 +
| 0: Selected pattern
 +
| The index of the selected pattern. 0 means none is selected, 0 is also the internal id of the "base" pattern.
 +
|-
 +
| Lectern
 +
| 0: Page number
 +
| The current page number, starting from 0.
 +
|}
 +
 
 +
For an enchanting table, the following numerical IDs are used:
 +
 
 +
{| class="wikitable"
 +
! Numerical ID
 +
! Enchantment ID
 +
! Enchantment Name
 +
|-
 +
| 0
 +
| minecraft:protection
 +
| Protection
 +
|-
 +
| 1
 +
| minecraft:fire_protection
 +
| Fire Protection
 +
|-
 +
| 2
 +
| minecraft:feather_falling
 +
| Feather Falling
 +
|-
 +
| 3
 +
| minecraft:blast_protection
 +
| Blast Protection
 +
|-
 +
| 4
 +
| minecraft:projectile_protection
 +
| Projectile Protection
 +
|-
 +
| 5
 +
| minecraft:respiration
 +
| Respiration
 +
|-
 +
  | 6
 +
| minecraft:aqua_affinity
 +
| Aqua Affinity
 
  |-
 
  |-
| suspended
 
 
  | 7
 
  | 7
 +
| minecraft:thorns
 +
| Thorns
 
  |-
 
  |-
| depthsuspend
 
 
  | 8
 
  | 8
 +
| minecraft:depth_strider
 +
| Depth Strider
 
  |-
 
  |-
| crit
 
 
  | 9
 
  | 9
 +
| minecraft:frost_walker
 +
| Frost Walker
 
  |-
 
  |-
| magicCrit
 
 
  | 10
 
  | 10
 +
| minecraft:binding_curse
 +
| Curse of Binding
 
  |-
 
  |-
| smoke
 
 
  | 11
 
  | 11
 +
| minecraft:soul_speed
 +
| Soul Speed
 
  |-
 
  |-
| largesmoke
 
 
  | 12
 
  | 12
 +
| minecraft:sharpness
 +
| Sharpness
 
  |-
 
  |-
| spell
 
 
  | 13
 
  | 13
 +
| minecraft:smite
 +
| Smite
 
  |-
 
  |-
| instantSpell
 
 
  | 14
 
  | 14
 +
| minecraft:bane_of_arthropods
 +
| Bane of Arthropods
 
  |-
 
  |-
| mobSpell
 
 
  | 15
 
  | 15
 +
| minecraft:knockback
 +
| Knockback
 
  |-
 
  |-
| mobSpellAmbient
 
 
  | 16
 
  | 16
 +
| minecraft:fire_aspect
 +
| Fire Aspect
 
  |-
 
  |-
| witchMagic
 
 
  | 17
 
  | 17
 +
| minecraft:looting
 +
| Looting
 
  |-
 
  |-
| dripWater
 
 
  | 18
 
  | 18
 +
| minecraft:sweeping
 +
| Sweeping Edge
 
  |-
 
  |-
| dripLava
 
 
  | 19
 
  | 19
 +
| minecraft:efficiency
 +
| Efficiency
 
  |-
 
  |-
| angryVillager
 
 
  | 20
 
  | 20
 +
| minecraft:silk_touch
 +
| Silk Touch
 
  |-
 
  |-
| happyVillager
 
 
  | 21
 
  | 21
 +
| minecraft:unbreaking
 +
| Unbreaking
 
  |-
 
  |-
| townaura
 
 
  | 22
 
  | 22
 +
| minecraft:fortune
 +
| Fortune
 
  |-
 
  |-
| note
 
 
  | 23
 
  | 23
 +
| minecraft:power
 +
| Power
 
  |-
 
  |-
| portal
 
 
  | 24
 
  | 24
 +
| minecraft:punch
 +
| Punch
 
  |-
 
  |-
| enchantmenttable
 
 
  | 25
 
  | 25
 +
| minecraft:flame
 +
| Flame
 
  |-
 
  |-
| flame
 
 
  | 26
 
  | 26
 +
| minecraft:infinity
 +
| Infinity
 
  |-
 
  |-
| lava
 
 
  | 27
 
  | 27
 +
| minecraft:luck_of_the_sea
 +
| Luck of the Sea
 
  |-
 
  |-
| footstep
 
 
  | 28
 
  | 28
 +
| minecraft:lure
 +
| Lure
 
  |-
 
  |-
| cloud
 
 
  | 29
 
  | 29
 +
| minecraft:loyalty
 +
| Loyalty
 
  |-
 
  |-
| reddust
 
 
  | 30
 
  | 30
 +
| minecraft:impaling
 +
| Impaling
 
  |-
 
  |-
| snowballpoof
 
 
  | 31
 
  | 31
 +
| minecraft:riptide
 +
| Riptide
 
  |-
 
  |-
| snowshovel
 
 
  | 32
 
  | 32
 +
| minecraft:channeling
 +
| Channeling
 
  |-
 
  |-
| slime
 
 
  | 33
 
  | 33
 +
| minecraft:multishot
 +
| Multishot
 
  |-
 
  |-
| heart
 
 
  | 34
 
  | 34
 +
| minecraft:quick_charge
 +
| Quick Charge
 
  |-
 
  |-
| barrier
 
 
  | 35
 
  | 35
 +
| minecraft:piercing
 +
| Piercing
 
  |-
 
  |-
| iconcrack_(id)_(data)
 
 
  | 36
 
  | 36
 +
| minecraft:mending
 +
| Mending
 
  |-
 
  |-
| blockcrack_(id+(data<<12))
 
 
  | 37
 
  | 37
 +
| minecraft:vanishing_curse
 +
| Curse of Vanishing
 +
|}
 +
 +
==== Set Container Slot ====
 +
 +
Sent by the server when an item in a slot (in a window) is added/removed.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | blockdust_(id)
+
  | rowspan="4"| 0x15
  | 38
+
  | rowspan="4"| Play
  |-
+
  | rowspan="4"| Client
| droplet
+
  | Window ID
  | 39
+
  | {{Type|Byte}}
  |-
+
  | The window which is being updated. 0 for player inventory. The client ignores any packets targeting a Window ID other than the current one; see below for exceptions.
| take
 
  | 40
 
 
  |-
 
  |-
  | mobappearance
+
  | State ID
  | 41
+
  | {{Type|VarInt}}
 +
| A server-managed sequence number used to avoid desynchronization; see [[#Click Container]].
 
  |-
 
  |-
  | dragonbreath
+
  | Slot
  | 42
+
  | {{Type|Short}}
 +
| The slot that should be updated.
 
  |-
 
  |-
  | endrod
+
  | Slot Data
  | 43
+
  | {{Type|Slot}}
|-
+
  |
| damageindicator
 
| 44
 
|-
 
| sweepattack
 
| 45
 
|-
 
| fallingdust
 
  | 46
 
 
  |}
 
  |}
  
==== Join Game ====
+
If Window ID is 0, the hotbar and offhand slots (slots 36 through 45) may be updated even when a different container window is open. (The Notchian server does not appear to utilize this special case.) Updates are also restricted to those slots when the player is looking at a creative inventory tab other than the survival inventory. (The Notchian server does ''not'' handle this restriction in any way, leading to [https://bugs.mojang.com/browse/MC-242392 MC-242392].)
  
See [[Protocol Encryption]] for information on logging in.
+
If Window ID is -1, the item being dragged with the mouse is set. In this case, State ID and Slot are ignored.
 +
 
 +
If Window ID is -2, any slot in the player's inventory can be updated irrespective of the current container window. In this case, State ID is ignored, and the Notchian server uses a bogus value of 0. Used by the Notchian server to implement the [[#Pick Item]] functionality.
 +
 
 +
When a container window is open, the server never sends updates targeting Window ID 0&mdash;all of the [[Inventory|window types]] include slots for the player inventory. The client must automatically apply changes targeting the inventory portion of a container window to the main inventory; the server does not resend them for ID 0 when the window is closed. However, since the armor and offhand slots are only present on ID 0, updates to those slots occurring while a window is open must be deferred by the server until the window's closure.
 +
 
 +
==== 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"
 
{| class="wikitable"
Line 2,217: Line 2,462:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x23
+
  | rowspan="2"| 0x16
  |rowspan="7"| Play
+
  | rowspan="2"| Play
  |rowspan="7"| Client
+
  | rowspan="2"| Client
  | Entity ID
+
  | Item ID
  | Int
+
  | {{Type|VarInt}}
  | The player's Entity ID (EID)
+
  | Numeric ID of the item to apply a cooldown to.
 
  |-
 
  |-
  | Gamemode
+
  | Cooldown Ticks
  | Unsigned Byte
+
  | {{Type|VarInt}}
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. Bit 3 (0x8) is the hardcore flag.
+
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
  |-
 
| Dimension
 
| Int Enum
 
| -1: Nether, 0: Overworld, 1: End; also, note that this is not a VarInt but instead a regular int.
 
|-
 
| Difficulty
 
| Unsigned Byte
 
| 0: peaceful, 1: easy, 2: normal, 3: hard
 
|-
 
| 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, default_1_1
 
|-
 
| Reduced Debug Info
 
| Boolean
 
| If true, a Notchian client shows reduced information on the {{Minecraft Wiki|debug screen}}.  For servers in development, this should almost always be false.
 
 
  |}
 
  |}
  
==== Map ====
+
==== Chat Suggestions ====
  
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
+
Unused by the Notchian server. Likely provided for custom servers to send chat message completions to clients.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,257: Line 2,482:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="13"| 0x24
+
  | rowspan="3"| 0x17
  |rowspan="13"| Play
+
  | rowspan="3"| Play
  |rowspan="13"| Client
+
  | rowspan="3"| Client
  |colspan="2"| Item Damage
+
  | Action
  |colspan="2"| VarInt
+
| {{Type|VarInt}} {{Type|Enum}}
  | The damage value (map ID) of the map being modified
+
| 0: Add, 1: Remove, 2: Set
 +
|-
 +
| Count
 +
  | {{Type|VarInt}}
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  |colspan="2"| Scale
+
  | Entries
  |colspan="2"| Byte
+
| {{Type|Array}} of {{Type|String}} (32767)
  | 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
+
==== Clientbound Plugin Message (play) ====
  | Specifies whether the icons are shown
+
 
  |-  
+
{{Main|Plugin channels}}
  |colspan="2"| Icon Count
+
 
  |colspan="2"| VarInt
+
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.
  | Number of elements in the following array
+
 
 +
More information on how it works on [https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ Dinnerbone's blog]. More documentation about internal and popular registered channels are [[plugin channel|here]].
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x18
 +
| rowspan="2"| Play
 +
  | rowspan="2"| Client
 +
| Channel
 +
| {{Type|Identifier}}
 +
  | Name of the [[plugin channel]] used to send the data.
 +
|-
 +
| Data
 +
| {{Type|Byte Array}} (1048576)
 +
  | Any data. The length of this array must be inferred from the packet length.
 +
  |}
 +
 
 +
In Notchian client, the maximum data length is 1048576 bytes.
 +
 
 +
==== Damage Event ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
  ! colspan="2"| Field Type
 +
  ! Notes
 +
  |-
 +
  | rowspan="9"| 0x19
 +
  | rowspan="9"| Play
 +
  | rowspan="9"| Client
 
  |-
 
  |-
  |rowspan="3"| Icon
+
  | colspan="2"| Entity ID
  | Direction And Type
+
  | colspan="2"| {{Type|VarInt}}
|rowspan="3"| Array
+
  | The ID of the entity taking damage
| Byte
 
  | 0xF0 = Type, 0x0F = Direction
 
 
  |-
 
  |-
  | X
+
  | colspan="2"| Source Type ID
  | Byte
+
  | colspan="2"| {{Type|VarInt}}
  |  
+
  | The type of damage in the <code>minecraft:damage_type</code> registry, defined by the [[Protocol#Registry_Data|Registry Data]] packet.
 
  |-
 
  |-
| Z
+
  | colspan="2"| Source Cause ID
| Byte
+
  | colspan="2"| {{Type|VarInt}}
|
+
  | The ID + 1 of the entity responsible for the damage, if present. If not present, the value is 0
|-
 
  |colspan="2"| Columns
 
  |colspan="2"| Byte
 
  | Number of columns updated
 
 
  |-
 
  |-
  |colspan="2"| Rows
+
  | colspan="2"| Source Direct ID
  |colspan="2"| Optional Byte
+
  | colspan="2"| {{Type|VarInt}}
  | Only if Columns is more than 0; number of rows updated
+
  | The ID + 1 of the entity that directly dealt the damage, if present. If not present, the value is 0. If this field is present:
 +
* and damage was dealt indirectly, such as by the use of a projectile, this field will contain the ID of such projectile;
 +
* and damage was dealt dirctly, such as by manually attacking, this field will contain the same value as Source Cause ID.
 
  |-
 
  |-
  |colspan="2"| X
+
  | colspan="2"| Has Source Position
  |colspan="2"| Optional Byte
+
  | colspan="2"| {{Type|Boolean}}
  | Only if Columns is more than 0; x offset of the westernmost column
+
  | Indicates the presence of the three following fields.
 +
The Notchian server sends the Source Position when the damage was dealt by the /damage command and a position was specified
 
  |-
 
  |-
  |colspan="2"| Z
+
  | colspan="2"| Source Position X
  |colspan="2"| Optional Byte
+
  | colspan="2"| {{Type|Optional}} {{Type|Double}}
  | Only if Columns is more than 0; z offset of the northernmost row
+
  | Only present if Has Source Position is true
 
  |-
 
  |-
  |colspan="2"| Length
+
  | colspan="2"| Source Position Y
  |colspan="2"| Optional VarInt
+
  | colspan="2"| {{Type|Optional}} {{Type|Double}}
  | Only if Columns is more than 0; length of the following array
+
  | Only present if Has Source Position is true
 
  |-
 
  |-
  |colspan="2"| Data
+
  | colspan="2"| Source Position Z
  |colspan="2"| Optional Array of Unsigned Byte
+
  | colspan="2"| {{Type|Optional}} {{Type|Double}}
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
+
  | Only present if Has Source Position is true
 
  |}
 
  |}
  
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
+
==== Delete Message ====
  
Types are based off of rows and columns in <code>map_icons.png</code>:
+
Removes a message from the client's chat. This only works for messages with signatures, system messages cannot be deleted with this packet.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Icon type
+
  | rowspan="2"| 0x1A
  ! Result
+
  | rowspan="2"| Play
 +
| rowspan="2"| Client
 +
| Message ID
 +
| {{Type|VarInt}}
 +
| The message Id + 1, used for validating message signature. The next field is present only when value of this field is equal to 0.
 
  |-
 
  |-
  | 0
+
  | Signature
  | White arrow (players)
+
  | {{Type|Optional}} {{Type|Byte Array}} (256)
|-
+
  | The previous message's signature. Always 256 bytes and not length-prefixed.
| 1
 
| Green arrow (item frames)
 
|-
 
| 2
 
| Red arrow
 
|-
 
| 3
 
| Blue arrow
 
|-
 
| 4
 
| White cross
 
|-
 
| 5
 
| Red pointer
 
|-
 
| 6
 
| White circle (off-map players)
 
  |-
 
| 7
 
| Small white circle (far-off-map players)
 
|-
 
| 8
 
| Mansion
 
|-
 
| 9
 
| Temple
 
|-
 
| 10-15
 
| Unused (blue square)
 
 
  |}
 
  |}
  
==== Entity ====
+
==== Disconnect (play) ====
  
This packet may be used to initialize an entity.
+
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.
 
 
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,376: Line 2,618:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x25
+
  | 0x1B
  |rowspan="1"| Play
+
  | Play
  |rowspan="1"| Client
+
  | Client
  | Entity ID
+
  | Reason
  | VarInt
+
  | {{Type|Text Component}}
  |  
+
  | Displayed to the client when the connection terminates.
 
  |}
 
  |}
  
==== Entity Relative Move ====
+
==== Disguised Chat Message ====
  
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.
+
Sends the client a chat message, but without any message signing information.
  
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.
+
The Notchian server uses this packet when the console is communicating with players through commands, such as <code>/say</code>, <code>/tell</code>, <code>/me</code>, among others.
  
{| class="wikitable"
+
{| class="wikitable
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 2,398: Line 2,640:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x26
+
  | rowspan="5"| 0x1C
  |rowspan="5"| Play
+
  | rowspan="5"| Play
  |rowspan="5"| Client
+
  | rowspan="5"| Client
  | Entity ID
+
  | Message
  | VarInt
+
  | {{Type|Text Component}}
  |  
+
  | This is used as the <code>content</code> parameter when formatting the message on the client.
 
  |-
 
  |-
  | Delta X
+
  | Chat Type
  | Short
+
  | {{Type|VarInt}}
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
  | The type of chat in the <code>minecraft:chat_type</code> registry, defined by the [[Protocol#Registry_Data|Registry Data]] packet.
 
  |-
 
  |-
  | Delta Y
+
  | Sender Name
  | Short
+
  | {{Type|Text Component}}
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
+
  | The name of the one sending the message, usually the sender's display name.
 +
This is used as the <code>sender</code> parameter when formatting the message on the client.
 
  |-
 
  |-
  | Delta Z
+
  | Has Target Name
  | Short
+
  | {{Type|Boolean}}
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
+
  | True if target name is present.
 
  |-
 
  |-
  | On Ground
+
  | Target Name
  | Boolean
+
  | {{Type|Text Component}}
  |  
+
  | The name of the one receiving the message, usually the receiver's display name. Only present if previous boolean is true.
 +
This is used as the <code>target</code> parameter when formatting the message on the client.
 
  |}
 
  |}
  
==== Entity Look And Relative Move ====
+
==== Entity Event ====
  
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>)
+
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"
 
{| class="wikitable"
Line 2,434: Line 2,678:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x27
+
  | rowspan="2"| 0x1D
  |rowspan="7"| Play
+
  | rowspan="2"| Play
  |rowspan="7"| Client
+
  | rowspan="2"| Client
 
  | Entity ID
 
  | Entity ID
  | VarInt
+
  | {{Type|Int}}
  |  
+
  |
 
  |-
 
  |-
  | Delta X
+
  | Entity Status
  | Short
+
  | {{Type|Byte}} {{Type|Enum}}
| Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
  | See [[Entity statuses]] for a list of which statuses are valid for each type of entity.
|-
 
| Delta Y
 
| Short
 
| 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
 
| Angle
 
| New angle, not a delta
 
|-
 
| Pitch
 
| Angle
 
| New angle, not a delta
 
|-
 
| On Ground
 
| Boolean
 
|
 
 
  |}
 
  |}
  
==== Entity Look ====
+
==== Explosion ====
 +
 
 +
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
  
This packet is sent by the server when an entity rotates.
+
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,474: Line 2,700:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2" | Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x28
+
  | rowspan="17"| 0x1E
  |rowspan="4"| Play
+
  | rowspan="17"| Play
  |rowspan="4"| Client
+
  | rowspan="17"| Client
  | Entity ID
+
  | colspan="2" | X
  | VarInt
+
  | {{Type|Double}}
  |  
+
  |
 
  |-
 
  |-
  | Yaw
+
  | colspan="2" | Y
  | Angle
+
  | {{Type|Double}}
  | New angle, not a delta
+
  |
 +
|-
 +
| colspan="2" | Z
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| colspan="2" | Strength
 +
| {{Type|Float}}
 +
| If the strength is greater or equal to 2.0, or the block interaction is not 0 (keep), large explosion particles are used. Otherwise, small explosion particles are used.
 +
|-
 +
| colspan="2" | Record Count
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| colspan="2" | Records
 +
| {{Type|Array}} of ({{Type|Byte}}, {{Type|Byte}}, {{Type|Byte}})
 +
| Each record is 3 signed bytes long; the 3 bytes are the XYZ (respectively) signed offsets of affected blocks.
 +
|-
 +
| colspan="2" | Player Motion X
 +
| {{Type|Float}}
 +
| X velocity of the player being pushed by the explosion.
 +
|-
 +
| colspan="2" | Player Motion Y
 +
| {{Type|Float}}
 +
| Y velocity of the player being pushed by the explosion.
 +
|-
 +
| colspan="2" | Player Motion Z
 +
| {{Type|Float}}
 +
| Z velocity of the player being pushed by the explosion.
 +
|-
 +
| colspan="2" | Block Interaction
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| 0 = keep, 1 = destroy, 2 = destroy_with_decay, 3 = trigger_block.
 +
|-
 +
| colspan="2" | Small Explosion Particle ID
 +
| {{Type|VarInt}}
 +
| The particle ID listed in [[Particles]].
 +
|-
 +
| colspan="2" | Small Explosion Particle Data
 +
| Varies
 +
| Particle data as specified in [[Particles]].
 +
|-
 +
| colspan="2" | Large Explosion Particle ID
 +
| {{Type|VarInt}}
 +
| The particle ID listed in [[Particles]].
 +
|-
 +
| colspan="2" | Large Explosion Particle Data
 +
| Varies
 +
| Particle data as specified in [[Particles]].
 +
|-
 +
| rowspan="3" | Explosion Sound
 +
| Sound Name
 +
| {{Type|Identifier}}
 +
| The name of the sound played.
 
  |-
 
  |-
  | Pitch
+
  | Has Fixed Range
  | Angle
+
  | {{Type|Optional}} {{Type|Boolean}}
  | New angle, not a delta
+
  | Whether is has fixed range.
 
  |-
 
  |-
  | On Ground
+
  | Range
  | Boolean
+
  | {{Type|Optional}} {{Type|Float}}
  |  
+
  | The fixed range of the sound. Only present if previous boolean is true.
 
  |}
 
  |}
  
==== Vehicle Move (clientbound) ====
+
==== Unload Chunk ====
  
Note that all fields use absolute positioning and do not allow for relative positioning.
+
Tells the client to unload a chunk column.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,510: Line 2,789:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x29
+
  | rowspan="2"| 0x1F
  |rowspan="7"| Play
+
  | rowspan="2"| Play
  |rowspan="7"| Client
+
  | rowspan="2"| Client
  | X
+
  | Chunk Z
  | Double
+
  | {{Type|Int}}
  | Absolute position (X coordinate)
+
  | Block coordinate divided by 16, rounded down.
 
  |-
 
  |-
  | Y
+
  | Chunk X
  | Double
+
  | {{Type|Int}}
| Absolute position (Y coordinate)
+
  | Block coordinate divided by 16, rounded down.
|-
 
  | Z
 
| Double
 
| Absolute position (Z coordinate)
 
|-
 
| Yaw
 
| Float
 
| Absolute rotation on the vertical axis, in degrees
 
|-
 
| Pitch
 
| Float
 
| Absolute rotation on the horizontal axis, in degrees
 
 
  |}
 
  |}
  
==== Open Sign Editor ====
+
Note: The order is inverted, because the client reads this packet as one big-endian {{Type|Long}}, with Z being the upper 32 bits.
 +
 
 +
It is legal to send this packet even if the given chunk is not currently loaded.
 +
 
 +
==== Game Event ====
  
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].
+
Used for a wide variety of game events, from weather to bed use to game mode to demo messages.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,546: Line 2,817:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x2A
+
  | rowspan="2"| 0x20
  |rowspan="1"| Play
+
  | rowspan="2"| Play
  |rowspan="1"| Client
+
  | rowspan="2"| Client
  | Location
+
  | Event
  | Position
+
  | {{Type|Unsigned Byte}}
  |  
+
| See below.
 +
|-
 +
| Value
 +
| {{Type|Float}}
 +
  | Depends on Event.
 
  |}
 
  |}
  
==== Craft Recipe Response ====
+
''Events'':
 
 
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"
  ! Packet ID
+
  ! Event
  ! State
+
  ! Effect
  ! Bound To
+
  ! Value
  ! Field Name
+
  |-
  ! Field Type
+
| 0
  ! Notes
+
| No respawn block available
 +
| Note: Displays message 'block.minecraft.spawn.not_valid' (You have no home bed or charged respawn anchor, or it was obstructed) to the player.
 +
|-
 +
| 1
 +
| End raining
 +
|
 +
|-
 +
| 2
 +
| Begin raining
 +
|
 +
|-
 +
| 3
 +
| Change game mode
 +
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
 +
|-
 +
| 4
 +
| Win game
 +
| 0: Just respawn player.<br>1: Roll the credits and respawn player.<br>Note that 1 is only sent by notchian server when player has not yet achieved advancement "The end?", else 0 is sent.
 +
|-
 +
| 5
 +
| Demo event
 +
| 0: Show welcome to demo screen.<br>101: Tell movement controls.<br>102: Tell jump control.<br>103: Tell inventory control.<br>104: Tell that the demo is over and print a message about how to take a screenshot.
 +
|-
 +
| 6
 +
| Arrow hit player
 +
| Note: Sent when any player is struck by an arrow.
 +
|-
 +
| 7
 +
| Rain level change
 +
| Note: Seems to change both sky color and lighting.<br>Rain level ranging from 0 to 1.
 +
|-
 +
| 8
 +
| Thunder level change
 +
| Note: Seems to change both sky color and lighting (same as Rain level change, but doesn't start rain). It also requires rain to render by notchian client.<br>Thunder level ranging from 0 to 1.
 +
|-
 +
  | 9
 +
  | Play pufferfish sting sound
 
  |-
 
  |-
  |rowspan="2"| 0x2B
+
  | 10
  |rowspan="2"| Play
+
  | Play elder guardian mob appearance (effect and sound)
|rowspan="2"| Client
 
| Window ID
 
| Byte
 
 
  |
 
  |
 
  |-
 
  |-
  | Recipe
+
  | 11
  | VarInt
+
  | Enable respawn screen
  | A recipe ID
+
  | 0: Enable respawn screen.<br>1: Immediately respawn (sent when the <code>doImmediateRespawn</code> gamerule changes).
 +
|-
 +
| 12
 +
| Limited crafting
 +
| 0: Disable limited crafting.<br>1: Enable limited crafting (sent when the <code>doLimitedCrafting</code> gamerule changes).
 +
|-
 +
| 13
 +
| Start waiting for level chunks
 +
| Instructs the client to begin the waiting process for the level chunks.<br>Sent by the server after the level is cleared on the client and is being re-sent (either during the first, or subsequent reconfigurations).
 
  |}
 
  |}
  
==== Player Abilities (clientbound) ====
+
==== Open Horse Screen ====
  
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.
+
This packet is used exclusively for opening the horse GUI. [[#Open Screen|Open Screen]] is used for all other GUIs.  The client will not open the inventory if the Entity ID does not point to an horse-like animal.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,590: Line 2,904:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x2C
+
  | rowspan="3"| 0x21
  |rowspan="3"| Play
+
  | rowspan="3"| Play
  |rowspan="3"| Client
+
  | rowspan="3"| Client
  | Flags
+
  | Window ID
  | Byte
+
  | {{Type|Unsigned Byte}}
  | Bit field, see below
+
  |
 
  |-
 
  |-
  | Flying Speed
+
  | Slot count
  | Float
+
  | {{Type|VarInt}}
  |  
+
  |
 
  |-
 
  |-
  | Field of View Modifier
+
  | Entity ID
  | Float
+
  | {{Type|Int}}
  | Modifies the field of view, like a speed potion. A Notchian server will use the same value as the movement speed (send in the [[Protocol#Entity_Properties|Entity Properties]] packet).
+
  |
 
  |}
 
  |}
  
About the flags:
+
==== Hurt Animation ====
 +
 
 +
Plays a bobbing animation for the entity receiving damage.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  ! Field
+
  | rowspan="3"| 0x22
  ! Bit
+
  | rowspan="3"| Play
 +
| rowspan="3"| Client
 
  |-
 
  |-
  | Invulnerable
+
  | colspan="2"| Entity ID
  | 0x01
+
| colspan="2"| {{Type|VarInt}}
 +
  | The ID of the entity taking damage
 
  |-
 
  |-
  | Flying
+
  | colspan="2"| Yaw
| 0x02
+
  | colspan="2"| {{Type|Float}}
|-
+
  | The direction the damage is coming from in relation to the entity
| Allow Flying
 
  | 0x04
 
|-
 
| Creative Mode
 
  | 0x08
 
 
  |}
 
  |}
  
==== Combat Event ====
+
==== Initialize World Border ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,632: Line 2,951:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x2D
+
  | rowspan="8"| 0x23
  |rowspan="8"| Play
+
  | rowspan="8"| Play
  |rowspan="8"| Client
+
  | rowspan="8"| Client
  |colspan="2"| Event
+
  | X
  | VarInt Enum
+
  | {{Type|Double}}
  | Determines the layout of the remaining packet
+
  |
 
  |-
 
  |-
  ! Event
+
  | Z
  ! Field Name
+
  | {{Type|Double}}
  !
+
  |
!
 
 
  |-
 
  |-
  | 0: enter combat
+
  | Old Diameter
  | ''no fields''
+
  | {{Type|Double}}
| ''no fields''
+
  | Current length of a single side of the world border, in meters.
  |  
 
 
  |-
 
  |-
  |rowspan="2"| 1: end combat
+
  | New Diameter
  | Duration
+
  | {{Type|Double}}
| VarInt
+
  | Target length of a single side of the world border, in meters.
  |  
 
 
  |-
 
  |-
  | Entity ID
+
  | Speed
  | Int
+
  | {{Type|VarLong}}
  |  
+
  | 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.
 
  |-
 
  |-
  |rowspan="3"| 2: entity dead
+
  | Portal Teleport Boundary
  | Player ID
+
  | {{Type|VarInt}}
| VarInt
+
  | Resulting coordinates from a portal teleport are limited to ±value. Usually 29999984.
  |  
 
 
  |-
 
  |-
  | Entity ID
+
  | Warning Blocks
  | Int
+
| {{Type|VarInt}}
  |  
+
| In meters.
 +
|-
 +
| Warning Time
 +
| {{Type|VarInt}}
 +
  | In seconds as set by <code>/worldborder warning time</code>.
 +
  |}
 +
 
 +
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:
 +
 
 +
<syntaxhighlight lang="java">
 +
distance = max(min(resizeSpeed * 1000 * warningTime, abs(targetDiameter - currentDiameter)), warningDistance);
 +
if (playerDistance < distance) {
 +
    warning = 1.0 - playerDistance / distance;
 +
} else {
 +
    warning = 0.0;
 +
}
 +
</syntaxhighlight>
 +
 
 +
==== Clientbound Keep Alive (play) ====
 +
 
 +
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same payload (see [[#Serverbound Keep Alive (play)|Serverbound Keep Alive]]). If the client does not respond to a Keep Alive packet within 15 seconds after it was sent, 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
 
  |-
 
  |-
  | Message
+
  | 0x24
  | [[Chat]]
+
  | Play
  |  
+
| Client
 +
| Keep Alive ID
 +
| {{Type|Long}}
 +
  |
 
  |}
 
  |}
  
==== Player List Item ====
+
==== Chunk Data and Update Light ====
 +
{{Main|Chunk Format}}
 +
{{See also|#Unload Chunk}}
 +
 
 +
Sent when a chunk comes into the client's view distance, specifying its terrain, lighting and block entities.
  
Sent by the server to update the user list (<tab> in the client).
+
The chunk must be within the view area previously specified with [[#Set Center Chunk|Set Center Chunk]]; see that packet for details.
  
 +
It is not strictly necessary to send all block entities in this packet; it is still legal to send them with [[#Block Entity Data|Block Entity Data]] later.
 
{| class="wikitable"
 
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="4"| Field Name
+
  ! colspan="2"| Field Name
  !colspan="3"| Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="19"| 0x2E
+
  | rowspan="20"| 0x25
  |rowspan="19"| Play
+
  | rowspan="20"| Play
  |rowspan="19"| Client
+
  | rowspan="20"| Client
  |colspan="4"| Action
+
  | colspan="2"| Chunk X
  |colspan="3"| VarInt
+
  | colspan="2"| {{Type|Int}}
  | Determines the rest of the Player format after the UUID
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  |colspan="4"| Number Of Players
+
  | colspan="2"| Chunk Z
  |colspan="3"| VarInt
+
  | colspan="2"| {{Type|Int}}
  | Number of elements in the following array
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
|rowspan="17"| Player
+
  | colspan="2"| Heightmaps
  |colspan="3"| UUID
+
  | colspan="2"| [[NBT]]
|rowspan="17"| Array
+
  | See [[Chunk Format#Heightmaps structure]]
  |colspan="2"| UUID
 
  |  
 
 
  |-
 
  |-
  ! Action
+
  | colspan="2"| Size
!colspan="2"| Field Name
+
  | colspan="2"| {{Type|VarInt}}
  !colspan="2"|  
+
  | Size of Data in bytes
  !
 
 
  |-
 
  |-
|rowspan="10"| 0: add player
+
  | colspan="2"| Data
  |colspan="2"| Name
+
  | colspan="2"| {{Type|Byte Array}}
  |colspan="2"| String (16)
+
  | See [[Chunk Format#Data structure]]
  |  
 
 
  |-
 
  |-
  |colspan="2"| Number Of Properties
+
  | colspan="2"| Number of block entities
  |colspan="2"| VarInt
+
  | colspan="2"| {{Type|VarInt}}
 
  | Number of elements in the following array
 
  | Number of elements in the following array
 
  |-
 
  |-
  |rowspan="4"| Property
+
  | rowspan="4"| Block Entity
  | Name
+
  | Packed XZ
  |rowspan="4"| Array
+
  | rowspan="4"| {{Type|Array}}
  | String (32767)
+
  | {{Type|Unsigned Byte}}
  |  
+
| The packed section coordinates are relative to the chunk they are in. Values 0-15 are valid. <pre>packed_xz = ((blockX & 15) << 4) | (blockZ & 15) // encode
 +
x = packed_xz >> 4, z = packed_xz & 15 // decode</pre>
 +
|-
 +
| Y
 +
| {{Type|Short}}
 +
| The height relative to the world
 +
|-
 +
| Type
 +
| {{Type|VarInt}}
 +
| The type of block entity
 +
|-
 +
| Data
 +
| [[NBT]]
 +
  | The block entity's data, without the X, Y, and Z values
 
  |-
 
  |-
  | Value
+
  | colspan="2"| Sky Light Mask
  | String (32767)
+
  | colspan="2"| {{Type|BitSet}}
|  
+
  | BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Sky Light array below. The least significant bit is for blocks 16 blocks to 1 block below the min world height (one section below the world), while the most significant bit covers blocks 1 to 16 blocks above the max world height (one section above the world).
|-
 
  | Is Signed
 
  | Boolean
 
  |
 
 
  |-
 
  |-
  | Signature
+
  | colspan="2"| Block Light Mask
  | Optional String (32767)
+
  | colspan="2"| {{Type|BitSet}}
  | Only if Is Signed is true
+
  | BitSet containing bits for each section in the world + 2.  Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Block Light array below.  The order of bits is the same as in Sky Light Mask.
 
  |-
 
  |-
  |colspan="2"| Gamemode
+
  | colspan="2"| Empty Sky Light Mask
  |colspan="2"| VarInt
+
  | colspan="2"| {{Type|BitSet}}
  |  
+
  | BitSet containing bits for each section in the world + 2.  Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Sky Light data.  The order of bits is the same as in Sky Light Mask.
 
  |-
 
  |-
  |colspan="2"| Ping
+
  | colspan="2"| Empty Block Light Mask
  |colspan="2"| VarInt
+
  | colspan="2"| {{Type|BitSet}}
  |  
+
  | BitSet containing bits for each section in the world + 2.  Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Block Light data.  The order of bits is the same as in Sky Light Mask.
 
  |-
 
  |-
  |colspan="2"| Has Display Name
+
  | colspan="2"| Sky Light array count
  |colspan="2"| Boolean
+
  | colspan="2"| {{Type|VarInt}}
  |  
+
  | Number of entries in the following array; should match the number of bits set in Sky Light Mask
 
  |-
 
  |-
  |colspan="2"| Display Name
+
  | rowspan="2"| Sky Light arrays
  |colspan="2"| Optional [[Chat]]
+
  | Length
  | Only if Has Display Name is true
+
| rowspan="2"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | 1: update gamemode
+
  | Sky Light array
  |colspan="2"| Gamemode
+
  | {{Type|Byte Array}} (2048)
  |colspan="2"| VarInt
+
  | 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. Indexed <code><nowiki>((y<<8) | (z<<4) | x) / 2 </nowiki></code> If there's a remainder, masked 0xF0 else 0x0F.
|
 
|-
 
| 2: update latency
 
  |colspan="2"| Ping
 
|colspan="2"| VarInt
 
|
 
 
  |-
 
  |-
  |rowspan="2"| 3: update display name
+
  | colspan="2"| Block Light array count
  |colspan="2"| Has Display Name
+
  | colspan="2"| {{Type|VarInt}}
|colspan="2"| Boolean
+
  | Number of entries in the following array; should match the number of bits set in Block Light Mask
  |  
 
 
  |-
 
  |-
  |colspan="2"| Display Name
+
  | rowspan="2"| Block Light arrays
  |colspan="2"| Optional [[Chat]]
+
  | Length
  | Only send if Has Display Name is true
+
| rowspan="2"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | 4: remove player
+
  | Block Light array
  |colspan="2"| ''no fields''
+
  | {{Type|Byte Array}} (2048)
  |colspan="2"| ''no fields''
+
  | 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. Indexed <code><nowiki>((y<<8) | (z<<4) | x) / 2 </nowiki></code> If there's a remainder, masked 0xF0 else 0x0F.
|
 
 
  |}
 
  |}
  
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.
+
Unlike the [[#Update Light|Update Light]] packet which uses the same format, setting the bit corresponding to a section to 0 in both of the block light or sky light masks does not appear to be useful, and the results in testing have been highly inconsistent.
  
==== Player Position And Look (clientbound) ====  
+
==== World Event ====
 
+
Sent when a client is to play a sound or particle effect.
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.
+
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), effect 1028 (enderdragon death), and effect 1038 (end portal opening); it is ignored on other effects.
 
 
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 2,800: Line 3,147:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x2F
+
  | rowspan="4"| 0x26
  |rowspan="7"| Play
+
  | rowspan="4"| Play
  |rowspan="7"| Client
+
  | rowspan="4"| Client
  | X
+
  | Event
  | Double
+
  | {{Type|Int}}
  | Absolute or relative position, depending on Flags
+
  | The event, see below.
 
  |-
 
  |-
  | Y
+
  | Location
  | Double
+
  | {{Type|Position}}
  | Absolute or relative position, depending on Flags
+
  | The location of the event.
 
  |-
 
  |-
  | Z
+
  | Data
  | Double
+
  | {{Type|Int}}
  | Absolute or relative position, depending on Flags
+
  | Extra data for certain events, see below.
 
  |-
 
  |-
  | Yaw
+
  | Disable Relative Volume
  | Float
+
  | {{Type|Boolean}}
| Absolute or relative rotation on the X axis, in degrees
+
  | See above.
|-
 
| Pitch
 
| Float
 
| Absolute or relative rotation on the Y axis, in degrees
 
|-
 
| Flags
 
| Byte
 
| Bit field, see below
 
|-
 
  | Teleport ID
 
| VarInt
 
| Client should confirm this packet with [[#Teleport Confirm|Teleport Confirm]] containing the same Teleport ID
 
 
  |}
 
  |}
  
About the Flags field:
+
Events:
 
 
<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! ID
 +
! Name
 +
! Data
 
  |-
 
  |-
  ! Field
+
  ! colspan="3"| Sound
! Bit
 
 
  |-
 
  |-
  | X
+
  | 1000
  | 0x01
+
| Dispenser dispenses
 +
  |
 
  |-
 
  |-
  | Y
+
  | 1001
  | 0x02
+
| Dispenser fails to dispense
 +
  |
 
  |-
 
  |-
  | Z
+
  | 1002
  | 0x04
+
| Dispenser shoots
 +
  |
 
  |-
 
  |-
  | Y_ROT
+
  | 1003
  | 0x08
+
| Ender eye launched
 +
  |
 
  |-
 
  |-
  | X_ROT
+
  | 1004
  | 0x10
+
  | Firework shot
  |}
+
  |
 
 
==== Use Bed ====
 
 
 
This packet tells that a player goes to bed.
 
 
 
The client with the matching Entity ID will go into bed mode.
 
 
 
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"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x30
+
  | 1009
|rowspan="2"| Play
+
  | Fire extinguished
|rowspan="2"| Client
+
  |
| Entity ID
 
  | VarInt
 
  | Sleeping player's EID
 
 
  |-
 
  |-
  | Location
+
  | 1010
  | Position
+
  | Play record
  | Block location of the head part of the bed
+
  | An ID in the <code>minecraft:item</code> registry, corresponding to a {{Minecraft Wiki|Music Disc|record item}}. If the ID doesn't correspond to a record, the packet is ignored. Any record already being played at the given location is overwritten. See [[Data Generators]] for information on item IDs.
|}
 
 
 
==== Unlock Recipes ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="8"| 0x31
+
  | 1011
  |rowspan="8"| Play
+
  | Stop record
  |rowspan="8"| Client
+
  |  
 
  |-
 
  |-
  | Action
+
  | 1015
  | VarInt
+
  | Ghast warns
  | 0: init, 1: add, 2: remove
+
  |
 
  |-
 
  |-
  | Crafting Book Open
+
  | 1016
  | Boolean
+
  | Ghast shoots
  | If true, then the crafting book will be open when the player opens its inventory.
+
  |
 
  |-
 
  |-
  | Filtering Craftable
+
  | 1017
  | Boolean
+
  | Enderdragon shoots
  | If true, then the filtering option is active when the players opens its inventory.
+
  |
 
  |-
 
  |-
  | Array size 1
+
  | 1018
  | VarInt
+
  | Blaze shoots
  | Number of elements in the following array
+
  |
 
  |-
 
  |-
  | Recipe IDs
+
  | 1019
  | Array of VarInt
+
  | Zombie attacks wood door
 
  |
 
  |
 
  |-
 
  |-
  | Array size 2
+
  | 1020
  | Optional VarInt
+
  | Zombie attacks iron door
  | Number of elements in the following array, only present if mode is 0 (init)
+
  |
 
  |-
 
  |-
  | Recipe IDs
+
  | 1021
  | Optional Array of VarInt, only present if mode is 0 (init)
+
  | Zombie breaks wood door
 +
|
 +
|-
 +
| 1022
 +
| Wither breaks block
 
  |
 
  |
|}
 
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.
 
 
Recipe ID:
 
These are hardcoded values in the client and server, all the recipe json files will be loaded in a specific order (alphabetical, like sounds) and internal ids will be assigned in that order. There are also inbuilt recipes like fireworks, banners, etc., these are the first recipes to have their id assigned. Due the fact that the recipes are loaded in a specific order will the ids very likely change when recipes get added. [https://twitter.com/dinnerbone/status/856505341479145472 Custom recipes are scheduled for Minecraft 1.13], so most likely will things change a bit in that version.
 
 
==== Destroy Entities ====
 
 
Sent by the server when a list of entities is to be destroyed on the client.
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x32
+
  | 1023
|rowspan="2"| Play
+
  | Wither spawned
|rowspan="2"| Client
+
  |
| Count
 
  | VarInt
 
  | Number of elements in the following array
 
 
  |-
 
  |-
  | Entity IDs
+
  | 1024
  | Array of VarInt
+
  | Wither shoots
  | The list of entities of destroy
+
  |
|}
 
 
 
==== Remove Entity Effect ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x33
+
  | 1025
|rowspan="2"| Play
+
  | Bat takes off
|rowspan="2"| Client
+
  |
| Entity ID
 
  | VarInt
 
  |  
 
 
  |-
 
  |-
  | Effect ID
+
  | 1026
  | Byte
+
  | Zombie infects
  | See {{Minecraft Wiki|Status effect#List of effects|this table}}
+
  |
|}
 
 
 
==== Resource Pack Send ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x34
+
  | 1027
|rowspan="2"| Play
+
  | Zombie villager converted
|rowspan="2"| Client
+
  |
| URL
 
  | String (32767)
 
  | The URL to the resource pack.
 
 
  |-
 
  |-
  | Hash
+
  | 1028
  | String (40)
+
  | Ender dragon death
  | 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
+
  |
|}
 
 
 
==== Respawn ====
 
 
 
To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x35
+
  | 1029
|rowspan="4"| Play
+
  | Anvil destroyed
|rowspan="4"| Client
+
  |
| Dimension
 
  | Int Enum
 
  | -1: The Nether, 0: The Overworld, 1: The End
 
 
  |-
 
  |-
  | Difficulty
+
  | 1030
  | Unsigned Byte
+
  | Anvil used
  | 0: Peaceful, 1: Easy, 2: Normal, 3: Hard
+
  |
 
  |-
 
  |-
  | Gamemode
+
  | 1031
  | Unsigned Byte
+
  | Anvil landed
  | 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
+
  |
 
  |-
 
  |-
  | Level Type
+
  | 1032
  | String (16)
+
  | Portal travel
  | 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).
 
 
 
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.}}
 
 
 
==== Entity Head Look ====
 
 
 
Changes the direction an entity's head is facing.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x36
+
  | 1033
|rowspan="2"| Play
+
  | Chorus flower grown
|rowspan="2"| Client
+
  |
| Entity ID
 
  | VarInt
 
  |  
 
 
  |-
 
  |-
  | Head Yaw
+
  | 1034
  | Angle
+
  | Chorus flower died
  | New angle, not a delta
+
  |
|}
 
 
 
==== Select Advancement Tab ====
 
 
 
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.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x37
+
  | 1035
|rowspan="2"| Play
+
  | Brewing stand brewed
|rowspan="2"| Client
+
  |
| Has id
 
  | Boolean
 
  | Indicates if the next field is present
 
 
  |-
 
  |-
  | Optional Identifier
+
  | 1036
  | String (32767)
+
  | Iron trapdoor opened
  | See below
+
  |
|}
 
 
 
The Identifier can be one of the following:
 
 
 
{| class="wikitable"
 
! Optional Identifier
 
 
  |-
 
  |-
  | minecraft:story/root
+
  | 1037
 +
| Iron trapdoor closed
 +
|
 
  |-
 
  |-
  | minecraft:nether/root
+
  | 1038
 +
| End portal created in overworld
 +
|
 
  |-
 
  |-
  | minecraft:end/root
+
  | 1039
 +
| Phantom bites
 +
|
 
  |-
 
  |-
  | minecraft:adventure/root
+
  | 1040
 +
| Zombie converts to drowned
 +
|
 
  |-
 
  |-
  | minecraft:husbandry/root
+
  | 1041
  |}
+
  | Husk converts to zombie by drowning
 
+
  |
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
 
 
 
==== World Border ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
  ! State
 
! Bound To
 
!colspan="2"| Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="18"| 0x38
+
  | 1042
|rowspan="18"| Play
+
  | Grindstone used
|rowspan="18"| Client
+
  |
|colspan="2"| Action
 
  | VarInt Enum
 
  | Determines the format of the rest of the packet
 
 
  |-
 
  |-
  ! Action
+
  | 1043
  ! Field Name
+
  | Book page turned
  !
+
  |
!
 
 
  |-
 
  |-
| 0: set size
 
| Diameter
 
| Double
 
| Length of a single side of the world border, in meters
 
 
  |-
 
  |-
  |rowspan="3"| 1: lerp size
+
  ! colspan="3"| Particle
| Old Diameter
 
| Double
 
| Current length of a single side of the world border, in meters
 
 
  |-
 
  |-
  | New Diameter
+
  | 1500
  | Double
+
  | Composter composts
  | Target length of a single side of the world border, in meters
+
  |
 
  |-
 
  |-
  | Speed
+
  | 1501
  | VarLong
+
  | Lava converts block (either water to stone, or removes existing blocks such as torches)
  | 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.
+
  |
 
  |-
 
  |-
  |rowspan="2"| 2: set center
+
  | 1502
| X
+
  | Redstone torch burns out
  | Double
+
  |
  |  
 
 
  |-
 
  |-
  | Z
+
  | 1503
  | Double
+
  | Ender eye placed
  |  
+
  |
 
  |-
 
  |-
  |rowspan="8"| 3: initialize
+
  | 2000
  | X
+
| Spawns 10 smoke particles, e.g. from a fire
  | Double
+
| Direction, see below.
  |  
+
|-
 +
| 2001
 +
| Block break + block break sound
 +
| Block state ID (see [[Chunk Format#Block state registry]]).
 +
|-
 +
  | 2002
 +
  | Splash potion. Particle effect + glass break sound.
 +
  | RGB color as an integer (e.g. 8364543 for #7FA1FF).
 
  |-
 
  |-
  | Z
+
  | 2003
  | Double
+
  | Eye of Ender entity break animation — particles and sound
  |  
+
  |
 
  |-
 
  |-
  | Old Diameter
+
  | 2004
  | Double
+
  | Mob spawn particle effect: smoke + flames
  | Current length of a single side of the world border, in meters
+
  |
 
  |-
 
  |-
  | New Diameter
+
  | 2005
  | Double
+
  | Bonemeal particles
  | Target length of a single side of the world border, in meters
+
  | How many particles to spawn (if set to 0, 15 are spawned).
 
  |-
 
  |-
  | Speed
+
  | 2006
  | VarLong
+
  | Dragon breath
  | 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.
+
  |
 
  |-
 
  |-
  | Portal Teleport Boundary
+
  | 2007
  | VarInt
+
  | Instant splash potion. Particle effect + glass break sound.
  | Resulting coordinates from a portal teleport are limited to ±value. Usually 29999984.
+
  | RGB color as an integer (e.g. 8364543 for #7FA1FF).
 
  |-
 
  |-
  | Warning Time
+
  | 2008
  | VarInt
+
  | Ender dragon destroys block
  | In seconds as set by <code>/worldborder warning time</code>
+
  |
 
  |-
 
  |-
  | Warning Blocks
+
  | 2009
  | VarInt
+
  | Wet sponge vaporizes in nether
  | In meters
+
  |
 
  |-
 
  |-
  |rowspan="1"| 4: set warning time
+
  | 3000
| Warning Time
+
  | End gateway spawn
  | VarInt
+
  |
  | In seconds as set by <code>/worldborder warning time</code>
 
 
  |-
 
  |-
  |rowspan="1"| 5: set warning blocks
+
  | 3001
  | Warning Blocks
+
| Enderdragon growl
  | VarInt
+
|
  | In meters
+
  |-
  |}
+
  | 3002
 
+
  | Electric spark
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:
+
  |
 
+
|-
<syntaxhighlight lang="java">
+
| 3003
distance = max(min(resizeSpeed * 1000 * warningTime, abs(targetDiameter - currentDiameter)), warningDistance);
+
| Copper apply wax
if (playerDistance < distance) {
+
|
    warning = 1.0 - playerDistance / distance;
+
|-
} else {
+
| 3004
    warning = 0.0;
+
| Copper remove wax
}
+
|
</syntaxhighlight>
+
|-
 +
| 3005
 +
| Copper scrape oxidation
 +
|
 +
|}
  
==== Camera ====
+
Smoke directions:
  
Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.
+
{| class="wikitable"
 +
! ID
 +
! Direction
 +
|-
 +
| 0
 +
| Down
 +
|-
 +
| 1
 +
| Up
 +
|-
 +
| 2
 +
| North
 +
|-
 +
| 3
 +
| South
 +
|-
 +
| 4
 +
| West
 +
|-
 +
| 5
 +
| East
 +
|}
  
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).
+
==== Particle ====
  
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.
+
Displays the named particle
 
 
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).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,229: Line 3,445:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x39
+
  | rowspan="11"| 0x27
  |rowspan="1"| Play
+
  | rowspan="11"| Play
  |rowspan="1"| Client
+
  | rowspan="11"| Client
  | Camera ID
+
  | Particle ID
  | VarInt
+
  | {{Type|VarInt}}
  | ID of the entity to set the client's camera to
+
  | The particle ID listed in [[Particles]].
 +
|-
 +
| Long Distance
 +
| {{Type|Boolean}}
 +
| If true, particle distance increases from 256 to 65536.
 +
|-
 +
| X
 +
| {{Type|Double}}
 +
| X position of the particle.
 +
|-
 +
| Y
 +
| {{Type|Double}}
 +
| Y position of the particle.
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
| Z position of the particle.
 +
|-
 +
| Offset X
 +
| {{Type|Float}}
 +
| This is added to the X position after being multiplied by <code>random.nextGaussian()</code>.
 +
|-
 +
| Offset Y
 +
| {{Type|Float}}
 +
| This is added to the Y position after being multiplied by <code>random.nextGaussian()</code>.
 +
|-
 +
| Offset Z
 +
| {{Type|Float}}
 +
| This is added to the Z position after being multiplied by <code>random.nextGaussian()</code>.
 +
|-
 +
| Max Speed
 +
| {{Type|Float}}
 +
|
 +
|-
 +
| Particle Count
 +
| {{Type|Int}}
 +
| The number of particles to create.
 +
|-
 +
| Data
 +
| Varies
 +
| Particle data as specified in [[Particles]].
 
  |}
 
  |}
  
The notchian also loads certain shaders for given entities:
+
==== Update Light ====
  
* Creeper &rarr; <code>shaders/post/creeper.json</code>
+
Updates light levels for a chunk. See {{Minecraft Wiki|Light}} for information on how lighting works in Minecraft.
* Spider (and cave spider) &rarr; <code>shaders/post/spider.json</code>
 
* Enderman &rarr; <code>shaders/post/invert.json</code>
 
* Anything else &rarr; the current shader is unloaded
 
 
 
==== Held Item Change (clientbound) ====
 
 
 
Sent to change the player's slot selection.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,252: Line 3,501:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x3A
+
  | rowspan="12"| 0x28
  |rowspan="1"| Play
+
  | rowspan="12"| Play
  |rowspan="1"| Client
+
  | rowspan="12"| Client
  | Slot
+
  | colspan="2"| Chunk X
  | Byte
+
| colspan="2"| {{Type|VarInt}}
  | The slot which the player has selected (0–8)
+
| Chunk coordinate (block coordinate divided by 16, rounded down)
 +
|-
 +
| colspan="2"| Chunk Z
 +
| colspan="2"| {{Type|VarInt}}
 +
| Chunk coordinate (block coordinate divided by 16, rounded down)
 +
|-
 +
| colspan="2"| Sky Light Mask
 +
  | colspan="2"| {{Type|BitSet}}
 +
| BitSet containing bits for each section in the world + 2.  Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Sky Light array below.  The least significant bit is for blocks 16 blocks to 1 block below the min world height (one section below the world), while the most significant bit covers blocks 1 to 16 blocks above the max world height (one section above the world).
 +
|-
 +
| colspan="2"| Block Light Mask
 +
| colspan="2"| {{Type|BitSet}}
 +
  | BitSet containing bits for each section in the world + 2.  Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Block Light array below.  The order of bits is the same as in Sky Light Mask.
 +
|-
 +
| colspan="2"| Empty Sky Light Mask
 +
| colspan="2"| {{Type|BitSet}}
 +
| BitSet containing bits for each section in the world + 2.  Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Sky Light data.  The order of bits is the same as in Sky Light Mask.
 +
|-
 +
| colspan="2"| Empty Block Light Mask
 +
| colspan="2"| {{Type|BitSet}}
 +
| BitSet containing bits for each section in the world + 2.  Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Block Light data.  The order of bits is the same as in Sky Light Mask.
 +
|-
 +
| colspan="2"| Sky Light array count
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of entries in the following array; should match the number of bits set in Sky Light Mask
 +
|-
 +
| rowspan="2"| Sky Light arrays
 +
| Length
 +
| rowspan="2"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
| Length of the following array in bytes (always 2048)
 +
|-
 +
| Sky Light array
 +
| {{Type|Byte Array}} (2048)
 +
| 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.
 +
|-
 +
| colspan="2"| Block Light array count
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of entries in the following array; should match the number of bits set in Block Light Mask
 +
|-
 +
| rowspan="2"| Block Light arrays
 +
| Length
 +
| rowspan="2"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
| Length of the following array in bytes (always 2048)
 +
|-
 +
| Block Light array
 +
| {{Type|Byte Array}} (2048)
 +
| 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.
 
  |}
 
  |}
  
==== Display Scoreboard ====
+
A bit will never be set in both the block light mask and the empty block light mask, though it may be present in neither of them (if the block light does not need to be updated for the corresponding chunk section).  The same applies to the sky light mask and the empty sky light mask.
  
This is sent to the client when it should display a scoreboard.
+
==== Login (play) ====
 +
 
 +
{{Need Info|Although the number of portal cooldown ticks is included in this packet, the whole portal usage process is still dictated entirely by the server. What kind of effect does this value have on the client, if any?}}
 +
 
 +
See [[Protocol Encryption]] for information on logging in.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,276: Line 3,577:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x3B
+
  | rowspan="21"| 0x29
  |rowspan="2"| Play
+
  | rowspan="21"| Play
  |rowspan="2"| Client
+
  | rowspan="21"| Client
  | Position
+
  | Entity ID
  | Byte
+
| {{Type|Int}}
  | The position of the scoreboard. 0: list, 1: sidebar, 2: below name.
+
| The player's Entity ID (EID).
 +
|-
 +
| Is hardcore
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Dimension Count
 +
| {{Type|VarInt}}
 +
| Size of the following array.
 +
|-
 +
| Dimension Names
 +
| {{Type|Array}} of {{Type|Identifier}}
 +
| Identifiers for all dimensions on the server.
 +
|-
 +
| Max Players
 +
| {{Type|VarInt}}
 +
| Was once used by the client to draw the player list, but now is ignored.
 +
|-
 +
| View Distance
 +
| {{Type|VarInt}}
 +
| Render distance (2-32).
 +
|-
 +
| Simulation Distance
 +
| {{Type|VarInt}}
 +
| The distance that the client will process specific things, such as entities.
 +
|-
 +
| Reduced Debug Info
 +
| {{Type|Boolean}}
 +
| If true, a Notchian client shows reduced information on the {{Minecraft Wiki|debug screen}}.  For servers in development, this should almost always be false.
 +
|-
 +
| Enable respawn screen
 +
| {{Type|Boolean}}
 +
| Set to false when the doImmediateRespawn gamerule is true.
 +
|-
 +
| Do limited crafting
 +
| {{Type|Boolean}}
 +
| Whether players can only craft recipes they have already unlocked. Currently unused by the client.
 +
|-
 +
| Dimension Type
 +
  | {{Type|Identifier}}
 +
  | The type of dimension in the <code>minecraft:dimension_type</code> registry, defined by the [[Protocol#Registry_Data|Registry Data]] packet.
 +
|-
 +
| Dimension Name
 +
| {{Type|Identifier}}
 +
| Name of the dimension being spawned into.
 +
|-
 +
| Hashed seed
 +
| {{Type|Long}}
 +
| First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
 +
|-
 +
| Game mode
 +
| {{Type|Unsigned Byte}}
 +
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
 +
|-
 +
| Previous Game mode
 +
| {{Type|Byte}}
 +
| -1: Undefined (null), 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. The previous game mode. Vanilla client uses this for the debug (F3 + N & F3 + F4) game mode switch. (More information needed)
 +
|-
 +
| Is Debug
 +
| {{Type|Boolean}}
 +
| True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
 +
|-
 +
| Is Flat
 +
| {{Type|Boolean}}
 +
| True if the world is a {{Minecraft Wiki|superflat}} world; flat worlds have different void fog and a horizon at y=0 instead of y=63.
 +
|-
 +
| Has death location
 +
| {{Type|Boolean}}
 +
| If true, then the next two fields are present.
 +
|-
 +
| Death dimension name
 +
| {{Type|Optional}} {{Type|Identifier}}
 +
| Name of the dimension the player died in.
 +
|-
 +
| Death location
 +
| {{Type|Optional}} {{Type|Position}}
 +
| The location that the player died at.
 
  |-
 
  |-
  | Score Name
+
  | Portal cooldown
  | String (16)
+
  | {{Type|VarInt}}
  | The unique name for the scoreboard to be displayed.
+
  | The number of ticks until the player can use the portal again.
 
  |}
 
  |}
  
==== Entity Metadata ====
+
==== Map Data ====
  
Updates one or more [[Entities#Entity Metadata Format|metadata]] properties for an existing entity. Any properties not included in the Metadata field are left unchanged.
+
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,296: Line 3,673:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x3C
+
  | rowspan="17"| 0x2A
  |rowspan="2"| Play
+
  | rowspan="17"| Play
  |rowspan="2"| Client
+
  | rowspan="17"| Client
  | Entity ID
+
  | colspan="2"| Map ID
  | VarInt
+
  | colspan="2"| {{Type|VarInt}}
  |  
+
| Map ID of the map being modified
 +
|-
 +
| colspan="2"| Scale
 +
| colspan="2"| {{Type|Byte}}
 +
| From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
 +
|-
 +
| colspan="2"| Locked
 +
| colspan="2"| {{Type|Boolean}}
 +
  | True if the map has been locked in a cartography table
 
  |-
 
  |-
  | Metadata
+
  | colspan="2"| Has Icons
  | [[Entities#Entity Metadata Format|Entity Metadata]]
+
  | colspan="2"| {{Type|Boolean}}
  |  
+
  |
  |}
+
  |-
 
+
| colspan="2"| Icon Count
==== Attach Entity ====
+
| colspan="2"| {{Type|Optional}} {{Type|VarInt}}
 
+
| Number of elements in the following array. Only present if previous Boolean is true.
This packet is sent when an entity has been {{Minecraft Wiki|Lead|leashed}} to another entity.
+
|-
 
+
| rowspan="6"| Icon
{| class="wikitable"
+
| Type
  ! Packet ID
+
| rowspan="6"| {{Type|Optional}} {{Type|Array}}
  ! State
+
| {{Type|VarInt}} {{Type|Enum}}
  ! Bound To
+
| See below
  ! Field Name
+
|-
  ! Field Type
+
| X
  ! Notes
+
| {{Type|Byte}}
 +
| Map coordinates: -128 for furthest left, +127 for furthest right
 +
|-
 +
| Z
 +
| {{Type|Byte}}
 +
| Map coordinates: -128 for highest, +127 for lowest
 +
|-
 +
| Direction
 +
| {{Type|Byte}}
 +
| 0-15
 +
|-
 +
| Has Display Name
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Display Name
 +
| {{Type|Optional}} {{Type|Text Component}}
 +
| Only present if previous Boolean is true
 +
|-
 +
| colspan="2"| Columns
 +
| colspan="2"| {{Type|Unsigned Byte}}
 +
| Number of columns updated
 +
|-
 +
| colspan="2"| Rows
 +
| colspan="2"| {{Type|Optional}} {{Type|Unsigned Byte}}
 +
| Only if Columns is more than 0; number of rows updated
 +
|-
 +
| colspan="2"| X
 +
  | colspan="2"| {{Type|Optional}} {{Type|Byte}}
 +
  | Only if Columns is more than 0; x offset of the westernmost column
 +
  |-
 +
  | colspan="2"| Z
 +
  | colspan="2"| {{Type|Optional}} {{Type|Byte}}
 +
  | Only if Columns is more than 0; z offset of the northernmost row
 
  |-
 
  |-
  |rowspan="2"| 0x3D
+
  | colspan="2"| Length
  |rowspan="2"| Play
+
  | colspan="2"| {{Type|Optional}} {{Type|VarInt}}
|rowspan="2"| Client
+
  | Only if Columns is more than 0; length of the following array
| Attached Entity ID
 
| Int
 
  | Attached entity's EID
 
 
  |-
 
  |-
  | Holding Entity ID
+
  | colspan="2"| Data
  | Int
+
  | colspan="2"| {{Type|Optional}} {{Type|Array}} of {{Type|Unsigned Byte}}
  | ID of the entity holding the lead. Set to -1 to detach.
+
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
 
  |}
 
  |}
  
==== Entity Velocity ====
+
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
  
Velocity is believed to be in units of 1/8000 of a block per server tick (50ms); for example, -1343 would move (-1343 / 8000) = −0.167875 blocks per tick (or −3,3575 blocks per second).
+
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="4"| 0x3E
+
  ! Icon type
  |rowspan="4"| Play
+
  ! Result
|rowspan="4"| Client
 
| Entity ID
 
| VarInt
 
|
 
 
  |-
 
  |-
  | Velocity X
+
  | 0
  | Short
+
  | White arrow (players)
| Velocity on the X axis
 
 
  |-
 
  |-
  | Velocity Y
+
  | 1
  | Short
+
  | Green arrow (item frames)
| Velocity on the Y axis
 
 
  |-
 
  |-
  | Velocity Z
+
  | 2
  | Short
+
  | Red arrow
| Velocity on the Z axis
 
|}
 
 
 
==== Entity Equipment ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x3F
+
  | 3
|rowspan="3"| Play
+
  | Blue arrow
|rowspan="3"| Client
 
| Entity ID
 
| VarInt
 
  | Entity's EID
 
 
  |-
 
  |-
  | Slot
+
  | 4
  | VarInt Enum
+
  | White cross
| Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet)
 
 
  |-
 
  |-
  | Item
+
  | 5
  | [[Slot Data|Slot]]
+
  | Red pointer
|
 
|}
 
 
 
==== Set Experience ====
 
 
 
Sent by the server when the client should change experience levels.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x40
+
  | 6
|rowspan="3"| Play
+
  | White circle (off-map players)
|rowspan="3"| Client
 
| Experience bar
 
| Float
 
  | Between 0 and 1
 
 
  |-
 
  |-
  | Level
+
  | 7
| VarInt
+
  | Small white circle (far-off-map players)
  |  
 
 
  |-
 
  |-
  | Total Experience
+
  | 8
  | VarInt
+
  | Mansion
| See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion
 
|}
 
 
 
==== Update Health ====
 
 
 
Sent by the server to update/set the health of the player it is sent to.
 
 
 
Food {{Minecraft Wiki|Food#Hunger vs. Saturation|saturation}} acts as a food “overcharge”. Food values will not decrease while the saturation is over zero. Players logging in automatically get a saturation of 5.0. Eating food increases the saturation as well as the food bar.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x41
+
  | 9
|rowspan="3"| Play
+
  | Temple
|rowspan="3"| Client
 
| Health
 
| Float
 
  | 0 or less = dead, 20 = full HP
 
 
  |-
 
  |-
  | Food
+
  | 10
  | VarInt
+
  | White Banner
| 0–20
 
|-
 
| Food Saturation
 
| Float
 
| Seems to vary from 0.0 to 5.0 in integer increments
 
|}
 
 
 
==== Scoreboard Objective ====
 
 
 
This is sent to the client when it should create a new {{Minecraft Wiki|scoreboard}} objective or remove one.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x42
+
  | 11
|rowspan="4"| Play
+
  | Orange Banner
|rowspan="4"| Client
 
| Objective Name
 
| String (16)
 
  | An unique name for the objective
 
 
  |-
 
  |-
  | Mode
+
  | 12
  | Byte
+
  | Magenta Banner
| 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
 
 
  |-
 
  |-
  | Objective Value
+
  | 13
  | Optional String (32)
+
  | Light Blue Banner
| Only if mode is 0 or 2. The text to be displayed for the score
 
 
  |-
 
  |-
  | Type
+
  | 14
  | Optional String (16)
+
| Yellow Banner
  | Only if mode is 0 or 2. “integer” or “hearts”
+
|-
  |}
+
| 15
 
+
| Lime Banner
==== Set Passengers ====
+
|-
 
+
  | 16
{| class="wikitable"
+
  | Pink Banner
  ! Packet ID
+
|-
  ! State
+
| 17
  ! Bound To
+
| Gray Banner
  ! Field Name
+
|-
  ! Field Type
+
| 18
  ! Notes
+
  | Light Gray Banner
 +
|-
 +
| 19
 +
| Cyan Banner
 +
|-
 +
  | 20
 +
  | Purple Banner
 +
  |-
 +
  | 21
 +
  | Blue Banner
 +
  |-
 +
| 22
 +
| Brown Banner
 +
|-
 +
| 23
 +
| Green Banner
 
  |-
 
  |-
  |rowspan="3"| 0x43
+
  | 24
|rowspan="3"| Play
+
  | Red Banner
|rowspan="3"| Client
 
| Entity ID
 
| VarInt
 
  | Vehicle's EID
 
 
  |-
 
  |-
  | Passenger Count
+
  | 25
  | VarInt
+
  | Black Banner
| Number of elements in the following array
 
 
  |-
 
  |-
  | Passengers
+
  | 26
  | Array of VarInt
+
  | Treasure marker
| EIDs of entity's passengers
 
 
  |}
 
  |}
  
==== Teams ====
+
==== Merchant Offers ====
  
Creates and updates teams.
+
The list of trades a villager NPC is offering.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,518: Line 3,850:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! colspan="2"| Field Name
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="23"| 0x44
+
  | rowspan="16"| 0x2B
  |rowspan="23"| Play
+
  | rowspan="16"| Play
  |rowspan="23"| Client
+
  | rowspan="16"| Client
  |colspan="2"| Team Name
+
  | colspan="2"| Window ID
  | String (16)
+
  | colspan="2"| {{Type|VarInt}}
  | A unique name for the team. (Shared with scoreboard).
+
  | The ID of the window that is open; this is an int rather than a byte.
 
  |-
 
  |-
  |colspan="2"| Mode
+
  | colspan="2"| Size
  | Byte
+
  | colspan="2"| {{Type|VarInt}}
  | Determines the layout of the remaining packet
+
  | The number of trades in the following array.
 
  |-
 
  |-
  |rowspan="9"| 0: create team
+
  | rowspan="10"| Trades
  | Team Display Name
+
  | Input item 1
  | String (32)
+
  | rowspan="10"| {{Type|Array}}
  |  
+
| {{Type|Slot}}
 +
  | The first item the player has to supply for this villager trade. The count of the item stack is the default "price" of this trade.
 
  |-
 
  |-
  | Team Prefix
+
  | Output item
  | String (16)
+
  | {{Type|Slot}}
  | Displayed before the names of players that are part of this team
+
  | The item the player will receive from this villager trade.
 
  |-
 
  |-
  | Team Suffix
+
  | Input item 2
  | String (16)
+
  | {{Type|Slot}}
  | Displayed after the names of players that are part of this team
+
  | The second item the player has to supply for this villager trade. May be an empty slot.
 
  |-
 
  |-
  | Friendly Flags
+
  | Trade disabled
  | Byte
+
  | {{Type|Boolean}}
  | Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team
+
  | True if the trade is disabled; false if the trade is enabled.
 
  |-
 
  |-
  | Name Tag Visibility
+
  | Number of trade uses
  | String Enum (32)
+
  | {{Type|Int}}
  | <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
+
  | Number of times the trade has been used so far. If equal to the maximum number of trades, the client will display a red X.
 
  |-
 
  |-
  | Collision Rule
+
  | Maximum number of trade uses
  | String Enum (32)
+
  | {{Type|Int}}
  | <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
+
  | Number of times this trade can be used before it's exhausted.
 
  |-
 
  |-
  | Color
+
  | XP
  | Byte
+
  | {{Type|Int}}
  | For colors, the same [[Chat]] colors (0-15).  -1 indicates RESET/no color.
+
  | Amount of XP the villager will earn each time the trade is used.
 
  |-
 
  |-
  | Entity Count
+
  | Special Price
  | VarInt
+
  | {{Type|Int}}
  | Number of elements in the following array
+
  | Can be zero or negative. The number is added to the price when an item is discounted due to player reputation or other effects.
 
  |-
 
  |-
  | Entities
+
  | Price Multiplier
  | Array of String (40)
+
  | {{Type|Float}}
  | Identifiers for the entities in this team. For players, this is their username; for other entities, it is their UUID.
+
  | Can be low (0.05) or high (0.2). Determines how much demand, player reputation, and temporary effects will adjust the price.
 
  |-
 
  |-
  | 1: remove team
+
  | Demand
  | ''no fields''
+
  | {{Type|Int}}
| ''no fields''
+
  | If positive, causes the price to increase. Negative values seem to be treated the same as zero.
  |  
 
 
  |-
 
  |-
  |rowspan="7"| 2: update team info
+
  | colspan="2"| Villager level
  | Team Display Name
+
  | colspan="2"| {{Type|VarInt}}
  | String (32)
+
  | 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.
 
  |-
 
  |-
  | Team Prefix
+
  | colspan="2"| Experience
  | String (16)
+
  | colspan="2"| {{Type|VarInt}}
  | Displayed before the names of entities that are part of this team
+
  | Total experience for this villager (always 0 for the wandering trader).
 
  |-
 
  |-
  | Team Suffix
+
  | colspan="2"| Is regular villager
  | String (16)
+
  | colspan="2"| {{Type|Boolean}}
  | Displayed after the names of entities that are part of this team
+
  | True if this is a regular villager; false for the wandering trader.  When false, hides the villager level and some other GUI elements.
 
  |-
 
  |-
  | Friendly Flags
+
  | colspan="2"| Can restock
| Byte
+
  | colspan="2"| {{Type|Boolean}}
| Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible entities on same team
+
  | 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.
|-
 
| Name Tag Visibility
 
| String Enum (32)
 
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
 
|-
 
| Collision Rule
 
| String Enum (32)
 
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 
|-
 
| Color
 
| Byte
 
| For colors, the same [[Chat]] colors (0-15).  -1 indicates RESET/no color.
 
|-
 
|rowspan="2"| 3: add players to team
 
  | Entity Count
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Entities
 
| Array of String (40)
 
| Identifiers for the entities added.  For players, this is their username; for other entities, it is their UUID.
 
|-
 
|rowspan="2"| 4: remove players from team
 
| Entity Count
 
  | VarInt
 
| Number of elements in the following array
 
|-
 
| Entities
 
| Array of String (40)
 
| Identifiers for the entities removed. For players, this is their username; for other entities, it is their UUID.
 
 
  |}
 
  |}
  
==== Update Score ====
+
Modifiers can increase or decrease the number of items for the first input slot. The second input slot and the output slot never change the nubmer of items. The number of items may never be less than 1, and never more than the stack size. If special price and demand are both zero, only the default price is displayed. If either is non-zero, then the adjusted price is displayed next to the crossed-out default price. The adjusted prices is calculated as follows:
 +
 
 +
Adjusted price = default price + floor(default price x multiplier x demand) + special price
 +
 
 +
[[File:1.14-merchant-slots.png|thumb|The merchant UI, for reference]]
 +
{{-}}
 +
 
 +
==== Update Entity Position ====
  
This is sent to the client when it should update a scoreboard item.  
+
This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks [[#Teleport Entity|Teleport Entity]] 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"
 
{| class="wikitable"
Line 3,635: Line 3,946:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x45
+
  | rowspan="5"| 0x2C
  |rowspan="4"| Play
+
  | rowspan="5"| Play
  |rowspan="4"| Client
+
  | rowspan="5"| Client
  | Entity Name
+
  | Entity ID
  | String (40)
+
  | {{Type|VarInt}}
  | The entity whose score this is. For players, this is their username; for other entities, it is their UUID.
+
|
 +
|-
 +
| Delta X
 +
  | {{Type|Short}}
 +
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>.
 
  |-
 
  |-
  | Action
+
  | Delta Y
  | Byte
+
  | {{Type|Short}}
  | 0 to create/update an item. 1 to remove an item.
+
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>.
 
  |-
 
  |-
  | Objective Name
+
  | Delta Z
  | String (16)
+
  | {{Type|Short}}
  | The name of the objective the score belongs to
+
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>.
 
  |-
 
  |-
  | Value
+
  | On Ground
  | Optional VarInt
+
  | {{Type|Boolean}}
  | The score to be displayed next to the entry. Only sent when Action does not equal 1.
+
  |
 
  |}
 
  |}
  
==== Spawn Position ====
+
==== Update Entity Position and Rotation ====
  
Sent by the server after login to specify the coordinates of the spawn point (the point at which players spawn at, and which the compass points to). It can be sent at any time to update the point compasses point at.
+
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>)
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,667: Line 3,982:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x46
+
  | rowspan="7"| 0x2D
  |rowspan="1"| Play
+
  | rowspan="7"| Play
  |rowspan="1"| Client
+
  | rowspan="7"| Client
  | Location
+
  | Entity ID
  | Position
+
  | {{Type|VarInt}}
  | Spawn location
+
|
 +
|-
 +
| Delta X
 +
| {{Type|Short}}
 +
| Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>.
 +
|-
 +
| Delta Y
 +
| {{Type|Short}}
 +
| Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>.
 +
|-
 +
| Delta Z
 +
| {{Type|Short}}
 +
| Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>.
 +
|-
 +
| Yaw
 +
| {{Type|Angle}}
 +
| New angle, not a delta.
 +
|-
 +
| Pitch
 +
| {{Type|Angle}}
 +
| New angle, not a delta.
 +
|-
 +
| On Ground
 +
| {{Type|Boolean}}
 +
  |
 
  |}
 
  |}
  
==== Time Update ====
+
==== Update Entity Rotation ====
  
Time is based on ticks, where 20 ticks happen every second. There are 24000 ticks in a day, making Minecraft days exactly 20 minutes long.
+
This packet is sent by the server when an entity rotates.
 
 
The time of day is based on the timestamp modulo 24000. 0 is sunrise, 6000 is noon, 12000 is sunset, and 18000 is midnight.
 
 
 
The default SMP server increments the time by <code>20</code> every second.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,691: Line 4,026:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x47
+
  | rowspan="4"| 0x2E
  |rowspan="2"| Play
+
  | rowspan="4"| Play
  |rowspan="2"| Client
+
  | rowspan="4"| Client
  | World Age
+
  | Entity ID
  | Long
+
  | {{Type|VarInt}}
  | In ticks; not changed by server commands
+
|
 +
|-
 +
| Yaw
 +
| {{Type|Angle}}
 +
| New angle, not a delta.
 +
|-
 +
| Pitch
 +
| {{Type|Angle}}
 +
  | New angle, not a delta.
 
  |-
 
  |-
  | Time of day
+
  | On Ground
  | Long
+
  | {{Type|Boolean}}
  | The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time
+
  |
 
  |}
 
  |}
  
==== Title ====
+
==== Move Vehicle ====
 +
 
 +
Note that all fields use absolute positioning and do not allow for relative positioning.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,709: Line 4,054:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="10"| 0x48
+
  | rowspan="5"| 0x2F
  |rowspan="10"| Play
+
  | rowspan="5"| Play
  |rowspan="10"| Client
+
  | rowspan="5"| Client
  |colspan="2"| Action
+
  | X
  | VarInt Enum
+
  | {{Type|Double}}
  |  
+
  | Absolute position (X coordinate).
 
  |-
 
  |-
  ! Action
+
  | Y
  ! Field Name
+
  | {{Type|Double}}
  !
+
  | Absolute position (Y coordinate).
!
 
 
  |-
 
  |-
  | 0: set title
+
  | Z
  | Title Text
+
  | {{Type|Double}}
| [[Chat]]
+
  | Absolute position (Z coordinate).
  |  
 
 
  |-
 
  |-
  | 1: set subtitle
+
  | Yaw
  | Subtitle Text
+
  | {{Type|Float}}
| [[Chat]]
+
  | Absolute rotation on the vertical axis, in degrees.
|
 
|-
 
| 2: set action bar
 
| Action bar text
 
| [[Chat]]
 
  | Displays a message above the hotbar (the same as position 2 in [[#Chat Message (clientbound)|Chat Message (clientbound)]], except that it correctly renders formatted chat. See [https://bugs.mojang.com/browse/MC-119145 MC-119145] for more information.)
 
 
  |-
 
  |-
  |rowspan="3"| 3: set times and display
+
  | Pitch
  | Fade In
+
  | {{Type|Float}}
  | Int
+
  | Absolute rotation on the horizontal axis, in degrees.
  | Ticks to spend fading in
+
  |}
 +
 
 +
==== Open Book ====
 +
 
 +
Sent when a player right clicks with a signed book. This tells the client to open the book GUI.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Stay
+
  | 0x30
  | Int
+
  | Play
  | Ticks to keep the title displayed
+
  | Client
  |-
+
  | Hand
  | Fade Out
+
  | {{Type|VarInt}} {{Type|Enum}}
| Int
+
  | 0: Main hand, 1: Off hand .
| Ticks to spend out, not when to start fading out
 
  |-
 
| 4: hide
 
| ''no fields''
 
| ''no fields''
 
|
 
|-
 
| 5: reset
 
| ''no fields''
 
| ''no fields''
 
|
 
 
  |}
 
  |}
  
“Hide” makes the title disappear, but if you run times again the same title will appear. “Reset” erases the text.
+
==== Open Screen ====
  
The title is visible on screen for Fade In + Stay + Fade Out ticks.
+
This is sent to the client when it should open an inventory, such as a chest, workbench, furnace, or other container. Resending this packet with already existing window id, will update the window title and window type without closing the window.
  
==== Sound Effect ====
+
This message is not sent to clients opening their own inventory, nor do clients inform the server in any way when doing so. From the server's perspective, the inventory is always "open" whenever no other windows are.
  
This packet is used to play a number of hardcoded sound events. For custom sounds, use [[#Named Sound Effect|Named Sound Effect]].
+
For horses, use [[#Open Horse Screen|Open Horse Screen]].
 
 
{{Warning|Numeric sound effect IDs are liable to change between versions}}
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,782: Line 4,118:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x49
+
  | rowspan="3"| 0x31
  |rowspan="7"| Play
+
  | rowspan="3"| Play
  |rowspan="7"| Client
+
  | rowspan="3"| Client
  | Sound ID
+
  | Window ID
  | VarInt
+
  | {{Type|VarInt}}
  | ID of hardcoded sound event ([http://pokechu22.github.io/Burger/1.12.2.html#sounds events] as of 1.12.2)
+
  | An identifier for the window to be displayed. Notchian server implementation is a counter, starting at 1. There can only be one window at a time; this is only used to ignore outdated packets targeting already-closed windows. Note also that the Window ID field in most other packets is only a single byte, and indeed, the Notchian server wraps around after 100.
 
  |-
 
  |-
  | Sound Category
+
  | Window Type
  | VarInt Enum
+
  | {{Type|VarInt}}
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
  | The window type to use for display. Contained in the <code>minecraft:menu</code> registry; see [[Inventory]] for the different values.
 
  |-
 
  |-
  | Effect Position X
+
  | Window Title
  | Int
+
  | {{Type|Text Component}}
  | Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
| 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 Update|Block Update]] first.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Effect Position Y
+
  | rowspan="2" | 0x32
  | Int
+
| rowspan="2" | Play
  | Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
| rowspan="2" | Client
 +
  | Location
 +
  | {{Type|Position}}
 +
|
 
  |-
 
  |-
  | Effect Position Z
+
  | Is Front Text
  | Int
+
  | {{Type|Boolean}}
  | Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Whether the opened editor is for the front or on the back of the sign
|-
 
| Volume
 
| Float
 
| 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients
 
|-
 
| Pitch
 
| Float
 
| Float between 0.5 and 2.0 by Notchian clients
 
 
 
 
  |}
 
  |}
  
==== Player List Header And Footer ====
+
==== Ping (play) ====
  
This packet may be used by custom servers to display additional information above/below the player list. It is never sent by the Notchian server.
+
Packet is not used by the Notchian server. When sent to the client, client responds with a [[#Pong (play)|Pong]] packet with the same id.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,827: Line 4,170:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x4A
+
  | 0x33
  |rowspan="2"| Play
+
  | Play
  |rowspan="2"| Client
+
  | Client
  | Header
+
  | ID
  | [[Chat]]
+
  | {{Type|Int}}
| To remove the header, send a empty translatable component: {"translate":""}
+
  |
  |-
 
| Footer
 
| [[Chat]]
 
| To remove the footer, send a empty translatable component: {"translate":""}
 
 
  |}
 
  |}
  
==== Collect Item ====
+
==== Ping Response (play) ====
 
 
Sent by the server when someone picks up an item lying on the ground — its sole purpose appears to be the animation of the item flying towards you. It doesn't destroy the entity in the client memory, and it doesn't add it to your inventory. The server only checks for items to be picked up after each [[#Player Position|Player Position]] (and [[#Player Position And Look|Player Position And Look]]) packet sent by the client.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,851: Line 4,188:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x4B
+
  | 0x34
  |rowspan="3"| Play
+
  | Play
  |rowspan="3"| Client
+
  | Client
  | Collected Entity ID
+
  | Payload
| VarInt
+
  | {{Type|Long}}
|
+
  | Should be the same as sent by the client.
|-
 
| Collector Entity ID
 
  | VarInt
 
|
 
|-
 
| Pickup Item Count
 
| VarInt
 
  | Seems to be 1 for XP orbs, otherwise the number of items in the stack.
 
 
  |}
 
  |}
  
==== Entity Teleport ====
+
==== Place Ghost Recipe ====
  
This packet is sent by the server when an entity moves more than 4 blocks.
+
Response to the serverbound packet ([[#Place Recipe|Place Recipe]]), with the same recipe ID. Appears to be used to notify the UI.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,879: Line 4,208:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x4C
+
  | rowspan="2"| 0x35
  |rowspan="7"| Play
+
  | rowspan="2"| Play
  |rowspan="7"| Client
+
  | rowspan="2"| Client
  | Entity ID
+
  | Window ID
  | VarInt
+
  | {{Type|Byte}}
  |  
+
  |
 
  |-
 
  |-
  | X
+
  | Recipe
  | Double
+
  | {{Type|Identifier}}
|
+
  | A recipe ID.
|-
 
| Y
 
| Double
 
|
 
|-
 
| Z
 
| Double
 
|
 
|-
 
| Yaw
 
| Angle
 
| New angle, not a delta
 
|-
 
| Pitch
 
| Angle
 
| New angle, not a delta
 
|-
 
| On Ground
 
| Boolean
 
  |  
 
 
  |}
 
  |}
  
==== Advancements ====
+
==== Player Abilities (clientbound) ====
 +
 
 +
The latter 2 floats are used to indicate the flying speed and field of view respectively, while the first byte is used to determine the value of 4 booleans.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,917: Line 4,228:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="9"| 0x4D
+
  | rowspan="3"| 0x36
  |rowspan="9"| Play
+
  | rowspan="3"| Play
  |rowspan="9"| Client
+
  | rowspan="3"| Client
  |colspan="2"| Reset/Clear
+
  | Flags
  |colspan="2"| Boolean
+
  | {{Type|Byte}}
  | Whether to reset/clear the current advancements
+
  | Bit field, see below.
 
  |-
 
  |-
  |colspan="2"| Mapping size
+
  | Flying Speed
  |colspan="2"| VarInt
+
  | {{Type|Float}}
  | Size of the following array
+
  | 0.05 by default.
 
  |-
 
  |-
  |rowspan="2"| Advancement mapping
+
  | Field of View Modifier
  | Key
+
  | {{Type|Float}}
  |rowspan="2"| Array
+
  | Modifies the field of view, like a speed potion. A Notchian server will use the same value as the movement speed sent in the [[#Update Attributes|Update Attributes]] packet, which defaults to 0.1 for players.
  | Identifier
+
  |}
| The identifier of the advancement
+
 
 +
About the flags:
 +
 
 +
{| class="wikitable"
 
  |-
 
  |-
  | Value
+
  ! Field
  | Advancement
+
  ! Bit
| See below
 
 
  |-
 
  |-
  |colspan="2"| List size
+
  | Invulnerable
|colspan="2"| VarInt
+
  | 0x01
  | Size of the following array
 
 
  |-
 
  |-
  |colspan="2"| Identifiers
+
  | Flying
|colspan="2"| Array of Identifier
+
  | 0x02
  | The identifiers of the advancements that should be removed
 
 
  |-
 
  |-
  |colspan="2"| Progress size
+
  | Allow Flying
|colspan="2"| VarInt
+
  | 0x04
  | Size of the following array
 
 
  |-
 
  |-
  |rowspan="2"| Progress mapping
+
  | Creative Mode (Instant Break)
| Key
+
  | 0x08
|rowspan="2"| Array
 
| Identifier
 
| The identifier of the advancement
 
|-
 
| Value
 
| Advancement progress
 
  | See below
 
 
  |}
 
  |}
  
Advancement structure:
+
==== Player Chat Message ====
 +
 
 +
Sends the client a chat message from a player.
 +
 
 +
Currently a lot is unknown about this packet, blank descriptions are for those that are unknown
  
 
{| class="wikitable"
 
{| class="wikitable"
  !colspan="2"| Field Name
+
! Packet ID
  !colspan="2"| Field Type
+
! State
 +
! Bound To
 +
! Sector
 +
  ! colspan="2"| Field Name
 +
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |colspan="2"| Has parent
+
  | rowspan="18"| 0x37
  |colspan="2"| Boolean
+
| rowspan="18"| Play
  | Indicates whether the next field exists.
+
| rowspan="18"| Client
 +
| rowspan="4"| Header
 +
  | colspan="2"| Sender
 +
  | {{Type|UUID}}
 +
| Used by the Notchian client for the disableChat launch option. Setting both longs to 0 will always display the message regardless of the setting.
 
  |-
 
  |-
  |colspan="2"| Parent id
+
  | colspan="2"| Index
  |colspan="2"| Optional Identifier
+
  | {{Type|VarInt}}
  | The identifier of the parent advancement.
+
  |  
 
  |-
 
  |-
  |colspan="2"| Has display
+
  | colspan="2"| Message Signature Present
  |colspan="2"| Boolean
+
  | {{Type|Boolean}}
  | Indicates whether the next field exists
+
  | States if a message signature is present
 
  |-
 
  |-
  |colspan="2"| Display data
+
  | colspan="2"| Message Signature bytes
  |colspan="2"| Optional advancement display
+
  | {{Type|Optional}} {{Type|Byte Array}} (256)
  | See below.
+
  | Only present if <code>Message Signature Present</code> is true. Cryptography, the signature consists of the Sender UUID, Session UUID from the [[#Player Session|Player Session]] packet, Index, Salt, Timestamp in epoch seconds, the length of the original chat content, the original content itself, the length of Previous Messages, and all of the Previous message signatures. These values are hashed with [https://en.wikipedia.org/wiki/SHA-2 SHA-256] and signed using the [https://en.wikipedia.org/wiki/RSA_(cryptosystem) RSA] cryptosystem. Modifying any of these values in the packet will cause this signature to fail. This buffer is always 256 bytes long and it is not length-prefixed.
 
  |-
 
  |-
  |colspan="2"| Number of criteria
+
  | rowspan="3"| Body
  |colspan="2"| VarInt
+
  | colspan="2"| Message
  | Size of the following array
+
  | {{Type|String}} (256)
 +
| Raw (optionally) signed sent message content.
 +
This is used as the <code>content</code> parameter when formatting the message on the client.
 
  |-
 
  |-
  |rowspan="2"| Criteria
+
  | colspan="2"| Timestamp
  | Key
+
  | {{Type|Long}}
  |rowspan="2"| Array
+
  | Represents the time the message was signed as milliseconds since the [https://en.wikipedia.org/wiki/Unix_time epoch], used to check if the message was received within 2 minutes of it being sent.
| Identifier
 
| The identifier of the criterion
 
 
  |-
 
  |-
  | Value
+
  | colspan="2"| Salt
  | '''Void'''
+
  | {{Type|Long}}
  | There is ''no'' content written here. Perhaps this will be expanded in the future?
+
  | Cryptography, used for validating the message signature.  
 
  |-
 
  |-
  |colspan="2"| Array length
+
  | rowspan="3"| Previous Messages
  |colspan="2"| VarInt
+
  | colspan="2"| Total Previous Messages
  | Number of arrays in the following array
+
| {{Type|VarInt}}
 +
  | The maximum length is 20 in Notchian client.
 +
|
 
  |-
 
  |-
  |rowspan="2"| Requirements
+
  | rowspan="2"| {{Type|Array}} (20)
| Array length 2
+
  | Message ID
  |rowspan="2"| Array
+
  | {{Type|VarInt}}
  | VarInt
+
  | The message Id + 1, used for validating message signature. The next field is present only when value of this field is equal to 0.
  | Number of elements in the following array
 
 
  |-
 
  |-
  | Requirement
+
  | Signature
  | Array of String
+
  | {{Type|Optional}} {{Type|Byte Array}} (256)
| Array of required criteria
+
  | The previous message's signature. Contains the same type of data as <code>Message Signature bytes</code> (256 bytes) above. Not length-prefxied.
|}
 
 
 
Advancement display:
 
 
 
{| class="wikitable"
 
  ! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  | Title
+
  | rowspan="4"| Other
  | Chat
+
| colspan="2"| Unsigned Content Present
  |
+
  | {{Type|Boolean}}
 +
  | True if the next field is present
 
  |-
 
  |-
  | Description
+
  | colspan="2"| Unsigned Content
  | Chat
+
  | {{Type|Optional}} {{Type|Text Component}}
  |
+
  |  
 
  |-
 
  |-
  | Icon
+
  | colspan="2"| Filter Type
  | [[Slot]]
+
  | {{Type|VarInt}} {{Type|Enum}}
  |
+
  | If the message has been filtered
 
  |-
 
  |-
  | Frame type
+
  | colspan="2"| Filter Type Bits
  | VarInt enum
+
  | {{Type|Optional}} {{Type|BitSet}}
  | 0 = <code>task</code>, 1 = <code>challenge</code>, 2 = <code>goal</code>
+
  | Only present if the Filter Type is Partially Filtered. Specifies the indexes at which characters in the original message string should be replaced with the <code>#</code> symbol (i.e. filtered) by the Notchian client
 
  |-
 
  |-
  | Flags
+
  | rowspan="4"| Chat Formatting
  | Integer
+
| colspan="2"| Chat Type
  | 0x1: has background texture; 0x2: <code>show_toast</code>; 0x4: <code>hidden</code>
+
  | {{Type|VarInt}}
 +
  | The type of chat in the <code>minecraft:chat_type</code> registry, defined by the [[Protocol#Registry_Data|Registry Data]] packet.
 
  |-
 
  |-
  | Background texture
+
  | colspan="2"| Sender Name
  | Optional Identifier
+
  | {{Type|Text Component}}
  | Background texture location. Only if flags indicates it.
+
  | The name of the one sending the message, usually the sender's display name.
 +
This is used as the <code>sender</code> parameter when formatting the message on the client.
 
  |-
 
  |-
  | X coord
+
  | colspan="2"| Has Target Name
  | Float
+
  | {{Type|Boolean}}
  |  
+
  | True if target name is present.
 
  |-
 
  |-
  | Y coord
+
  | colspan="2"| Target Name
  | Float
+
  | {{Type|Optional}} {{Type|Text Component}}
  |  
+
  | The name of the one receiving the message, usually the receiver's display name. Only present if previous boolean is true.
 +
This is used as the <code>target</code> parameter when formatting the message on the client.
 
  |}
 
  |}
 +
[[File:MinecraftChat.drawio4.png|thumb|Player Chat Handling Logic]]
 +
 +
Filter Types:
  
Advancement progress:
+
The filter type mask should NOT be specified unless partially filtered is selected
  
 
{| class="wikitable"
 
{| class="wikitable"
  !colspan="2"| Field Name
+
  ! ID
  !colspan="2"| Field Type
+
  ! Name
  ! Notes
+
  ! Description
 
  |-
 
  |-
  |colspan="2"| Size
+
  | 0
  |colspan="2"| VarInt
+
  | PASS_THROUGH
  | Size of the following array
+
  | Message is not filtered at all
 
  |-
 
  |-
  |rowspan="2"| Criteria
+
  | 1
| Criterion identifier
+
  | FULLY_FILTERED
|rowspan="2"| Array
+
  | Message is fully filtered
  | Identifier
 
  | The identifier of the criterion.
 
 
  |-
 
  |-
  | Criterion progress
+
  | 2
  | Criterion progress
+
  | PARTIALLY_FILTERED
  |
+
  | Only some characters in the message are filtered
 
  |}
 
  |}
  
Criterion progress:
+
==== End Combat ====
 +
 
 +
Unused by the Notchian client.  This data was once used for twitch.tv metadata circa 1.8.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 
  ! Field Name
 
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | Achieved
+
  | rowspan="1"| 0x38
  | Boolean
+
| rowspan="1"| Play
  | If true, next field is present
+
| rowspan="1"| Client
 +
| Duration
 +
| {{Type|VarInt}}
 +
| Length of the combat in ticks.
 +
  |}
 +
 
 +
==== Enter Combat ====
 +
 
 +
Unused by the Notchian client. This data was once used for twitch.tv metadata circa 1.8.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Date of achieving
+
  | rowspan="1"| 0x39
  | Optional Long
+
  | rowspan="1"| Play
  | As returned by [https://docs.oracle.com/javase/6/docs/api/java/util/Date.html#getTime() <code>Date.getTime</code>]
+
  | rowspan="1"| Client
 +
| colspan="3"| ''no fields''
 
  |}
 
  |}
  
==== Entity Properties ====
+
==== Combat Death ====
  
Sets {{Minecraft Wiki|Attribute|attributes}} on the given entity.
+
Used to send a respawn screen.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,103: Line 4,438:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x4E
+
  | rowspan="2"| 0x3A
  |rowspan="6"| Play
+
  | rowspan="2"| Play
  |rowspan="6"| Client
+
  | rowspan="2"| Client
  |colspan="2"| Entity ID
+
  | Player ID
  |colspan="2"| VarInt
+
  | {{Type|VarInt}}
  |  
+
  | Entity ID of the player that died (should match the client's entity ID).
 
  |-
 
  |-
  |colspan="2"| Number Of Properties
+
  | Message
  |colspan="2"| Int
+
| {{Type|Text Component}}
  | Number of elements in the following array
+
| The death message.
 +
|}
 +
 
 +
==== Player Info Remove ====
 +
 
 +
Used by the server to remove players from the player list.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
  ! Field Type
 +
! Notes
 
  |-
 
  |-
  |rowspan="4"| Property
+
  | rowspan="2"| 0x3B
  | Key
+
  | rowspan="2"| Play
  |rowspan="4"| Array
+
  | rowspan="2"| Client
  | String (64)
+
  | colspan="2"| Number of Players
  | See below
+
| {{Type|VarInt}}
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  | Value
+
  | Player
  | Double
+
  | Player Id
  | See below
+
  | {{Type|Array}} of {{Type|UUID}}
|-
+
| UUIDs of players to remove.
| Number Of Modifiers
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Modifiers
 
| Array of Modifier Data
 
| See {{Minecraft Wiki|Attribute#Modifiers}}. Modifier Data defined below.
 
 
  |}
 
  |}
  
Known Key values (see also {{Minecraft Wiki|Attribute#Modifiers}}):
+
==== Player Info Update ====
  
 +
Sent by the server to update the user list (<tab> in the client).
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  ! Key
+
  | rowspan="4"| 0x3C
  ! Default
+
  | rowspan="4"| Play
  ! Min
+
  | rowspan="4"| Client
  ! Max
+
  | colspan="2"| Actions
  ! Label
+
  | colspan="2"| {{Type|Byte}}
 +
| Determines what actions are present.
 
  |-
 
  |-
  | generic.maxHealth
+
  | colspan="2"| Number Of Players
  | 20.0
+
  | colspan="2"| {{Type|VarInt}}
| 0.0
+
  | Number of elements in the following array.
  | 1024.0
 
| Max Health
 
 
  |-
 
  |-
  | generic.followRange
+
  | rowspan="2" | Players
  | 32.0
+
  | UUID
  | 0.0
+
  | rowspan="2" | {{Type|Array}}
  | 2048.0
+
  | {{Type|UUID}}
  | Follow Range
+
  | The player UUID
 
  |-
 
  |-
  | generic.knockbackResistance
+
  | Player Actions
  | 0.0
+
| {{Type|Array}} of [[#player-info:player-actions|Player&nbsp;Actions]]
  | 0.0
+
| The length of this array is determined by the number of [[#player-info:player-actions|Player Actions]] that give a non-zero value when applying its mask to the actions flag. For example given the decimal number 5, binary 00000101. The masks 0x01 and 0x04 would return a non-zero value, meaning the Player Actions array would include two actions: Add Player and Update Game Mode.
  | 1.0
+
|}
  | Knockback Resistance
+
 +
 
 +
{| class="wikitable"
 +
|+ id="player-info:player-actions" | Player Actions
 +
! Action
 +
! Mask
 +
! colspan="2" | Field Name
 +
! colspan="2" | Type
 +
! Notes
 +
|-
 +
| rowspan="6" | Add Player
 +
| rowspan="6" | 0x01
 +
  | colspan="2" | Name
 +
| colspan="2" | {{Type|String (16)}}
 +
|-
 +
| colspan="2" | Number Of Properties
 +
| colspan="2" | {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
  |-
 +
| rowspan="4" | Property
 +
| Name
 +
| rowspan="4"| {{Type|Array}}
 +
| {{Type|String (32767)}}
 +
|
 +
|-
 +
| Value
 +
  | {{Type|String (32767)}}
 +
  |
 
  |-
 
  |-
  | generic.movementSpeed
+
  | Is Signed
  | 0.699999988079071
+
  | {{Type|Boolean}}
| 0.0
+
  |
| 1024.0
 
  | Movement Speed
 
 
  |-
 
  |-
  | generic.attackDamage
+
  | Signature
  | 2.0
+
  | {{Type|Optional}} {{Type|String (32767)}}
| 0.0
+
  | Only if Is Signed is true.
  | 2048.0
 
| Attack Damage
 
 
  |-
 
  |-
  | generic.attackSpeed
+
  | rowspan="7" | Initialize Chat
  | 4.0
+
  | rowspan="7" | 0x02
  | 0.0
+
  | colspan="2" | Has Signature Data
  | 1024.0
+
  | colspan="2" | {{Type|Boolean}}
| Attack Speed
 
 
  |-
 
  |-
  | generic.flyingSpeed
+
  | colspan="2" | Chat session ID
  | 0.4000000059604645
+
  | colspan="2" | {{Type|UUID}}
| 0.0
+
  | Only sent if Has Signature Data is true.
  | 1024.0
 
| Flying Speed
 
 
  |-
 
  |-
  | horse.jumpStrength
+
  | colspan="2" | Public key expiry time
  | 0.7
+
  | colspan="2" | {{Type|Long}}
  | 0.0
+
  | Key expiry time, as a UNIX timestamp in milliseconds. Only sent if Has Signature Data is true.
| 2.0
 
| Jump Strength
 
 
  |-
 
  |-
  | zombie.spawnReinforcements
+
  | colspan="2" | Encoded public key size
| 0.0
+
  | colspan="2" | {{Type|VarInt}}
  | 0.0
+
  | Size of the following array. Only sent if Has Signature Data is true. Maximum length is 512 bytes.
| 1.0
 
| Spawn Reinforcements Chance
 
  |}
 
 
 
''Modifier Data'' structure:
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Field Name
+
  | colspan="2" | Encoded public key
  ! Field Type
+
  | colspan="2" | {{Type|Byte Array}} (512)
  ! Notes
+
  | The player's public key, in bytes. Only sent if Has Signature Data is true.
 
  |-
 
  |-
  | UUID
+
  | colspan="2" | Public key signature size
  | UUID
+
  | colspan="2" | {{Type|VarInt}}
  |  
+
  | Size of the following array. Only sent if Has Signature Data is true. Maximum length is 4096 bytes.
 
  |-
 
  |-
  | Amount
+
  | colspan="2" | Public key signature
  | Double
+
  | colspan="2" | {{Type|Byte Array}} (4096)
  | May be positive or negative
+
  | The public key's digital signature. Only sent if Has Signature Data is true.
 
  |-
 
  |-
  | Operation
+
  | Update Game Mode
  | Byte
+
  | 0x04
  | See below
+
  | colspan="2" | Game Mode
  |}
+
| colspan="2" | {{Type|VarInt}}
 +
|-
 +
| Update Listed
 +
| 0x08
 +
| colspan="2" | Listed
 +
| colspan="2" | {{Type|Boolean}}
 +
| Whether the player should be listed on the player list.
 +
|-
 +
| Update Latency
 +
| 0x10
 +
| colspan="2" | Ping
 +
| colspan="2" | {{Type|VarInt}}
 +
| Measured in milliseconds.
 +
|-
 +
| rowspan="2" | Update Display Name
 +
| rowspan="2" | 0x20
 +
| colspan="2" | Has Display Name
 +
| colspan="2" | {{Type|Boolean}}
 +
|-
 +
| colspan="2" | Display Name
 +
| colspan="2" | {{Type|Optional}} {{Type|Text Component}}
 +
| Only sent if Has Display Name is true.
 +
  |}
  
The operation controls how the base value of the modifier is changed.
+
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.
  
* 0: Add/subtract amount
+
Ping values correspond with icons in the following way:
* 1: Add/subtract amount percent of the current value
+
* A ping that negative (i.e. not known to the server yet) will result in the no connection icon.
* 2: Multiply by amount percent
+
* 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.
  
All of the 0's are applied first, and then the 1's, and then the 2's.
+
==== Look At ====
  
==== Entity Effect ====
+
Used to rotate the client player to face the given location or entity (for <code>/teleport [<targets>] <x> <y> <z> facing</code>).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,241: Line 4,626:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x4F
+
  | rowspan="8"| 0x3D
  |rowspan="5"| Play
+
  | rowspan="8"| Play
  |rowspan="5"| Client
+
  | rowspan="8"| Client
  | Entity ID
+
  |-
  | VarInt
+
  | Feet/eyes
  |  
+
| {{Type|VarInt}} {{Type|Enum}}
 +
| Values are feet=0, eyes=1.  If set to eyes, aims using the head position; otherwise aims using the feet position.
 +
|-
 +
| Target x
 +
| {{Type|Double}}
 +
| x coordinate of the point to face towards.
 +
|-
 +
| Target y
 +
| {{Type|Double}}
 +
  | y coordinate of the point to face towards.
 
  |-
 
  |-
  | Effect ID
+
  | Target z
  | Byte
+
  | {{Type|Double}}
| See {{Minecraft Wiki|Status effect#List of effects|this table}}
+
| z coordinate of the point to face towards.
 
  |-
 
  |-
  | Amplifier
+
  | Is entity
  | Byte
+
  | {{Type|Boolean}}
  | Notchian client displays effect level as Amplifier + 1
+
  | If true, additional information about an entity is provided.
 
  |-
 
  |-
  | Duration
+
  | Entity ID
  | VarInt
+
  | {{Type|Optional}} {{Type|VarInt}}
  | Seconds
+
  | Only if is entity is true &mdash; the entity to face towards.
 
  |-
 
  |-
  | Flags
+
  | Entity feet/eyes
  | Byte
+
  | {{Type|Optional}} {{Type|VarInt}} {{Type|Enum}}
  | Bit field, see below.
+
  | Whether to look at the entity's eyes or feet.  Same values and meanings as before, just for the entity's head/feet.
 
  |}
 
  |}
  
Within flags:
+
If the entity given by entity ID cannot be found, this packet should be treated as if is entity was false.
 +
 
 +
==== Synchronize Player Position ====
  
* 0x01: Is ambient - was the effect spawned from a beacon?  All beacon-generated effects are ambient. Ambient effects use a different icon in the HUD (blue border rather than gray). If all effects on an entity are ambient, the [[Entities#Living|"Is potion effect ambient" living metadata field]] should be set to true.  Usually should not be enabled.
+
Teleports the client, e.g. during login, when using an ender pearl, in response to invalid move packets, etc.
* 0x02: Show particles - should all particles from this effect be hidden?  Effects with particles hidden are not included in the calculation of the effect color, and are not rendered on the HUD (but are still rendered within the inventory).  Usually should be enabled.
 
  
=== Serverbound ===
+
Due to latency, the server may receive outdated movement packets sent before the client was aware of the teleport. To account for this, the server ignores all movement packets from the client until a [[#Confirm Teleportation|Confirm Teleportation]] packet with an ID matching the one sent in the teleport packet is received.
  
==== Teleport Confirm ====
+
Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0, -1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.
  
Sent by client as confirmation of [[#Player Position And Look (clientbound)|Player Position And Look]].
+
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 4,284: Line 4,679:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x00
+
  | rowspan="7"| 0x3E
  | Play
+
  | rowspan="7"| Play
  | Server
+
  | rowspan="7"| Client
  | Teleport ID
+
| X
  | VarInt
+
| {{Type|Double}}
  | The ID given by the [[#Player Position And Look (clientbound)|Player Position And Look]] packet
+
| Absolute or relative position, depending on Flags.
  |}
+
|-
 
+
| Y
==== Tab-Complete (serverbound) ====
+
| {{Type|Double}}
 +
| Absolute or relative position, depending on Flags.
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
| Absolute or relative position, depending on Flags.
 +
|-
 +
| Yaw
 +
| {{Type|Float}}
 +
| Absolute or relative rotation on the X axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Absolute or relative rotation on the Y axis, in degrees.
 +
|-
 +
| Flags
 +
| {{Type|Byte}}
 +
| Reference the Flags table below. When the value of the this byte masked is zero the field is absolute, otherwise relative.
 +
|-
 +
  | Teleport ID
 +
  | {{Type|VarInt}}
 +
  | Client should confirm this packet with [[#Confirm Teleportation|Confirm Teleportation]] containing the same Teleport ID.
 +
  |}
  
Sent when the user presses ''tab'' while writing text.
+
{| class="wikitable"  
 
+
  |+ Flags
{| class="wikitable"
+
  |-
  ! Packet ID
+
  ! Field
  ! State
+
  ! Hex Mask
! Bound To
 
! Field Name
 
  ! Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x01
+
  | X
  |rowspan="4"| Play
+
  | 0x01
|rowspan="4"| Server
 
| Text
 
| String (32767)
 
| All text behind the cursor (e.g. to the left of the cursor in left-to-right languages like English)
 
 
  |-
 
  |-
  | Assume Command
+
  | Y
  | Boolean
+
  | 0x02
| If true, the server will parse Text as a command even if it doesn't start with a <code>/</code>. Used in the command block GUI.
 
 
  |-
 
  |-
  | Has Position
+
  | Z
  | Boolean
+
  | 0x04
  |  
+
  |-
 +
| Y_ROT (Pitch)
 +
| 0x08
 
  |-
 
  |-
  | Looked At Block
+
  | X_ROT (Yaw)
  | Optional Position
+
  | 0x10
| The position of the block being looked at. Only sent if Has Position is true.
 
 
  |}
 
  |}
  
==== Chat Message (serverbound) ====
+
==== Update Recipe Book ====
 
 
Used to send a chat message to the server.  The message may not be longer than 256 characters or else the server will kick the client.
 
 
 
If the message starts with a <code>/</code>, the server will attempt to interpret it as a command.  Otherwise, the server will broadcast the same chat message to all players on the server (including the player that sent the message), prepended with player's name.  Specifically, it will respond with a translate [[chat]] component, "<code>chat.type.text</code>" with the first parameter set to the display name of the player (including some chat component logic to support clicking the name to send a PM) and the second parameter set to the message.  See [[Chat#Processing chat|processing chat]] for more information.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,338: Line 4,743:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x02
+
  | rowspan="14"| 0x3F
  |rowspan="1"| Play
+
  | rowspan="14"| Play
  |rowspan="1"| Server
+
  | rowspan="14"| Client
| Message
 
| String (256)
 
| The client sends the raw input, not a [[Chat]] component
 
|}
 
 
 
==== Client Status ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x03
+
  | Action
  |rowspan="1"| Play
+
| {{Type|VarInt}}
  |rowspan="1"| Server
+
| 0: init, 1: add, 2: remove.
  | Action ID
+
|-
  | VarInt Enum
+
| Crafting Recipe Book Open
  | See below
+
| {{Type|Boolean}}
 +
| If true, then the crafting recipe book will be open when the player opens its inventory.
 +
|-
 +
| Crafting Recipe Book Filter Active
 +
| {{Type|Boolean}}
 +
| If true, then the filtering option is active when the players opens its inventory.
 +
|-
 +
| Smelting Recipe Book Open
 +
| {{Type|Boolean}}
 +
| If true, then the smelting recipe book will be open when the player opens its inventory.
 +
|-
 +
| Smelting Recipe Book Filter Active
 +
| {{Type|Boolean}}
 +
| If true, then the filtering option is active when the players opens its inventory.
 +
|-
 +
| Blast Furnace Recipe Book Open
 +
| {{Type|Boolean}}
 +
| If true, then the blast furnace recipe book will be open when the player opens its inventory.
 +
|-
 +
| Blast Furnace Recipe Book Filter Active
 +
| {{Type|Boolean}}
 +
| If true, then the filtering option is active when the players opens its inventory.
 +
|-
 +
| Smoker Recipe Book Open
 +
  | {{Type|Boolean}}
 +
| If true, then the smoker recipe book will be open when the player opens its inventory.
 +
|-
 +
| Smoker Recipe Book Filter Active
 +
| {{Type|Boolean}}
 +
| If true, then the filtering option is active when the players opens its inventory.
 +
|-
 +
| Array size 1
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
  |-
 +
| Recipe IDs
 +
| {{Type|Array}} of {{Type|Identifier}}
 +
|
 +
|-
 +
  | Array size 2
 +
  | {{Type|Optional}} {{Type|VarInt}}
 +
| Number of elements in the following array, only present if mode is 0 (init).
 +
|-
 +
| Recipe IDs
 +
| {{Type|Optional}} {{Type|Array}} of {{Type|Identifier}}
 +
  | Only present if mode is 0 (init)
 
  |}
 
  |}
 +
Action:
 +
* 0 (init) = All the recipes in list 1 will be tagged as displayed, and all the recipes in list 2 will be added to the recipe book. Recipes that aren't tagged will be shown in the notification.
 +
* 1 (add) = All the recipes in the list are added to the recipe book and their icons will be shown in the notification.
 +
* 2 (remove) = Remove all the recipes in the list. This allows them to be re-displayed when they are re-added.
  
''Action ID'' values:
+
==== Remove Entities ====
 +
 
 +
Sent by the server when an entity is to be destroyed on the client.
  
 
{| class="wikitable"
 
{| class="wikitable"
  |-
+
  ! Packet ID
  ! Action ID
+
  ! State
  ! Action
+
! Bound To
 +
! Field Name
 +
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0
+
  | rowspan="2"| 0x40
  | Perform respawn
+
| rowspan="2"| Play
  | Sent when the client is ready to complete login and when the client is ready to respawn after death.
+
| rowspan="2"| Client
 +
  | Count
 +
  | {{Type|VarInt}}
 +
| Number of elements in the following array.
 
  |-
 
  |-
  | 1
+
  | Entity IDs
  | Request stats
+
  | {{Type|Array}} of {{Type|VarInt}}
  | Sent when the client opens the Statistics menu
+
  | The list of entities to destroy.
 
  |}
 
  |}
  
==== Client Settings ====
+
==== Remove Entity Effect ====
 
 
Sent when the player connects, or when settings are changed.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,393: Line 4,838:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x04
+
  | rowspan="2"| 0x41
  |rowspan="6"| Play
+
  | rowspan="2"| Play
  |rowspan="6"| Server
+
  | rowspan="2"| Client
  | Locale
+
  | Entity ID
  | String (16)
+
  | {{Type|VarInt}}
  | e.g. en_GB
+
  |
 
  |-
 
  |-
  | View Distance
+
  | Effect ID
  | Byte
+
  | {{Type|VarInt}}
| Client-side render distance, in chunks
+
  | See {{Minecraft Wiki|Status effect#Effect list|this table}}.
|-
 
| Chat Mode
 
| VarInt Enum
 
  | 0: enabled, 1: commands only, 2: hidden.  See [[Chat#Processing chat|processing chat]] for more information.
 
|-
 
| Chat Colors
 
| Boolean
 
| “Colors” multiplayer setting
 
|-
 
| Displayed Skin Parts
 
| Unsigned Byte
 
| Bit mask, see below
 
|-
 
| Main Hand
 
| VarInt Enum
 
| 0: Left, 1: Right
 
 
  |}
 
  |}
  
''Displayed Skin Parts'' flags:
+
==== Reset Score ====
  
* Bit 0 (0x01): Cape enabled
+
This is sent to the client when it should remove a scoreboard item.
* Bit 1 (0x02): Jacket enabled
 
* Bit 2 (0x04): Left Sleeve enabled
 
* Bit 3 (0x08): Right Sleeve enabled
 
* Bit 4 (0x10): Left Pants Leg enabled
 
* Bit 5 (0x20): Right Pants Leg enabled
 
* Bit 6 (0x40): Hat enabled
 
 
 
The most significant bit (bit 7, 0x80) appears to be unused.
 
 
 
==== Confirm Transaction (serverbound) ====
 
 
 
If a transaction sent by the client was not accepted, the server will reply with a [[#Confirm Transaction (clientbound)|Confirm Transaction (clientbound)]] packet with the Accepted field set to false. When this happens, the client must send this packet to apologize (as with movement), otherwise the server ignores any successive transactions.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,445: Line 4,862:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x05
+
  | rowspan="3"| 0x42
  |rowspan="3"| Play
+
  | rowspan="3"| Play
  |rowspan="3"| Server
+
  | rowspan="3"| Client
  | Window ID
+
  | Entity Name
  | Byte
+
  | {{Type|String}} (32767)
  | The ID of the window that the action occurred in
+
  | The entity whose score this is. For players, this is their username; for other entities, it is their UUID.
 
  |-
 
  |-
  | Action Number
+
  | Has Objective Name
  | Short
+
  | {{Type|Boolean}}
  | Every action that is to be accepted has a unique number. This number is an incrementing integer (starting at 1) with separate counts for each window ID.
+
  | Whether the score should be removed for the specified objective, or for all of them.
 
  |-
 
  |-
  | Accepted
+
  | Objective Name
  | Boolean
+
  | {{Type|Optional}} {{Type|String}} (32767)
  | Whether the action was accepted
+
  | The name of the objective the score belongs to. Only present if the previous field is true.
 
  |}
 
  |}
  
==== Enchant Item ====
+
==== Remove Resource Pack (play) ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,471: Line 4,888:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x06
+
  | rowspan="2"| 0x43
  |rowspan="2"| Play
+
  | rowspan="2"| Play
  |rowspan="2"| Server
+
  | rowspan="2"| Client
  | Window ID
+
  | Has UUID
  | Byte
+
  | {{Type|Boolean}}
  | The ID of the enchantment table window sent by [[#Open Window|Open Window]]
+
  | Whether a specific resource pack should be removed, or all of them.
 
  |-
 
  |-
  | Enchantment
+
  | UUID
  | Byte
+
  | {{Type|Optional}} {{Type|UUID}}
  | The position of the enchantment on the enchantment table window, starting with 0 as the topmost one
+
  | The UUID of the resource pack to be removed. Only present if the previous field is true.
 
  |}
 
  |}
  
==== Click Window ====
+
==== Add Resource Pack (play) ====
 
 
This packet is sent by the player when it clicks on a slot in a window.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,495: Line 4,910:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x07
+
  | rowspan="6"| 0x44
  |rowspan="6"| Play
+
  | rowspan="6"| Play
  |rowspan="6"| Server
+
  | rowspan="6"| Client
  | Window ID
+
  | UUID
  | Unsigned Byte
+
  | {{Type|UUID}}
  | The ID of the window which was clicked. 0 for player inventory.
+
  | The unique identifier of the resource pack.
 
  |-
 
  |-
  | Slot
+
  | URL
  | Short
+
  | {{Type|String}} (32767)
  | The clicked slot number, see below
+
  | The URL to the resource pack.
 
  |-
 
  |-
  | Button
+
  | Hash
  | Byte
+
  | {{Type|String}} (40)
  | The button used in the click, see below
+
  | A 40 character hexadecimal, case-insensitive [[wikipedia:SHA-1|SHA-1]] hash of the resource pack file.<br />If it's not a 40 character hexadecimal string, the client will not use it for hash verification and likely waste bandwidth.
 
  |-
 
  |-
  | Action Number
+
  | Forced
  | Short
+
  | {{Type|Boolean}}
  | A unique number for the action, implemented by Notchian as a counter, starting at 1 (different counter for every window ID). Used by the server to send back a [[#Confirm Transaction (clientbound)|Confirm Transaction (clientbound)]].
+
  | The Notchian client will be forced to use the resource pack from the server. If they decline they will be kicked from the server.
 
  |-
 
  |-
  | Mode
+
  | Has Prompt Message
  | VarInt Enum
+
  | {{Type|Boolean}}
  | Inventory operation mode, see below
+
  | Whether a custom message should be used on the resource pack prompt.
 
  |-
 
  |-
  | Clicked item
+
  | Prompt Message
  | [[Slot Data|Slot]]
+
  | {{Type|Optional}} {{Type|Text Component}}
  | The clicked slot. Has to be empty (item ID = -1) for drop mode.
+
  | This is shown in the prompt making the client accept or decline the resource pack. Only present if the previous field is true.
 
  |}
 
  |}
  
See [[Inventory]] for further information about how slots are indexed.
+
==== Respawn ====
  
When right-clicking on a stack of items, half the stack will be picked up and half left in the slot. If the stack is an odd number, the half left in the slot will be smaller of the amounts.
+
{{Need Info|Although the number of portal cooldown ticks is included in this packet, the whole portal usage process is still dictated entirely by the server. What kind of effect does this value have on the client, if any?}}
  
The distinct type of click performed by the client is determined by the combination of the Mode and Button fields.
+
To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Mode
+
  ! Packet ID
  ! Button
+
  ! State
  ! Slot
+
  ! Bound To
  ! Trigger
+
  ! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  !rowspan="2"| 0
+
  | rowspan="12"| 0x45
  | 0
+
  | rowspan="12"| Play
  | Normal
+
  | rowspan="12"| Client
  | Left mouse click
+
  | Dimension Type
 +
| {{Type|Identifier}}
 +
| The type of dimension in the <code>minecraft:dimension_type</code> registry, defined by the [[Protocol#Registry_Data|Registry Data]] packet.
 
  |-
 
  |-
  | 1
+
  | Dimension Name
  | Normal
+
  | {{Type|Identifier}}
  | Right mouse click
+
  | Name of the dimension being spawned into.
 
  |-
 
  |-
  !rowspan="2"| 1
+
  | Hashed seed
  | 0
+
  | {{Type|Long}}
| Normal
+
  | First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
  | Shift + left mouse click
 
 
  |-
 
  |-
  | 1
+
  | Game mode
  | Normal
+
  | {{Type|Unsigned Byte}}
  | Shift + right mouse click ''(identical behavior)''
+
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
 
  |-
 
  |-
  !rowspan="5"| 2
+
  | Previous Game mode
  | 0
+
  | {{Type|Byte}}
| Normal
+
  | -1: Undefined (null), 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. The previous game mode. Vanilla client uses this for the debug (F3 + N & F3 + F4) game mode switch. (More information needed)
  | Number key 1
 
 
  |-
 
  |-
  | 1
+
  | Is Debug
  | Normal
+
  | {{Type|Boolean}}
  | Number key 2
+
  | True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
 
  |-
 
  |-
  | 2
+
  | Is Flat
  | Normal
+
  | {{Type|Boolean}}
  | Number key 3
+
  | True if the world is a {{Minecraft Wiki|superflat}} world; flat worlds have different void fog and a horizon at y=0 instead of y=63.
 
  |-
 
  |-
  |
+
  | Has death location
  |
+
  | {{Type|Boolean}}
| ⋮
+
  | If true, then the next two fields are present.
|-
 
| 8
 
| Normal
 
  | Number key 9
 
 
  |-
 
  |-
  !rowspan="1"| 3
+
  | Death dimension Name
  | 2
+
  | {{Type|Optional}} {{Type|Identifier}}
| Normal
+
  | Name of the dimension the player died in.
  | Middle click, only defined for creative players in non-player inventories.
 
 
  |-
 
  |-
  !rowspan="4"| 4
+
  | Death location
  | 0
+
  | {{Type|Optional}} {{Type|Position}}
| Normal*
+
  | The location that the player died at.
  | Drop key (Q) (* Clicked item is different, see above)
 
 
  |-
 
  |-
  | 1
+
  | Portal cooldown
  | Normal*
+
  | {{Type|VarInt}}
  | Ctrl + Drop key (Ctrl-Q) ''(drops full stack)''
+
  | The number of ticks until the player can use the portal again.
 
  |-
 
  |-
  | 0
+
  | Data kept
  | -999
+
  | {{Type|Byte}}
  | Left click outside inventory holding nothing ''(no-op)''
+
  | Bit mask. 0x01: Keep attributes, 0x02: Keep metadata. Tells which data should be kept on the client side once the player has respawned.
 +
In the Notchian implementation, this is context dependent:
 +
* normal respawns (after death) keep no data;
 +
* exiting the end poem/credits keeps the attributes;
 +
* other dimension changes (portals or teleports) keep all data.
 +
|}
 +
 
 +
{{Warning2|Avoid changing player's dimension to same dimension they were already in unless they are dead. If you change the dimension to one they are already in, weird bugs can occur, such as the player being unable to attack other players in new world (until they die and respawn).
 +
 
 +
Before 1.16, if you must respawn a player in the same dimension without killing them, send two respawn packets, one to a different world and then another to the world you want. You do not need to complete the first respawn; it only matters that you send two packets.}}
 +
 
 +
==== Set Head Rotation ====
 +
 
 +
Changes the direction an entity's head is facing.
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1
+
  | rowspan="2"| 0x46
  | -999
+
  | rowspan="2"| Play
  | Right click outside inventory holding nothing ''(no-op)''
+
| rowspan="2"| Client
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
  |
 
  |-
 
  |-
  !rowspan="9"| 5
+
  | Head Yaw
  | 0
+
  | {{Type|Angle}}
  | -999
+
  | New angle, not a delta.
  | Starting left mouse drag
+
  |}
 +
 
 +
==== Update Section Blocks ====
 +
 
 +
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 Update|Block Update]]).}}
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 4
+
  | rowspan="3"| 0x47
  | -999
+
  | rowspan="3"| Play
  | Starting right mouse drag
+
| rowspan="3"| Client
 +
| Chunk section position
 +
| {{Type|Long}}
 +
  | Chunk section coordinate (encoded chunk x and z with each 22 bits, and section y with 20 bits, from left to right).
 
  |-
 
  |-
  | 8
+
  | Blocks array size
  | -999
+
  | {{Type|VarInt}}
  | Starting middle mouse drag, only defined for creative players in non-player inventories.  (Note: the vanilla client will still incorrectly send this for non-creative players - see [https://bugs.mojang.com/browse/MC-46584 MC-46584])
+
  | Number of elements in the following array.
 
  |-
 
  |-
  | 1
+
  | Blocks
  | Normal
+
  | {{Type|Array}} of {{Type|VarLong}}
| Add slot for left-mouse drag
+
  | Each entry is composed of the block state id, shifted left by 12, and the relative block position in the chunk section (4 bits for x, z, and y, from left to right).
|-
+
  |}
  | 5
+
 
| Normal
+
Chunk section position is encoded:
| Add slot for right-mouse drag
+
<syntaxhighlight lang="java">
|-
+
((sectionX & 0x3FFFFF) << 42) | (sectionY & 0xFFFFF) | ((sectionZ & 0x3FFFFF) << 20);
| 9
+
</syntaxhighlight>
| Normal
+
and decoded:
| Add slot for middle-mouse drag, only defined for creative players in non-player inventories.  (Note: the vanilla client will still incorrectly send this for non-creative players - see [https://bugs.mojang.com/browse/MC-46584 MC-46584])
+
<syntaxhighlight lang="java">
  |-
+
sectionX = long >> 42;
| 2
+
sectionY = long << 44 >> 44;
| -999
+
sectionZ = long << 22 >> 42;
| Ending left mouse drag
+
</syntaxhighlight>
|-
 
| 6
 
| -999
 
| Ending right mouse drag
 
|-
 
| 10
 
| -999
 
| Ending middle mouse drag, only defined for creative players in non-player inventories.  (Note: the vanilla client will still incorrectly send this for non-creative players - see [https://bugs.mojang.com/browse/MC-46584 MC-46584])
 
|-
 
! 6
 
| 0
 
| Normal
 
| Double click
 
|}
 
  
Starting from version 1.5, “painting mode” is available for use in inventory windows. It is done by picking up stack of something (more than 1 item), then holding mouse button (left, right or middle) and dragging held stack over empty (or same type in case of right button) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):
+
Blocks are encoded:
 
+
<syntaxhighlight lang="java">
# packet with mode 5, slot -999, button (0 for left | 4 for right);
+
blockStateId << 12 | (blockLocalX << 8 | blockLocalZ << 4 | blockLocalY)
# packet for every slot painted on, mode is still 5, button (1 | 5);
+
//Uses the local position of the given block position relative to its respective chunk section
# packet with mode 5, slot -999, button (2 | 6);
+
</syntaxhighlight>
 +
and decoded:
 +
<syntaxhighlight lang="java">
 +
blockStateId = long >> 12;
 +
blockLocalX = (long >> 8) & 0xF;
 +
blockLocalY = long & 0xF;
 +
blockLocalZ = (long >> 4) & 0xF;
 +
</syntaxhighlight>
  
If any of the painting packets other than the “progress” ones are sent out of order (for example, a start, some slots, then another start; or a left-click in the middle) the painting status will be reset.
+
==== Select Advancements Tab ====
  
The server will send back a [[#Confirm Transaction (clientbound)|Confirm Transaction]] packet. If the click was not accepted, the client must send a matching [[#Confirm Transaction (serverbound)|serverbound confirm transaction]] packet before sending more [[#Click Window|Click Window]] packets, otherwise the server will reject them silently. The Notchian server also sends a [[#Window Items|Window Items]] packet for the open window and [[#Set Slot|Set Slot]] packets for the clicked and cursor slot, but only when the click was not accepted, probably to resynchronize client and server.
+
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.
 
 
==== Close Window (serverbound) ====
 
 
 
This packet is sent by the client when closing a window.
 
 
 
Notchian clients send a Close Window packet with Window ID 0 to close their inventory even though there is never an [[#Open Window|Open Window]] packet for the inventory.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,663: Line 5,104:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x08
+
  | rowspan="2"| 0x48
  | Play
+
  | rowspan="2"| Play
  | Server
+
  | rowspan="2"| Client
  | Window ID
+
  | Has id
  | Unsigned Byte
+
  | {{Type|Boolean}}
  | This is the ID of the window that was closed. 0 for player inventory.
+
  | Indicates if the next field is present.
 +
|-
 +
| Identifier
 +
| {{Type|Optional}} {{Type|Identifier}}
 +
| See below.
 
  |}
 
  |}
  
==== Plugin Message (serverbound) ====
+
The {{Type|Identifier}} can be one of the following:
  
{{Main|Plugin channels}}
+
{| class="wikitable"
 +
! Identifier
 +
|-
 +
| minecraft:story/root
 +
|-
 +
| minecraft:nether/root
 +
|-
 +
| minecraft:end/root
 +
|-
 +
| minecraft:adventure/root
 +
|-
 +
| minecraft:husbandry/root
 +
|}
  
Mods and plugins can use this to send their data. Minecraft itself uses a number of [[plugin channel]]s. These internal channels are prefixed with <code>MC|</code>.
+
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
  
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/]
+
==== Server Data ====
 
 
Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,689: Line 5,144:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x09
+
  | rowspan="5"| 0x49
  |rowspan="2"| Play
+
  | rowspan="5"| Play
  |rowspan="2"| Server
+
  | rowspan="5"| Client
  | Channel
+
  | MOTD
  | String (20)
+
| {{Type|Text Component}}
  | Name of the [[plugin channel]] used to send the data
+
  |
 +
  |-
 +
| Has Icon
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Size
 +
| {{Type|VarInt}}
 +
| Number of bytes in the following array.
 +
|-
 +
| Icon
 +
| {{Type|Optional}} {{Type|Byte Array}}
 +
| Icon bytes in the PNG format
 
  |-
 
  |-
  | Data
+
  | Enforces Secure Chat
  | Byte Array
+
  | {{Type|Boolean}}
  | Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
+
  |
 
  |}
 
  |}
  
==== Use Entity ====
+
==== Set Action Bar Text ====
  
This packet is sent from the client to the server when the client attacks or right-clicks another entity (a player, minecart, etc).
+
Displays a message above the hotbar. Equivalent to [[#System Chat Message|System Chat Message]] with Overlay set to true, except that [[Chat#Social Interactions (blocking)|chat message blocking]] isn't performed. Used by the Notchian server only to implement the <code>/title</code> command.
  
A Notchian server only accepts this packet if the entity being attacked/used is visible without obstruction and within a 4-unit radius of the player's position.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x4A
 +
| rowspan="1"| Play
 +
| rowspan="1"| Client
 +
| Action bar text
 +
| {{Type|Text Component}}
 +
|}
  
Note that middle-click in creative mode is interpreted by the client and sent as a [[#Creative Inventory Action|Creative Inventory Action]] packet instead.
+
==== Set Border Center ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,717: Line 5,197:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x0A
+
  | rowspan="2"| 0x4B
  |rowspan="6"| Play
+
  | rowspan="2"| Play
  |rowspan="6"| Server
+
  | rowspan="2"| Client
  | Target
+
  | X
  | VarInt
+
  | {{Type|Double}}
  |  
+
  |
 
  |-
 
  |-
  | Type
+
  | Z
  | VarInt Enum
+
| {{Type|Double}}
  | 0: interact, 1: attack, 2: interact at
+
  |
 +
  |}
 +
 
 +
==== Set Border Lerp Size ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Target X
+
  | rowspan="3"| 0x4C
  | Optional Float
+
  | rowspan="3"| Play
  | Only if Type is interact at
+
  | rowspan="3"| Client
 +
| Old Diameter
 +
| {{Type|Double}}
 +
| Current length of a single side of the world border, in meters.
 
  |-
 
  |-
  | Target Y
+
  | New Diameter
  | Optional Float
+
  | {{Type|Double}}
  | Only if Type is interact at
+
  | Target length of a single side of the world border, in meters.
 
  |-
 
  |-
  | Target Z
+
  | Speed
  | Optional Float
+
  | {{Type|VarLong}}
| Only if Type is interact at
+
  | 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.
  |-
 
| Hand
 
| Optional VarInt Enum
 
| Only if Type is interact or interact at; 0: main hand, 1: off hand
 
 
  |}
 
  |}
  
==== Keep Alive (serverbound) ====
+
==== Set Border Size ====
 
 
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same packet.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,757: Line 5,245:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x0B
+
  | rowspan="1"| 0x4D
  | Play
+
  | rowspan="1"| Play
  | Server
+
  | rowspan="1"| Client
  | Keep Alive ID
+
  | Diameter
  | Long
+
  | {{Type|Double}}
  |  
+
  | Length of a single side of the world border, in meters.
 
  |}
 
  |}
  
==== Player ====
+
==== Set Border Warning Delay ====
 
 
This packet as well as [[#Player Position|Player Position]], [[#Player Look|Player Look]], and [[#Player Position And Look 2|Player Position And Look]] are called the “serverbound movement packets”. Vanilla clients will send Player Position once every 20 ticks even for a stationary player.
 
 
 
This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).
 
 
 
When dropping from sufficient height, fall damage is applied when this state goes from false to true. The amount of damage applied is based on the point where it last changed from true to false. Note that there are several movement related packets containing this state.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,781: Line 5,263:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x0C
+
  | rowspan="1"| 0x4E
  |rowspan="1"| Play
+
  | rowspan="1"| Play
  |rowspan="1"| Server
+
  | rowspan="1"| Client
  | On Ground
+
  | Warning Time
  | Boolean
+
  | {{Type|VarInt}}
  | True if the client is on the ground, false otherwise
+
  | In seconds as set by <code>/worldborder warning time</code>.
 
  |}
 
  |}
  
==== Player Position ====
+
==== Set Border Warning Distance ====
 
 
Updates the player's XYZ position on the server.
 
 
 
Checking for moving too fast is achieved like this:
 
 
 
* Each server tick, the player's current position is stored
 
* When a player moves, the changes in x, y, and z coordinates are compared with the positions from the previous tick (&Delta;x, &Delta;y, &Delta;z)
 
* Total movement distance squared is computed as &Delta;x&sup2; + &Delta;y&sup2; + &Delta;z&sup2;
 
* The expected movement distance squared is computed as velocityX&sup2; + veloctyY&sup2; + velocityZ&sup2;
 
* If the total movement distance squared value minus the expected movement distance squared value is more than 100 (300 if the player is using an elytra), they are moving too fast.
 
 
 
If the player is moving too fast, it will be logged that "<player> moved too quickly! " followed by the change in x, y, and z, and the player will be teleported back to their current (before this packet) serverside position.
 
 
 
Also, if the absolute value of X or the absolute value of Z is a value greater than 3.2×10<sup>7</sup>, or X, Y, or Z are not finite (either positive infinity, negative infinity, or NaN), the client will be kicked for “Invalid move player packet received”.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,813: Line 5,281:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x0D
+
  | rowspan="1"| 0x4F
  |rowspan="4"| Play
+
  | rowspan="1"| Play
  |rowspan="4"| Server
+
  | rowspan="1"| Client
| X
+
  | Warning Blocks
| Double
+
  | {{Type|VarInt}}
| Absolute position
+
  | In meters.
  |-
 
  | Feet Y
 
| Double
 
  | Absolute feet position, normally Head Y - 1.62
 
|-
 
| Z
 
| Double
 
| Absolute position
 
|-
 
| On Ground
 
| Boolean
 
| True if the client is on the ground, false otherwise
 
 
  |}
 
  |}
  
==== Player Position And Look (serverbound) ====
+
==== Set Camera ====
 +
 
 +
Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.
  
A combination of [[#Player Look|Player Look]] and [[#Player Position|Player Position]].
+
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).
 +
 
 +
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.
 +
 
 +
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).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,845: Line 5,307:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x0E
+
  | 0x50
  |rowspan="6"| Play
+
  | Play
  |rowspan="6"| Server
+
  | Client
| X
+
  | Camera ID
| Double
+
  | {{Type|VarInt}}
| Absolute position
+
  | ID of the entity to set the client's camera to.
|-
 
| Feet Y
 
| Double
 
| Absolute feet position, normally Head Y - 1.62
 
|-
 
| Z
 
| Double
 
  | Absolute position
 
  |-
 
| Yaw
 
  | Float
 
| Absolute rotation on the X Axis, in degrees
 
|-
 
| Pitch
 
| Float
 
| Absolute rotation on the Y Axis, in degrees
 
|-
 
| On Ground
 
| Boolean
 
| True if the client is on the ground, false otherwise
 
 
  |}
 
  |}
  
==== Player Look ====
+
The notchian client also loads certain shaders for given entities:
[[File:Minecraft-trig-yaw.png|thumb|The unit circle for yaw]]
 
[[File:Yaw.png|thumb|The unit circle of yaw, redrawn]]
 
  
Updates the direction the player is looking in.
+
* Creeper &rarr; <code>shaders/post/creeper.json</code>
 +
* Spider (and cave spider) &rarr; <code>shaders/post/spider.json</code>
 +
* Enderman &rarr; <code>shaders/post/invert.json</code>
 +
* Anything else &rarr; the current shader is unloaded
  
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.
+
==== Set Held Item (clientbound) ====
  
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
+
Sent to change the player's slot selection.
  
The yaw and pitch of player (in degrees), standing at point (x0, y0, z0) and looking towards point (x, y, z) can be calculated with:
+
{| class="wikitable"
 
+
! Packet ID
  dx = x-x0
+
! State
  dy = y-y0
+
! Bound To
  dz = z-z0
+
! Field Name
  r = sqrt( dx*dx + dy*dy + dz*dz )
+
! Field Type
  yaw = -atan2(dx,dz)/PI*180
+
! Notes
  if yaw < 0 then
+
  |-
    yaw = 360 - yaw
+
  | 0x51
pitch = -arcsin(dy/r)/PI*180
+
| Play
 +
| Client
 +
  | Slot
 +
  | {{Type|Byte}}
 +
  | The slot which the player has selected (0–8).
 +
  |}
 +
 
 +
==== Set Center Chunk ====
 +
 
 +
Sets the center position of the client's chunk loading area. The area is square-shaped, spanning 2 &times; server view distance + 7 chunks on both axes (width, not radius!). Since the area's width is always an odd number, there is no ambiguity as to which chunk is the center.
 +
 
 +
The Notchian client ignores attempts to send chunks located outside the loading area, and immediately unloads any existing chunks no longer inside it.
  
You can get a unit vector from a given yaw/pitch via:
+
The center chunk is normally the chunk the player is in, but apart from the implications on chunk loading, the (Notchian) client takes no issue with this not being the case. Indeed, as long as chunks are sent only within the default loading area centered on the world origin, it is not necessary to send this packet at all. This may be useful for servers with small bounded worlds, such as minigames, since it ensures chunks never need to be resent after the client has joined, saving on bandwidth.
  
x = -cos(pitch) * sin(yaw)
+
The Notchian server sends this packet whenever the player moves across a chunk border horizontally, and also (according to testing) for any integer change in the vertical axis, even if it doesn't go across a chunk section border.
y = -sin(pitch)
 
z =  cos(pitch) * cos(yaw)
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,908: Line 5,360:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x0F
+
  | rowspan="2"| 0x52
  |rowspan="3"| Play
+
  | rowspan="2"| Play
  |rowspan="3"| Server
+
  | rowspan="2"| Client
  | Yaw
+
  | Chunk X
  | Float
+
  | {{Type|VarInt}}
  | Absolute rotation on the X Axis, in degrees
+
  | Chunk X coordinate of the loading area center.
 
  |-
 
  |-
  | Pitch
+
  | Chunk Z
  | Float
+
  | {{Type|VarInt}}
| Absolute rotation on the Y Axis, in degrees
+
  | Chunk Z coordinate of the loading area center.
  |-
 
| On Ground
 
| Boolean
 
| True if the client is on the ground, False otherwise
 
 
  |}
 
  |}
  
==== Vehicle Move (serverbound) ====
+
==== Set Render Distance ====
  
Sent when a player moves in a vehicle. Fields are the same as in [[#Player Position And Look (serverbound)|Player Position And Look]]. Note that all fields use absolute positioning and do not allow for relative positioning.
+
Sent by the integrated singleplayer server when changing render distance. This packet is sent by the server when the client reappears in the overworld after leaving the end.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,936: Line 5,384:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x10
+
  | 0x53
  |rowspan="7"| Play
+
  | Play
  |rowspan="7"| Server
+
  | Client
  | X
+
  | View Distance
  | Double
+
  | {{Type|VarInt}}
| Absolute position (X coordinate)
+
  | Render distance (2-32).
  |-
 
| Y
 
| Double
 
| Absolute position (Y coordinate)
 
|-
 
| Z
 
| Double
 
| Absolute position (Z coordinate)
 
|-
 
| Yaw
 
| Float
 
| Absolute rotation on the vertical axis, in degrees
 
|-
 
| Pitch
 
| Float
 
| Absolute rotation on the horizontal axis, in degrees
 
 
  |}
 
  |}
  
==== Steer Boat ====
+
==== Set Default Spawn Position ====
  
Used to ''visually'' update whether boat paddles are turning. The server will update the [[Entities#Boat|Boat entity metadata]] to match the values here.
+
Sent by the server after login to specify the coordinates of the spawn point (the point at which players spawn at, and which the compass points to). It can be sent at any time to update the point compasses point at.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,972: Line 5,404:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x11
+
  | rowspan="2"| 0x54
  |rowspan="2"| Play
+
  | rowspan="2"| Play
  |rowspan="2"| Server
+
  | rowspan="2"| Client
  | Right paddle turning
+
  | Location
  | Boolean
+
  | {{Type|Position}}
  |
+
  | Spawn location.
 
  |-
 
  |-
  | Left paddle turning
+
  | Angle
  | Boolean
+
  | {{Type|Float}}
  |
+
  | The angle at which to respawn at.
 
  |}
 
  |}
  
Right paddle turning is set to true when the left button or forward button is held; left paddle turning is set to true when the right button or forward button is set to true.
+
==== Display Objective ====
  
==== Craft Recipe Request ====
+
This is sent to the client when it should display a scoreboard.
 
 
A replacement for [[Protocol#Prepare Crafting Grid|Prepare Crafting Grid]].  It appears to behave more or less the same, but the client does not specify where to move the items.
 
 
 
This packet is sent when a player clicks a recipe in the crafting book that is craftable (white border).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,000: Line 5,428:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x12
+
  | rowspan="2"| 0x55
  |rowspan="3"| Play
+
  | rowspan="2"| Play
  |rowspan="3"| Server
+
  | rowspan="2"| Client
  | Window ID
+
  | Position
  | Byte
+
  | {{Type|VarInt}}
  |
+
  | The position of the scoreboard. 0: list, 1: sidebar, 2: below name, 3 - 18: team specific sidebar, indexed as 3 + team color.
 
  |-
 
  |-
  | Recipe
+
  | Score Name
  | VarInt
+
  | {{Type|String}} (32767)
| A recipe ID
+
  | The unique name for the scoreboard to be displayed.
|-
 
| Make all
 
| Boolean
 
  | Affects the amount of items processed; true if shift is down when clicked
 
 
  |}
 
  |}
  
==== Player Abilities (serverbound) ====
+
==== Set Entity Metadata ====
 
 
The latter 2 bytes are used to indicate the walking and flying speeds respectively, while the first byte is used to determine the value of 4 booleans.
 
  
The vanilla client sends this packet when the player starts/stops flying with the Flags parameter changed accordingly. All other parameters are ignored by the vanilla server.
+
Updates one or more [[Entity_metadata#Entity Metadata Format|metadata]] properties for an existing entity. Any properties not included in the Metadata field are left unchanged.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,030: Line 5,452:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x13
+
  | rowspan="2"| 0x56
  |rowspan="3"| Play
+
  | rowspan="2"| Play
  |rowspan="3"| Server
+
  | rowspan="2"| Client
  | Flags
+
  | Entity ID
  | Byte
+
  | {{Type|VarInt}}
  | Bit mask. 0x08: damage disabled (god mode), 0x04: can fly, 0x02: is flying, 0x01: is Creative
+
  |
 
  |-
 
  |-
  | Flying Speed
+
  | Metadata
  | Float
+
  | [[Entity_metadata#Entity Metadata Format|Entity Metadata]]
|
+
  |
|-
 
| Walking Speed
 
| Float
 
  |  
 
 
  |}
 
  |}
  
==== Player Digging ====
+
==== Link Entities ====
  
Sent when the player mines a block. A Notchian server only accepts digging packets with coordinates within a 6-unit radius between the center of the block and 1.5 units from the player's feet (''not'' their eyes).
+
This packet is sent when an entity has been {{Minecraft Wiki|Lead|leashed}} to another entity.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,058: Line 5,476:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x14
+
  | rowspan="2"| 0x57
  |rowspan="3"| Play
+
  | rowspan="2"| Play
  |rowspan="3"| Server
+
  | rowspan="2"| Client
  | Status
+
  | Attached Entity ID
  | VarInt Enum
+
  | {{Type|Int}}
  | The action the player is taking against the block (see below)
+
  | Attached entity's EID.
 
  |-
 
  |-
  | Location
+
  | Holding Entity ID
  | Position
+
  | {{Type|Int}}
| Block position
+
  | ID of the entity holding the lead. Set to -1 to detach.
  |-
 
| Face
 
| Byte Enum
 
| The face being hit (see below)
 
 
  |}
 
  |}
  
Status can be one of seven values:
+
==== Set Entity Velocity ====
 +
 
 +
Velocity is in units of 1/8000 of a block per server tick (50ms); for example, -1343 would move (-1343 / 8000) = −0.167875 blocks per tick (or −3.3575 blocks per second).
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Value
+
  ! Packet ID
  ! Meaning
+
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0
+
  | rowspan="4"| 0x58
  | Started digging
+
  | rowspan="4"| Play
  |  
+
| rowspan="4"| Client
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
  |
 
  |-
 
  |-
  | 1
+
  | Velocity X
  | Cancelled digging
+
  | {{Type|Short}}
  | Sent when the player lets go of the Mine Block key (default: left click)
+
  | Velocity on the X axis.
 
  |-
 
  |-
  | 2
+
  | Velocity Y
  | Finished digging
+
  | {{Type|Short}}
  | Sent when the client thinks it is finished
+
  | Velocity on the Y axis.
 
  |-
 
  |-
  | 3
+
  | Velocity Z
  | Drop item stack
+
  | {{Type|Short}}
  | Triggered by using the Drop Item key (default: Q) with the modifier to drop the entire selected stack (default: depends on OS). Location is always set to 0/0/0, Face is always set to -Y.
+
  | Velocity on the Z axis.
 +
|}
 +
 
 +
==== Set Equipment ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | 4
+
  | rowspan="3"| 0x59
  | Drop item
+
| rowspan="3"| Play
  | Triggered by using the Drop Item key (default: Q). Location is always set to 0/0/0, Face is always set to -Y.
+
  | rowspan="3"| Client
 +
| colspan="2"| Entity ID
 +
| colspan="2"| {{Type|VarInt}}
 +
  | Entity's ID.
 
  |-
 
  |-
  | 5
+
  | rowspan="2"| Equipment
  | Shoot arrow / finish eating
+
| Slot
  | Indicates that the currently held item should have its state updated such as eating food, pulling back bows, using buckets, etc. Location is always set to 0/0/0, Face is always set to -Y.
+
| rowspan="2"| {{Type|Array}}
 +
  | {{Type|Byte}} {{Type|Enum}}
 +
  | Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet). Also has the top bit set if another entry follows, and otherwise unset if this is the last item in the array.
 
  |-
 
  |-
  | 6
+
  | Item
  | Swap item in hand
+
  | {{Type|Slot}}
  | Used to swap or assign an item to the second hand. Location is always set to 0/0/0, Face is always set to -Y.
+
  |
 
  |}
 
  |}
  
The Face field can be one of the following values, representing the face being hit:
+
==== Set Experience ====
 +
 
 +
Sent by the server when the client should change experience levels.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Value
+
  | rowspan="3"| 0x5A
  ! Offset
+
  | rowspan="3"| Play
  ! Face
+
  | rowspan="3"| Client
 +
| Experience bar
 +
| {{Type|Float}}
 +
| Between 0 and 1.
 
  |-
 
  |-
  | 0
+
  | Level
  | -Y
+
  | {{Type|VarInt}}
  | Bottom
+
  |
 
  |-
 
  |-
  | 1
+
  | Total Experience
  | +Y
+
  | {{Type|VarInt}}
| Top
+
  | See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion.
|-
 
| 2
 
| -Z
 
| North
 
|-
 
| 3
 
| +Z
 
| South
 
|-
 
| 4
 
  | -X
 
| West
 
|-
 
| 5
 
| +X
 
| East
 
 
  |}
 
  |}
  
==== Entity Action ====
+
==== Set Health ====
  
Sent by the client to indicate that it has performed certain actions: sneaking (crouching), sprinting, exiting a bed, jumping with a horse, and opening a horse's inventory while riding it.
+
Sent by the server to set the health of the player it is sent to.
 +
 
 +
Food {{Minecraft Wiki|Food#Hunger and saturation|saturation}} acts as a food “overcharge”. Food values will not decrease while the saturation is over zero. New players logging in or respawning automatically get a saturation of 5.0. Eating food increases the saturation as well as the food bar.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,155: Line 5,590:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x15
+
  | rowspan="3"| 0x5B
  |rowspan="3"| Play
+
  | rowspan="3"| Play
  |rowspan="3"| Server
+
  | rowspan="3"| Client
  | Entity ID
+
  | Health
  | VarInt
+
  | {{Type|Float}}
  | Player ID
+
  | 0 or less = dead, 20 = full HP.
 
  |-
 
  |-
  | Action ID
+
  | Food
  | VarInt Enum
+
  | {{Type|VarInt}}
  | The ID of the action, see below
+
  | 0–20.
 
  |-
 
  |-
  | Jump Boost
+
  | Food Saturation
  | VarInt
+
  | {{Type|Float}}
  | Only used by the “start jump with horse” action, in which case it ranges from 0 to 100. In all other cases it is 0.
+
  | Seems to vary from 0.0 to 5.0 in integer increments.
 
  |}
 
  |}
  
Action ID can be one of the following values:
+
==== Update Objectives ====
 +
 
 +
This is sent to the client when it should create a new {{Minecraft Wiki|scoreboard}} objective or remove one.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Action
+
  ! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  | rowspan="10"| 0x5C
  | Start sneaking
+
| rowspan="10"| Play
 +
| rowspan="10"| Client
 +
| colspan="2"| Objective Name
 +
| {{Type|String}} (32767)
 +
  | A unique name for the objective.
 
  |-
 
  |-
  | 1
+
  | colspan="2"| Mode
  | Stop sneaking
+
| {{Type|Byte}}
 +
| 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
 +
|-
 +
| colspan="2"| Objective Value
 +
| {{Type|Optional}} {{Type|Text Component}}
 +
  | Only if mode is 0 or 2.The text to be displayed for the score.
 
  |-
 
  |-
  | 2
+
  | colspan="2"| Type
  | Leave bed
+
| {{Type|Optional}} {{Type|VarInt}} {{Type|Enum}}
 +
  | Only if mode is 0 or 2. 0 = "integer", 1 = "hearts".
 
  |-
 
  |-
  | 3
+
  | colspan="2"| Has Number Format
  | Start sprinting
+
| {{Type|Optional}} {{Type|Boolean}}
 +
  | Only if mode is 0 or 2. Whether this objective has a set number format for the scores.
 
  |-
 
  |-
  | 4
+
  | colspan="2"| Number Format
  | Stop sprinting
+
| {{Type|Optional}} {{Type|VarInt}} {{Type|Enum}}
 +
  | Only if mode is 0 or 2 and the previous boolean is true. Determines how the score number should be formatted.
 
  |-
 
  |-
  | 5
+
  ! Number Format
  | Start jump with horse
+
  ! Field Name
 +
!
 +
!
 
  |-
 
  |-
  | 6
+
  | 0: blank
  | Stop jump with horse
+
  | colspan="2"| ''no fields''
 +
| Show nothing.
 
  |-
 
  |-
  | 7
+
  | 1: styled
  | Open horse inventory
+
  | Styling
 +
| [[NBT#Specification:compound_tag|Compound Tag]]
 +
| The styling to be used when formatting the score number. Contains the [[Text formatting#Styling fields|text component styling fields]].
 
  |-
 
  |-
  | 8
+
  | 2: fixed
  | Start flying with elytra
+
  | Content
 +
| {{Type|Text Component}}
 +
| The text to be used as placeholder.
 
  |}
 
  |}
  
Leave bed is only sent when the “Leave Bed” button is clicked on the sleep GUI, not when waking up due today time.
+
==== Set Passengers ====
 
 
Open horse inventory is only sent when pressing the inventory key (default: E) while on a horse — all other methods of opening a horse's inventory (involving right-clicking or shift-right-clicking it) do not use this packet.
 
 
 
==== Steer Vehicle ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,219: Line 5,675:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x16
+
  | rowspan="3"| 0x5D
  |rowspan="3"| Play
+
  | rowspan="3"| Play
  |rowspan="3"| Server
+
  | rowspan="3"| Client
  | Sideways
+
  | Entity ID
  | Float
+
  | {{Type|VarInt}}
  | Positive to the left of the player
+
  | Vehicle's EID.
 
  |-
 
  |-
  | Forward
+
  | Passenger Count
  | Float
+
  | {{Type|VarInt}}
  | Positive forward
+
  | Number of elements in the following array.
 
  |-
 
  |-
  | Flags
+
  | Passengers
  | Unsigned Byte
+
  | {{Type|Array}} of {{Type|VarInt}}
  | Bit mask. 0x1: jump, 0x2: unmount
+
  | EIDs of entity's passengers.
 
  |}
 
  |}
  
Also known as 'Input' packet.
+
==== Update Teams ====
  
==== Crafting Book Data ====
+
Creates and updates teams.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,243: Line 5,699:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x17
+
  | rowspan="23"| 0x5E
  |rowspan="5"| Play
+
  | rowspan="23"| Play
  |rowspan="5"| Server
+
  | rowspan="23"| Client
  |colspan="2"| Type
+
  | colspan="2"| Team Name
  | VarInt
+
| {{Type|String}} (32767)
  | Determines the format of the rest of the packet
+
| A unique name for the team. (Shared with scoreboard).
 +
|-
 +
| colspan="2"| Mode
 +
  | {{Type|Byte}}
 +
  | Determines the layout of the remaining packet.
 +
|-
 +
| rowspan="9"| 0: create team
 +
| Team Display Name
 +
| {{Type|Text Component}}
 +
|
 +
|-
 +
| Friendly Flags
 +
| {{Type|Byte}}
 +
| Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team.
 
  |-
 
  |-
  ! Type
+
  | Name Tag Visibility
! Field Name
+
  | {{Type|String}} {{Type|Enum}} (40)
  !
+
  | <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>.
  !
 
 
  |-
 
  |-
  | 0: Displayed Recipe
+
  | Collision Rule
  | Recipe ID
+
  | {{Type|String}} {{Type|Enum}} (40)
| Int
+
  | <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>.
  | The internal id of the displayed recipe.
 
 
  |-
 
  |-
  |rowspan="2"| 1: Crafting Book Status
+
  | Team Color
  | Crafting Book Open
+
  | {{Type|VarInt}} {{Type|Enum}}
| Boolean
+
  | Used to color the name of players on the team; see below.
  | Whether the player has the crafting book currently openened/active.
 
 
  |-
 
  |-
  | Crafting Filter
+
  | Team Prefix
  | Boolean
+
  | {{Type|Text Component}}
  | Whether the player has the crafting filter option currently active.
+
  | Displayed before the names of players that are part of this team.
  |}
+
|-
 
+
| Team Suffix
The Crafting Book Status type is send when the player closes its inventory.
+
| {{Type|Text Component}}
 
+
| Displayed after the names of players that are part of this team.
==== Resource Pack Status ====
+
  |-
 
+
| Entity Count
{| class="wikitable"
+
| {{Type|VarInt}}
  ! Packet ID
+
| Number of elements in the following array.
  ! State
+
|-
  ! Bound To
+
| Entities
  ! Field Name
+
| {{Type|Array}} of {{Type|String}} (32767)
  ! Field Type
+
| Identifiers for the entities in this team.  For players, this is their username; for other entities, it is their UUID.
  ! Notes
+
|-
 +
| 1: remove team
 +
| ''no fields''
 +
| ''no fields''
 +
|
 +
|-
 +
| rowspan="7"| 2: update team info
 +
| Team Display Name
 +
| {{Type|Text Component}}
 +
|
 +
|-
 +
| Friendly Flags
 +
| {{Type|Byte}}
 +
| Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible entities on same team.
 +
|-
 +
| Name Tag Visibility
 +
| {{Type|String}} {{Type|Enum}} (40)
 +
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
 +
|-
 +
| Collision Rule
 +
| {{Type|String}} {{Type|Enum}} (40)
 +
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 +
|-
 +
| Team Color
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| Used to color the name of players on the team; see below.
 +
|-
 +
| Team Prefix
 +
| {{Type|Text Component}}
 +
| Displayed before the names of players that are part of this team.
 +
|-
 +
| Team Suffix
 +
| {{Type|Text Component}}
 +
| Displayed after the names of players that are part of this team.
 +
|-
 +
| rowspan="2"| 3: add entities to team
 +
| Entity Count
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| Entities
 +
  | {{Type|Array}} of {{Type|String}} (32767)
 +
  | Identifiers for the added entities.  For players, this is their username; for other entities, it is their UUID.
 +
  |-
 +
| rowspan="2"| 4: remove entities from team
 +
  | Entity Count
 +
  | {{Type|VarInt}}
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  |rowspan="2"| 0x18
+
  | Entities
|rowspan="2"| Play
+
  | {{Type|Array}} of {{Type|String}} (32767)
  |rowspan="2"| Server
+
  | Identifiers for the removed entities. For players, this is their username; for other entities, it is their UUID.
| Result
 
  | VarInt Enum
 
  | 0: successfully loaded, 1: declined, 2: failed download, 3: accepted
 
 
  |}
 
  |}
  
==== Advancement Tab ====
+
Team Color: The color of a team defines how the names of the team members are visualized; any formatting code can be used. The following table lists all the possible values.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
! ID
 +
! Formatting
 +
|-
 +
| 0-15
 +
| Color formatting, same values as in [[Text formatting#Colors]].
 +
|-
 +
| 16
 +
| Obfuscated
 +
|-
 +
| 17
 +
| Bold
 +
|-
 +
| 18
 +
| Strikethrough
 +
|-
 +
| 19
 +
| Underlined
 +
|-
 +
| 20
 +
| Italic
 +
|-
 +
| 21
 +
| Reset
 +
|}
 +
 
 +
==== Update Score ====
 +
 
 +
This is sent to the client when it should update a scoreboard item.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  ! colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x19
+
  | rowspan="11"| 0x5F
  |rowspan="2"| Play
+
  | rowspan="11"| Play
  |rowspan="2"| Server
+
  | rowspan="11"| Client
  | Action
+
| colspan="2"| Entity Name
  | VarInt enum
+
| {{Type|String}} (32767)
  | 0: Opened tab, 1: Closed screen
+
  | The entity whose score this is. For players, this is their username; for other entities, it is their UUID.
 +
  |-
 +
| colspan="2"| Objective Name
 +
| {{Type|String}} (32767)
 +
| The name of the objective the score belongs to.
 +
|-
 +
| colspan="2"| Value
 +
| {{Type|VarInt}}
 +
| The score to be displayed next to the entry.
 +
|-
 +
| colspan="2"| Has Display Name
 +
| {{Type|Boolean}}
 +
| Whether this score has a custom display name.
 +
|-
 +
| colspan="2"| Display Name
 +
| {{Type|Optional}} {{Type|Text Component}}
 +
| The custom display name. Only present if the previous boolean is true.
 +
|-
 +
| colspan="2"| Has Number Format
 +
| {{Type|Boolean}}
 +
| Whether this score has a set number format. This overrides the number format set on the objective, if any.
 +
|-
 +
| colspan="2"| Number Format
 +
| {{Type|Optional}} {{Type|VarInt}} {{Type|Enum}}
 +
| Determines how the score number should be formatted. Only present if the previous boolean is true.
 +
|-
 +
! Number Format
 +
! Field Name
 +
!
 +
!
 +
|-
 +
  | 0: blank
 +
| colspan="2"| ''no fields''
 +
| Show nothing.
 +
|-
 +
| 1: styled
 +
| Styling
 +
| [[NBT#Specification:compound_tag|Compound Tag]]
 +
| The styling to be used when formatting the score number. Contains the [[Text formatting#Styling fields|text component styling fields]].
 
  |-
 
  |-
  | Tab ID
+
  | 2: fixed
  | Optional identifier
+
  | Content
  | Only present if action is Opened tab
+
  | {{Type|Text Component}}
 +
| The text to be used as placeholder.
 
  |}
 
  |}
  
==== Held Item Change (serverbound) ====
+
==== Set Simulation Distance ====
 
 
Sent when the player changes the slot selection
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,328: Line 5,905:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x1A
+
  | 0x60
  |rowspan="1"| Play
+
  | Play
  |rowspan="1"| Server
+
  | Client
  | Slot
+
  | Simulation Distance
  | Short
+
  | {{Type|VarInt}}
  | The slot which the player has selected (0–8)
+
  | The distance that the client will process specific things, such as entities.
 
  |}
 
  |}
  
==== Creative Inventory Action ====
+
==== Set Subtitle Text ====
 
 
While the user is in the standard inventory (i.e., not a crafting bench) in Creative mode, the player will send this packet.
 
 
 
Clicking in the creative inventory menu is quite different from non-creative inventory management. Picking up an item with the mouse actually deletes the item from the server, and placing an item into a slot or dropping it out of the inventory actually tells the server to create the item from scratch. (This can be verified by clicking an item that you don't mind deleting, then severing the connection to the server; the item will be nowhere to be found when you log back in.) As a result of this implementation strategy, the "Destroy Item" slot is just a client-side implementation detail that means "I don't intend to recreate this item.". Additionally, the long listings of items (by category, etc.) are a client-side interface for choosing which item to create. Picking up an item from such listings sends no packets to the server; only when you put it somewhere does it tell the server to create the item in that location.
 
 
 
This action can be described as "set inventory slot". Picking up an item sets the slot to item ID -1. Placing an item into an inventory slot sets the slot to the specified item. Dropping an item (by clicking outside the window) effectively sets slot -1 to the specified item, which causes the server to spawn the item entity, etc.. All other inventory slots are numbered the same as the non-creative inventory (including slots for the 2x2 crafting menu, even though they aren't visible in the vanilla client).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,352: Line 5,923:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x1B
+
  | rowspan="1"| 0x61
  |rowspan="2"| Play
+
  | rowspan="1"| Play
  |rowspan="2"| Server
+
  | rowspan="1"| Client
  | Slot
+
  | Subtitle Text
  | Short
+
  | {{Type|Text Component}}
| Inventory slot
+
  |
|-
 
| Clicked Item
 
| [[Slot Data|Slot]]
 
  |  
 
 
  |}
 
  |}
  
==== Update Sign ====
+
==== Update Time ====
 +
 
 +
Time is based on ticks, where 20 ticks happen every second. There are 24000 ticks in a day, making Minecraft days exactly 20 minutes long.
  
{{anchor|Update Sign (serverbound)}}This message is sent from the client to the server when the “Done” button is pushed after placing a sign.
+
The time of day is based on the timestamp modulo 24000. 0 is sunrise, 6000 is noon, 12000 is sunset, and 18000 is midnight.
  
The server only accepts this packet after [[#Open Sign Editor|Open Sign Editor]], otherwise this packet is silently ignored.
+
The default SMP server increments the time by <code>20</code> every second.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,378: Line 5,947:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x1C
+
  | rowspan="2"| 0x62
  |rowspan="5"| Play
+
  | rowspan="2"| Play
  |rowspan="5"| Server
+
  | rowspan="2"| Client
  | Location
+
  | World Age
  | Position
+
  | {{Type|Long}}
  | Block Coordinates
+
  | In ticks; not changed by server commands.
 
  |-
 
  |-
  | Line 1
+
  | Time of day
| String (384)
+
  | {{Type|Long}}
| First line of text in the sign
+
  | The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time.
  |-
 
| Line 2
 
  | String (384)
 
| Second line of text in the sign
 
|-
 
| Line 3
 
| String (384)
 
| Third line of text in the sign
 
|-
 
| Line 4
 
| String (384)
 
| Fourth line of text in the sign
 
 
  |}
 
  |}
  
==== Animation (serverbound) ====
+
==== Set Title Text ====
 
 
Sent when the player's arm swings.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,414: Line 5,969:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x1D
+
  | rowspan="1"| 0x63
  | Play
+
  | rowspan="1"| Play
  | Server
+
  | rowspan="1"| Client
  | Hand
+
  | Title Text
  | VarInt Enum
+
  | {{Type|Text Component}}
  | Hand used for the animation. 0: main hand, 1: off hand.
+
  |
 
  |}
 
  |}
  
==== Spectate ====
+
==== Set Title Animation Times ====
 
 
Teleports the player to the given entity.  The player must be in spectator mode.
 
 
 
The Notchian client only uses this to teleport to players, but it appears to accept any type of entity.  The entity does not need to be in the same dimension as the player; if necessary, the player will be respawned in the right world.  If the given entity cannot be found (or isn't loaded), this packet will be ignored.  It will also be ignored if the player attempts to teleport to themselves.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,436: Line 5,987:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x1E
+
  | rowspan="3"| 0x64
  |rowspan="1"| Play
+
  | rowspan="3"| Play
  |rowspan="1"| Server
+
  | rowspan="3"| Client
  | Target Player
+
  | Fade In
  | UUID
+
  | {{Type|Int}}
  | UUID of the player to teleport to (can also be an entity UUID)
+
| Ticks to spend fading in.
 +
|-
 +
  | Stay
 +
| {{Type|Int}}
 +
| Ticks to keep the title displayed.
 +
|-
 +
| Fade Out
 +
| {{Type|Int}}
 +
| Ticks to spend fading out, not when to start fading out.
 
  |}
 
  |}
  
==== Player Block Placement ====
+
==== Entity Sound Effect ====
 +
 
 +
Plays a sound effect from an entity, either by hardcoded ID or Identifier. Sound IDs and names can be found [https://pokechu22.github.io/Burger/1.20.4.html#sounds here].
 +
 
 +
{{Warning|Numeric sound effect IDs are liable to change between versions}}
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
 
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 5,455: Line 6,017:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x1F
+
  | rowspan="9"| 0x65
  |rowspan="6"| Play
+
  | rowspan="9"| Play
  |rowspan="6"| Server
+
  | rowspan="9"| Client
  | Location
+
  | Sound ID
  | Position
+
  | {{Type|VarInt}}
  | Block position
+
| Represents the <code>Sound ID + 1</code>. If the value is 0, the packet contains a sound specified by Identifier.
 +
|-
 +
| Sound Name
 +
| {{Type|Optional}} {{Type|Identifier}}
 +
| Only present if Sound ID is 0
 +
|-
 +
| Has Fixed Range
 +
| {{Type|Optional}} {{Type|Boolean}}
 +
| Only present if Sound ID is 0.
 +
|-
 +
| Range
 +
| {{Type|Optional}} {{Type|Float}}
 +
  | The fixed range of the sound. Only present if previous boolean is true and Sound ID is 0.
 
  |-
 
  |-
  | Face
+
  | Sound Category
  | VarInt Enum
+
  | {{Type|VarInt}} {{Type|Enum}}
  | The face on which the block is placed (as documented at [[#Player Digging|Player Digging]])
+
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories]).
 
  |-
 
  |-
  | Hand
+
  | Entity ID
  | VarInt Enum
+
  | {{Type|VarInt}}
  | The hand from which the block is placed; 0: main hand, 1: off hand
+
  |
 
  |-
 
  |-
  | Cursor Position X
+
  | Volume
  | Float
+
  | {{Type|Float}}
  | The position of the crosshair on the block, from 0 to 1 increasing from west to east
+
  | 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients.
 
  |-
 
  |-
  | Cursor Position Y
+
  | Pitch
  | Float
+
  | {{Type|Float}}
  | The position of the crosshair on the block, from 0 to 1 increasing from bottom to top
+
  | Float between 0.5 and 2.0 by Notchian clients.
 
  |-
 
  |-
  | Cursor Position Z
+
  | Seed
  | Float
+
  | {{Type|Long}}
  | The position of the crosshair on the block, from 0 to 1 increasing from north to south
+
  | Seed used to pick sound variant.
 
  |}
 
  |}
  
Upon placing a block, this packet is sent once.
+
==== Sound Effect ====
  
The Cursor Position X/Y/Z fields (also known as in-block coordinates) are calculated using raytracing. The unit corresponds to sixteen pixel in the default resource pack. For example, let's say a slab is being placed against the south face of a full block. The Cursor Position X will be higher if the player was pointing near the right (east) edge of the face, lower if pointing near the left. The Cursor Position Y will be used to determine whether it will appear as a bottom slab (values 0.0–0.5) or as a top slab (values 0.5-1.0). The Cursor Position Z should be 1.0 since the player was looking at the southernmost part of the block.
+
Plays a sound effect at the given location, either by hardcoded ID or Identifier. Sound IDs and names can be found [https://pokechu22.github.io/Burger/1.20.4.html#sounds here].
  
==== Use Item ====
+
{{Warning|Numeric sound effect IDs are liable to change between versions}}
 
 
Sent when pressing the Use Item key (default: right click) with an item in hand.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,499: Line 6,071:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x20
+
  | rowspan="11"| 0x66
  | Play
+
  | rowspan="11"| Play
  | Server
+
  | rowspan="11"| Client
  | Hand
+
  | Sound ID
  | VarInt Enum
+
  | {{Type|VarInt}}
  | Hand used for the animation. 0: main hand, 1: off hand.
+
  | Represents the <code>Sound ID + 1</code>. If the value is 0, the packet contains a sound specified by Identifier.
|}
 
 
 
== Status ==
 
{{Main|Server List Ping}}
 
 
 
=== Clientbound ===
 
 
 
==== Response ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  | Sound Name
  |rowspan="1"| Status
+
| {{Type|Optional}} {{Type|Identifier}}
  |rowspan="1"| Client
+
| Only present if Sound ID is 0
  | JSON Response
+
|-
  | String (32767)
+
| Has Fixed Range
  | See [[Server List Ping#Response]]
+
| {{Type|Optional}} {{Type|Boolean}}
 +
| Only present if Sound ID is 0.
 +
|-
 +
| Range
 +
| {{Type|Optional}} {{Type|Float}}
 +
| The fixed range of the sound. Only present if previous boolean is true and Sound ID is 0.
 +
|-
 +
| Sound Category
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories]).
 +
|-
 +
| Effect Position X
 +
| {{Type|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
 +
  | {{Type|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
 +
| {{Type|Int}}
 +
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part).
 +
|-
 +
| Volume
 +
| {{Type|Float}}
 +
| 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Float between 0.5 and 2.0 by Notchian clients.
 +
|-
 +
| Seed
 +
| {{Type|Long}}
 +
| Seed used to pick sound variant.
 
  |}
 
  |}
  
==== Pong ====
+
==== Start Configuration ====
 +
 
 +
Sent during gameplay in order to redo the configuration process. The client must respond with [[#Acknowledge Configuration|Acknowledge Configuration]] for the process to start.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,540: Line 6,131:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x01
+
  | rowspan="1"| 0x67
  |rowspan="1"| Status
+
  | rowspan="1"| Play
  |rowspan="1"| Client
+
  | rowspan="1"| Client
  | Payload
+
  | colspan="3"| ''no fields''
| Long
 
| Should be the same as sent by the client
 
 
  |}
 
  |}
  
=== Serverbound ===
+
This packet switches the connection state to [[#Configuration|configuration]].
  
==== Request ====
+
==== Stop Sound ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,560: Line 6,149:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  | rowspan="3"| 0x68
  | Status
+
| rowspan="3"| Play
  | Server
+
| rowspan="3"| Client
  |colspan="3"| ''no fields''
+
| Flags
 +
| {{Type|Byte}}
 +
| Controls which fields are present.
 +
|-
 +
| Source
 +
| {{Type|Optional}} {{Type|VarInt}} {{Type|Enum}}
 +
| Only if flags is 3 or 1 (bit mask 0x1). See below. If not present, then sounds from all sources are cleared.
 +
|-
 +
  | Sound
 +
  | {{Type|Optional}} {{Type|Identifier}}
 +
  | Only if flags is 2 or 3 (bit mask 0x2).  A sound effect name, see [[#Custom Sound Effect|Custom Sound Effect]]. If not present, then all sounds are cleared.
 +
|}
 +
 
 +
Categories:
 +
 
 +
{| class="wikitable"
 +
! Name !! Value
 +
|-
 +
| master || 0
 +
|-
 +
| music || 1
 +
|-
 +
| record || 2
 +
|-
 +
| weather || 3
 +
|-
 +
| block || 4
 +
|-
 +
| hostile || 5
 +
|-
 +
| neutral || 6
 +
|-
 +
| player || 7
 +
|-
 +
| ambient || 8
 +
|-
 +
| voice || 9
 
  |}
 
  |}
  
==== Ping ====
+
==== System Chat Message ====
 +
 
 +
Sends the client a raw system message.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,576: Line 6,203:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x01
+
  | rowspan="2"| 0x69
  |rowspan="1"| Status
+
  | rowspan="2"| Play
  |rowspan="1"| Server
+
  | rowspan="2"| Client
  | Payload
+
  | Content
  | Long
+
  | {{Type|Text Component}}
  | May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.
+
  | Limited to 262144 bytes.
 +
|-
 +
| Overlay
 +
| {{Type|Boolean}}
 +
| Whether the message is an actionbar or chat message. See also [[#Set Action Bar Text]].
 
  |}
 
  |}
  
== Login ==
+
==== Set Tab List Header And Footer ====
  
The login process is as follows:
+
This packet may be used by custom servers to display additional information above/below the player list. It is never sent by the Notchian server.
 
 
# 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"
 
{| class="wikitable"
Line 5,615: Line 6,227:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  | rowspan="2"| 0x6A
  |rowspan="1"| Login
+
  | rowspan="2"| Play
  |rowspan="1"| Client
+
  | rowspan="2"| Client
  | Reason
+
  | Header
  | [[Chat]]
+
  | {{Type|Text Component}}
  |  
+
| To remove the header, send a empty text component: <code>{"text":""}</code>.
 +
|-
 +
| Footer
 +
  | {{Type|Text Component}}
 +
| To remove the footer, send a empty text component: <code>{"text":""}</code>.
 
  |}
 
  |}
  
==== Encryption Request ====
+
==== Tag Query Response ====
 +
 
 +
Sent in response to [[#Query Block Entity Tag|Query Block Entity Tag]] or [[#Query Entity Tag|Query Entity Tag]].
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,633: Line 6,251:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x01
+
  | rowspan="2"| 0x6B
  |rowspan="5"| Login
+
  | rowspan="2"| Play
  |rowspan="5"| Client
+
  | rowspan="2"| Client
  | Server ID
+
  | Transaction ID
  | String (20)
+
  | {{Type|VarInt}}
| Appears to be empty
+
  | Can be compared to the one sent in the original query packet.
|-
 
| Public Key Length
 
| VarInt
 
  | Length of Public Key
 
 
  |-
 
  |-
  | Public Key
+
  | NBT
  | Byte Array
+
  | {{Type|NBT}}
|
+
  | The NBT of the block or entity. May be a TAG_END (0) in which case no NBT is present.
|-
 
| Verify Token Length
 
| VarInt
 
  | Length of Verify Token. Always 4 for Notchian servers.
 
|-
 
| Verify Token
 
| Byte Array
 
| A sequence of random bytes generated by the server
 
 
  |}
 
  |}
  
See [[Protocol Encryption]] for details.
+
==== Pickup Item ====
  
==== Login Success ====
+
Sent by the server when someone picks up an item lying on the ground — its sole purpose appears to be the animation of the item flying towards you. It doesn't destroy the entity in the client memory, and it doesn't add it to your inventory. The server only checks for items to be picked up after each [[#Set Player Position|Set Player Position]] (and [[#Set Player Position And Rotation|Set Player Position And Rotation]]) packet sent by the client. The collector entity can be any entity; it does not have to be a player. The collected entity also can be any entity, but the Notchian server only uses this for items, experience orbs, and the different varieties of arrows.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,669: Line 6,275:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x02
+
  | rowspan="3"| 0x6C
  |rowspan="2"| Login
+
  | rowspan="3"| Play
  |rowspan="2"| Client
+
  | rowspan="3"| Client
  | UUID
+
  | Collected Entity ID
  | String (36)
+
  | {{Type|VarInt}}
  | Unlike in other packets, this field contains the UUID as a string with hyphens.
+
|
 +
|-
 +
| Collector Entity ID
 +
| {{Type|VarInt}}
 +
  |
 
  |-
 
  |-
  | Username
+
  | Pickup Item Count
  | String (16)
+
  | {{Type|VarInt}}
  |  
+
  | Seems to be 1 for XP orbs, otherwise the number of items in the stack.
 
  |}
 
  |}
  
This packet switches the connection state to [[#Play|play]].
+
==== Teleport Entity ====
 
 
==== Set Compression ====
 
  
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).
+
This packet is sent by the server when an entity moves more than 8 blocks.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,695: Line 6,303:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x03
+
  | rowspan="7"| 0x6D
  |rowspan="1"| Login
+
  | rowspan="7"| Play
  |rowspan="1"| Client
+
  | rowspan="7"| Client
  | Threshold
+
  | Entity ID
  | VarInt
+
  | {{Type|VarInt}}
  | Maximum size of a packet before it is compressed
+
|
 +
|-
 +
| X
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Y
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
|
 +
|-
 +
| Yaw
 +
| {{Type|Angle}}
 +
| (Y Rot)New angle, not a delta.
 +
|-
 +
| Pitch
 +
| {{Type|Angle}}
 +
  | (X Rot)New angle, not a delta.
 +
|-
 +
| On Ground
 +
| {{Type|Boolean}}
 +
|
 
  |}
 
  |}
  
=== Serverbound ===
+
==== Set Ticking State ====
  
==== Login Start  ====
+
Used to adjust the ticking rate of the client, and whether it's frozen.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,715: Line 6,347:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  | rowspan="2" | 0x6E
  |rowspan="1"| Login
+
  | rowspan="2" | Play
  |rowspan="1"| Server
+
  | rowspan="2" | Client
  | Name
+
  | Tick rate
  | String (16)
+
  | {{Type|Float}}
  | Player's Username
+
|
 +
|-
 +
| Is frozen
 +
| {{Type|Boolean}}
 +
  |
 
  |}
 
  |}
  
==== Encryption Response ====
+
==== Step Tick ====
 +
 
 +
Advances the client processing by the specified number of ticks. Has no effect unless client ticking is frozen.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,733: Line 6,371:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x01
+
  | 0x6F
|rowspan="4"| Login
+
  | Play
|rowspan="4"| Server
+
  | Client
| Shared Secret Length
+
  | Tick steps
| VarInt
+
  | {{Type|VarInt}}
  | Length of Shared Secret
+
  |
  |-
 
  | Shared Secret
 
  | Byte Array
 
|
 
|-
 
| Verify Token Length
 
| VarInt
 
| Length of Verify Token
 
|-
 
| Verify Token
 
| Byte Array
 
  |  
 
 
  |}
 
  |}
  
See [[Protocol Encryption]] for details.
+
==== Update Advancements ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="9"| 0x70
 +
| rowspan="9"| Play
 +
| rowspan="9"| Client
 +
| colspan="2"| Reset/Clear
 +
| colspan="2"| {{Type|Boolean}}
 +
| Whether to reset/clear the current advancements.
 +
|-
 +
| colspan="2"| Mapping size
 +
| colspan="2"| {{Type|VarInt}}
 +
| Size of the following array.
 +
|-
 +
| rowspan="2"| Advancement mapping
 +
| Key
 +
| rowspan="2"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
| The identifier of the advancement.
 +
|-
 +
| Value
 +
| Advancement
 +
| See below
 +
|-
 +
| colspan="2"| List size
 +
| colspan="2"| {{Type|VarInt}}
 +
| Size of the following array.
 +
|-
 +
| colspan="2"| Identifiers
 +
| colspan="2"| {{Type|Array}} of {{Type|Identifier}}
 +
| The identifiers of the advancements that should be removed.
 +
|-
 +
| colspan="2"| Progress size
 +
| colspan="2"| {{Type|VarInt}}
 +
| Size of the following array.
 +
|-
 +
| rowspan="2"| Progress mapping
 +
| Key
 +
| rowspan="2"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
| The identifier of the advancement.
 +
|-
 +
| Value
 +
| Advancement progress
 +
| See below.
 +
|}
 +
 
 +
Advancement structure:
 +
 
 +
{| class="wikitable"
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| colspan="2"| Has parent
 +
| colspan="2"| {{Type|Boolean}}
 +
| Indicates whether the next field exists.
 +
|-
 +
| colspan="2"| Parent id
 +
| colspan="2"| {{Type|Optional}} {{Type|Identifier}}
 +
| The identifier of the parent advancement.
 +
|-
 +
| colspan="2"| Has display
 +
| colspan="2"| {{Type|Boolean}}
 +
| Indicates whether the next field exists.
 +
|-
 +
| colspan="2"| Display data
 +
| colspan="2"| {{Type|Optional}} Advancement display
 +
| See below.
 +
|-
 +
| colspan="2"| Array length
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of arrays in the following array.
 +
|-
 +
| rowspan="2"| Requirements
 +
| Array length 2
 +
| rowspan="2"| {{Type|Array}}
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| Requirement
 +
| {{Type|Array}} of {{Type|String}} (32767)
 +
| Array of required criteria.
 +
|-
 +
| colspan="2"| Sends telemetry data
 +
| colspan="2"| {{Type|Boolean}}
 +
| Whether the client should include this achievement in the telemetry data when it's completed.
 +
The Notchian client only sends data for advancements on the <code>minecraft</code> namespace.
 +
|}
 +
 
 +
Advancement display:
 +
 
 +
{| class="wikitable"
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| Title
 +
| {{Type|Text Component}}
 +
|
 +
|-
 +
| Description
 +
| {{Type|Text Component}}
 +
|
 +
|-
 +
| Icon
 +
| {{Type|Slot}}
 +
|
 +
|-
 +
| Frame type
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| 0 = <code>task</code>, 1 = <code>challenge</code>, 2 = <code>goal</code>.
 +
|-
 +
| Flags
 +
| {{Type|Int}}
 +
| 0x01: has background texture; 0x02: <code>show_toast</code>; 0x04: <code>hidden</code>.
 +
|-
 +
| Background texture
 +
| {{Type|Optional}} {{Type|Identifier}}
 +
| Background texture location.  Only if flags indicates it.
 +
|-
 +
| X coord
 +
| {{Type|Float}}
 +
|
 +
|-
 +
| Y coord
 +
| {{Type|Float}}
 +
|
 +
|}
 +
 
 +
Advancement progress:
 +
 
 +
{| class="wikitable"
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| colspan="2"| Size
 +
| colspan="2"| {{Type|VarInt}}
 +
| Size of the following array.
 +
|-
 +
| rowspan="2"| Criteria
 +
| Criterion identifier
 +
| rowspan="2"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
| The identifier of the criterion.
 +
|-
 +
| Criterion progress
 +
| Criterion progress
 +
|
 +
|}
 +
 
 +
Criterion progress:
 +
 
 +
{| class="wikitable"
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| Achieved
 +
| {{Type|Boolean}}
 +
| If true, next field is present.
 +
|-
 +
| Date of achieving
 +
| {{Type|Optional}} {{Type|Long}}
 +
| As returned by [https://docs.oracle.com/javase/6/docs/api/java/util/Date.html#getTime() <code>Date.getTime</code>].
 +
|}
 +
 
 +
==== Update Attributes ====
 +
 
 +
Sets {{Minecraft Wiki|Attribute|attributes}} on the given entity.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="6"| 0x71
 +
| rowspan="6"| Play
 +
| rowspan="6"| Client
 +
| colspan="2"| Entity ID
 +
| colspan="2"| {{Type|VarInt}}
 +
|
 +
|-
 +
| colspan="2"| Number Of Properties
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| rowspan="4"| Property
 +
| Key
 +
| rowspan="4"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
| See below.
 +
|-
 +
| Value
 +
| {{Type|Double}}
 +
| See below.
 +
|-
 +
| Number Of Modifiers
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| Modifiers
 +
| {{Type|Array}} of Modifier Data
 +
| See {{Minecraft Wiki|Attribute#Modifiers}}. Modifier Data defined below.
 +
|}
 +
 
 +
Known Key values (see also {{Minecraft Wiki|Attribute#Modifiers}}):
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Key
 +
! Default
 +
! Min
 +
! Max
 +
! Label
 +
|-
 +
| generic.max_health
 +
| 20.0
 +
| 1.0
 +
| 1024.0
 +
| Max Health.
 +
|-
 +
| generic.follow_range
 +
| 32.0
 +
| 0.0
 +
| 2048.0
 +
| Follow Range.
 +
|-
 +
| generic.knockback_resistance
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Knockback Resistance.
 +
|-
 +
| generic.movement_speed
 +
| 0.7
 +
| 0.0
 +
| 1024.0
 +
| Movement Speed.
 +
|-
 +
| generic.flying_speed
 +
| 0.4
 +
| 0.0
 +
| 1024.0
 +
| Flying Speed.
 +
|-
 +
| generic.attack_damage
 +
| 2.0
 +
| 0.0
 +
| 2048.0
 +
| Attack Damage.
 +
|-
 +
| generic.attack_knockback
 +
| 0.0
 +
| 0.0
 +
| 5.0
 +
| &mdash;
 +
|-
 +
| generic.attack_speed
 +
| 4.0
 +
| 0.0
 +
| 1024.0
 +
| Attack Speed.
 +
|-
 +
| generic.armor
 +
| 0.0
 +
| 0.0
 +
| 30.0
 +
| Armor.
 +
|-
 +
| generic.armor_toughness
 +
| 0.0
 +
| 0.0
 +
| 20.0
 +
| Armor Toughness.
 +
|-
 +
| generic.luck
 +
| 0.0
 +
| -1024.0
 +
| 1024.0
 +
| Luck.
 +
|-
 +
| zombie.spawn_reinforcements
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Spawn Reinforcements Chance.
 +
|-
 +
| horse.jump_strength
 +
| 0.7
 +
| 0.0
 +
| 2.0
 +
| Jump Strength.
 +
|-
 +
| generic.reachDistance
 +
| 5.0
 +
| 0.0
 +
| 1024.0
 +
| Player Reach Distance (Forge only).
 +
|-
 +
| forge.swimSpeed
 +
| 1.0
 +
| 0.0
 +
| 1024.0
 +
| Swimming Speed (Forge only).
 +
|}
 +
 
 +
''Modifier Data'' structure:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| UUID
 +
| {{Type|UUID}}
 +
|
 +
|-
 +
| Amount
 +
| {{Type|Double}}
 +
| May be positive or negative.
 +
|-
 +
| Operation
 +
| {{Type|Byte}}
 +
| See below.
 +
|}
 +
 
 +
The operation controls how the base value of the modifier is changed.
 +
 
 +
* 0: Add/subtract amount
 +
* 1: Add/subtract amount percent of the current value
 +
* 2: Multiply by amount percent
 +
 
 +
All of the 0's are applied first, and then the 1's, and then the 2's.
 +
 
 +
==== Entity Effect ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="7"| 0x72
 +
| rowspan="7"| Play
 +
| rowspan="7"| Client
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Effect ID
 +
| {{Type|VarInt}}
 +
| See {{Minecraft Wiki|Status effect#Effect list|this table}}.
 +
|-
 +
| Amplifier
 +
| {{Type|Byte}}
 +
| Notchian client displays effect level as Amplifier + 1.
 +
|-
 +
| Duration
 +
| {{Type|VarInt}}
 +
| Duration in ticks. (-1 for infinite)
 +
|-
 +
| Flags
 +
| {{Type|Byte}}
 +
| Bit field, see below.
 +
|-
 +
| Has Factor Data
 +
| {{Type|Boolean}}
 +
| Used in DARKNESS effect
 +
|-
 +
| Factor Codec
 +
| {{Type|NBT}}
 +
| See below
 +
|}
 +
 
 +
Within flags:
 +
 
 +
* 0x01: Is ambient - was the effect spawned from a beacon?  All beacon-generated effects are ambient.  Ambient effects use a different icon in the HUD (blue border rather than gray).  If all effects on an entity are ambient, the [[Entity_metadata#Living Entity|"Is potion effect ambient" living metadata field]] should be set to true.  Usually should not be enabled.
 +
* 0x02: Show particles - should all particles from this effect be hidden?  Effects with particles hidden are not included in the calculation of the effect color, and are not rendered on the HUD (but are still rendered within the inventory).  Usually should be enabled.
 +
* 0x04: Show icon - should the icon be displayed on the client?  Usually should be enabled.
 +
 
 +
Factor Data
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| padding_duration
 +
| TAG_INT
 +
|
 +
|-
 +
| factor_start
 +
| TAG_FLOAT
 +
|
 +
|-
 +
| factor_target
 +
| TAG_FLOAT
 +
|
 +
|-
 +
| factor_current
 +
| TAG_FLOAT
 +
|
 +
|-
 +
| effect_changed_timestamp
 +
| TAG_INT
 +
|-
 +
| factor_previous_frame
 +
| TAG_FLOAT
 +
|-
 +
| had_effect_last_tick
 +
| TAG_BOOLEAN
 +
|}
 +
 
 +
==== Update Recipes ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="4"| 0x73
 +
| rowspan="4"| Play
 +
| rowspan="4"| Client
 +
| colspan="2"| Num Recipes
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| rowspan="3"| Recipe
 +
| Type
 +
| rowspan="3"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
| The recipe type, see below.
 +
|-
 +
| Recipe ID
 +
| {{Type|Identifier}}
 +
|
 +
|-
 +
| Data
 +
| Varies
 +
| Additional data for the recipe.
 +
|}
 +
 
 +
Recipe types:
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Description
 +
! Data
 +
|-
 +
| <code>minecraft:crafting_shapeless</code>
 +
| Shapeless crafting recipe. All items in the ingredient list must be present, but in any order/slot.
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Group
 +
    | {{Type|String}} (32767)
 +
    | Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
 +
    |-
 +
    |Category
 +
    |{{Type|VarInt}} {{Type|Enum}}
 +
    |Building = 0, Redstone = 1, Equipment = 2, Misc = 3
 +
    |-
 +
    | Ingredient count
 +
    | {{Type|VarInt}}
 +
    | Number of elements in the following array.
 +
    |-
 +
    | Ingredients
 +
    | {{Type|Array}} of Ingredient.
 +
    |
 +
    |-
 +
    | Result
 +
    | {{Type|Slot}}
 +
    |
 +
    |}
 +
|-
 +
| <code>minecraft:crafting_shaped</code>
 +
| Shaped crafting recipe. All items must be present in the same pattern (which may be flipped horizontally or translated).
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Group
 +
    | {{Type|String}} (32767)
 +
    | Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
 +
    |-
 +
    |Category
 +
    |{{Type|VarInt}} {{Type|Enum}}
 +
    |Building = 0, Redstone = 1, Equipment = 2, Misc = 3
 +
    |-
 +
    | Width
 +
    | {{Type|VarInt}}
 +
    |
 +
    |-
 +
    | Height
 +
    | {{Type|VarInt}}
 +
    |
 +
    |-
 +
    | Ingredients
 +
    | {{Type|Array}} of Ingredient
 +
    | Length is <code>width * height</code>. Indexed by <code>x + (y * width)</code>.
 +
    |-
 +
    | Result
 +
    | {{Type|Slot}}
 +
    |-
 +
    | Show notification
 +
    | {{Type|Boolean}}
 +
    | Show a toast when the recipe is [[Protocol#Update_Recipe_Book|added]].
 +
    |}
 +
|-
 +
| <code>minecraft:crafting_special_armordye</code>
 +
| Recipe for dying leather armor
 +
| rowspan="14" | As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    |Category
 +
    |{{Type|VarInt}} {{Type|Enum}}
 +
    |Building = 0, Redstone = 1, Equipment = 2, Misc = 3
 +
    |}
 +
|-
 +
| <code>minecraft:crafting_special_bookcloning</code>
 +
| Recipe for copying contents of written books
 +
|-
 +
| <code>minecraft:crafting_special_mapcloning</code>
 +
| Recipe for copying maps
 +
|-
 +
| <code>minecraft:crafting_special_mapextending</code>
 +
| Recipe for adding paper to maps
 +
|-
 +
| <code>minecraft:crafting_special_firework_rocket</code>
 +
| Recipe for making firework rockets
 +
|-
 +
| <code>minecraft:crafting_special_firework_star</code>
 +
| Recipe for making firework stars
 +
|-
 +
| <code>minecraft:crafting_special_firework_star_fade</code>
 +
| Recipe for making firework stars fade between multiple colors
 +
|-
 +
| <code>minecraft:crafting_special_repairitem</code>
 +
| Recipe for repairing items via crafting
 +
|-
 +
| <code>minecraft:crafting_special_tippedarrow</code>
 +
| Recipe for crafting tipped arrows
 +
|-
 +
| <code>minecraft:crafting_special_bannerduplicate</code>
 +
| Recipe for copying banner patterns
 +
|-
 +
| <code>minecraft:crafting_special_shielddecoration</code>
 +
| Recipe for applying a banner's pattern to a shield
 +
|-
 +
| <code>minecraft:crafting_special_shulkerboxcoloring</code>
 +
| Recipe for recoloring a shulker box
 +
|-
 +
| <code>minecraft:crafting_special_suspiciousstew</code>
 +
| Recipe for crafting suspicious stews
 +
|-
 +
| <code>minecraft:crafting_decorated_pot</code>
 +
| Recipe for crafting decorated pots
 +
|-
 +
| <code>minecraft:smelting</code>
 +
| Smelting recipe
 +
| rowspan="4"| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Group
 +
    | {{Type|String}} (32767)
 +
    | Used to group similar recipes together in the recipe book.
 +
    |-
 +
    |Category
 +
    |{{Type|VarInt}} {{Type|Enum}}
 +
    |Food = 0, Blocks = 1, Misc = 2
 +
    |-
 +
    | Ingredient
 +
    | Ingredient
 +
    |
 +
    |-
 +
    | Result
 +
    | {{Type|Slot}}
 +
    |
 +
    |-
 +
    | Experience
 +
    | {{Type|Float}}
 +
    |
 +
    |-
 +
    | Cooking time
 +
    | {{Type|VarInt}}
 +
    |
 +
    |}
 +
|-
 +
| <code>minecraft:blasting</code>
 +
| Blast furnace recipe
 +
|-
 +
| <code>minecraft:smoking</code>
 +
| Smoker recipe
 +
|-
 +
| <code>minecraft:campfire_cooking</code>
 +
| Campfire recipe
 +
|-
 +
| <code>minecraft:stonecutting</code>
 +
| Stonecutter recipe
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Group
 +
    | {{Type|String}} (32767)
 +
    | Used to group similar recipes together in the recipe book.  Tag is present in recipe JSON.
 +
    |-
 +
    | Ingredient
 +
    | Ingredient
 +
    |
 +
    |-
 +
    | Result
 +
    | {{Type|Slot}}
 +
    |
 +
    |}
 +
|-
 +
| <code>minecraft:smithing_transform</code>
 +
| Recipe for smithing netherite gear
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Template
 +
    | Ingredient
 +
    | The smithing template.
 +
    |-
 +
    | Base
 +
    | Ingredient
 +
    | The base item.
 +
    |-
 +
    | Addition
 +
    | Ingredient
 +
    | The additional ingredient.
 +
    |-
 +
    | Result
 +
    | {{Type|Slot}}
 +
    |
 +
    |}
 +
|-
 +
| <code>minecraft:smithing_trim</code>
 +
| Recipe for applying armor trims
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Template
 +
    | Ingredient
 +
    | The smithing template.
 +
    |-
 +
    | Base
 +
    | Ingredient
 +
    | The base item.
 +
    |-
 +
    | Addition
 +
    | Ingredient
 +
    | The additional ingredient.
 +
    |}
 +
|}
 +
 
 +
Ingredient is defined as:
 +
 
 +
{| class="wikitable"
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| Count
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array.
 +
|-
 +
| Items
 +
| {{Type|Array}} of {{Type|Slot}}
 +
| Any item in this array may be used for the recipe.  The count of each item should be 1.
 +
|}
 +
 
 +
==== Update Tags (play) ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x74
 +
| rowspan="3"| Play
 +
| rowspan="3"| Client
 +
| colspan="2"| Length of the array
 +
| colspan="2"| {{Type|VarInt}}
 +
|
 +
|-
 +
| rowspan="2"| Array of tags
 +
| Registry
 +
| rowspan="2"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
| Registry identifier (Vanilla expects tags for the registries <code>minecraft:block</code>, <code>minecraft:item</code>, <code>minecraft:fluid</code>, <code>minecraft:entity_type</code>, and <code>minecraft:game_event</code>)
 +
|-
 +
| Array of Tag
 +
| (See below)
 +
|
 +
|}
 +
 
 +
Tag arrays look like:
 +
 
 +
{| class="wikitable"
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| colspan="2"| Length
 +
| colspan="2"| {{Type|VarInt}}
 +
| Number of elements in the following array
 +
|-
 +
| rowspan="3"| Tags
 +
| Tag name
 +
| rowspan="3"| {{Type|Array}}
 +
| {{Type|Identifier}}
 +
|
 +
|-
 +
| Count
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array
 +
|-
 +
| Entries
 +
| {{Type|Array}} of {{Type|VarInt}}
 +
| Numeric IDs of the given type (block, item, etc.). This list replaces the previous list of IDs for the given tag. If some preexisting tags are left unmentioned, a warning is printed.
 +
|}
 +
 
 +
See {{Minecraft Wiki|Tag}} on the Minecraft Wiki for more information, including a list of vanilla tags.
 +
 
 +
=== Serverbound ===
 +
 
 +
==== Confirm Teleportation ====
 +
 
 +
Sent by client as confirmation of [[#Synchronize Player Position|Synchronize Player Position]].
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x00
 +
| Play
 +
| Server
 +
| Teleport ID
 +
| {{Type|VarInt}}
 +
| The ID given by the [[#Synchronize Player Position|Synchronize Player Position]] packet.
 +
|}
 +
 
 +
==== Query Block Entity Tag ====
 +
 
 +
Used when <kbd>F3</kbd>+<kbd>I</kbd> is pressed while looking at a block.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x01
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Transaction ID
 +
| {{Type|VarInt}}
 +
| An incremental ID so that the client can verify that the response matches.
 +
|-
 +
| Location
 +
| {{Type|Position}}
 +
| The location of the block to check.
 +
|}
 +
 
 +
==== Change Difficulty ====
 +
 
 +
Must have at least op level 2 to use.  Appears to only be used on singleplayer; the difficulty buttons are still disabled in multiplayer.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x02
 +
| Play
 +
| Server
 +
| New difficulty
 +
| {{Type|Byte}}
 +
| 0: peaceful, 1: easy, 2: normal, 3: hard .
 +
|}
 +
 
 +
==== Acknowledge Message ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x03
 +
| rowspan="1"| Play
 +
| rowspan="1"| Server
 +
| Message Count
 +
| {{Type|VarInt}}
 +
|
 +
|}
 +
 
 +
==== Chat Command ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="8"| 0x04
 +
| rowspan="8"| Play
 +
| rowspan="8"| Server
 +
| colspan="2"| Command
 +
| colspan="2"| {{Type|String}} (256)
 +
| colspan="2"| The command typed by the client.
 +
|-
 +
| colspan="2"| Timestamp
 +
| colspan="2"| {{Type|Long}}
 +
| colspan="2"| The timestamp that the command was executed.
 +
|-
 +
| colspan="2"| Salt
 +
| colspan="2"| {{Type|Long}}
 +
| colspan="2"| The salt for the following argument signatures.
 +
|-
 +
| colspan="2"| Array length
 +
| colspan="2"| {{Type|VarInt}}
 +
| colspan="2"| Number of entries in the following array. The maximum length in Notchian server is 8.
 +
|-
 +
| rowspan="2"| Array of argument signatures
 +
| Argument name
 +
| rowspan="2"| {{Type|Array}} (8)
 +
| {{Type|String}} (16)
 +
| The name of the argument that is signed by the following signature.
 +
|-
 +
| Signature
 +
| {{Type|Byte Array}} (256)
 +
| The signature that verifies the argument. Always 256 bytes and is not length-prefixed.
 +
|-
 +
| colspan="2"| Message Count
 +
| colspan="2"| {{Type|VarInt}}
 +
| colspan="2"|
 +
|-
 +
| colspan="2"| Acknowledged
 +
| colspan="2"| {{Type|Fixed BitSet}} (20)
 +
| colspan="2"|
 +
|}
 +
 
 +
==== Chat Message ====
 +
 
 +
Used to send a chat message to the server.  The message may not be longer than 256 characters or else the server will kick the client.
 +
 
 +
The server will broadcast a [[#Player Chat Message|Player Chat Message]] packet with Chat Type <code>minecraft:chat</code> to all players that haven't disabled chat (including the player that sent the message). See [[Chat#Processing chat]] for more information.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="7"| 0x05
 +
| rowspan="7"| Play
 +
| rowspan="7"| Server
 +
| Message
 +
| {{Type|String}} (256)
 +
|
 +
|-
 +
| Timestamp
 +
| {{Type|Long}}
 +
|
 +
|-
 +
| Salt
 +
| {{Type|Long}}
 +
| The salt used to verify the signature hash.
 +
|-
 +
| Has Signature
 +
| {{Type|Boolean}}
 +
| Whether the next field is present.
 +
|-
 +
| Signature
 +
| {{Type|Optional}} {{Type|Byte Array}} (256)
 +
| The signature used to verify the chat message's authentication. When present, always 256 bytes and not length-prefixed.
 +
|-
 +
| Message Count
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Acknowledged
 +
| {{Type|Fixed BitSet}} (20)
 +
|
 +
|}
 +
 
 +
==== Player Session ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="6"| 0x06
 +
| rowspan="6"| Play
 +
| rowspan="6"| Server
 +
| colspan="2"| Session Id
 +
| {{Type|UUID}}
 +
|
 +
|-
 +
| rowspan="5"| Public Key
 +
| Expires At
 +
| {{Type|Long}}
 +
| The time the play session key expires in [https://en.wikipedia.org/wiki/Unix_time epoch] milliseconds.
 +
|-
 +
| Public Key Length
 +
| {{Type|VarInt}}
 +
| Length of the proceeding public key. Maximum length in Notchian server is 512 bytes.
 +
|-
 +
| Public Key
 +
| {{Type|Byte Array}} (512)
 +
| A byte array of an X.509-encoded public key.
 +
|-
 +
| Key Signature Length
 +
| {{Type|VarInt}}
 +
| Length of the proceeding key signature array. Maximum length in Notchian server is 4096 bytes.
 +
|-
 +
| Key Signature
 +
| {{Type|Byte Array}} (4096)
 +
| The signature consists of the player UUID, the key expiration timestamp, and the public key data. These values are hashed using [https://en.wikipedia.org/wiki/SHA-1 SHA-1] and signed using Mojang's private [https://en.wikipedia.org/wiki/RSA_(cryptosystem) RSA] key.
 +
|}
 +
 
 +
==== Chunk Batch Received ====
 +
 
 +
Notifies the server that the chunk batch has been received by the client. The server uses the value sent in this packet to adjust the number of chunks to be sent in a batch.
 +
 
 +
The Notchian server will stop sending further chunk data until the client acknowledges the sent chunk batch. After the first acknowledgement, the server adjusts this number to allow up to 10 unacknowledged batches.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x07
 +
| rowspan="1"| Play
 +
| rowspan="1"| Server
 +
| Chunks per tick
 +
| {{Type|Float}}
 +
| Desired chunks per tick.
 +
|}
 +
 
 +
==== Client Status ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x08
 +
| Play
 +
| Server
 +
| Action ID
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| See below
 +
|}
 +
 
 +
''Action ID'' values:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Action ID
 +
! Action
 +
! Notes
 +
|-
 +
| 0
 +
| Perform respawn
 +
| Sent when the client is ready to complete login and when the client is ready to respawn after death.
 +
|-
 +
| 1
 +
| Request stats
 +
| Sent when the client opens the Statistics menu.
 +
|}
 +
 
 +
==== Client Information (play) ====
 +
 
 +
Sent when the player connects, or when settings are changed.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="8"| 0x09
 +
| rowspan="8"| Play
 +
| rowspan="8"| Server
 +
| Locale
 +
| {{Type|String}} (16)
 +
| e.g. <code>en_GB</code>.
 +
|-
 +
| View Distance
 +
| {{Type|Byte}}
 +
| Client-side render distance, in chunks.
 +
|-
 +
| Chat Mode
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| 0: enabled, 1: commands only, 2: hidden.  See [[Chat#Client chat mode]] for more information.
 +
|-
 +
| Chat Colors
 +
| {{Type|Boolean}}
 +
| “Colors” multiplayer setting. Can the chat be colored?
 +
|-
 +
| Displayed Skin Parts
 +
| {{Type|Unsigned Byte}}
 +
| Bit mask, see below.
 +
|-
 +
| Main Hand
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| 0: Left, 1: Right.
 +
|-
 +
| Enable text filtering
 +
| {{Type|Boolean}}
 +
| Enables filtering of text on signs and written book titles. Currently always false (i.e. the filtering is disabled)
 +
|-
 +
| Allow server listings
 +
| {{Type|Boolean}}
 +
| Servers usually list online players, this option should let you not show up in that list.
 +
|}
 +
 
 +
''Displayed Skin Parts'' flags:
 +
 
 +
* Bit 0 (0x01): Cape enabled
 +
* Bit 1 (0x02): Jacket enabled
 +
* Bit 2 (0x04): Left Sleeve enabled
 +
* Bit 3 (0x08): Right Sleeve enabled
 +
* Bit 4 (0x10): Left Pants Leg enabled
 +
* Bit 5 (0x20): Right Pants Leg enabled
 +
* Bit 6 (0x40): Hat enabled
 +
 
 +
The most significant bit (bit 7, 0x80) appears to be unused.
 +
 
 +
==== Command Suggestions Request ====
 +
 
 +
Sent when the client needs to tab-complete a <code>minecraft:ask_server</code> suggestion type.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x0A
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Transaction Id
 +
| {{Type|VarInt}}
 +
| The id of the transaction that the server will send back to the client in the response of this packet. Client generates this and increments it each time it sends another tab completion that doesn't get a response.
 +
|-
 +
| Text
 +
| {{Type|String}} (32500)
 +
| All text behind the cursor without the <code>/</code> (e.g. to the left of the cursor in left-to-right languages like English).
 +
|}
 +
 
 +
==== Acknowledge Configuration ====
 +
 
 +
Sent by the client upon receiving a [[#Start Configuration|Start Configuration]] packet from the server.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x0B
 +
| rowspan="1"| Play
 +
| rowspan="1"| Server
 +
| colspan="3"| ''no fields''
 +
|}
 +
 
 +
This packet switches the connection state to [[#Configuration|configuration]].
 +
 
 +
==== Click Container Button ====
 +
 
 +
Used when clicking on window buttons.  Until 1.14, this was only used by enchantment tables.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x0C
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Window ID
 +
| {{Type|Byte}}
 +
| The ID of the window sent by [[#Open Screen|Open Screen]].
 +
|-
 +
| Button ID
 +
| {{Type|Byte}}
 +
| Meaning depends on window type; see below.
 +
|}
 +
 
 +
{| class="wikitable"
 +
! Window type
 +
! ID
 +
! Meaning
 +
|-
 +
| rowspan="3"| Enchantment Table
 +
| 0 || Topmost enchantment.
 +
|-
 +
| 1 || Middle enchantment.
 +
|-
 +
| 2 || Bottom enchantment.
 +
|-
 +
| rowspan="4"| Lectern
 +
| 1 || Previous page (which does give a redstone output).
 +
|-
 +
| 2 || Next page.
 +
|-
 +
| 3 || Take Book.
 +
|-
 +
| 100+page || Opened page number - 100 + number.
 +
|-
 +
| Stonecutter
 +
| colspan="2"| Recipe button number - 4*row + col.  Depends on the item.
 +
|-
 +
| Loom
 +
| colspan="2"| Recipe button number - 4*row + col.  Depends on the item.
 +
|}
 +
 
 +
==== Click Container ====
 +
 
 +
This packet is sent by the client when the player clicks on a slot in a window.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="9"| 0x0D
 +
| rowspan="9"| Play
 +
| rowspan="9"| Server
 +
| colspan="2"| Window ID
 +
| colspan="2"| {{Type|Unsigned Byte}}
 +
| colspan="2"| The ID of the window which was clicked. 0 for player inventory. The server ignores any packets targeting a Window ID other than the current one, including ignoring 0 when any other window is open.
 +
|-
 +
| colspan="2"| State ID
 +
| colspan="2"| {{Type|VarInt}}
 +
| colspan="2"| The last received State ID from either a [[#Set Container Slot|Set Container Slot]] or a [[#Set Container Content|Set Container Content]] packet.
 +
|-
 +
| colspan="2"| Slot
 +
| colspan="2"| {{Type|Short}}
 +
| colspan="2"| The clicked slot number, see below.
 +
|-
 +
| colspan="2"| Button
 +
| colspan="2"| {{Type|Byte}}
 +
| colspan="2"| The button used in the click, see below.
 +
|-
 +
| colspan="2"| Mode
 +
| colspan="2"| {{Type|VarInt}} {{Type|Enum}}
 +
| colspan="2"| Inventory operation mode, see below.
 +
|-
 +
| colspan="2"| Length of the array
 +
| colspan="2"| {{Type|VarInt}}
 +
| colspan="2"| Maximum value for Notchian server is 128 slots.
 +
|-
 +
| rowspan="2"| Array of changed slots
 +
| Slot number
 +
| rowspan="2"| {{Type|Array}} (128)
 +
| {{Type|Short}}
 +
|
 +
|-
 +
| Slot data
 +
| {{Type|Slot}}
 +
| New data for this slot, in the client's opinion; see below.
 +
|-
 +
| colspan="2"| Carried item
 +
| colspan="2"| [[Slot Data|Slot]]
 +
| colspan="2"| Item carried by the cursor. Has to be empty (item ID = -1) for drop mode, otherwise nothing will happen.
 +
|}
 +
 
 +
See [[Inventory]] for further information about how slots are indexed.
 +
 
 +
After performing the action, the server compares the results to the slot change information included in the packet, as applied on top of the server's view of the container's state prior to the action. For any slots that do not match, it sends [[#Set Container Slot|Set Container Slot]] packets containing the correct results. If State ID does not match the last ID sent by the server, it will instead send a full [[#Set Container Content|Set Container Content]] to resynchronize the client.
 +
 
 +
When right-clicking on a stack of items, half the stack will be picked up and half left in the slot. If the stack is an odd number, the half left in the slot will be smaller of the amounts.
 +
 
 +
The distinct type of click performed by the client is determined by the combination of the Mode and Button fields.
 +
 
 +
{| class="wikitable"
 +
! Mode
 +
! Button
 +
! Slot
 +
! Trigger
 +
|-
 +
! rowspan="4"| 0
 +
| 0
 +
| Normal
 +
| Left mouse click
 +
|-
 +
| 1
 +
| Normal
 +
| Right mouse click
 +
|-
 +
| 0
 +
| -999
 +
| Left click outside inventory (drop cursor stack)
 +
|-
 +
| 1
 +
| -999
 +
| Right click outside inventory (drop cursor single item)
 +
|-
 +
! rowspan="2"| 1
 +
| 0
 +
| Normal
 +
| Shift + left mouse click
 +
|-
 +
| 1
 +
| Normal
 +
| Shift + right mouse click ''(identical behavior)''
 +
|-
 +
! rowspan="7"| 2
 +
| 0
 +
| Normal
 +
| Number key 1
 +
|-
 +
| 1
 +
| Normal
 +
| Number key 2
 +
|-
 +
| 2
 +
| Normal
 +
| Number key 3
 +
|-
 +
| ⋮
 +
| ⋮
 +
| ⋮
 +
|-
 +
| 8
 +
| Normal
 +
| Number key 9
 +
|-
 +
| ⋮
 +
| ⋮
 +
| Button is used as the slot index (impossible in vanilla clients)
 +
|-
 +
| 40
 +
| Normal
 +
| Offhand swap key F
 +
|-
 +
! 3
 +
| 2
 +
| Normal
 +
| Middle click, only defined for creative players in non-player inventories.
 +
|-
 +
! rowspan="2"| 4
 +
| 0
 +
| Normal*
 +
| Drop key (Q) (* Clicked item is always empty)
 +
|-
 +
| 1
 +
| Normal*
 +
| Control + Drop key (Q) (* Clicked item is always empty)
 +
|-
 +
! rowspan="9"| 5
 +
| 0
 +
| -999
 +
| Starting left mouse drag
 +
|-
 +
| 4
 +
| -999
 +
| Starting right mouse drag
 +
|-
 +
| 8
 +
| -999
 +
| Starting middle mouse drag, only defined for creative players in non-player inventories.
 +
|-
 +
| 1
 +
| Normal
 +
| Add slot for left-mouse drag
 +
|-
 +
| 5
 +
| Normal
 +
| Add slot for right-mouse drag
 +
|-
 +
| 9
 +
| Normal
 +
| Add slot for middle-mouse drag, only defined for creative players in non-player inventories.
 +
|-
 +
| 2
 +
| -999
 +
| Ending left mouse drag
 +
|-
 +
| 6
 +
| -999
 +
| Ending right mouse drag
 +
|-
 +
| 10
 +
| -999
 +
| Ending middle mouse drag, only defined for creative players in non-player inventories.
 +
|-
 +
! rowspan="2"| 6
 +
| 0
 +
| Normal
 +
| Double click
 +
|-
 +
| 1
 +
| Normal
 +
| Pickup all but check items in reverse order (impossible in vanilla clients)
 +
|}
 +
 
 +
Starting from version 1.5, “painting mode” is available for use in inventory windows. It is done by picking up stack of something (more than 1 item), then holding mouse button (left, right or middle) and dragging held stack over empty (or same type in case of right button) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):
 +
 
 +
# packet with mode 5, slot -999, button (0 for left | 4 for right);
 +
# packet for every slot painted on, mode is still 5, button (1 | 5);
 +
# packet with mode 5, slot -999, button (2 | 6);
 +
 
 +
If any of the painting packets other than the “progress” ones are sent out of order (for example, a start, some slots, then another start; or a left-click in the middle) the painting status will be reset.
 +
 
 +
==== Close Container ====
 +
 
 +
This packet is sent by the client when closing a window.
 +
 
 +
Notchian clients send a Close Window packet with Window ID 0 to close their inventory even though there is never an [[#Open Screen|Open Screen]] packet for the inventory.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x0E
 +
| Play
 +
| Server
 +
| Window ID
 +
| {{Type|Unsigned Byte}}
 +
| This is the ID of the window that was closed. 0 for player inventory.
 +
|}
 +
 
 +
==== Change Container Slot State ====
 +
 
 +
This packet is sent by the client when toggling the state of a Crafter.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x0F
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Slot ID
 +
| {{Type|VarInt}}
 +
| This is the ID of the slot that was changed.
 +
|-
 +
| Window ID
 +
| {{Type|VarInt}}
 +
| This is the ID of the window that was changed.
 +
|-
 +
| State
 +
| {{Type|Boolean}}
 +
| The new state of the slot. True for enabled, false for disabled.
 +
|}
 +
 
 +
==== Serverbound Plugin Message (play) ====
 +
 
 +
{{Main|Plugin channels}}
 +
 
 +
Mods and plugins can use this to send their data. Minecraft itself uses some [[plugin channel]]s. These internal channels are in the <code>minecraft</code> namespace.
 +
 
 +
More documentation on this: [https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 +
 
 +
Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x10
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Channel
 +
| {{Type|Identifier}}
 +
| Name of the [[plugin channel]] used to send the data.
 +
|-
 +
| Data
 +
| {{Type|Byte Array}} (32767)
 +
| 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.
 +
|}
 +
 
 +
In Notchian server, the maximum data length is 32767 bytes.
 +
 
 +
==== Edit Book ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="5"| 0x11
 +
| rowspan="5"| Play
 +
| rowspan="5"| Server
 +
| Slot
 +
| {{Type|VarInt}}
 +
| The hotbar slot where the written book is located
 +
|-
 +
| Count
 +
| {{Type|VarInt}}
 +
| Number of elements in the following array. Maximum array size is 200.
 +
|-
 +
| Entries
 +
| {{Type|Array}} (200) of {{Type|String}} (8192)
 +
| Text from each page. Maximum string length is 8192 chars.
 +
|-
 +
| Has title
 +
| {{Type|Boolean}}
 +
| If true, the next field is present. true if book is being signed, false if book is being edited.
 +
|-
 +
| Title
 +
| {{Type|Optional}} {{Type|String}} (128)
 +
| Title of book.
 +
|}
 +
 
 +
==== Query Entity Tag ====
 +
 
 +
Used when <kbd>F3</kbd>+<kbd>I</kbd> is pressed while looking at an entity.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x12
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Transaction ID
 +
| {{Type|VarInt}}
 +
| An incremental ID so that the client can verify that the response matches.
 +
|-
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
| The ID of the entity to query.
 +
|}
 +
 
 +
==== Interact ====
 +
 
 +
This packet is sent from the client to the server when the client attacks or right-clicks another entity (a player, minecart, etc).
 +
 
 +
A Notchian server only accepts this packet if the entity being attacked/used is visible without obstruction and within a 4-unit radius of the player's position.
 +
 
 +
The target X, Y, and Z fields represent the difference between the vector location of the cursor at the time of the packet and the entity's position.
 +
 
 +
Note that middle-click in creative mode is interpreted by the client and sent as a [[#Set Creative Mode Slot|Set Creative Mode Slot]] packet instead.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="7"| 0x13
 +
| rowspan="7"| Play
 +
| rowspan="7"| Server
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
| The ID of the entity to interact.
 +
|-
 +
| Type
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| 0: interact, 1: attack, 2: interact at.
 +
|-
 +
| Target X
 +
| {{Type|Optional}} {{Type|Float}}
 +
| Only if Type is interact at.
 +
|-
 +
| Target Y
 +
| {{Type|Optional}} {{Type|Float}}
 +
| Only if Type is interact at.
 +
|-
 +
| Target Z
 +
| {{Type|Optional}} {{Type|Float}}
 +
| Only if Type is interact at.
 +
|-
 +
| Hand
 +
| {{Type|Optional}} {{Type|VarInt}} {{Type|Enum}}
 +
| Only if Type is interact or interact at; 0: main hand, 1: off hand.
 +
|-
 +
| Sneaking
 +
| {{Type|Boolean}}
 +
| If the client is sneaking.
 +
|}
 +
 
 +
==== Jigsaw Generate ====
 +
 
 +
Sent when Generate is pressed on the {{Minecraft Wiki|Jigsaw Block}} interface.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x14
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Location
 +
| {{Type|Position}}
 +
| Block entity location.
 +
|-
 +
| Levels
 +
| {{Type|VarInt}}
 +
| Value of the levels slider/max depth to generate.
 +
|-
 +
| Keep Jigsaws
 +
| {{Type|Boolean}}
 +
|
 +
|}
 +
 
 +
==== Serverbound Keep Alive (play) ====
 +
 
 +
The server will frequently send out a keep-alive (see [[#Clientbound Keep Alive (play)|Clientbound Keep Alive]]), each containing a random ID. The client must respond with the same packet.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x15
 +
| Play
 +
| Server
 +
| Keep Alive ID
 +
| {{Type|Long}}
 +
|
 +
|}
 +
 
 +
==== Lock Difficulty ====
 +
 
 +
Must have at least op level 2 to use.  Appears to only be used on singleplayer; the difficulty buttons are still disabled in multiplayer.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x16
 +
| Play
 +
| Server
 +
| Locked
 +
| {{Type|Boolean}}
 +
|
 +
|}
 +
 
 +
==== Set Player Position ====
 +
 
 +
Updates the player's XYZ position on the server.
 +
 
 +
If the player is in a vehicle, the position is ignored (but in case of [[#Set Player Position and Rotation|Set Player Position and Rotation]], the rotation is still used as normal). No validation steps other than value range clamping are performed in this case.
 +
 
 +
If the player is sleeping, the position (or rotation) is not changed, and a [[#Synchronize Player Position|Synchronize Player Position]] is sent if the received position deviated from the server's view by more than a meter.
 +
 
 +
The Notchian server silently clamps the x and z coordinates between -30,000,000 and 30,000,000, and the y coordinate between -20,000,000 and 20,000,000. A similar condition has historically caused a kick for "Illegal position"; this is no longer the case. However, infinite or NaN coordinates (or angles) still result in a kick for <code>multiplayer.disconnect.invalid_player_movement</code>.
 +
 
 +
As of 1.20.4, checking for moving too fast is achieved like this (sic):
 +
 
 +
* Each server tick, the player's current position is stored.
 +
* When the player moves, the offset from the stored position to the requested position is computed (&Delta;x, &Delta;y, &Delta;z).
 +
* The requested movement distance squared is computed as &Delta;x&sup2; + &Delta;y&sup2; + &Delta;z&sup2;.
 +
* The baseline expected movement distance squared is computed based on  the player's server-side velocity as Vx&sup2; + Vy&sup2; + Vz&sup2;. The player's server-side velocity is a somewhat ill-defined quantity that includes among other things gravity, jump velocity and knockback, but ''not'' regular horizontal movement. A proper description would bring much of Minecraft's physics engine with it. It is accessible as the <code>Motion</code> NBT tag on the player entity.
 +
* The maximum permitted movement distance squared is computed as 100 (300 if the player is using an elytra), multiplied by the number of movement packets received since the last tick, including this one, unless that value is greater than 5, in which case no multiplier is applied.
 +
* If the requested movement distance squared minus the baseline distance squared is more than the maximum squared, the player is moving too fast.
 +
 
 +
If the player is moving too fast, it is logged that "<player> moved too quickly! " followed by the change in x, y, and z, and the player is teleported back to their current (before this packet) server-side position.
 +
 
 +
Checking for block collisions is achieved like this:
 +
 
 +
* A temporary collision-checked move of the player is attempted from its current position to the requested one.
 +
* The offset from the resulting position to the requested position is computed. If the absolute value of the offset on the y axis is less than 0.5, it (only the y component) is rounded down to 0.
 +
* If the magnitude of the offset is greater than 0.25 and the player isn't in creative or spectator mode, it is logged that "<player> moved wrongly!", and the player is teleported back to their current (before this packet) server-side position.
 +
* In addition, if the player's hitbox stationary at the requested position would intersect with a block, and they aren't in spectator mode, they are teleported back without a log message.
 +
 
 +
Checking for illegal flight is achieved like this:
 +
 
 +
* When a movement packet is received, a flag indicating whether or not the player is floating mid-air is updated. The flag is set if the move test described above detected no collision below the player ''and'' the y component of the offset from the player's current position to the requested one is greater than -0.5, unless any of various conditions permitting flight (creative mode, elytra, levitation effect, etc., but not jumping) are met.
 +
* Each server tick, it is checked if the flag has been set for more than 80 consecutive ticks. If so, and the player isn't currently sleeping, dead or riding a vehicle, they are kicked for <code>multiplayer.disconnect.flying</code>.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="4"| 0x17
 +
| rowspan="4"| Play
 +
| rowspan="4"| Server
 +
| X
 +
| {{Type|Double}}
 +
| Absolute position.
 +
|-
 +
| Feet Y
 +
| {{Type|Double}}
 +
| Absolute feet position, normally Head Y - 1.62.
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
| Absolute position.
 +
|-
 +
| On Ground
 +
| {{Type|Boolean}}
 +
| True if the client is on the ground, false otherwise.
 +
|}
 +
 
 +
==== Set Player Position and Rotation ====
 +
 
 +
A combination of [[#Set Player Rotation|Move Player Rotation]] and [[#Set Player Position|Move Player Position]].
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="6"| 0x18
 +
| rowspan="6"| Play
 +
| rowspan="6"| Server
 +
| X
 +
| {{Type|Double}}
 +
| Absolute position.
 +
|-
 +
| Feet Y
 +
| {{Type|Double}}
 +
| Absolute feet position, normally Head Y - 1.62.
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
| Absolute position.
 +
|-
 +
| Yaw
 +
| {{Type|Float}}
 +
| Absolute rotation on the X Axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Absolute rotation on the Y Axis, in degrees.
 +
|-
 +
| On Ground
 +
| {{Type|Boolean}}
 +
| True if the client is on the ground, false otherwise.
 +
|}
 +
 
 +
==== Set Player Rotation ====
 +
[[File:Minecraft-trig-yaw.png|thumb|The unit circle for yaw]]
 +
[[File:Yaw.png|thumb|The unit circle of yaw, redrawn]]
 +
 
 +
Updates the direction the player is looking in.
 +
 
 +
Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0,-1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.
 +
 
 +
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
 +
 
 +
The yaw and pitch of player (in degrees), standing at point (x0, y0, z0) and looking towards point (x, y, z) can be calculated with:
 +
 
 +
dx = x-x0
 +
dy = y-y0
 +
dz = z-z0
 +
r = sqrt( dx*dx + dy*dy + dz*dz )
 +
yaw = -atan2(dx,dz)/PI*180
 +
if yaw < 0 then
 +
    yaw = 360 + yaw
 +
pitch = -arcsin(dy/r)/PI*180
 +
 
 +
You can get a unit vector from a given yaw/pitch via:
 +
 
 +
x = -cos(pitch) * sin(yaw)
 +
y = -sin(pitch)
 +
z =  cos(pitch) * cos(yaw)
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x19
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Yaw
 +
| {{Type|Float}}
 +
| Absolute rotation on the X Axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Absolute rotation on the Y Axis, in degrees.
 +
|-
 +
| On Ground
 +
| {{Type|Boolean}}
 +
| True if the client is on the ground, false otherwise.
 +
|}
 +
 
 +
==== Set Player On Ground ====
 +
 
 +
This packet as well as [[#Set Player Position|Set Player Position]], [[#Set Player Rotation|Set Player Rotation]], and [[#Set Player Position and Rotation|Set Player Position and Rotation]] are called the “serverbound movement packets”. Vanilla clients will send Move Player Position once every 20 ticks even for a stationary player.
 +
 
 +
This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).
 +
 
 +
When dropping from sufficient height, fall damage is applied when this state goes from false to true. The amount of damage applied is based on the point where it last changed from true to false. Note that there are several movement related packets containing this state.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x1A
 +
| Play
 +
| Server
 +
| On Ground
 +
| {{Type|Boolean}}
 +
| True if the client is on the ground, false otherwise.
 +
|}
 +
 
 +
==== Move Vehicle ====
 +
 
 +
Sent when a player moves in a vehicle. Fields are the same as in [[#Set Player Position and Rotation|Set Player Position and Rotation]]. Note that all fields use absolute positioning and do not allow for relative positioning.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="5"| 0x1B
 +
| rowspan="5"| Play
 +
| rowspan="5"| Server
 +
| X
 +
| {{Type|Double}}
 +
| Absolute position (X coordinate).
 +
|-
 +
| Y
 +
| {{Type|Double}}
 +
| Absolute position (Y coordinate).
 +
|-
 +
| Z
 +
| {{Type|Double}}
 +
| Absolute position (Z coordinate).
 +
|-
 +
| Yaw
 +
| {{Type|Float}}
 +
| Absolute rotation on the vertical axis, in degrees.
 +
|-
 +
| Pitch
 +
| {{Type|Float}}
 +
| Absolute rotation on the horizontal axis, in degrees.
 +
|}
 +
 
 +
==== Paddle Boat ====
 +
 
 +
Used to ''visually'' update whether boat paddles are turning.  The server will update the [[Entity_metadata#Boat|Boat entity metadata]] to match the values here.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x1C
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Left paddle turning
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Right paddle turning
 +
| {{Type|Boolean}}
 +
|
 +
|}
 +
 
 +
Right paddle turning is set to true when the left button or forward button is held, left paddle turning is set to true when the right button or forward button is held.
 +
 
 +
==== Pick Item ====
 +
 
 +
Used to swap out an empty space on the hotbar with the item in the given inventory slot.  The Notchian client uses this for pick block functionality (middle click) to retrieve items from the inventory.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x1D
 +
| Play
 +
| Server
 +
| Slot to use
 +
| {{Type|VarInt}}
 +
| See [[Inventory]].
 +
|}
 +
 
 +
The server first searches the player's hotbar for an empty slot, starting from the current slot and looping around to the slot before it.  If there are no empty slots, it starts a second search from the current slot and finds the first slot that does not contain an enchanted item.  If there still are no slots that meet that criteria, then the server uses the currently selected slot.
 +
 
 +
After finding the appropriate slot, the server swaps the items and sends 3 packets:
 +
 
 +
* [[#Set Container Slot|Set Container Slot]] with window ID set to -2, updating the chosen hotbar slot.
 +
* [[#Set Container Slot|Set Container Slot]] with window ID set to -2, updating the slot where the picked item used to be.
 +
* [[#Set Held Item (clientbound)|Set Held Item]], switching to the newly chosen slot.
 +
 
 +
==== Ping Request (play) ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x1E
 +
| Play
 +
| Server
 +
| Payload
 +
| {{Type|Long}}
 +
| May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.
 +
|}
 +
 
 +
==== Place Recipe ====
 +
 
 +
This packet is sent when a player clicks a recipe in the crafting book that is craftable (white border).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x1F
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Window ID
 +
| {{Type|Byte}}
 +
|
 +
|-
 +
| Recipe
 +
| {{Type|Identifier}}
 +
| A recipe ID.
 +
|-
 +
| Make all
 +
| {{Type|Boolean}}
 +
| Affects the amount of items processed; true if shift is down when clicked.
 +
|}
 +
 
 +
==== Player Abilities (serverbound) ====
 +
 
 +
The vanilla client sends this packet when the player starts/stops flying with the Flags parameter changed accordingly.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x20
 +
| Play
 +
| Server
 +
| Flags
 +
| {{Type|Byte}}
 +
| Bit mask. 0x02: is flying.
 +
|}
 +
 
 +
==== Player Action ====
 +
 
 +
Sent when the player mines a block. A Notchian server only accepts digging packets with coordinates within a 6-unit radius between the center of the block and the player's eyes.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="4"| 0x21
 +
| rowspan="4"| Play
 +
| rowspan="4"| Server
 +
| Status
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| The action the player is taking against the block (see below).
 +
|-
 +
| Location
 +
| {{Type|Position}}
 +
| Block position.
 +
|-
 +
| Face
 +
| {{Type|Byte}} {{Type|Enum}}
 +
| The face being hit (see below).
 +
|-
 +
| Sequence
 +
| {{Type|VarInt}}
 +
| Block change sequence number (see [[#Acknowledge Block Change]]).
 +
|}
 +
 
 +
Status can be one of seven values:
 +
 
 +
{| class="wikitable"
 +
! Value
 +
! Meaning
 +
! Notes
 +
|-
 +
| 0
 +
| Started digging
 +
| Sent when the player starts digging a block. If the block was instamined or the player is in creative mode, the client will ''not'' send Status = Finished digging, and will assume the server completed the destruction. To detect this, it is necessary to {{Minecraft Wiki|Breaking#Speed|calculate the block destruction speed}} server-side.
 +
|-
 +
| 1
 +
| Cancelled digging
 +
| Sent when the player lets go of the Mine Block key (default: left click). Face is always set to -Y.
 +
|-
 +
| 2
 +
| Finished digging
 +
| Sent when the client thinks it is finished.
 +
|-
 +
| 3
 +
| Drop item stack
 +
| Triggered by using the Drop Item key (default: Q) with the modifier to drop the entire selected stack (default: Control or Command, depending on OS). Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.
 +
|-
 +
| 4
 +
| Drop item
 +
| Triggered by using the Drop Item key (default: Q). Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.
 +
|-
 +
| 5
 +
| Shoot arrow / finish eating
 +
| Indicates that the currently held item should have its state updated such as eating food, pulling back bows, using buckets, etc. Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.
 +
|-
 +
| 6
 +
| Swap item in hand
 +
| Used to swap or assign an item to the second hand. Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.
 +
|}
 +
 
 +
The Face field can be one of the following values, representing the face being hit:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Value
 +
! Offset
 +
! Face
 +
|-
 +
| 0
 +
| -Y
 +
| Bottom
 +
|-
 +
| 1
 +
| +Y
 +
| Top
 +
|-
 +
| 2
 +
| -Z
 +
| North
 +
|-
 +
| 3
 +
| +Z
 +
| South
 +
|-
 +
| 4
 +
| -X
 +
| West
 +
|-
 +
| 5
 +
| +X
 +
| East
 +
|}
 +
 
 +
==== Player Command ====
 +
 
 +
Sent by the client to indicate that it has performed certain actions: sneaking (crouching), sprinting, exiting a bed, jumping with a horse, and opening a horse's inventory while riding it.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x22
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
| Player ID
 +
|-
 +
| Action ID
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| The ID of the action, see below.
 +
|-
 +
| Jump Boost
 +
| {{Type|VarInt}}
 +
| Only used by the “start jump with horse” action, in which case it ranges from 0 to 100. In all other cases it is 0.
 +
|}
 +
 
 +
Action ID can be one of the following values:
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Action
 +
|-
 +
| 0
 +
| Start sneaking
 +
|-
 +
| 1
 +
| Stop sneaking
 +
|-
 +
| 2
 +
| Leave bed
 +
|-
 +
| 3
 +
| Start sprinting
 +
|-
 +
| 4
 +
| Stop sprinting
 +
|-
 +
| 5
 +
| Start jump with horse
 +
|-
 +
| 6
 +
| Stop jump with horse
 +
|-
 +
| 7
 +
| Open vehicle inventory
 +
|-
 +
| 8
 +
| Start flying with elytra
 +
|}
 +
 
 +
Leave bed is only sent when the “Leave Bed” button is clicked on the sleep GUI, not when waking up in the morning.
 +
 
 +
Open vehicle inventory is only sent when pressing the inventory key (default: E) while on a horse or chest boat — all other methods of opening such an inventory (involving right-clicking or shift-right-clicking it) do not use this packet.
 +
 
 +
==== Player Input ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x23
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Sideways
 +
| {{Type|Float}}
 +
| Positive to the left of the player.
 +
|-
 +
| Forward
 +
| {{Type|Float}}
 +
| Positive forward.
 +
|-
 +
| Flags
 +
| {{Type|Unsigned Byte}}
 +
| Bit mask. 0x1: jump, 0x2: unmount.
 +
|}
 +
 
 +
Also known as 'Input' packet.
 +
 
 +
==== Pong (play) ====
 +
 
 +
Response to the clientbound packet ([[#Ping (play)|Ping]]) with the same id.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x24
 +
| Play
 +
| Server
 +
| ID
 +
| {{Type|Int}}
 +
| id is the same as the ping packet
 +
|}
 +
 
 +
==== Change Recipe Book Settings ====
 +
 
 +
Replaces Recipe Book Data, type 1.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x25
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Book ID
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| 0: crafting, 1: furnace, 2: blast furnace, 3: smoker.
 +
|-
 +
| Book Open
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Filter Active
 +
| {{Type|Boolean}}
 +
|
 +
|}
 +
 
 +
==== Set Seen Recipe ====
 +
 
 +
Sent when recipe is first seen in recipe book. Replaces Recipe Book Data, type 0.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x26
 +
| Play
 +
| Server
 +
| Recipe ID
 +
| {{Type|Identifier}}
 +
|
 +
|}
 +
 
 +
==== Rename Item ====
 +
 
 +
Sent as a player is renaming an item in an anvil (each keypress in the anvil UI sends a new Rename Item packet). If the new name is empty, then the item loses its custom name (this is different from setting the custom name to the normal name of the item). The item name may be no longer than 50 characters long, and if it is longer than that, then the rename is silently ignored.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x27
 +
| Play
 +
| Server
 +
| Item name
 +
| {{Type|String}} (32767)
 +
| The new name of the item.
 +
|}
 +
 
 +
==== Resource Pack Response (play) ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3" | 0x28
 +
| rowspan="3" | Play
 +
| rowspan="3" | Server
 +
|-
 +
| UUID
 +
| {{Type|UUID}}
 +
| The unique identifier of the resource pack received in the [[#Add_Resource_Pack_(play)|Add Resource Pack (play)]] request.
 +
|-
 +
| Result
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| Result ID (see below).
 +
|}
 +
 
 +
Result can be one of the following values:
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Result
 +
|-
 +
| 0
 +
| Successfully downloaded
 +
|-
 +
| 1
 +
| Declined
 +
|-
 +
| 2
 +
| Failed to download
 +
|-
 +
| 3
 +
| Accepted
 +
|-
 +
| 4
 +
| Invalid URL
 +
|-
 +
| 5
 +
| Failed to reload
 +
|-
 +
| 6
 +
| Discarded
 +
|}
 +
 
 +
 
 +
==== Seen Advancements ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x29
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Action
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| 0: Opened tab, 1: Closed screen.
 +
|-
 +
| Tab ID
 +
| {{Type|Optional}} {{Type|Identifier}}
 +
| Only present if action is Opened tab.
 +
|}
 +
 
 +
==== Select Trade ====
 +
 
 +
When a player selects a specific trade offered by a villager NPC.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x2A
 +
| Play
 +
| Server
 +
| Selected slot
 +
| {{Type|VarInt}}
 +
| The selected slot in the players current (trading) inventory.
 +
|}
 +
 
 +
==== Set Beacon Effect ====
 +
 
 +
Changes the effect of the current beacon.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="5"| 0x2B
 +
| rowspan="5"| Play
 +
| rowspan="5"| Server
 +
|-
 +
| Has Primary Effect
 +
| {{Type|Boolean}}
 +
|-
 +
| Primary Effect
 +
| {{Type|Optional}} {{Type|VarInt}}
 +
| A [https://minecraft.wiki/w/Potion#ID Potion ID].
 +
|-
 +
| Has Secondary Effect
 +
| {{Type|Boolean}}
 +
|
 +
|-
 +
| Secondary Effect
 +
| {{Type|Optional}} {{Type|VarInt}}
 +
| A [https://minecraft.wiki/w/Potion#ID Potion ID].
 +
|}
 +
 
 +
==== Set Held Item (serverbound) ====
 +
 
 +
Sent when the player changes the slot selection.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x2C
 +
| Play
 +
| Server
 +
| Slot
 +
| {{Type|Short}}
 +
| The slot which the player has selected (0–8).
 +
|}
 +
 
 +
==== Program Command Block ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="5"| 0x2D
 +
| rowspan="5"| Play
 +
| rowspan="5"| Server
 +
|-
 +
| Location
 +
| {{Type|Position}}
 +
|
 +
|-
 +
| Command
 +
| {{Type|String}} (32767)
 +
|
 +
|-
 +
| Mode || {{Type|VarInt}} {{Type|Enum}} || One of SEQUENCE (0), AUTO (1), or REDSTONE (2).
 +
|-
 +
| Flags
 +
| {{Type|Byte}}
 +
| 0x01: Track Output (if false, the output of the previous command will not be stored within the command block); 0x02: Is conditional; 0x04: Automatic.
 +
|}
 +
 
 +
==== Program Command Block Minecart ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x2E
 +
| rowspan="3"| Play
 +
| rowspan="3"| Server
 +
| Entity ID
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Command
 +
| {{Type|String}} (32767)
 +
|
 +
|-
 +
| Track Output
 +
| {{Type|Boolean}}
 +
| If false, the output of the previous command will not be stored within the command block.
 +
|}
 +
 
 +
==== Set Creative Mode Slot ====
 +
 
 +
While the user is in the standard inventory (i.e., not a crafting bench) in Creative mode, the player will send this packet.
 +
 
 +
Clicking in the creative inventory menu is quite different from non-creative inventory management. Picking up an item with the mouse actually deletes the item from the server, and placing an item into a slot or dropping it out of the inventory actually tells the server to create the item from scratch. (This can be verified by clicking an item that you don't mind deleting, then severing the connection to the server; the item will be nowhere to be found when you log back in.) As a result of this implementation strategy, the "Destroy Item" slot is just a client-side implementation detail that means "I don't intend to recreate this item.". Additionally, the long listings of items (by category, etc.) are a client-side interface for choosing which item to create. Picking up an item from such listings sends no packets to the server; only when you put it somewhere does it tell the server to create the item in that location.
 +
 
 +
This action can be described as "set inventory slot". Picking up an item sets the slot to item ID -1. Placing an item into an inventory slot sets the slot to the specified item. Dropping an item (by clicking outside the window) effectively sets slot -1 to the specified item, which causes the server to spawn the item entity, etc.. All other inventory slots are numbered the same as the non-creative inventory (including slots for the 2x2 crafting menu, even though they aren't visible in the vanilla client).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x2F
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Slot
 +
| {{Type|Short}}
 +
| Inventory slot.
 +
|-
 +
| Clicked Item
 +
| {{Type|Slot}}
 +
|
 +
|}
 +
 
 +
==== Program Jigsaw Block ====
 +
 
 +
Sent when Done is pressed on the {{Minecraft Wiki|Jigsaw Block}} interface.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="8"| 0x30
 +
| rowspan="8"| Play
 +
| rowspan="8"| Server
 +
| Location
 +
| {{Type|Position}}
 +
| Block entity location
 +
|-
 +
| Name
 +
| {{Type|Identifier}}
 +
|
 +
|-
 +
| Target
 +
| {{Type|Identifier}}
 +
|
 +
|-
 +
| Pool
 +
| {{Type|Identifier}}
 +
|
 +
|-
 +
| Final state
 +
| {{Type|String}} (32767)
 +
| "Turns into" on the GUI, <code>final_state</code> in NBT.
 +
|-
 +
| Joint type
 +
| {{Type|String}} (32767)
 +
| <code>rollable</code> if the attached piece can be rotated, else <code>aligned</code>.
 +
|-
 +
| Selection priority
 +
| {{Type|VarInt}}
 +
|
 +
|-
 +
| Placement priority
 +
| {{Type|VarInt}}
 +
|
 +
|}
 +
 
 +
[[Category:Minecraft Modern]]
 +
 
 +
 
 +
==== Program Structure Block ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="17"| 0x31
 +
| rowspan="17"| Play
 +
| rowspan="17"| Server
 +
|-
 +
| Location
 +
| {{Type|Position}}
 +
| Block entity location.
 +
|-
 +
| Action
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| An additional action to perform beyond simply saving the given data; see below.
 +
|-
 +
| Mode
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| One of SAVE (0), LOAD (1), CORNER (2), DATA (3).
 +
|-
 +
| Name
 +
| {{Type|String}} (32767)
 +
|
 +
|-
 +
| Offset X || {{Type|Byte}}
 +
| Between -48 and 48.
 +
|-
 +
| Offset Y || {{Type|Byte}}
 +
| Between -48 and 48.
 +
|-
 +
| Offset Z || {{Type|Byte}}
 +
| Between -48 and 48.
 +
|-
 +
| Size X || {{Type|Byte}}
 +
| Between 0 and 48.
 +
|-
 +
| Size Y || {{Type|Byte}}
 +
| Between 0 and 48.
 +
|-
 +
| Size Z || {{Type|Byte}}
 +
| Between 0 and 48.
 +
|-
 +
| Mirror
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| One of NONE (0), LEFT_RIGHT (1), FRONT_BACK (2).
 +
|-
 +
| Rotation
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| One of NONE (0), CLOCKWISE_90 (1), CLOCKWISE_180 (2), COUNTERCLOCKWISE_90 (3).
 +
|-
 +
| Metadata
 +
| {{Type|String}} (128)
 +
|
 +
|-
 +
| Integrity
 +
| {{Type|Float}}
 +
| Between 0 and 1.
 +
|-
 +
|Seed
 +
|{{Type|VarLong}}
 +
|
 +
|-
 +
| Flags
 +
| {{Type|Byte}}
 +
| 0x01: Ignore entities; 0x02: Show air; 0x04: Show bounding box.
 +
|}
 +
 
 +
Possible actions:
 +
 
 +
* 0 - Update data
 +
* 1 - Save the structure
 +
* 2 - Load the structure
 +
* 3 - Detect size
 +
 
 +
The Notchian client uses update data to indicate no special action should be taken (i.e. the done button).
 +
 
 +
==== Update Sign ====
 +
 
 +
This message is sent from the client to the server when the “Done” button is pushed after placing a sign.
 +
 
 +
The server only accepts this packet after [[#Open Sign Editor|Open Sign Editor]], otherwise this packet is silently ignored.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="6"| 0x32
 +
| rowspan="6"| Play
 +
| rowspan="6"| Server
 +
| Location
 +
| {{Type|Position}}
 +
| Block Coordinates.
 +
|-
 +
| Is Front Text
 +
| {{Type|Boolean}}
 +
| Whether the updated text is in front or on the back of the sign
 +
|-
 +
| Line 1
 +
| {{Type|String}} (384)
 +
| First line of text in the sign.
 +
|-
 +
| Line 2
 +
| {{Type|String}} (384)
 +
| Second line of text in the sign.
 +
|-
 +
| Line 3
 +
| {{Type|String}} (384)
 +
| Third line of text in the sign.
 +
|-
 +
| Line 4
 +
| {{Type|String}} (384)
 +
| Fourth line of text in the sign.
 +
|}
 +
 
 +
==== Swing Arm ====
 +
 
 +
Sent when the player's arm swings.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x33
 +
| Play
 +
| Server
 +
| Hand
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| Hand used for the animation. 0: main hand, 1: off hand.
 +
|}
 +
 
 +
==== Teleport To Entity ====
 +
 
 +
Teleports the player to the given entity.  The player must be in spectator mode.
 +
 
 +
The Notchian client only uses this to teleport to players, but it appears to accept any type of entity.  The entity does not need to be in the same dimension as the player; if necessary, the player will be respawned in the right world.  If the given entity cannot be found (or isn't loaded), this packet will be ignored.  It will also be ignored if the player attempts to teleport to themselves.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x34
 +
| Play
 +
| Server
 +
| Target Player
 +
| {{Type|UUID}}
 +
| UUID of the player to teleport to (can also be an entity UUID).
 +
|}
 +
 
 +
==== Use Item On ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="8"| 0x35
 +
| rowspan="8"| Play
 +
| rowspan="8"| Server
 +
| Hand
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| The hand from which the block is placed; 0: main hand, 1: off hand.
 +
|-
 +
| Location
 +
| {{Type|Position}}
 +
| Block position.
 +
|-
 +
| Face
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| The face on which the block is placed (as documented at [[#Player Action|Player Action]]).
 +
|-
 +
| Cursor Position X
 +
| {{Type|Float}}
 +
| The position of the crosshair on the block, from 0 to 1 increasing from west to east.
 +
|-
 +
| Cursor Position Y
 +
| {{Type|Float}}
 +
| The position of the crosshair on the block, from 0 to 1 increasing from bottom to top.
 +
|-
 +
| Cursor Position Z
 +
| {{Type|Float}}
 +
| The position of the crosshair on the block, from 0 to 1 increasing from north to south.
 +
|-
 +
| Inside block
 +
| {{Type|Boolean}}
 +
| True when the player's head is inside of a block.
 +
|-
 +
| Sequence
 +
| {{Type|VarInt}}
 +
| Block change sequence number (see [[#Acknowledge Block Change]]).
 +
|}
 +
 
 +
Upon placing a block, this packet is sent once.
 +
 
 +
The Cursor Position X/Y/Z fields (also known as in-block coordinates) are calculated using raytracing. The unit corresponds to sixteen pixels in the default resource pack. For example, let's say a slab is being placed against the south face of a full block. The Cursor Position X will be higher if the player was pointing near the right (east) edge of the face, lower if pointing near the left. The Cursor Position Y will be used to determine whether it will appear as a bottom slab (values 0.0–0.5) or as a top slab (values 0.5-1.0). The Cursor Position Z should be 1.0 since the player was looking at the southernmost part of the block.
 +
 
 +
Inside block is true when a player's head (specifically eyes) are inside of a block's collision. In 1.13 and later versions, collision is rather complicated and individual blocks can have multiple collision boxes. For instance, a ring of vines has a non-colliding hole in the middle. This value is only true when the player is directly in the box. In practice, though, this value is only used by scaffolding to place in front of the player when sneaking inside of it (other blocks will place behind when you intersect with them -- try with glass for instance).
 +
 
 +
==== Use Item ====
 +
 
 +
Sent when pressing the Use Item key (default: right click) with an item in hand.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x36
 +
| rowspan="2"| Play
 +
| rowspan="2"| Server
 +
| Hand
 +
| {{Type|VarInt}} {{Type|Enum}}
 +
| Hand used for the animation. 0: main hand, 1: off hand.
 +
|-
 +
| Sequence
 +
| {{Type|VarInt}}
 +
| Block change sequence number (see [[#Acknowledge Block Change]]).
 +
|}
  
 
[[Category:Protocol Details]]
 
[[Category:Protocol Details]]
 
[[Category:Minecraft Modern]]
 
[[Category:Minecraft Modern]]

Revision as of 05:49, 6 April 2024

Heads up!

This article is about the protocol for the latest stable release of Minecraft Java Edition (1.20.4, protocol 765). For the Java Edition pre-releases, see Pre-release protocol. For the incomplete Bedrock Edition docs, see Bedrock Protocol. For the old Pocket Edition, see Pocket Edition Protocol Documentation.

This page presents a dissection of the current Minecraft protocol.

If you're having trouble, check out the FAQ or ask for help in the IRC channel #mcdevs on irc.libera.chat (More Information).

Note: While you may use the contents of this page without restriction to create servers, clients, bots, etc; substantial reproductions of this page must be attributed IAW CC BY-SA 4.0.

The changes between versions may be viewed at Protocol History.

Contents

Definitions

The Minecraft server accepts connections from TCP clients and communicates with them using packets. A packet is a sequence of bytes sent over the TCP connection. The meaning of a packet depends both on its packet ID and the current state of the connection. The initial state of each connection is Handshaking, and state is switched using the packets Handshake and Login Success.

Data types

All data sent over the network (except for VarInt and VarLong) is big-endian, that is the bytes are sent from most significant byte to least significant byte. The majority of everyday computers are little-endian, therefore it may be necessary to change the endianness before sending data over the network.


Name Size (bytes) Encodes Notes
Boolean 1 Either false or true True is encoded as 0x01, false as 0x00.
Byte 1 An integer between -128 and 127 Signed 8-bit integer, two's complement
Unsigned Byte 1 An integer between 0 and 255 Unsigned 8-bit integer
Short 2 An integer between -32768 and 32767 Signed 16-bit integer, two's complement
Unsigned Short 2 An integer between 0 and 65535 Unsigned 16-bit integer
Int 4 An integer between -2147483648 and 2147483647 Signed 32-bit integer, two's complement
Long 8 An integer between -9223372036854775808 and 9223372036854775807 Signed 64-bit integer, two's complement
Float 4 A single-precision 32-bit IEEE 754 floating point number
Double 8 A double-precision 64-bit IEEE 754 floating point number
String (n) ≥ 1
≤ (n×3) + 3
A sequence of Unicode scalar values UTF-8 string prefixed with its size in bytes as a VarInt. Maximum length of n characters, which varies by context. The encoding used on the wire is regular UTF-8, not Java's "slight modification". However, the length of the string for purposes of the length limit is its number of UTF-16 code units, that is, scalar values > U+FFFF are counted as two. Up to n × 3 bytes can be used to encode a UTF-8 string comprising n code units when converted to UTF-16, and both of those limits are checked. Maximum n value is 32767. The + 3 is due to the max size of a valid length VarInt.
Text Component Varies See Text formatting#Text components Encoded as a NBT Tag, with the type of tag used depending on the case:
  • As a String Tag: For components only containing text (no styling, no events etc.).
  • As a Compound Tag: Every other case.
JSON Text Component ≥ 1
≤ (262144×3) + 3
See Text formatting#Text components The maximum permitted length when decoding is 262144, but the Notchian server since 1.20.3 refuses to encode longer than 32767. This may be a bug.
Identifier ≥ 1
≤ (32767×3) + 3
See Identifier below Encoded as a String with max length of 32767.
VarInt ≥ 1
≤ 5
An integer between -2147483648 and 2147483647 Variable-length data encoding a two's complement signed 32-bit integer; more info in their section
VarLong ≥ 1
≤ 10
An integer between -9223372036854775808 and 9223372036854775807 Variable-length data encoding a two's complement signed 64-bit integer; more info in their section
Entity Metadata Varies Miscellaneous information about an entity See Entity_metadata#Entity Metadata Format
Slot Varies An item stack in an inventory or container See Slot Data
NBT Varies Depends on context See NBT
Position 8 An integer/block position: x (-33554432 to 33554431), z (-33554432 to 33554431), y (-2048 to 2047) x as a 26-bit integer, followed by z as a 26-bit integer, followed by y as a 12-bit integer (all signed, two's complement). See also the section below.
Angle 1 A rotation angle in steps of 1/256 of a full turn Whether or not this is signed does not matter, since the resulting angles are the same.
UUID 16 A UUID Encoded as an unsigned 128-bit integer (or two unsigned 64-bit integers: the most significant 64 bits and then the least significant 64 bits)
BitSet Varies See #BitSet below A length-prefixed bit set.
Fixed BitSet (n) ceil(n / 8) See #Fixed BitSet below A bit set with a fixed length of n bits.
Optional X 0 or size of X A field of type X, or nothing Whether or not the field is present must be known from the context.
Array of X count times size of X Zero or more fields of type X The count must be known from the context.
X Enum size of X A specific value from a given list The list of possible values and how each is encoded as an X must be known from the context. An invalid value sent by either side will usually result in the client being disconnected with an error or even crashing.
Byte Array Varies Depends on context This is just a sequence of zero or more bytes, its meaning should be explained somewhere else, e.g. in the packet description. The length must also be known from the context.

Identifier

Identifiers are a namespaced location, in the form of minecraft:thing. If the namespace is not provided, it defaults to minecraft (i.e. thing is minecraft:thing). Custom content should always be in its own namespace, not the default one. Both the namespace and value can use all lowercase alphanumeric characters (a-z and 0-9), dot (.), dash (-), and underscore (_). In addition, values can use slash (/). The naming convention is lower_case_with_underscores. More information. For ease of determining whether a namespace or value is valid, here are regular expressions for each:

  • Namespace: [a-z0-9.-_]
  • Value: [a-z0-9.-_/]

VarInt and VarLong

Variable-length format such that smaller numbers use fewer bytes. These are very similar to Protocol Buffer Varints: the 7 least significant bits are used to encode the value and the most significant bit indicates whether there's another byte after it for the next part of the number. The least significant group is written first, followed by each of the more significant groups; thus, VarInts are effectively little endian (however, groups are 7 bits, not 8).

VarInts are never longer than 5 bytes, and VarLongs are never longer than 10 bytes. Within these limits, unnecessarily long encodings (e.g. 81 00 to encode 1) are allowed.

Pseudocode to read and write VarInts and VarLongs:

private static final int SEGMENT_BITS = 0x7F;
private static final int CONTINUE_BIT = 0x80;
public int readVarInt() {
    int value = 0;
    int position = 0;
    byte currentByte;

    while (true) {
        currentByte = readByte();
        value |= (currentByte & SEGMENT_BITS) << position;

        if ((currentByte & CONTINUE_BIT) == 0) break;

        position += 7;

        if (position >= 32) throw new RuntimeException("VarInt is too big");
    }

    return value;
}
public long readVarLong() {
    long value = 0;
    int position = 0;
    byte currentByte;

    while (true) {
        currentByte = readByte();
        value |= (long) (currentByte & SEGMENT_BITS) << position;

        if ((currentByte & CONTINUE_BIT) == 0) break;

        position += 7;

        if (position >= 64) throw new RuntimeException("VarLong is too big");
    }

    return value;
}
public void writeVarInt(int value) {
    while (true) {
        if ((value & ~SEGMENT_BITS) == 0) {
            writeByte(value);
            return;
        }

        writeByte((value & SEGMENT_BITS) | CONTINUE_BIT);

        // Note: >>> means that the sign bit is shifted with the rest of the number rather than being left alone
        value >>>= 7;
    }
}
public void writeVarLong(long value) {
    while (true) {
        if ((value & ~((long) SEGMENT_BITS)) == 0) {
            writeByte(value);
            return;
        }

        writeByte((value & SEGMENT_BITS) | CONTINUE_BIT);

        // Note: >>> means that the sign bit is shifted with the rest of the number rather than being left alone
        value >>>= 7;
    }
}

Warning.png Note Minecraft's VarInts are identical to LEB128 with the slight change of throwing a exception if it goes over a set amount of bytes.

Warning.png Note that Minecraft's VarInts are not encoded using Protocol Buffers; it's just similar. If you try to use Protocol Buffers Varints with Minecraft's VarInts, you'll get incorrect results in some cases. The major differences:

  • Minecraft's VarInts are all signed, but do not use the ZigZag encoding. Protocol buffers have 3 types of Varints: uint32 (normal encoding, unsigned), sint32 (ZigZag encoding, signed), and int32 (normal encoding, signed). Minecraft's are the int32 variety. Because Minecraft uses the normal encoding instead of ZigZag encoding, negative values always use the maximum number of bytes.
  • Minecraft's VarInts are never longer than 5 bytes and its VarLongs will never be longer than 10 bytes, while Protocol Buffer Varints will always use 10 bytes when encoding negative numbers, even if it's an int32.

Sample VarInts:

Value Hex bytes Decimal bytes
0 0x00 0
1 0x01 1
2 0x02 2
127 0x7f 127
128 0x80 0x01 128 1
255 0xff 0x01 255 1
25565 0xdd 0xc7 0x01 221 199 1
2097151 0xff 0xff 0x7f 255 255 127
2147483647 0xff 0xff 0xff 0xff 0x07 255 255 255 255 7
-1 0xff 0xff 0xff 0xff 0x0f 255 255 255 255 15
-2147483648 0x80 0x80 0x80 0x80 0x08 128 128 128 128 8

Sample VarLongs:

Value Hex bytes Decimal bytes
0 0x00 0
1 0x01 1
2 0x02 2
127 0x7f 127
128 0x80 0x01 128 1
255 0xff 0x01 255 1
2147483647 0xff 0xff 0xff 0xff 0x07 255 255 255 255 7
9223372036854775807 0xff 0xff 0xff 0xff 0xff 0xff 0xff 0xff 0x7f 255 255 255 255 255 255 255 255 127
-1 0xff 0xff 0xff 0xff 0xff 0xff 0xff 0xff 0xff 0x01 255 255 255 255 255 255 255 255 255 1
-2147483648 0x80 0x80 0x80 0x80 0xf8 0xff 0xff 0xff 0xff 0x01 128 128 128 128 248 255 255 255 255 1
-9223372036854775808 0x80 0x80 0x80 0x80 0x80 0x80 0x80 0x80 0x80 0x01 128 128 128 128 128 128 128 128 128 1

Position

Note: What you are seeing here is the latest version of the Data types article, but the position type was different before 1.14.

64-bit value split into three signed integer parts:

  • x: 26 MSBs
  • z: 26 middle bits
  • y: 12 LSBs

For example, a 64-bit position can be broken down as follows:

Example value (big endian): 01000110000001110110001100 10110000010101101101001000 001100111111

  • The red value is the X coordinate, which is 18357644 in this example.
  • The blue value is the Z coordinate, which is -20882616 in this example.
  • The green value is the Y coordinate, which is 831 in this example.

Encoded as follows:

((x & 0x3FFFFFF) << 38) | ((z & 0x3FFFFFF) << 12) | (y & 0xFFF)

And decoded as:

val = read_long();
x = val >> 38;
y = val << 52 >> 52;
z = val << 26 >> 38;

Note: The above assumes that the right shift operator sign extends the value (this is called an arithmetic shift), so that the signedness of the coordinates is preserved. In many languages, this requires the integer type of val to be signed. In the absence of such an operator, the following may be useful:

if x >= 1 << 25 { x -= 1 << 26 }
if y >= 1 << 11 { y -= 1 << 12 }
if z >= 1 << 25 { z -= 1 << 26 }

Fixed-point numbers

Some fields may be stored as fixed-point numbers, where a certain number of bits represent the signed integer part (number to the left of the decimal point) and the rest represent the fractional part (to the right). Floating point numbers (float and double), in contrast, keep the number itself (mantissa) in one chunk, while the location of the decimal point (exponent) is stored beside it. Essentially, while fixed-point numbers have lower range than floating point numbers, their fractional precision is greater for higher values.

Prior to version 1.9 a fixed-point format with 5 fraction bits and 27 integer bits was used to send entity positions to the client. Some uses of fixed point remain in modern versions, but they differ from that format.

Most programming languages lack support for fractional integers directly, but you can represent them as integers. The following C or Java-like pseudocode converts a double to a fixed-point integer with n fraction bits:

 x_fixed = (int)(x_double * (1 << n));

And back again:

 x_double = (double)x_fixed / (1 << n);

Bit sets

The types BitSet and Fixed BitSet represent packed lists of bits. The Notchian implementation uses Java's BitSet class.

BitSet

Bit sets of type BitSet are prefixed by their length in longs.

Field Name Field Type Meaning
Length VarInt Number of longs in the following array. May be 0 (if no bits are set).
Data Array of Long A packed representation of the bit set as created by BitSet.toLongArray.

The ith bit is set when (Data[i / 64] & (1 << (i % 64))) != 0, where i starts at 0.

Fixed BitSet

Bit sets of type Fixed BitSet (n) have a fixed length of n bits, encoded as ceil(n / 8) bytes. Note that this is different from BitSet, which uses longs.

Field Name Field Type Meaning
Data Byte Array (n) A packed representation of the bit set as created by BitSet.toByteArray, padded with zeroes at the end to fit the specified length.

The ith bit is set when (Data[i / 8] & (1 << (i % 8))) != 0, where i starts at 0. This encoding is not equivalent to the long array in BitSet.


Other definitions

Term Definition
Player When used in the singular, Player always refers to the client connected to the server.
Entity Entity refers to any item, player, mob, minecart or boat etc. See the Minecraft Wiki article for a full list.
EID An EID — or Entity ID — is a 4-byte sequence used to identify a specific entity. An entity's EID is unique on the entire server.
XYZ In this document, the axis names are the same as those shown in the debug screen (F3). Y points upwards, X points east, and Z points south.
Meter The meter is Minecraft's base unit of length, equal to the length of a vertex of a solid block. The term “block” may be used to mean “meter” or “cubic meter”.
Registry A table describing static, gameplay-related objects of some kind, such as the types of entities, block states or biomes. The entries of a registry are typically associated with textual or numeric identifiers, or both.

Minecraft has a unified registry system used to implement most of the registries, including blocks, items, entities, biomes and dimensions. These "ordinary" registries associate entries with both namespaced textual identifiers (see #Identifier), and signed (positive) 32-bit numeric identifiers. There is also a registry of registries listing all of the registries in the registry system. Some other registries, most notably the block state registry, are however implemented in a more ad-hoc fashion.

Some registries, such as biomes and dimensions, can be customized at runtime by the server (see Registry Data), while others, such as blocks, items and entities, are hardcoded. The contents of the hardcoded registries can be extracted via the built-in Data Generators system.

Block state Each block in Minecraft has 0 or more properties, which in turn may have any number of possible values. These represent, for example, the orientations of blocks, poweredness states of redstone components, and so on. Each of the possible permutations of property values for a block is a distinct block state. The block state registry assigns a numeric identifier to every block state of every block.

A current list of properties and state ID ranges is found on burger.

Alternatively, the vanilla server now includes an option to export the current block state ID mapping, by running java -cp minecraft_server.jar net.minecraft.data.Main --reports. See Data Generators for more information.

Notchian The official implementation of vanilla Minecraft as developed and released by Mojang.
Sequence The action number counter for local block changes, incremented by one when clicking a block with a hand, right clicking an item, or starting or finishing digging a block. Counter handles latency to avoid applying outdated block changes to the local world. Also is used to revert ghost blocks created when placing blocks, using buckets, or breaking blocks.

Packet format

Packets cannot be larger than 221 − 1 or 2097151 bytes (the maximum that can be sent in a 3-byte VarInt). Moreover, the length field must not be longer than 3 bytes, even if the encoded value is within the limit. Unnecessarily long encodings at 3 bytes or below are still allowed. For compressed packets, this applies to the Packet Length field, i.e. the compressed length.

Without compression

Field Name Field Type Notes
Length VarInt Length of Packet ID + Data
Packet ID VarInt
Data Byte Array Depends on the connection state and packet ID, see the sections below

With compression

Once a Set Compression packet (with a non-negative threshold) is sent, zlib compression is enabled for all following packets. The format of a packet changes slightly to include the size of the uncompressed packet.

Compressed? Field Name Field Type Notes
No Packet Length VarInt Length of (Data Length) + Compressed length of (Packet ID + Data)
No Data Length VarInt Length of uncompressed (Packet ID + Data) or 0
Yes Packet ID VarInt zlib compressed packet ID (see the sections below)
Data Byte Array zlib compressed packet data (see the sections below)

For serverbound packets, the uncompressed length of (Packet ID + Data) must not be greater than 223 or 8388608 bytes. Not that a length equal to 223 is permitted, which differs from the compressed length limit. The Notchian client, on the other hand, has no limit for the uncompressed length of incoming compressed packets.

If the size of the buffer containing the packet data and ID (as a VarInt) is smaller than the threshold specified in the packet Set Compression. It will be sent as uncompressed. This is done by setting the data length as 0. (Comparable to sending a non-compressed format with an extra 0 between the length, and packet data).

If it's larger than or equal to the threshold, then it follows the regular compressed protocol format.

The Notchian server (but not client) rejects compressed packets smaller than the threshold. Uncompressed packets exceeding the threshold, however, are accepted.

Compression can be disabled by sending the packet Set Compression with a negative Threshold, or not sending the Set Compression packet at all.

Handshaking

Clientbound

There are no clientbound packets in the Handshaking state, since the protocol immediately switches to a different state after the client sends the first packet.

Serverbound

Handshake

This causes the server to switch into the target state.

Packet ID State Bound To Field Name Field Type Notes
0x00 Handshaking Server Protocol Version VarInt See protocol version numbers (currently 765 in Minecraft 1.20.4).
Server Address 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. Note that SRV records are a simple redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide example.org as server address in addition to connecting to it.
Server Port Unsigned Short Default is 25565. The Notchian server does not use this information.
Next State VarInt Enum 1 for Status, 2 for Login.

Legacy Server List Ping

Warning.png This packet uses a nonstandard format. It is never length-prefixed, and the packet ID is an Unsigned Byte instead of a VarInt.

While not technically part of the current protocol, legacy clients may send this packet to initiate Server List Ping, and modern servers should handle it correctly. The format of this packet is a remnant of the pre-Netty age, before the switch to Netty in 1.7 brought the standard format that is recognized now. This packet merely exists to inform legacy clients that they can't join our modern server.

Packet ID State Bound To Field Name Field Type Notes
0xFE Handshaking Server Payload Unsigned Byte always 1 (0x01).

See Server List Ping#1.6 for the details of the protocol that follows this packet.

Status

Main article: Server List Ping

Clientbound

Status Response

Packet ID State Bound To Field Name Field Type Notes
0x00 Status Client
JSON Response String (32767) See Server List Ping#Status Response; as with all strings this is prefixed by its length as a VarInt.

Ping Response (status)

Packet ID State Bound To Field Name Field Type Notes
0x01 Status Client Payload Long Should be the same as sent by the client.

Serverbound

Status Request

The status can only be requested once immediately after the handshake, before any ping. The server won't respond otherwise.

Packet ID State Bound To Field Name Field Type Notes
0x00 Status Server no fields

Ping Request (status)

Packet ID State Bound To Field Name Field Type Notes
0x01 Status Server Payload 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:

  1. C→S: Handshake with Next State set to 2 (login)
  2. C→S: Login Start
  3. S→C: Encryption Request
  4. Client auth
  5. C→S: Encryption Response
  6. Server auth, both enable encryption
  7. S→C: Set Compression (optional)
  8. S→C: Login Success
  9. C→S: Login Acknowledged

Set Compression, if present, must be sent before Login Success. Note that anything sent after Set Compression must use the Post Compression packet format.

For unauthenticated ("cracked"/offline-mode) and integrated servers (either of the two conditions is enough for an unencrypted connection) there is no encryption. In that case Login Start is directly followed by Login Success. The Notchian server uses UUID v3 for offline player UUIDs, with the namespace “OfflinePlayer” and the value as the player’s username. For example, Notch’s offline UUID would be derived from the string “OfflinePlayer:Notch”. This is not a requirement however, the UUID may be anything.

See Protocol Encryption for details.

Clientbound

Disconnect (login)

Packet ID State Bound To Field Name Field Type Notes
0x00 Login Client Reason JSON Text Component The reason why the player was disconnected.

Encryption Request

Packet ID State Bound To Field Name Field Type Notes
0x01 Login Client Server ID String (20) Appears to be empty.
Public Key Length VarInt Length of Public Key.
Public Key Byte Array The server's public key, in bytes.
Verify Token Length VarInt Length of Verify Token. Always 4 for Notchian servers.
Verify Token Byte Array A sequence of random bytes generated by the server.

See Protocol Encryption for details.

Login Success

Packet ID State Bound To Field Name Field Type Notes
0x02 Login Client UUID UUID
Username String (16)
Number Of Properties VarInt Number of elements in the following array.
Property Name Array String (32767)
Value String (32767)
Is Signed Boolean
Signature Optional String (32767) Only if Is Signed is true.

The properties included in this packet are the same as in Player Info Update, for the current player.

Set Compression

Enables compression. If compression is enabled, all following packets are encoded in the compressed packet format. Negative values will disable compression, meaning the packet format should remain in the 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).

Packet ID State Bound To Field Name Field Type Notes
0x03 Login Client Threshold 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.

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.

Packet ID State Bound To Field Name Field Type Notes
0x04 Login Client Message ID VarInt Generated by the server - should be unique to the connection.
Channel Identifier Name of the plugin channel used to send the data.
Data Byte Array (1048576) Any data, depending on the channel. The length of this array must be inferred from the packet length.

In Notchian client, the maximum data length is 1048576 bytes.

Serverbound

Login Start

Packet ID State Bound To Field Name Field Type Notes
0x00 Login Server Name String (16) Player's Username.
Player UUID UUID The UUID of the player logging in. Unused by the Notchian server.

Encryption Response

Packet ID State Bound To Field Name Field Type Notes
0x01 Login Server Shared Secret Length VarInt Length of Shared Secret.
Shared Secret Byte Array Shared Secret value, encrypted with the server's public key.
Verify Token Length VarInt Length of Verify Token.
Verify Token Byte Array Verify Token value, encrypted with the same public key as the shared secret.

See Protocol Encryption for details.

Login Plugin Response

Packet ID State Bound To Field Name Field Type Notes
0x02 Login Server Message ID VarInt Should match ID from server.
Successful Boolean true if the client understood the request, false otherwise. When false, no payload follows.
Data Optional Byte Array (1048576) Any data, depending on the channel. The length of this array must be inferred from the packet length.

In Notchian server, the maximum data length is 1048576 bytes.

Login Acknowledged

Acknowledgement to the Login Success packet sent by the server.

Packet ID State Bound To Field Name Field Type Notes
0x03 Login Server no fields

This packet switches the connection state to configuration.

Configuration

Clientbound

Clientbound Plugin Message (configuration)

Main article: Plugin channels

Mods and plugins can use this to send their data. Minecraft itself uses several plugin channels. These internal channels are in the minecraft namespace.

More information on how it works on Dinnerbone's blog. More documentation about internal and popular registered channels are here.

Packet ID State Bound To Field Name Field Type Notes
0x00 Configuration Client Channel Identifier Name of the plugin channel used to send the data.
Data Byte Array (1048576) Any data. The length of this array must be inferred from the packet length.

In Notchian client, the maximum data length is 1048576 bytes.

Disconnect (configuration)

Packet ID State Bound To Field Name Field Type Notes
0x01 Configuration Client Reason Text Component The reason why the player was disconnected.

Finish Configuration

Sent by the server to notify the client that the configuration process has finished. The client answers with Acknowledge Finish Configuration whenever it is ready to continue.

Packet ID State Bound To Field Name Field Type Notes
0x02 Configuration Client no fields

This packet switches the connection state to play.

Clientbound Keep Alive (configuration)

The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same payload (see Serverbound Keep Alive). If the client does not respond to a Keep Alive packet within 15 seconds after it was sent, 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.

Packet ID State Bound To Field Name Field Type Notes
0x03 Configuration Client Keep Alive ID Long

Ping (configuration)

Packet is not used by the Notchian server. When sent to the client, client responds with a Pong packet with the same id.

Packet ID State Bound To Field Name Field Type Notes
0x04 Configuration Client ID Int

Registry Data

Represents certain registries that are sent from the server and are applied on the client.

Packet ID State Bound To Field Name Field Type Notes
0x05 Configuration Client Registry Codec NBT (Compound) See Registry Data.

Remove Resource Pack (configuration)

Packet ID State Bound To Field Name Field Type Notes
0x06 Configuration Client Has UUID Boolean Whether a specific resource pack should be removed, or all of them.
UUID Optional UUID The UUID of the resource pack to be removed. Only present if the previous field is true.

Add Resource Pack (configuration)

Packet ID State Bound To Field Name Field Type Notes
0x07 Configuration Client UUID UUID The unique identifier of the resource pack.
URL String (32767) The URL to the resource pack.
Hash String (40) A 40 character hexadecimal, case-insensitive SHA-1 hash of the resource pack file.
If it's not a 40 character hexadecimal string, the client will not use it for hash verification and likely waste bandwidth.
Forced Boolean The Notchian client will be forced to use the resource pack from the server. If they decline they will be kicked from the server.
Has Prompt Message Boolean Whether a custom message should be used on the resource pack prompt.
Prompt Message Optional Text Component This is shown in the prompt making the client accept or decline the resource pack. Only present if the previous field is true.

Feature Flags

Used to enable and disable features, generally experimental ones, on the client.

Packet ID State Bound To Field Name Field Type Notes
0x08 Configuration Client Total Features VarInt Number of features that appear in the array below.
Feature Flags Array of Identifier

As of 1.20.4, the following feature flags are available:

  • minecraft:vanilla - enables vanilla features
  • minecraft:bundle - enables support for the bundle
  • minecraft:trade_rebalance - enables support for the rebalanced villager trades
  • minecraft:update_1_21 - enables support for 1.21 features

Update Tags (configuration)

Packet ID State Bound To Field Name Field Type Notes
0x09 Configuration Client Length of the array VarInt
Array of tags Registry Array Identifier Registry identifier (Vanilla expects tags for the registries minecraft:block, minecraft:item, minecraft:fluid, minecraft:entity_type, and minecraft:game_event)
Array of Tag (See below)

Tag arrays look like:

Field Name Field Type Notes
Length VarInt Number of elements in the following array
Tags Tag name Array Identifier
Count VarInt Number of elements in the following array
Entries Array of VarInt Numeric IDs of the given type (block, item, etc.). This list replaces the previous list of IDs for the given tag. If some preexisting tags are left unmentioned, a warning is printed.

See Tag on the Minecraft Wiki for more information, including a list of vanilla tags.

Serverbound

Client Information (configuration)

Sent when the player connects, or when settings are changed.

Packet ID State Bound To Field Name Field Type Notes
0x00 Configuration Server Locale String (16) e.g. en_GB.
View Distance Byte Client-side render distance, in chunks.
Chat Mode VarInt Enum 0: enabled, 1: commands only, 2: hidden. See Chat#Client chat mode for more information.
Chat Colors Boolean “Colors” multiplayer setting. Can the chat be colored?
Displayed Skin Parts Unsigned Byte Bit mask, see below.
Main Hand VarInt Enum 0: Left, 1: Right.
Enable text filtering Boolean Enables filtering of text on signs and written book titles. Currently always false (i.e. the filtering is disabled)
Allow server listings Boolean Servers usually list online players, this option should let you not show up in that list.

Displayed Skin Parts flags:

  • Bit 0 (0x01): Cape enabled
  • Bit 1 (0x02): Jacket enabled
  • Bit 2 (0x04): Left Sleeve enabled
  • Bit 3 (0x08): Right Sleeve enabled
  • Bit 4 (0x10): Left Pants Leg enabled
  • Bit 5 (0x20): Right Pants Leg enabled
  • Bit 6 (0x40): Hat enabled

The most significant bit (bit 7, 0x80) appears to be unused.

Serverbound Plugin Message (configuration)

Main article: Plugin channels

Mods and plugins can use this to send their data. Minecraft itself uses some plugin channels. These internal channels are in the minecraft namespace.

More documentation on this: https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/

Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.

Packet ID State Bound To Field Name Field Type Notes
0x01 Configuration Server Channel Identifier Name of the plugin channel used to send the data.
Data Byte Array (32767) Any data, depending on the channel. minecraft: channels are documented here. The length of this array must be inferred from the packet length.

In Notchian server, the maximum data length is 32767 bytes.

Acknowledge Finish Configuration

Sent by the client to notify the server that the configuration process has finished. It is sent in response to the server's Finish Configuration.

Packet ID State Bound To Field Name Field Type Notes
0x02 Configuration Server no fields

This packet switches the connection state to play.

Serverbound Keep Alive (configuration)

The server will frequently send out a keep-alive (see Clientbound Keep Alive), each containing a random ID. The client must respond with the same packet.

Packet ID State Bound To Field Name Field Type Notes
0x03 Configuration Server Keep Alive ID Long

Pong (configuration)

Response to the clientbound packet (Ping) with the same id.

Packet ID State Bound To Field Name Field Type Notes
0x04 Configuration Server ID Int id is the same as the ping packet

Resource Pack Response (configuration)

Packet ID State Bound To Field Name Field Type Notes
0x05 Configuration Server
UUID UUID The unique identifier of the resource pack received in the Add Resource Pack (configuration) request.
Result VarInt Enum Result ID (see below).

Result can be one of the following values:

ID Result
0 Successfully downloaded
1 Declined
2 Failed to download
3 Accepted
4 Downloaded
5 Invalid URL
6 Failed to reload
7 Discarded

Play

Clientbound

Bundle Delimiter

The delimiter for a bundle of packets. When received, the client should store every subsequent packet it receives, and wait until another delimiter is received. Once that happens, the client is guaranteed to process every packet in the bundle on the same tick, and the client should stop storing packets. For example, this is used to ensure Spawn Entity and Set Entity Metadata happen on the same tick.

The Notchian client doesn't allow more than 4096 packets in the same bundle.

Packet ID State Bound To Field Name Field Type Notes
0x00 Play Client no fields

Spawn Entity

Sent by the server when an entity (aside from Experince Orb) is created.

Packet ID State Bound To Field Name Field Type Notes
0x01 Play Client Entity ID VarInt A unique integer ID mostly used in the protocol to identify the entity.
Entity UUID UUID A unique identifier that is mostly used in persistence and places where the uniqueness matters more.
Type VarInt ID in the minecraft:entity_type registry (see "type" field in Entity metadata#Entities).
X Double
Y Double
Z Double
Pitch Angle To get the real pitch, you must divide this by (256.0F / 360.0F)
Yaw Angle To get the real yaw, you must divide this by (256.0F / 360.0F)
Head Yaw Angle Only used by living entities, where the head of the entity may differ from the general body rotation.
Data VarInt Meaning dependent on the value of the Type field, see Object Data for details.
Velocity X Short Same units as Set Entity Velocity.
Velocity Y Short
Velocity Z Short

Warning.png The points listed below should be considered when this packet is used to spawn a player entity.

When in online mode, the UUIDs must be valid and have valid skin blobs. In offline mode, UUID v3 is used with the String OfflinePlayer:<player name>, encoded in UTF-8 (and case-sensitive). The Notchian server uses UUID.nameUUIDFromBytes, implemented by OpenJDK here.

For NPCs UUID v2 should be used. Note:

<+Grum> i will never confirm this as a feature you know that :)

In an example UUID, xxxxxxxx-xxxx-Yxxx-xxxx-xxxxxxxxxxxx, the UUID version is specified by Y. So, for UUID v3, Y will always be 3, and for UUID v2, Y will always be 2.

Spawn Experience Orb

Spawns one or more experience orbs.

Packet ID State Bound To Field Name Field Type Notes
0x02 Play Client Entity ID VarInt
X Double
Y Double
Z Double
Count Short The amount of experience this orb will reward once collected.

Entity Animation

Sent whenever an entity should change animation.

Packet ID State Bound To Field Name Field Type Notes
0x03 Play Client Entity ID VarInt Player ID.
Animation Unsigned Byte Animation ID (see below).

Animation can be one of the following values:

ID Animation
0 Swing main arm
2 Leave bed
3 Swing offhand
4 Critical effect
5 Magic critical effect

Award Statistics

Sent as a response to Client Command (id 1). Will only send the changed values if previously requested.

Packet ID State Bound To Field Name Field Type Notes
0x04 Play Client Count VarInt Number of elements in the following array.
Statistic Category ID Array VarInt See below.
Statistic ID VarInt See below.
Value VarInt The amount to set it to.

Categories (these are namespaced, but with : replaced with .):

Name ID Registry
minecraft.mined 0 Blocks
minecraft.crafted 1 Items
minecraft.used 2 Items
minecraft.broken 3 Items
minecraft.picked_up 4 Items
minecraft.dropped 5 Items
minecraft.killed 6 Entities
minecraft.killed_by 7 Entities
minecraft.custom 8 Custom

Blocks, Items, and Entities use block (not block state), item, and entity ids.

Custom has the following (unit only matters for clients):

Name ID Unit
minecraft.leave_game 0 None
minecraft.play_one_minute 1 Time
minecraft.time_since_death 2 Time
minecraft.time_since_rest 3 Time
minecraft.sneak_time 4 Time
minecraft.walk_one_cm 5 Distance
minecraft.crouch_one_cm 6 Distance
minecraft.sprint_one_cm 7 Distance
minecraft.walk_on_water_one_cm 8 Distance
minecraft.fall_one_cm 9 Distance
minecraft.climb_one_cm 10 Distance
minecraft.fly_one_cm 11 Distance
minecraft.walk_under_water_one_cm 12 Distance
minecraft.minecart_one_cm 13 Distance
minecraft.boat_one_cm 14 Distance
minecraft.pig_one_cm 15 Distance
minecraft.horse_one_cm 16 Distance
minecraft.aviate_one_cm 17 Distance
minecraft.swim_one_cm 18 Distance
minecraft.strider_one_cm 19 Distance
minecraft.jump 20 None
minecraft.drop 21 None
minecraft.damage_dealt 22 Damage
minecraft.damage_dealt_absorbed 23 Damage
minecraft.damage_dealt_resisted 24 Damage
minecraft.damage_taken 25 Damage
minecraft.damage_blocked_by_shield 26 Damage
minecraft.damage_absorbed 27 Damage
minecraft.damage_resisted 28 Damage
minecraft.deaths 29 None
minecraft.mob_kills 30 None
minecraft.animals_bred 31 None
minecraft.player_kills 32 None
minecraft.fish_caught 33 None
minecraft.talked_to_villager 34 None
minecraft.traded_with_villager 35 None
minecraft.eat_cake_slice 36 None
minecraft.fill_cauldron 37 None
minecraft.use_cauldron 38 None
minecraft.clean_armor 39 None
minecraft.clean_banner 40 None
minecraft.clean_shulker_box 41 None
minecraft.interact_with_brewingstand 42 None
minecraft.interact_with_beacon 43 None
minecraft.inspect_dropper 44 None
minecraft.inspect_hopper 45 None
minecraft.inspect_dispenser 46 None
minecraft.play_noteblock 47 None
minecraft.tune_noteblock 48 None
minecraft.pot_flower 49 None
minecraft.trigger_trapped_chest 50 None
minecraft.open_enderchest 51 None
minecraft.enchant_item 52 None
minecraft.play_record 53 None
minecraft.interact_with_furnace 54 None
minecraft.interact_with_crafting_table 55 None
minecraft.open_chest 56 None
minecraft.sleep_in_bed 57 None
minecraft.open_shulker_box 58 None
minecraft.open_barrel 59 None
minecraft.interact_with_blast_furnace 60 None
minecraft.interact_with_smoker 61 None
minecraft.interact_with_lectern 62 None
minecraft.interact_with_campfire 63 None
minecraft.interact_with_cartography_table 64 None
minecraft.interact_with_loom 65 None
minecraft.interact_with_stonecutter 66 None
minecraft.bell_ring 67 None
minecraft.raid_trigger 68 None
minecraft.raid_win 69 None
minecraft.interact_with_anvil 70 None
minecraft.interact_with_grindstone 71 None
minecraft.target_hit 72 None
minecraft.interact_with_smithing_table 73 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

Acknowledge Block Change

Acknowledges a user-initiated block change. After receiving this packet, the client will display the block state sent by the server instead of the one predicted by the client.

Packet ID State Bound To Field Name Field Type Notes
0x05 Play Client Sequence ID VarInt Represents the sequence to acknowledge, this is used for properly syncing block changes to the client after interactions.

Set Block Destroy Stage

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.

Packet ID State Bound To Field Name Field Type Notes
0x06 Play Client Entity ID VarInt The ID of the entity breaking the block.
Location Position Block Position.
Destroy Stage Byte 0–9 to set it, any other value to remove it.

Block Entity Data

Sets the block entity associated with the block at the given location.

Packet ID State Bound To Field Name Field Type Notes
0x07 Play Client Location Position
Type VarInt The type of the block entity
NBT Data NBT 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 Action

This packet is used for a number of actions and animations performed by blocks, usually non-persistent. The client ignores the provided block type and instead uses the block state in their world.

See Block Actions for a list of values.

Warning.png This packet uses a block ID from the minecraft:block registry, not a block state.

Packet ID State Bound To Field Name Field Type Notes
0x08 Play Client Location Position Block coordinates.
Action ID (Byte 1) Unsigned Byte Varies depending on block — see Block Actions.
Action Parameter (Byte 2) Unsigned Byte Varies depending on block — see Block Actions.
Block Type VarInt The block type ID for the block. This value is unused by the Notchian client, as it will infer the type of block based on the given position.

Block Update

Fired whenever a block is changed within the render distance.

Warning.png 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.

Packet ID State Bound To Field Name Field Type Notes
0x09 Play Client Location Position Block Coordinates.
Block ID VarInt The new block state ID for the block as given in the block state registry.

Boss Bar

Packet ID State Bound To Field Name Field Type Notes
0x0A Play Client UUID UUID Unique ID for this bar.
Action VarInt Enum Determines the layout of the remaining packet.
Action Field Name
0: add Title Text Component
Health Float From 0 to 1. Values greater than 1 do not crash a Notchian client, and start rendering part of a second health bar at around 1.5.
Color VarInt Enum Color ID (see below).
Division VarInt Enum Type of division (see below).
Flags Unsigned Byte 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.
2: update health Health Float as above
3: update title Title Text Component
4: update style Color VarInt Enum Color ID (see below).
Dividers VarInt Enum as above
5: update flags Flags Unsigned Byte as above
ID Color
0 Pink
1 Blue
2 Red
3 Green
4 Yellow
5 Purple
6 White
ID Type of division
0 No division
1 6 notches
2 10 notches
3 12 notches
4 20 notches

Change Difficulty

Changes the difficulty setting in the client's option menu

Packet ID State Bound To Field Name Field Type Notes
0x0B Play Client Difficulty Unsigned Byte 0: peaceful, 1: easy, 2: normal, 3: hard.
Difficulty locked? Boolean

Chunk Batch Finished

Marks the end of a chunk batch. The Notchian client marks the time it receives this packet and calculates the elapsed duration since the beginning of the chunk batch. The server uses this duration and the batch size received in this packet to estimate the number of milliseconds elapsed per chunk received. This value is then used to calculate the desired number of chunks per tick through the formula 25 / millisPerChunk, which is reported to the server through Chunk Batch Received. This likely uses 25 instead of the normal tick duration of 50 so chunk processing will only use half of the client's and network's bandwidth.

The Notchian client uses the samples from the latest 15 batches to estimate the milliseconds per chunk number.

Packet ID State Bound To Field Name Field Type Notes
0x0C Play Client Batch size VarInt Number of chunks.

Chunk Batch Start

Marks the start of a chunk batch. The Notchian client marks and stores the time it receives this packet.

Packet ID State Bound To Field Name Field Type Notes
0x0D Play Client no fields

Chunk Biomes

Packet ID State Bound To Field Name Field Type Notes
0x0E Play Client
Number of chunks VarInt Number of elements in the following array
Chunk biome data Chunk Z Array Int Chunk coordinate (block coordinate divided by 16, rounded down)
Chunk X Int Chunk coordinate (block coordinate divided by 16, rounded down)
Size VarInt Size of Data in bytes
Data Byte Array Chunk data structure, with sections containing only the Biomes field

Note: The order of X and Z is inverted, because the client reads them as one big-endian Long, with Z being the upper 32 bits.

Clear Titles

Clear the client's current title information, with the option to also reset it.

Packet ID State Bound To Field Name Field Type Notes
0x0F Play Client Reset Boolean

Command Suggestions Response

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.

Packet ID State Bound To Field Name Field Type Notes
0x10 Play Client
ID VarInt Transaction ID.
Start VarInt Start of the text to replace.
Length VarInt Length of the text to replace.
Count VarInt Number of elements in the following array.
Matches Match 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 / on commands.
Has tooltip Boolean True if the following is present.
Tooltip Optional Text Component Tooltip to display; only present if previous boolean is true.

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.

Packet ID State Bound To Field Name Field Type Notes
0x11 Play Client Count VarInt Number of elements in the following array.
Nodes Array of Node An array of nodes.
Root index VarInt Index of the root node in the previous array.

For more information on this packet, see the Command Data article.

Close Container

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

Packet ID State Bound To Field Name Field Type Notes
0x12 Play Client Window ID Unsigned Byte This is the ID of the window that was closed. 0 for inventory.

Set Container Content

The inventory slots

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

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

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

Set Container Property

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

Packet ID State Bound To Field Name Field Type Notes
0x14 Play Client Window ID Unsigned Byte
Property Short The property to be updated, see below.
Value Short The new value for the property, see below.

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

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

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

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

Set Container Slot

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

Packet ID State Bound To Field Name Field Type Notes
0x15 Play Client Window ID Byte The window which is being updated. 0 for player inventory. The client ignores any packets targeting a Window ID other than the current one; see below for exceptions.
State ID VarInt A server-managed sequence number used to avoid desynchronization; see #Click Container.
Slot Short The slot that should be updated.
Slot Data Slot

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

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

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

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

Set Cooldown

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

Packet ID State Bound To Field Name Field Type Notes
0x16 Play Client Item ID VarInt Numeric ID of the item to apply a cooldown to.
Cooldown Ticks VarInt Number of ticks to apply a cooldown for, or 0 to clear the cooldown.

Chat Suggestions

Unused by the Notchian server. Likely provided for custom servers to send chat message completions to clients.

Packet ID State Bound To Field Name Field Type Notes
0x17 Play Client Action VarInt Enum 0: Add, 1: Remove, 2: Set
Count VarInt Number of elements in the following array.
Entries Array of String (32767)

Clientbound Plugin Message (play)

Main article: Plugin channels

Mods and plugins can use this to send their data. Minecraft itself uses several plugin channels. These internal channels are in the minecraft namespace.

More information on how it works on Dinnerbone's blog. More documentation about internal and popular registered channels are here.

Packet ID State Bound To Field Name Field Type Notes
0x18 Play Client Channel Identifier Name of the plugin channel used to send the data.
Data Byte Array (1048576) Any data. The length of this array must be inferred from the packet length.

In Notchian client, the maximum data length is 1048576 bytes.

Damage Event

Packet ID State Bound To Field Name Field Type Notes
0x19 Play Client
Entity ID VarInt The ID of the entity taking damage
Source Type ID VarInt The type of damage in the minecraft:damage_type registry, defined by the Registry Data packet.
Source Cause ID VarInt The ID + 1 of the entity responsible for the damage, if present. If not present, the value is 0
Source Direct ID VarInt The ID + 1 of the entity that directly dealt the damage, if present. If not present, the value is 0. If this field is present:
  • and damage was dealt indirectly, such as by the use of a projectile, this field will contain the ID of such projectile;
  • and damage was dealt dirctly, such as by manually attacking, this field will contain the same value as Source Cause ID.
Has Source Position Boolean Indicates the presence of the three following fields.

The Notchian server sends the Source Position when the damage was dealt by the /damage command and a position was specified

Source Position X Optional Double Only present if Has Source Position is true
Source Position Y Optional Double Only present if Has Source Position is true
Source Position Z Optional Double Only present if Has Source Position is true

Delete Message

Removes a message from the client's chat. This only works for messages with signatures, system messages cannot be deleted with this packet.

Packet ID State Bound To Field Name Field Type Notes
0x1A Play Client Message ID VarInt The message Id + 1, used for validating message signature. The next field is present only when value of this field is equal to 0.
Signature Optional Byte Array (256) The previous message's signature. Always 256 bytes and not length-prefixed.

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.

Packet ID State Bound To Field Name Field Type Notes
0x1B Play Client Reason Text Component Displayed to the client when the connection terminates.

Disguised Chat Message

Sends the client a chat message, but without any message signing information.

The Notchian server uses this packet when the console is communicating with players through commands, such as /say, /tell, /me, among others.

Packet ID State Bound To Field Name Field Type Notes
0x1C Play Client Message Text Component This is used as the content parameter when formatting the message on the client.
Chat Type VarInt The type of chat in the minecraft:chat_type registry, defined by the Registry Data packet.
Sender Name Text Component The name of the one sending the message, usually the sender's display name.

This is used as the sender parameter when formatting the message on the client.

Has Target Name Boolean True if target name is present.
Target Name Text Component The name of the one receiving the message, usually the receiver's display name. Only present if previous boolean is true.

This is used as the target parameter when formatting the message on the client.

Entity Event

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).

Packet ID State Bound To Field Name Field Type Notes
0x1D Play Client Entity ID Int
Entity Status Byte Enum See Entity statuses for a list of which statuses are valid for each type of entity.

Explosion

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

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

Packet ID State Bound To Field Name Field Type Notes
0x1E Play Client X Double
Y Double
Z Double
Strength Float If the strength is greater or equal to 2.0, or the block interaction is not 0 (keep), large explosion particles are used. Otherwise, small explosion particles are used.
Record Count VarInt Number of elements in the following array.
Records Array of (Byte, Byte, Byte) Each record is 3 signed bytes long; the 3 bytes are the XYZ (respectively) signed offsets of affected blocks.
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.
Player Motion Z Float Z velocity of the player being pushed by the explosion.
Block Interaction VarInt Enum 0 = keep, 1 = destroy, 2 = destroy_with_decay, 3 = trigger_block.
Small Explosion Particle ID VarInt The particle ID listed in Particles.
Small Explosion Particle Data Varies Particle data as specified in Particles.
Large Explosion Particle ID VarInt The particle ID listed in Particles.
Large Explosion Particle Data Varies Particle data as specified in Particles.
Explosion Sound Sound Name Identifier The name of the sound played.
Has Fixed Range Optional Boolean Whether is has fixed range.
Range Optional Float The fixed range of the sound. Only present if previous boolean is true.

Unload Chunk

Tells the client to unload a chunk column.

Packet ID State Bound To Field Name Field Type Notes
0x1F Play Client Chunk Z Int Block coordinate divided by 16, rounded down.
Chunk X Int Block coordinate divided by 16, rounded down.

Note: The order is inverted, because the client reads this packet as one big-endian Long, with Z being the upper 32 bits.

It is legal to send this packet even if the given chunk is not currently loaded.

Game Event

Used for a wide variety of game events, from weather to bed use to game mode to demo messages.

Packet ID State Bound To Field Name Field Type Notes
0x20 Play Client Event Unsigned Byte See below.
Value Float Depends on Event.

Events:

Event Effect Value
0 No respawn block available Note: Displays message 'block.minecraft.spawn.not_valid' (You have no home bed or charged respawn anchor, or it was obstructed) to the player.
1 End raining
2 Begin raining
3 Change game mode 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
4 Win game 0: Just respawn player.
1: Roll the credits and respawn player.
Note that 1 is only sent by notchian server when player has not yet achieved advancement "The end?", else 0 is sent.
5 Demo event 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 hit player Note: Sent when any player is struck by an arrow.
7 Rain level change Note: Seems to change both sky color and lighting.
Rain level ranging from 0 to 1.
8 Thunder level change Note: Seems to change both sky color and lighting (same as Rain level change, but doesn't start rain). It also requires rain to render by notchian client.
Thunder level ranging from 0 to 1.
9 Play pufferfish sting sound
10 Play elder guardian mob appearance (effect and sound)
11 Enable respawn screen 0: Enable respawn screen.
1: Immediately respawn (sent when the doImmediateRespawn gamerule changes).
12 Limited crafting 0: Disable limited crafting.
1: Enable limited crafting (sent when the doLimitedCrafting gamerule changes).
13 Start waiting for level chunks Instructs the client to begin the waiting process for the level chunks.
Sent by the server after the level is cleared on the client and is being re-sent (either during the first, or subsequent reconfigurations).

Open Horse Screen

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

Packet ID State Bound To Field Name Field Type Notes
0x21 Play Client Window ID Unsigned Byte
Slot count VarInt
Entity ID Int

Hurt Animation

Plays a bobbing animation for the entity receiving damage.

Packet ID State Bound To Field Name Field Type Notes
0x22 Play Client
Entity ID VarInt The ID of the entity taking damage
Yaw Float The direction the damage is coming from in relation to the entity

Initialize World Border

Packet ID State Bound To Field Name Field Type Notes
0x23 Play Client X Double
Z Double
Old Diameter Double Current length of a single side of the world border, in meters.
New Diameter Double Target length of a single side of the world border, in meters.
Speed VarLong Number of real-time milliseconds 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.
Portal Teleport Boundary VarInt Resulting coordinates from a portal teleport are limited to ±value. Usually 29999984.
Warning Blocks VarInt In meters.
Warning Time VarInt In seconds as set by /worldborder warning time.

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:

distance = max(min(resizeSpeed * 1000 * warningTime, abs(targetDiameter - currentDiameter)), warningDistance);
if (playerDistance < distance) {
    warning = 1.0 - playerDistance / distance;
} else {
    warning = 0.0;
}

Clientbound Keep Alive (play)

The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same payload (see Serverbound Keep Alive). If the client does not respond to a Keep Alive packet within 15 seconds after it was sent, 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.

Packet ID State Bound To Field Name Field Type Notes
0x24 Play Client Keep Alive ID Long

Chunk Data and Update Light

Main article: Chunk Format
See also: #Unload Chunk

Sent when a chunk comes into the client's view distance, specifying its terrain, lighting and block entities.

The chunk must be within the view area previously specified with Set Center Chunk; see that packet for details.

It is not strictly necessary to send all block entities in this packet; it is still legal to send them with Block Entity Data later.

Packet ID State Bound To Field Name Field Type Notes
0x25 Play Client Chunk X Int Chunk coordinate (block coordinate divided by 16, rounded down)
Chunk Z Int Chunk coordinate (block coordinate divided by 16, rounded down)
Heightmaps NBT See Chunk Format#Heightmaps structure
Size VarInt Size of Data in bytes
Data Byte Array See Chunk Format#Data structure
Number of block entities VarInt Number of elements in the following array
Block Entity Packed XZ Array Unsigned Byte The packed section coordinates are relative to the chunk they are in. Values 0-15 are valid.
packed_xz = ((blockX & 15) << 4) | (blockZ & 15) // encode
x = packed_xz >> 4, z = packed_xz & 15 // decode
Y Short The height relative to the world
Type VarInt The type of block entity
Data NBT The block entity's data, without the X, Y, and Z values
Sky Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Sky Light array below. The least significant bit is for blocks 16 blocks to 1 block below the min world height (one section below the world), while the most significant bit covers blocks 1 to 16 blocks above the max world height (one section above the world).
Block Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Block Light array below. The order of bits is the same as in Sky Light Mask.
Empty Sky Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Sky Light data. The order of bits is the same as in Sky Light Mask.
Empty Block Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Block Light data. The order of bits is the same as in Sky Light Mask.
Sky Light array count VarInt Number of entries in the following array; should match the number of bits set in Sky Light Mask
Sky Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Sky Light array Byte Array (2048) 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. Indexed ((y<<8) | (z<<4) | x) / 2 If there's a remainder, masked 0xF0 else 0x0F.
Block Light array count VarInt Number of entries in the following array; should match the number of bits set in Block Light Mask
Block Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Block Light array Byte Array (2048) 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. Indexed ((y<<8) | (z<<4) | x) / 2 If there's a remainder, masked 0xF0 else 0x0F.

Unlike the Update Light packet which uses the same format, setting the bit corresponding to a section to 0 in both of the block light or sky light masks does not appear to be useful, and the results in testing have been highly inconsistent.

World Event

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), effect 1028 (enderdragon death), and effect 1038 (end portal opening); it is ignored on other effects.

Packet ID State Bound To Field Name Field Type Notes
0x26 Play Client Event Int The event, see below.
Location Position The location of the event.
Data Int Extra data for certain events, see below.
Disable Relative Volume Boolean See above.

Events:

ID Name Data
Sound
1000 Dispenser dispenses
1001 Dispenser fails to dispense
1002 Dispenser shoots
1003 Ender eye launched
1004 Firework shot
1009 Fire extinguished
1010 Play record An ID in the minecraft:item registry, corresponding to a record item. If the ID doesn't correspond to a record, the packet is ignored. Any record already being played at the given location is overwritten. See Data Generators for information on item IDs.
1011 Stop record
1015 Ghast warns
1016 Ghast shoots
1017 Enderdragon shoots
1018 Blaze shoots
1019 Zombie attacks wood door
1020 Zombie attacks iron door
1021 Zombie breaks wood door
1022 Wither breaks block
1023 Wither spawned
1024 Wither shoots
1025 Bat takes off
1026 Zombie infects
1027 Zombie villager converted
1028 Ender dragon death
1029 Anvil destroyed
1030 Anvil used
1031 Anvil landed
1032 Portal travel
1033 Chorus flower grown
1034 Chorus flower died
1035 Brewing stand brewed
1036 Iron trapdoor opened
1037 Iron trapdoor closed
1038 End portal created in overworld
1039 Phantom bites
1040 Zombie converts to drowned
1041 Husk converts to zombie by drowning
1042 Grindstone used
1043 Book page turned
Particle
1500 Composter composts
1501 Lava converts block (either water to stone, or removes existing blocks such as torches)
1502 Redstone torch burns out
1503 Ender eye placed
2000 Spawns 10 smoke particles, e.g. from a fire Direction, see below.
2001 Block break + block break sound Block state ID (see Chunk Format#Block state registry).
2002 Splash potion. Particle effect + glass break sound. RGB color as an integer (e.g. 8364543 for #7FA1FF).
2003 Eye of Ender entity break animation — particles and sound
2004 Mob spawn particle effect: smoke + flames
2005 Bonemeal particles How many particles to spawn (if set to 0, 15 are spawned).
2006 Dragon breath
2007 Instant splash potion. Particle effect + glass break sound. RGB color as an integer (e.g. 8364543 for #7FA1FF).
2008 Ender dragon destroys block
2009 Wet sponge vaporizes in nether
3000 End gateway spawn
3001 Enderdragon growl
3002 Electric spark
3003 Copper apply wax
3004 Copper remove wax
3005 Copper scrape oxidation

Smoke directions:

ID Direction
0 Down
1 Up
2 North
3 South
4 West
5 East

Particle

Displays the named particle

Packet ID State Bound To Field Name Field Type Notes
0x27 Play Client Particle ID VarInt The particle ID listed in Particles.
Long Distance Boolean If true, particle distance increases from 256 to 65536.
X Double X position of the particle.
Y Double Y position of the particle.
Z Double Z position of the particle.
Offset X Float This is added to the X position after being multiplied by random.nextGaussian().
Offset Y Float This is added to the Y position after being multiplied by random.nextGaussian().
Offset Z Float This is added to the Z position after being multiplied by random.nextGaussian().
Max Speed Float
Particle Count Int The number of particles to create.
Data Varies Particle data as specified in Particles.

Update Light

Updates light levels for a chunk. See Light for information on how lighting works in Minecraft.

Packet ID State Bound To Field Name Field Type Notes
0x28 Play Client Chunk X VarInt Chunk coordinate (block coordinate divided by 16, rounded down)
Chunk Z VarInt Chunk coordinate (block coordinate divided by 16, rounded down)
Sky Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Sky Light array below. The least significant bit is for blocks 16 blocks to 1 block below the min world height (one section below the world), while the most significant bit covers blocks 1 to 16 blocks above the max world height (one section above the world).
Block Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has data in the Block Light array below. The order of bits is the same as in Sky Light Mask.
Empty Sky Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Sky Light data. The order of bits is the same as in Sky Light Mask.
Empty Block Light Mask BitSet BitSet containing bits for each section in the world + 2. Each set bit indicates that the corresponding 16×16×16 chunk section has all zeros for its Block Light data. The order of bits is the same as in Sky Light Mask.
Sky Light array count VarInt Number of entries in the following array; should match the number of bits set in Sky Light Mask
Sky Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Sky Light array Byte Array (2048) There is 1 array for each bit set to true in the sky light mask, starting with the lowest value. Half a byte per light value.
Block Light array count VarInt Number of entries in the following array; should match the number of bits set in Block Light Mask
Block Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Block Light array Byte Array (2048) 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.

A bit will never be set in both the block light mask and the empty block light mask, though it may be present in neither of them (if the block light does not need to be updated for the corresponding chunk section). The same applies to the sky light mask and the empty sky light mask.

Login (play)

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

See Protocol Encryption for information on logging in.

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

Map Data

Updates a rectangular area on a map item.

Packet ID State Bound To Field Name Field Type Notes
0x2A Play Client Map ID VarInt Map ID of the map being modified
Scale Byte From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
Locked Boolean True if the map has been locked in a cartography table
Has Icons Boolean
Icon Count Optional VarInt Number of elements in the following array. Only present if previous Boolean is true.
Icon Type Optional Array VarInt Enum See below
X Byte Map coordinates: -128 for furthest left, +127 for furthest right
Z Byte Map coordinates: -128 for highest, +127 for lowest
Direction Byte 0-15
Has Display Name Boolean
Display Name Optional Text Component Only present if previous Boolean is true
Columns Unsigned Byte Number of columns updated
Rows Optional Unsigned Byte Only if Columns is more than 0; number of rows updated
X Optional Byte Only if Columns is more than 0; x offset of the westernmost column
Z Optional Byte Only if Columns is more than 0; z offset of the northernmost row
Length Optional VarInt Only if Columns is more than 0; length of the following array
Data Optional Array of Unsigned Byte Only if Columns is more than 0; see Map item format

For icons, a direction of 0 is a vertical icon and increments by 22.5° (360/16).

Types are based off of rows and columns in map_icons.png:

Icon type Result
0 White arrow (players)
1 Green arrow (item frames)
2 Red arrow
3 Blue arrow
4 White cross
5 Red pointer
6 White circle (off-map players)
7 Small white circle (far-off-map players)
8 Mansion
9 Temple
10 White Banner
11 Orange Banner
12 Magenta Banner
13 Light Blue Banner
14 Yellow Banner
15 Lime Banner
16 Pink Banner
17 Gray Banner
18 Light Gray Banner
19 Cyan Banner
20 Purple Banner
21 Blue Banner
22 Brown Banner
23 Green Banner
24 Red Banner
25 Black Banner
26 Treasure marker

Merchant Offers

The list of trades a villager NPC is offering.

Packet ID State Bound To Field Name Field Type Notes
0x2B Play Client Window ID VarInt The ID of the window that is open; this is an int rather than a byte.
Size VarInt The number of trades in the following array.
Trades Input item 1 Array Slot The first item the player has to supply for this villager trade. The count of the item stack is the default "price" of this trade.
Output item Slot The item the player will receive from this villager trade.
Input item 2 Slot The second item the player has to supply for this villager trade. May be an empty slot.
Trade disabled Boolean True if the trade is disabled; false if the trade is enabled.
Number of trade uses Int Number of times the trade has been used so far. If equal to the maximum number of trades, the client will display a red X.
Maximum number of trade uses Int Number of times this trade can be used before it's exhausted.
XP Int Amount of XP the villager will earn each time the trade is used.
Special Price Int Can be zero or negative. The number is added to the price when an item is discounted due to player reputation or other effects.
Price Multiplier Float Can be low (0.05) or high (0.2). Determines how much demand, player reputation, and temporary effects will adjust the price.
Demand Int If positive, causes the price to increase. Negative values seem to be treated the same as zero.
Villager level VarInt Appears on the trade GUI; meaning comes from the translation key merchant.level. + level.

1: Novice, 2: Apprentice, 3: Journeyman, 4: Expert, 5: Master.

Experience VarInt Total experience for this villager (always 0 for the wandering trader).
Is regular villager Boolean True if this is a regular villager; false for the wandering trader. When false, hides the villager level and some other GUI elements.
Can restock Boolean 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.

Modifiers can increase or decrease the number of items for the first input slot. The second input slot and the output slot never change the nubmer of items. The number of items may never be less than 1, and never more than the stack size. If special price and demand are both zero, only the default price is displayed. If either is non-zero, then the adjusted price is displayed next to the crossed-out default price. The adjusted prices is calculated as follows:

Adjusted price = default price + floor(default price x multiplier x demand) + special price

The merchant UI, for reference

Update Entity Position

This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks Teleport Entity should be sent instead.

This packet allows at most 8 blocks movement in any direction, because short range is from -32768 to 32767. And 32768 / (128 * 32) = 8.

Packet ID State Bound To Field Name Field Type Notes
0x2C Play Client Entity ID VarInt
Delta X Short Change in X position as (currentX * 32 - prevX * 32) * 128.
Delta Y Short Change in Y position as (currentY * 32 - prevY * 32) * 128.
Delta Z Short Change in Z position as (currentZ * 32 - prevZ * 32) * 128.
On Ground Boolean

Update Entity Position and Rotation

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. (-32768 / (32 * 128) == -8)

Packet ID State Bound To Field Name Field Type Notes
0x2D Play Client Entity ID VarInt
Delta X Short Change in X position as (currentX * 32 - prevX * 32) * 128.
Delta Y Short Change in Y position as (currentY * 32 - prevY * 32) * 128.
Delta Z Short Change in Z position as (currentZ * 32 - prevZ * 32) * 128.
Yaw Angle New angle, not a delta.
Pitch Angle New angle, not a delta.
On Ground Boolean

Update Entity Rotation

This packet is sent by the server when an entity rotates.

Packet ID State Bound To Field Name Field Type Notes
0x2E Play Client Entity ID VarInt
Yaw Angle New angle, not a delta.
Pitch Angle New angle, not a delta.
On Ground Boolean

Move Vehicle

Note that all fields use absolute positioning and do not allow for relative positioning.

Packet ID State Bound To Field Name Field Type Notes
0x2F Play Client X Double Absolute position (X coordinate).
Y Double Absolute position (Y coordinate).
Z Double Absolute position (Z coordinate).
Yaw Float Absolute rotation on the vertical axis, in degrees.
Pitch Float Absolute rotation on the horizontal axis, in degrees.

Open Book

Sent when a player right clicks with a signed book. This tells the client to open the book GUI.

Packet ID State Bound To Field Name Field Type Notes
0x30 Play Client Hand VarInt Enum 0: Main hand, 1: Off hand .

Open Screen

This is sent to the client when it should open an inventory, such as a chest, workbench, furnace, or other container. Resending this packet with already existing window id, will update the window title and window type without closing the window.

This message is not sent to clients opening their own inventory, nor do clients inform the server in any way when doing so. From the server's perspective, the inventory is always "open" whenever no other windows are.

For horses, use Open Horse Screen.

Packet ID State Bound To Field Name Field Type Notes
0x31 Play Client Window ID VarInt An identifier for the window to be displayed. Notchian server implementation is a counter, starting at 1. There can only be one window at a time; this is only used to ignore outdated packets targeting already-closed windows. Note also that the Window ID field in most other packets is only a single byte, and indeed, the Notchian server wraps around after 100.
Window Type VarInt The window type to use for display. Contained in the minecraft:menu registry; see Inventory for the different values.
Window Title Text Component The title of the window.

Open Sign Editor

Sent when the client has placed a sign and is allowed to send Update Sign. There must already be a sign at the given location (which the client does not do automatically) - send a Block Update first.

Packet ID State Bound To Field Name Field Type Notes
0x32 Play Client Location Position
Is Front Text Boolean Whether the opened editor is for the front or on the back of the sign

Ping (play)

Packet is not used by the Notchian server. When sent to the client, client responds with a Pong packet with the same id.

Packet ID State Bound To Field Name Field Type Notes
0x33 Play Client ID Int

Ping Response (play)

Packet ID State Bound To Field Name Field Type Notes
0x34 Play Client Payload Long Should be the same as sent by the client.

Place Ghost Recipe

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

Packet ID State Bound To Field Name Field Type Notes
0x35 Play Client Window ID Byte
Recipe Identifier A recipe ID.

Player Abilities (clientbound)

The latter 2 floats are used to indicate the flying speed and field of view respectively, while the first byte is used to determine the value of 4 booleans.

Packet ID State Bound To Field Name Field Type Notes
0x36 Play Client Flags Byte Bit field, see below.
Flying Speed Float 0.05 by default.
Field of View Modifier Float Modifies the field of view, like a speed potion. A Notchian server will use the same value as the movement speed sent in the Update Attributes packet, which defaults to 0.1 for players.

About the flags:

Field Bit
Invulnerable 0x01
Flying 0x02
Allow Flying 0x04
Creative Mode (Instant Break) 0x08

Player Chat Message

Sends the client a chat message from a player.

Currently a lot is unknown about this packet, blank descriptions are for those that are unknown

Packet ID State Bound To Sector Field Name Field Type Notes
0x37 Play Client Header Sender UUID Used by the Notchian client for the disableChat launch option. Setting both longs to 0 will always display the message regardless of the setting.
Index VarInt
Message Signature Present Boolean States if a message signature is present
Message Signature bytes Optional Byte Array (256) Only present if Message Signature Present is true. Cryptography, the signature consists of the Sender UUID, Session UUID from the Player Session packet, Index, Salt, Timestamp in epoch seconds, the length of the original chat content, the original content itself, the length of Previous Messages, and all of the Previous message signatures. These values are hashed with SHA-256 and signed using the RSA cryptosystem. Modifying any of these values in the packet will cause this signature to fail. This buffer is always 256 bytes long and it is not length-prefixed.
Body Message String (256) Raw (optionally) signed sent message content.

This is used as the content parameter when formatting the message on the client.

Timestamp Long Represents the time the message was signed as milliseconds since the epoch, used to check if the message was received within 2 minutes of it being sent.
Salt Long Cryptography, used for validating the message signature.
Previous Messages Total Previous Messages VarInt The maximum length is 20 in Notchian client.
Array (20) Message ID VarInt The message Id + 1, used for validating message signature. The next field is present only when value of this field is equal to 0.
Signature Optional Byte Array (256) The previous message's signature. Contains the same type of data as Message Signature bytes (256 bytes) above. Not length-prefxied.
Other Unsigned Content Present Boolean True if the next field is present
Unsigned Content Optional Text Component
Filter Type VarInt Enum If the message has been filtered
Filter Type Bits Optional BitSet Only present if the Filter Type is Partially Filtered. Specifies the indexes at which characters in the original message string should be replaced with the # symbol (i.e. filtered) by the Notchian client
Chat Formatting Chat Type VarInt The type of chat in the minecraft:chat_type registry, defined by the Registry Data packet.
Sender Name Text Component The name of the one sending the message, usually the sender's display name.

This is used as the sender parameter when formatting the message on the client.

Has Target Name Boolean True if target name is present.
Target Name Optional Text Component The name of the one receiving the message, usually the receiver's display name. Only present if previous boolean is true.

This is used as the target parameter when formatting the message on the client.

Player Chat Handling Logic

Filter Types:

The filter type mask should NOT be specified unless partially filtered is selected

ID Name Description
0 PASS_THROUGH Message is not filtered at all
1 FULLY_FILTERED Message is fully filtered
2 PARTIALLY_FILTERED Only some characters in the message are filtered

End Combat

Unused by the Notchian client. This data was once used for twitch.tv metadata circa 1.8.

Packet ID State Bound To Field Name Field Type Notes
0x38 Play Client Duration VarInt Length of the combat in ticks.

Enter Combat

Unused by the Notchian client. This data was once used for twitch.tv metadata circa 1.8.

Packet ID State Bound To Field Name Field Type Notes
0x39 Play Client no fields

Combat Death

Used to send a respawn screen.

Packet ID State Bound To Field Name Field Type Notes
0x3A Play Client Player ID VarInt Entity ID of the player that died (should match the client's entity ID).
Message Text Component The death message.

Player Info Remove

Used by the server to remove players from the player list.

Packet ID State Bound To Field Name Field Type Notes
0x3B Play Client Number of Players VarInt Number of elements in the following array.
Player Player Id Array of UUID UUIDs of players to remove.

Player Info Update

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

Packet ID State Bound To Field Name Field Type Notes
0x3C Play Client Actions Byte Determines what actions are present.
Number Of Players VarInt Number of elements in the following array.
Players UUID Array UUID The player UUID
Player Actions Array of Player Actions The length of this array is determined by the number of Player Actions that give a non-zero value when applying its mask to the actions flag. For example given the decimal number 5, binary 00000101. The masks 0x01 and 0x04 would return a non-zero value, meaning the Player Actions array would include two actions: Add Player and Update Game Mode.


Player Actions
Action Mask Field Name Type Notes
Add Player 0x01 Name String (16)
Number Of Properties VarInt Number of elements in the following array.
Property Name Array String (32767)
Value String (32767)
Is Signed Boolean
Signature Optional String (32767) Only if Is Signed is true.
Initialize Chat 0x02 Has Signature Data Boolean
Chat session ID UUID Only sent if Has Signature Data is true.
Public key expiry time Long Key expiry time, as a UNIX timestamp in milliseconds. Only sent if Has Signature Data is true.
Encoded public key size VarInt Size of the following array. Only sent if Has Signature Data is true. Maximum length is 512 bytes.
Encoded public key Byte Array (512) The player's public key, in bytes. Only sent if Has Signature Data is true.
Public key signature size VarInt Size of the following array. Only sent if Has Signature Data is true. Maximum length is 4096 bytes.
Public key signature Byte Array (4096) The public key's digital signature. Only sent if Has Signature Data is true.
Update Game Mode 0x04 Game Mode VarInt
Update Listed 0x08 Listed Boolean Whether the player should be listed on the player list.
Update Latency 0x10 Ping VarInt Measured in milliseconds.
Update Display Name 0x20 Has Display Name Boolean
Display Name Optional Text Component Only sent if Has Display Name is true.

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.

Look At

Used to rotate the client player to face the given location or entity (for /teleport [<targets>] <x> <y> <z> facing).

Packet ID State Bound To Field Name Field Type Notes
0x3D Play Client
Feet/eyes VarInt Enum Values are feet=0, eyes=1. If set to eyes, aims using the head position; otherwise aims using the feet position.
Target x Double x coordinate of the point to face towards.
Target y Double y coordinate of the point to face towards.
Target z Double z coordinate of the point to face towards.
Is entity Boolean If true, additional information about an entity is provided.
Entity ID Optional VarInt Only if is entity is true — 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.

Synchronize Player Position

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

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

Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0, -1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.

Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.

Packet ID State Bound To Field Name Field Type Notes
0x3E Play Client X Double Absolute or relative position, depending on Flags.
Y Double Absolute or relative position, depending on Flags.
Z Double Absolute or relative position, depending on Flags.
Yaw Float Absolute or relative rotation on the X axis, in degrees.
Pitch Float Absolute or relative rotation on the Y axis, in degrees.
Flags Byte Reference the Flags table below. When the value of the this byte masked is zero the field is absolute, otherwise relative.
Teleport ID VarInt Client should confirm this packet with Confirm Teleportation containing the same Teleport ID.
Flags
Field Hex Mask
X 0x01
Y 0x02
Z 0x04
Y_ROT (Pitch) 0x08
X_ROT (Yaw) 0x10

Update Recipe Book

Packet ID State Bound To Field Name Field Type Notes
0x3F Play Client
Action VarInt 0: init, 1: add, 2: remove.
Crafting Recipe Book Open Boolean If true, then the crafting recipe book will be open when the player opens its inventory.
Crafting Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.
Smelting Recipe Book Open Boolean If true, then the smelting recipe book will be open when the player opens its inventory.
Smelting Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.
Blast Furnace Recipe Book Open Boolean If true, then the blast furnace recipe book will be open when the player opens its inventory.
Blast Furnace Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.
Smoker Recipe Book Open Boolean If true, then the smoker recipe book will be open when the player opens its inventory.
Smoker Recipe Book Filter Active Boolean If true, then the filtering option is active when the players opens its inventory.
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 list 1 will be tagged as displayed, and all the recipes in list 2 will be added to the recipe book. Recipes that aren't tagged will be shown in the notification.
  • 1 (add) = All the recipes in the list are added to the recipe book and their icons will be shown in the notification.
  • 2 (remove) = Remove all the recipes in the list. This allows them to be re-displayed when they are re-added.

Remove Entities

Sent by the server when an entity is to be destroyed on the client.

Packet ID State Bound To Field Name Field Type Notes
0x40 Play Client Count VarInt Number of elements in the following array.
Entity IDs Array of VarInt The list of entities to destroy.

Remove Entity Effect

Packet ID State Bound To Field Name Field Type Notes
0x41 Play Client Entity ID VarInt
Effect ID VarInt See this table.

Reset Score

This is sent to the client when it should remove a scoreboard item.

Packet ID State Bound To Field Name Field Type Notes
0x42 Play Client Entity Name String (32767) The entity whose score this is. For players, this is their username; for other entities, it is their UUID.
Has Objective Name Boolean Whether the score should be removed for the specified objective, or for all of them.
Objective Name Optional String (32767) The name of the objective the score belongs to. Only present if the previous field is true.

Remove Resource Pack (play)

Packet ID State Bound To Field Name Field Type Notes
0x43 Play Client Has UUID Boolean Whether a specific resource pack should be removed, or all of them.
UUID Optional UUID The UUID of the resource pack to be removed. Only present if the previous field is true.

Add Resource Pack (play)

Packet ID State Bound To Field Name Field Type Notes
0x44 Play Client UUID UUID The unique identifier of the resource pack.
URL String (32767) The URL to the resource pack.
Hash String (40) A 40 character hexadecimal, case-insensitive SHA-1 hash of the resource pack file.
If it's not a 40 character hexadecimal string, the client will not use it for hash verification and likely waste bandwidth.
Forced Boolean The Notchian client will be forced to use the resource pack from the server. If they decline they will be kicked from the server.
Has Prompt Message Boolean Whether a custom message should be used on the resource pack prompt.
Prompt Message Optional Text Component This is shown in the prompt making the client accept or decline the resource pack. Only present if the previous field is true.

Respawn

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

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

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

In the Notchian implementation, this is context dependent:

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

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

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

Set Head Rotation

Changes the direction an entity's head is facing.

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.

Packet ID State Bound To Field Name Field Type Notes
0x46 Play Client Entity ID VarInt
Head Yaw Angle New angle, not a delta.

Update Section Blocks

Fired whenever 2 or more blocks are changed within the same chunk on the same tick.

Warning.png Changing blocks in chunks not loaded by the client is unsafe (see note on Block Update).

Packet ID State Bound To Field Name Field Type Notes
0x47 Play Client Chunk section position Long Chunk section coordinate (encoded chunk x and z with each 22 bits, and section y with 20 bits, from left to right).
Blocks array size VarInt Number of elements in the following array.
Blocks Array of VarLong Each entry is composed of the block state id, shifted left by 12, and the relative block position in the chunk section (4 bits for x, z, and y, from left to right).

Chunk section position is encoded:

((sectionX & 0x3FFFFF) << 42) | (sectionY & 0xFFFFF) | ((sectionZ & 0x3FFFFF) << 20);

and decoded:

sectionX = long >> 42;
sectionY = long << 44 >> 44;
sectionZ = long << 22 >> 42;

Blocks are encoded:

blockStateId << 12 | (blockLocalX << 8 | blockLocalZ << 4 | blockLocalY)
//Uses the local position of the given block position relative to its respective chunk section

and decoded:

blockStateId = long >> 12;
blockLocalX = (long >> 8) & 0xF;
blockLocalY = long & 0xF;
blockLocalZ = (long >> 4) & 0xF;

Select Advancements Tab

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.

Packet ID State Bound To Field Name Field Type Notes
0x48 Play Client Has id Boolean Indicates if the next field is present.
Identifier Optional Identifier See below.

The Identifier can be one of the following:

Identifier
minecraft:story/root
minecraft:nether/root
minecraft:end/root
minecraft:adventure/root
minecraft:husbandry/root

If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.

Server Data

Packet ID State Bound To Field Name Field Type Notes
0x49 Play Client MOTD Text Component
Has Icon Boolean
Size VarInt Number of bytes in the following array.
Icon Optional Byte Array Icon bytes in the PNG format
Enforces Secure Chat Boolean

Set Action Bar Text

Displays a message above the hotbar. Equivalent to System Chat Message with Overlay set to true, except that chat message blocking isn't performed. Used by the Notchian server only to implement the /title command.

Packet ID State Bound To Field Name Field Type Notes
0x4A Play Client Action bar text Text Component

Set Border Center

Packet ID State Bound To Field Name Field Type Notes
0x4B Play Client X Double
Z Double

Set Border Lerp Size

Packet ID State Bound To Field Name Field Type Notes
0x4C Play Client Old Diameter Double Current length of a single side of the world border, in meters.
New Diameter Double Target length of a single side of the world border, in meters.
Speed VarLong Number of real-time milliseconds 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.

Set Border Size

Packet ID State Bound To Field Name Field Type Notes
0x4D Play Client Diameter Double Length of a single side of the world border, in meters.

Set Border Warning Delay

Packet ID State Bound To Field Name Field Type Notes
0x4E Play Client Warning Time VarInt In seconds as set by /worldborder warning time.

Set Border Warning Distance

Packet ID State Bound To Field Name Field Type Notes
0x4F Play Client Warning Blocks VarInt In meters.

Set Camera

Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.

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).

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.

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).

Packet ID State Bound To Field Name Field Type Notes
0x50 Play Client Camera ID VarInt ID of the entity to set the client's camera to.

The notchian client also loads certain shaders for given entities:

  • Creeper → shaders/post/creeper.json
  • Spider (and cave spider) → shaders/post/spider.json
  • Enderman → shaders/post/invert.json
  • Anything else → the current shader is unloaded

Set Held Item (clientbound)

Sent to change the player's slot selection.

Packet ID State Bound To Field Name Field Type Notes
0x51 Play Client Slot Byte The slot which the player has selected (0–8).

Set Center Chunk

Sets the center position of the client's chunk loading area. The area is square-shaped, spanning 2 × server view distance + 7 chunks on both axes (width, not radius!). Since the area's width is always an odd number, there is no ambiguity as to which chunk is the center.

The Notchian client ignores attempts to send chunks located outside the loading area, and immediately unloads any existing chunks no longer inside it.

The center chunk is normally the chunk the player is in, but apart from the implications on chunk loading, the (Notchian) client takes no issue with this not being the case. Indeed, as long as chunks are sent only within the default loading area centered on the world origin, it is not necessary to send this packet at all. This may be useful for servers with small bounded worlds, such as minigames, since it ensures chunks never need to be resent after the client has joined, saving on bandwidth.

The Notchian server sends this packet whenever the player moves across a chunk border horizontally, and also (according to testing) for any integer change in the vertical axis, even if it doesn't go across a chunk section border.

Packet ID State Bound To Field Name Field Type Notes
0x52 Play Client Chunk X VarInt Chunk X coordinate of the loading area center.
Chunk Z VarInt Chunk Z coordinate of the loading area center.

Set Render Distance

Sent by the integrated singleplayer server when changing render distance. This packet is sent by the server when the client reappears in the overworld after leaving the end.

Packet ID State Bound To Field Name Field Type Notes
0x53 Play Client View Distance VarInt Render distance (2-32).

Set Default Spawn Position

Sent by the server after login to specify the coordinates of the spawn point (the point at which players spawn at, and which the compass points to). It can be sent at any time to update the point compasses point at.

Packet ID State Bound To Field Name Field Type Notes
0x54 Play Client Location Position Spawn location.
Angle Float The angle at which to respawn at.

Display Objective

This is sent to the client when it should display a scoreboard.

Packet ID State Bound To Field Name Field Type Notes
0x55 Play Client Position VarInt The position of the scoreboard. 0: list, 1: sidebar, 2: below name, 3 - 18: team specific sidebar, indexed as 3 + team color.
Score Name String (32767) The unique name for the scoreboard to be displayed.

Set Entity Metadata

Updates one or more metadata properties for an existing entity. Any properties not included in the Metadata field are left unchanged.

Packet ID State Bound To Field Name Field Type Notes
0x56 Play Client Entity ID VarInt
Metadata Entity Metadata

Link Entities

This packet is sent when an entity has been leashed to another entity.

Packet ID State Bound To Field Name Field Type Notes
0x57 Play Client Attached Entity ID Int Attached entity's EID.
Holding Entity ID Int ID of the entity holding the lead. Set to -1 to detach.

Set Entity Velocity

Velocity is in units of 1/8000 of a block per server tick (50ms); for example, -1343 would move (-1343 / 8000) = −0.167875 blocks per tick (or −3.3575 blocks per second).

Packet ID State Bound To Field Name Field Type Notes
0x58 Play Client Entity ID VarInt
Velocity X Short Velocity on the X axis.
Velocity Y Short Velocity on the Y axis.
Velocity Z Short Velocity on the Z axis.

Set Equipment

Packet ID State Bound To Field Name Field Type Notes
0x59 Play Client Entity ID VarInt Entity's ID.
Equipment Slot Array Byte Enum Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet). Also has the top bit set if another entry follows, and otherwise unset if this is the last item in the array.
Item Slot

Set Experience

Sent by the server when the client should change experience levels.

Packet ID State Bound To Field Name Field Type Notes
0x5A Play Client Experience bar Float Between 0 and 1.
Level VarInt
Total Experience VarInt See Experience#Leveling up on the Minecraft Wiki for Total Experience to Level conversion.

Set Health

Sent by the server to set the health of the player it is sent to.

Food saturation acts as a food “overcharge”. Food values will not decrease while the saturation is over zero. New players logging in or respawning automatically get a saturation of 5.0. Eating food increases the saturation as well as the food bar.

Packet ID State Bound To Field Name Field Type Notes
0x5B Play Client Health Float 0 or less = dead, 20 = full HP.
Food VarInt 0–20.
Food Saturation Float Seems to vary from 0.0 to 5.0 in integer increments.

Update Objectives

This is sent to the client when it should create a new scoreboard objective or remove one.

Packet ID State Bound To Field Name Field Type Notes
0x5C Play Client Objective Name String (32767) A unique name for the objective.
Mode Byte 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
Objective Value Optional Text Component Only if mode is 0 or 2.The text to be displayed for the score.
Type Optional VarInt Enum Only if mode is 0 or 2. 0 = "integer", 1 = "hearts".
Has Number Format Optional Boolean Only if mode is 0 or 2. Whether this objective has a set number format for the scores.
Number Format Optional VarInt Enum Only if mode is 0 or 2 and the previous boolean is true. Determines how the score number should be formatted.
Number Format Field Name
0: blank no fields Show nothing.
1: styled Styling Compound Tag The styling to be used when formatting the score number. Contains the text component styling fields.
2: fixed Content Text Component The text to be used as placeholder.

Set Passengers

Packet ID State Bound To Field Name Field Type Notes
0x5D Play Client Entity ID VarInt Vehicle's EID.
Passenger Count VarInt Number of elements in the following array.
Passengers Array of VarInt EIDs of entity's passengers.

Update Teams

Creates and updates teams.

Packet ID State Bound To Field Name Field Type Notes
0x5E Play Client Team Name String (32767) A unique name for the team. (Shared with scoreboard).
Mode Byte Determines the layout of the remaining packet.
0: create team Team Display Name Text Component
Friendly Flags Byte Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team.
Name Tag Visibility String Enum (40) always, hideForOtherTeams, hideForOwnTeam, never.
Collision Rule String Enum (40) always, pushOtherTeams, pushOwnTeam, never.
Team Color VarInt Enum Used to color the name of players on the team; see below.
Team Prefix Text Component Displayed before the names of players that are part of this team.
Team Suffix Text Component Displayed after the names of players that are part of this team.
Entity Count VarInt Number of elements in the following array.
Entities Array of String (32767) Identifiers for the entities in this team. For players, this is their username; for other entities, it is their UUID.
1: remove team no fields no fields
2: update team info Team Display Name Text Component
Friendly Flags Byte Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible entities on same team.
Name Tag Visibility String Enum (40) always, hideForOtherTeams, hideForOwnTeam, never
Collision Rule String Enum (40) always, pushOtherTeams, pushOwnTeam, never
Team Color VarInt Enum Used to color the name of players on the team; see below.
Team Prefix Text Component Displayed before the names of players that are part of this team.
Team Suffix Text Component Displayed after the names of players that are part of this team.
3: add entities to team Entity Count VarInt Number of elements in the following array.
Entities Array of String (32767) Identifiers for the added entities. For players, this is their username; for other entities, it is their UUID.
4: remove entities from team Entity Count VarInt Number of elements in the following array.
Entities Array of String (32767) Identifiers for the removed entities. For players, this is their username; for other entities, it is their UUID.

Team Color: The color of a team defines how the names of the team members are visualized; any formatting code can be used. The following table lists all the possible values.

ID Formatting
0-15 Color formatting, same values as in Text formatting#Colors.
16 Obfuscated
17 Bold
18 Strikethrough
19 Underlined
20 Italic
21 Reset

Update Score

This is sent to the client when it should update a scoreboard item.

Packet ID State Bound To Field Name Field Type Notes
0x5F Play Client Entity Name String (32767) The entity whose score this is. For players, this is their username; for other entities, it is their UUID.
Objective Name String (32767) The name of the objective the score belongs to.
Value VarInt The score to be displayed next to the entry.
Has Display Name Boolean Whether this score has a custom display name.
Display Name Optional Text Component The custom display name. Only present if the previous boolean is true.
Has Number Format Boolean Whether this score has a set number format. This overrides the number format set on the objective, if any.
Number Format Optional VarInt Enum Determines how the score number should be formatted. Only present if the previous boolean is true.
Number Format Field Name
0: blank no fields Show nothing.
1: styled Styling Compound Tag The styling to be used when formatting the score number. Contains the text component styling fields.
2: fixed Content Text Component The text to be used as placeholder.

Set Simulation Distance

Packet ID State Bound To Field Name Field Type Notes
0x60 Play Client Simulation Distance VarInt The distance that the client will process specific things, such as entities.

Set Subtitle Text

Packet ID State Bound To Field Name Field Type Notes
0x61 Play Client Subtitle Text Text Component

Update Time

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

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

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

Packet ID State Bound To Field Name Field Type Notes
0x62 Play Client World Age Long In ticks; not changed by server commands.
Time of day Long The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time.

Set Title Text

Packet ID State Bound To Field Name Field Type Notes
0x63 Play Client Title Text Text Component

Set Title Animation Times

Packet ID State Bound To Field Name Field Type Notes
0x64 Play Client Fade In Int Ticks to spend fading in.
Stay Int Ticks to keep the title displayed.
Fade Out Int Ticks to spend fading out, not when to start fading out.

Entity Sound Effect

Plays a sound effect from an entity, either by hardcoded ID or Identifier. Sound IDs and names can be found here.

Warning.png Numeric sound effect IDs are liable to change between versions

Packet ID State Bound To Field Name Field Type Notes
0x65 Play Client Sound ID VarInt Represents the Sound ID + 1. If the value is 0, the packet contains a sound specified by Identifier.
Sound Name Optional Identifier Only present if Sound ID is 0
Has Fixed Range Optional Boolean Only present if Sound ID is 0.
Range Optional Float The fixed range of the sound. Only present if previous boolean is true and Sound ID is 0.
Sound Category VarInt Enum The category that this sound will be played from (current categories).
Entity ID VarInt
Volume Float 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients.
Pitch Float Float between 0.5 and 2.0 by Notchian clients.
Seed Long Seed used to pick sound variant.

Sound Effect

Plays a sound effect at the given location, either by hardcoded ID or Identifier. Sound IDs and names can be found here.

Warning.png Numeric sound effect IDs are liable to change between versions

Packet ID State Bound To Field Name Field Type Notes
0x66 Play Client Sound ID VarInt Represents the Sound ID + 1. If the value is 0, the packet contains a sound specified by Identifier.
Sound Name Optional Identifier Only present if Sound ID is 0
Has Fixed Range Optional Boolean Only present if Sound ID is 0.
Range Optional Float The fixed range of the sound. Only present if previous boolean is true and Sound ID is 0.
Sound Category VarInt Enum The category that this sound will be played from (current categories).
Effect Position X Int Effect X multiplied by 8 (fixed-point number with only 3 bits dedicated to the fractional part).
Effect Position Y Int Effect Y multiplied by 8 (fixed-point number with only 3 bits dedicated to the fractional part).
Effect Position Z Int Effect Z multiplied by 8 (fixed-point number with only 3 bits dedicated to the fractional part).
Volume Float 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients.
Pitch Float Float between 0.5 and 2.0 by Notchian clients.
Seed Long Seed used to pick sound variant.

Start Configuration

Sent during gameplay in order to redo the configuration process. The client must respond with Acknowledge Configuration for the process to start.

Packet ID State Bound To Field Name Field Type Notes
0x67 Play Client no fields

This packet switches the connection state to configuration.

Stop Sound

Packet ID State Bound To Field Name Field Type Notes
0x68 Play Client Flags Byte Controls which fields are present.
Source Optional VarInt Enum Only if flags is 3 or 1 (bit mask 0x1). See below. If not present, then sounds from all sources are cleared.
Sound Optional Identifier Only if flags is 2 or 3 (bit mask 0x2). A sound effect name, see Custom Sound Effect. If not present, then all sounds are cleared.

Categories:

Name Value
master 0
music 1
record 2
weather 3
block 4
hostile 5
neutral 6
player 7
ambient 8
voice 9

System Chat Message

Sends the client a raw system message.

Packet ID State Bound To Field Name Field Type Notes
0x69 Play Client Content Text Component Limited to 262144 bytes.
Overlay Boolean Whether the message is an actionbar or chat message. See also #Set Action Bar Text.

Set Tab List Header And Footer

This packet may be used by custom servers to display additional information above/below the player list. It is never sent by the Notchian server.

Packet ID State Bound To Field Name Field Type Notes
0x6A Play Client Header Text Component To remove the header, send a empty text component: {"text":""}.
Footer Text Component To remove the footer, send a empty text component: {"text":""}.

Tag Query Response

Sent in response to Query Block Entity Tag or Query Entity Tag.

Packet ID State Bound To Field Name Field Type Notes
0x6B Play Client Transaction ID VarInt Can be compared to the one sent in the original query packet.
NBT NBT The NBT of the block or entity. May be a TAG_END (0) in which case no NBT is present.

Pickup Item

Sent by the server when someone picks up an item lying on the ground — its sole purpose appears to be the animation of the item flying towards you. It doesn't destroy the entity in the client memory, and it doesn't add it to your inventory. The server only checks for items to be picked up after each Set Player Position (and Set Player Position And Rotation) packet sent by the client. The collector entity can be any entity; it does not have to be a player. The collected entity also can be any entity, but the Notchian server only uses this for items, experience orbs, and the different varieties of arrows.

Packet ID State Bound To Field Name Field Type Notes
0x6C Play Client Collected Entity ID VarInt
Collector Entity ID VarInt
Pickup Item Count VarInt Seems to be 1 for XP orbs, otherwise the number of items in the stack.

Teleport Entity

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

Packet ID State Bound To Field Name Field Type Notes
0x6D Play Client Entity ID VarInt
X Double
Y Double
Z Double
Yaw Angle (Y Rot)New angle, not a delta.
Pitch Angle (X Rot)New angle, not a delta.
On Ground Boolean

Set Ticking State

Used to adjust the ticking rate of the client, and whether it's frozen.

Packet ID State Bound To Field Name Field Type Notes
0x6E Play Client Tick rate Float
Is frozen Boolean

Step Tick

Advances the client processing by the specified number of ticks. Has no effect unless client ticking is frozen.

Packet ID State Bound To Field Name Field Type Notes
0x6F Play Client Tick steps VarInt

Update Advancements

Packet ID State Bound To Field Name Field Type Notes
0x70 Play Client Reset/Clear Boolean Whether to reset/clear the current advancements.
Mapping size VarInt Size of the following array.
Advancement mapping Key Array Identifier The identifier of the advancement.
Value Advancement See below
List size VarInt Size of the following array.
Identifiers Array of Identifier The identifiers of the advancements that should be removed.
Progress size VarInt Size of the following array.
Progress mapping Key Array Identifier The identifier of the advancement.
Value Advancement progress See below.

Advancement structure:

Field Name Field Type Notes
Has parent Boolean Indicates whether the next field exists.
Parent id Optional Identifier The identifier of the parent advancement.
Has display Boolean Indicates whether the next field exists.
Display data Optional Advancement display See below.
Array length VarInt Number of arrays in the following array.
Requirements Array length 2 Array VarInt Number of elements in the following array.
Requirement Array of String (32767) Array of required criteria.
Sends telemetry data Boolean Whether the client should include this achievement in the telemetry data when it's completed.

The Notchian client only sends data for advancements on the minecraft namespace.

Advancement display:

Field Name Field Type Notes
Title Text Component
Description Text Component
Icon Slot
Frame type VarInt Enum 0 = task, 1 = challenge, 2 = goal.
Flags Int 0x01: has background texture; 0x02: show_toast; 0x04: hidden.
Background texture Optional Identifier Background texture location. Only if flags indicates it.
X coord Float
Y coord Float

Advancement progress:

Field Name Field Type Notes
Size VarInt Size of the following array.
Criteria Criterion identifier Array Identifier The identifier of the criterion.
Criterion progress Criterion progress

Criterion progress:

Field Name Field Type Notes
Achieved Boolean If true, next field is present.
Date of achieving Optional Long As returned by Date.getTime.

Update Attributes

Sets attributes on the given entity.

Packet ID State Bound To Field Name Field Type Notes
0x71 Play Client Entity ID VarInt
Number Of Properties VarInt Number of elements in the following array.
Property Key Array Identifier See below.
Value Double See below.
Number Of Modifiers VarInt Number of elements in the following array.
Modifiers Array of Modifier Data See Attribute#Modifiers. Modifier Data defined below.

Known Key values (see also Attribute#Modifiers):

Key Default Min Max Label
generic.max_health 20.0 1.0 1024.0 Max Health.
generic.follow_range 32.0 0.0 2048.0 Follow Range.
generic.knockback_resistance 0.0 0.0 1.0 Knockback Resistance.
generic.movement_speed 0.7 0.0 1024.0 Movement Speed.
generic.flying_speed 0.4 0.0 1024.0 Flying Speed.
generic.attack_damage 2.0 0.0 2048.0 Attack Damage.
generic.attack_knockback 0.0 0.0 5.0
generic.attack_speed 4.0 0.0 1024.0 Attack Speed.
generic.armor 0.0 0.0 30.0 Armor.
generic.armor_toughness 0.0 0.0 20.0 Armor Toughness.
generic.luck 0.0 -1024.0 1024.0 Luck.
zombie.spawn_reinforcements 0.0 0.0 1.0 Spawn Reinforcements Chance.
horse.jump_strength 0.7 0.0 2.0 Jump Strength.
generic.reachDistance 5.0 0.0 1024.0 Player Reach Distance (Forge only).
forge.swimSpeed 1.0 0.0 1024.0 Swimming Speed (Forge only).

Modifier Data structure:

Field Name Field Type Notes
UUID UUID
Amount Double May be positive or negative.
Operation Byte See below.

The operation controls how the base value of the modifier is changed.

  • 0: Add/subtract amount
  • 1: Add/subtract amount percent of the current value
  • 2: Multiply by amount percent

All of the 0's are applied first, and then the 1's, and then the 2's.

Entity Effect

Packet ID State Bound To Field Name Field Type Notes
0x72 Play Client Entity ID VarInt
Effect ID VarInt See this table.
Amplifier Byte Notchian client displays effect level as Amplifier + 1.
Duration VarInt Duration in ticks. (-1 for infinite)
Flags Byte Bit field, see below.
Has Factor Data Boolean Used in DARKNESS effect
Factor Codec NBT See below

Within flags:

  • 0x01: Is ambient - was the effect spawned from a beacon? All beacon-generated effects are ambient. Ambient effects use a different icon in the HUD (blue border rather than gray). If all effects on an entity are ambient, the "Is potion effect ambient" living metadata field should be set to true. Usually should not be enabled.
  • 0x02: Show particles - should all particles from this effect be hidden? Effects with particles hidden are not included in the calculation of the effect color, and are not rendered on the HUD (but are still rendered within the inventory). Usually should be enabled.
  • 0x04: Show icon - should the icon be displayed on the client? Usually should be enabled.

Factor Data

Name Type Notes
padding_duration TAG_INT
factor_start TAG_FLOAT
factor_target TAG_FLOAT
factor_current TAG_FLOAT
effect_changed_timestamp TAG_INT
factor_previous_frame TAG_FLOAT
had_effect_last_tick TAG_BOOLEAN

Update Recipes

Packet ID State Bound To Field Name Field Type Notes
0x73 Play Client Num Recipes VarInt Number of elements in the following array.
Recipe Type Array Identifier The recipe type, see below.
Recipe ID Identifier
Data Varies Additional data for the recipe.

Recipe types:

Type Description Data
minecraft:crafting_shapeless Shapeless crafting recipe. All items in the ingredient list must be present, but in any order/slot. As follows:
Name Type Description
Group String (32767) Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
Category VarInt Enum Building = 0, Redstone = 1, Equipment = 2, Misc = 3
Ingredient count VarInt Number of elements in the following array.
Ingredients Array of Ingredient.
Result Slot
minecraft:crafting_shaped Shaped crafting recipe. All items must be present in the same pattern (which may be flipped horizontally or translated). As follows:
Name Type Description
Group String (32767) Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
Category VarInt Enum Building = 0, Redstone = 1, Equipment = 2, Misc = 3
Width VarInt
Height VarInt
Ingredients Array of Ingredient Length is width * height. Indexed by x + (y * width).
Result Slot
Show notification Boolean Show a toast when the recipe is added.
minecraft:crafting_special_armordye Recipe for dying leather armor As follows:
Name Type Description
Category VarInt Enum Building = 0, Redstone = 1, Equipment = 2, Misc = 3
minecraft:crafting_special_bookcloning Recipe for copying contents of written books
minecraft:crafting_special_mapcloning Recipe for copying maps
minecraft:crafting_special_mapextending Recipe for adding paper to maps
minecraft:crafting_special_firework_rocket Recipe for making firework rockets
minecraft:crafting_special_firework_star Recipe for making firework stars
minecraft:crafting_special_firework_star_fade Recipe for making firework stars fade between multiple colors
minecraft:crafting_special_repairitem Recipe for repairing items via crafting
minecraft:crafting_special_tippedarrow Recipe for crafting tipped arrows
minecraft:crafting_special_bannerduplicate Recipe for copying banner patterns
minecraft:crafting_special_shielddecoration Recipe for applying a banner's pattern to a shield
minecraft:crafting_special_shulkerboxcoloring Recipe for recoloring a shulker box
minecraft:crafting_special_suspiciousstew Recipe for crafting suspicious stews
minecraft:crafting_decorated_pot Recipe for crafting decorated pots
minecraft:smelting Smelting recipe As follows:
Name Type Description
Group String (32767) Used to group similar recipes together in the recipe book.
Category VarInt Enum Food = 0, Blocks = 1, Misc = 2
Ingredient Ingredient
Result Slot
Experience Float
Cooking time VarInt
minecraft:blasting Blast furnace recipe
minecraft:smoking Smoker recipe
minecraft:campfire_cooking Campfire recipe
minecraft:stonecutting Stonecutter recipe As follows:
Name Type Description
Group String (32767) Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
Ingredient Ingredient
Result Slot
minecraft:smithing_transform Recipe for smithing netherite gear As follows:
Name Type Description
Template Ingredient The smithing template.
Base Ingredient The base item.
Addition Ingredient The additional ingredient.
Result Slot
minecraft:smithing_trim Recipe for applying armor trims As follows:
Name Type Description
Template Ingredient The smithing template.
Base Ingredient The base item.
Addition Ingredient The additional ingredient.

Ingredient is defined as:

Name Type Description
Count VarInt Number of elements in the following array.
Items Array of Slot Any item in this array may be used for the recipe. The count of each item should be 1.

Update Tags (play)

Packet ID State Bound To Field Name Field Type Notes
0x74 Play Client Length of the array VarInt
Array of tags Registry Array Identifier Registry identifier (Vanilla expects tags for the registries minecraft:block, minecraft:item, minecraft:fluid, minecraft:entity_type, and minecraft:game_event)
Array of Tag (See below)

Tag arrays look like:

Field Name Field Type Notes
Length VarInt Number of elements in the following array
Tags Tag name Array Identifier
Count VarInt Number of elements in the following array
Entries Array of VarInt Numeric IDs of the given type (block, item, etc.). This list replaces the previous list of IDs for the given tag. If some preexisting tags are left unmentioned, a warning is printed.

See Tag on the Minecraft Wiki for more information, including a list of vanilla tags.

Serverbound

Confirm Teleportation

Sent by client as confirmation of Synchronize Player Position.

Packet ID State Bound To Field Name Field Type Notes
0x00 Play Server Teleport ID VarInt The ID given by the Synchronize Player Position packet.

Query Block Entity Tag

Used when F3+I is pressed while looking at a block.

Packet ID State Bound To Field Name Field Type Notes
0x01 Play Server Transaction ID VarInt An incremental ID so that the client can verify that the response matches.
Location Position The location of the block to check.

Change Difficulty

Must have at least op level 2 to use. Appears to only be used on singleplayer; the difficulty buttons are still disabled in multiplayer.

Packet ID State Bound To Field Name Field Type Notes
0x02 Play Server New difficulty Byte 0: peaceful, 1: easy, 2: normal, 3: hard .

Acknowledge Message

Packet ID State Bound To Field Name Field Type Notes
0x03 Play Server Message Count VarInt

Chat Command

Packet ID State Bound To Field Name Field Type Notes
0x04 Play Server Command String (256) The command typed by the client.
Timestamp Long The timestamp that the command was executed.
Salt Long The salt for the following argument signatures.
Array length VarInt Number of entries in the following array. The maximum length in Notchian server is 8.
Array of argument signatures Argument name Array (8) String (16) The name of the argument that is signed by the following signature.
Signature Byte Array (256) The signature that verifies the argument. Always 256 bytes and is not length-prefixed.
Message Count VarInt
Acknowledged Fixed BitSet (20)

Chat Message

Used to send a chat message to the server. The message may not be longer than 256 characters or else the server will kick the client.

The server will broadcast a Player Chat Message packet with Chat Type minecraft:chat to all players that haven't disabled chat (including the player that sent the message). See Chat#Processing chat for more information.

Packet ID State Bound To Field Name Field Type Notes
0x05 Play Server Message String (256)
Timestamp Long
Salt Long The salt used to verify the signature hash.
Has Signature Boolean Whether the next field is present.
Signature Optional Byte Array (256) The signature used to verify the chat message's authentication. When present, always 256 bytes and not length-prefixed.
Message Count VarInt
Acknowledged Fixed BitSet (20)

Player Session

Packet ID State Bound To Field Name Field Type Notes
0x06 Play Server Session Id UUID
Public Key Expires At Long The time the play session key expires in epoch milliseconds.
Public Key Length VarInt Length of the proceeding public key. Maximum length in Notchian server is 512 bytes.
Public Key Byte Array (512) A byte array of an X.509-encoded public key.
Key Signature Length VarInt Length of the proceeding key signature array. Maximum length in Notchian server is 4096 bytes.
Key Signature Byte Array (4096) The signature consists of the player UUID, the key expiration timestamp, and the public key data. These values are hashed using SHA-1 and signed using Mojang's private RSA key.

Chunk Batch Received

Notifies the server that the chunk batch has been received by the client. The server uses the value sent in this packet to adjust the number of chunks to be sent in a batch.

The Notchian server will stop sending further chunk data until the client acknowledges the sent chunk batch. After the first acknowledgement, the server adjusts this number to allow up to 10 unacknowledged batches.

Packet ID State Bound To Field Name Field Type Notes
0x07 Play Server Chunks per tick Float Desired chunks per tick.

Client Status

Packet ID State Bound To Field Name Field Type Notes
0x08 Play Server Action ID VarInt Enum See below

Action ID values:

Action ID Action Notes
0 Perform respawn Sent when the client is ready to complete login and when the client is ready to respawn after death.
1 Request stats Sent when the client opens the Statistics menu.

Client Information (play)

Sent when the player connects, or when settings are changed.

Packet ID State Bound To Field Name Field Type Notes
0x09 Play Server Locale String (16) e.g. en_GB.
View Distance Byte Client-side render distance, in chunks.
Chat Mode VarInt Enum 0: enabled, 1: commands only, 2: hidden. See Chat#Client chat mode for more information.
Chat Colors Boolean “Colors” multiplayer setting. Can the chat be colored?
Displayed Skin Parts Unsigned Byte Bit mask, see below.
Main Hand VarInt Enum 0: Left, 1: Right.
Enable text filtering Boolean Enables filtering of text on signs and written book titles. Currently always false (i.e. the filtering is disabled)
Allow server listings Boolean Servers usually list online players, this option should let you not show up in that list.

Displayed Skin Parts flags:

  • Bit 0 (0x01): Cape enabled
  • Bit 1 (0x02): Jacket enabled
  • Bit 2 (0x04): Left Sleeve enabled
  • Bit 3 (0x08): Right Sleeve enabled
  • Bit 4 (0x10): Left Pants Leg enabled
  • Bit 5 (0x20): Right Pants Leg enabled
  • Bit 6 (0x40): Hat enabled

The most significant bit (bit 7, 0x80) appears to be unused.

Command Suggestions Request

Sent when the client needs to tab-complete a minecraft:ask_server suggestion type.

Packet ID State Bound To Field Name Field Type Notes
0x0A Play Server Transaction Id VarInt The id of the transaction that the server will send back to the client in the response of this packet. Client generates this and increments it each time it sends another tab completion that doesn't get a response.
Text String (32500) All text behind the cursor without the / (e.g. to the left of the cursor in left-to-right languages like English).

Acknowledge Configuration

Sent by the client upon receiving a Start Configuration packet from the server.

Packet ID State Bound To Field Name Field Type Notes
0x0B Play Server no fields

This packet switches the connection state to configuration.

Click Container Button

Used when clicking on window buttons. Until 1.14, this was only used by enchantment tables.

Packet ID State Bound To Field Name Field Type Notes
0x0C Play Server Window ID Byte The ID of the window sent by Open Screen.
Button ID Byte Meaning depends on window type; see below.
Window type ID Meaning
Enchantment Table 0 Topmost enchantment.
1 Middle enchantment.
2 Bottom enchantment.
Lectern 1 Previous page (which does give a redstone output).
2 Next page.
3 Take Book.
100+page Opened page number - 100 + number.
Stonecutter Recipe button number - 4*row + col. Depends on the item.
Loom Recipe button number - 4*row + col. Depends on the item.

Click Container

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

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

See Inventory for further information about how slots are indexed.

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

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

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

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

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

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

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

Close Container

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

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

Packet ID State Bound To Field Name Field Type Notes
0x0E Play Server Window ID Unsigned Byte This is the ID of the window that was closed. 0 for player inventory.

Change Container Slot State

This packet is sent by the client when toggling the state of a Crafter.

Packet ID State Bound To Field Name Field Type Notes
0x0F Play Server Slot ID VarInt This is the ID of the slot that was changed.
Window ID VarInt This is the ID of the window that was changed.
State Boolean The new state of the slot. True for enabled, false for disabled.

Serverbound Plugin Message (play)

Main article: Plugin channels

Mods and plugins can use this to send their data. Minecraft itself uses some plugin channels. These internal channels are in the minecraft namespace.

More documentation on this: https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/

Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.

Packet ID State Bound To Field Name Field Type Notes
0x10 Play Server Channel Identifier Name of the plugin channel used to send the data.
Data Byte Array (32767) Any data, depending on the channel. minecraft: channels are documented here. The length of this array must be inferred from the packet length.

In Notchian server, the maximum data length is 32767 bytes.

Edit Book

Packet ID State Bound To Field Name Field Type Notes
0x11 Play Server Slot VarInt The hotbar slot where the written book is located
Count VarInt Number of elements in the following array. Maximum array size is 200.
Entries Array (200) of String (8192) Text from each page. Maximum string length is 8192 chars.
Has title Boolean If true, the next field is present. true if book is being signed, false if book is being edited.
Title Optional String (128) Title of book.

Query Entity Tag

Used when F3+I is pressed while looking at an entity.

Packet ID State Bound To Field Name Field Type Notes
0x12 Play Server Transaction ID VarInt An incremental ID so that the client can verify that the response matches.
Entity ID VarInt The ID of the entity to query.

Interact

This packet is sent from the client to the server when the client attacks or right-clicks another entity (a player, minecart, etc).

A Notchian server only accepts this packet if the entity being attacked/used is visible without obstruction and within a 4-unit radius of the player's position.

The target X, Y, and Z fields represent the difference between the vector location of the cursor at the time of the packet and the entity's position.

Note that middle-click in creative mode is interpreted by the client and sent as a Set Creative Mode Slot packet instead.

Packet ID State Bound To Field Name Field Type Notes
0x13 Play Server Entity ID VarInt The ID of the entity to interact.
Type VarInt Enum 0: interact, 1: attack, 2: interact at.
Target X Optional Float Only if Type is interact at.
Target Y Optional Float Only if Type is interact at.
Target Z Optional Float Only if Type is interact at.
Hand Optional VarInt Enum Only if Type is interact or interact at; 0: main hand, 1: off hand.
Sneaking Boolean If the client is sneaking.

Jigsaw Generate

Sent when Generate is pressed on the Jigsaw Block interface.

Packet ID State Bound To Field Name Field Type Notes
0x14 Play Server Location Position Block entity location.
Levels VarInt Value of the levels slider/max depth to generate.
Keep Jigsaws Boolean

Serverbound Keep Alive (play)

The server will frequently send out a keep-alive (see Clientbound Keep Alive), each containing a random ID. The client must respond with the same packet.

Packet ID State Bound To Field Name Field Type Notes
0x15 Play Server Keep Alive ID Long

Lock Difficulty

Must have at least op level 2 to use. Appears to only be used on singleplayer; the difficulty buttons are still disabled in multiplayer.

Packet ID State Bound To Field Name Field Type Notes
0x16 Play Server Locked Boolean

Set Player Position

Updates the player's XYZ position on the server.

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

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

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

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

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

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

Checking for block collisions is achieved like this:

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

Checking for illegal flight is achieved like this:

  • When a movement packet is received, a flag indicating whether or not the player is floating mid-air is updated. The flag is set if the move test described above detected no collision below the player and the y component of the offset from the player's current position to the requested one is greater than -0.5, unless any of various conditions permitting flight (creative mode, elytra, levitation effect, etc., but not jumping) are met.
  • Each server tick, it is checked if the flag has been set for more than 80 consecutive ticks. If so, and the player isn't currently sleeping, dead or riding a vehicle, they are kicked for multiplayer.disconnect.flying.
Packet ID State Bound To Field Name Field Type Notes
0x17 Play Server X Double Absolute position.
Feet Y Double Absolute feet position, normally Head Y - 1.62.
Z Double Absolute position.
On Ground Boolean True if the client is on the ground, false otherwise.

Set Player Position and Rotation

A combination of Move Player Rotation and Move Player Position.

Packet ID State Bound To Field Name Field Type Notes
0x18 Play Server X Double Absolute position.
Feet Y Double Absolute feet position, normally Head Y - 1.62.
Z Double Absolute position.
Yaw Float Absolute rotation on the X Axis, in degrees.
Pitch Float Absolute rotation on the Y Axis, in degrees.
On Ground Boolean True if the client is on the ground, false otherwise.

Set Player Rotation

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

Updates the direction the player is looking in.

Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0,-1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.

Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.

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

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

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

x = -cos(pitch) * sin(yaw)
y = -sin(pitch)
z =  cos(pitch) * cos(yaw)
Packet ID State Bound To Field Name Field Type Notes
0x19 Play Server Yaw Float Absolute rotation on the X Axis, in degrees.
Pitch Float Absolute rotation on the Y Axis, in degrees.
On Ground Boolean True if the client is on the ground, false otherwise.

Set Player On Ground

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

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

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

Packet ID State Bound To Field Name Field Type Notes
0x1A Play Server On Ground Boolean True if the client is on the ground, false otherwise.

Move Vehicle

Sent when a player moves in a vehicle. Fields are the same as in Set Player Position and Rotation. Note that all fields use absolute positioning and do not allow for relative positioning.

Packet ID State Bound To Field Name Field Type Notes
0x1B Play Server X Double Absolute position (X coordinate).
Y Double Absolute position (Y coordinate).
Z Double Absolute position (Z coordinate).
Yaw Float Absolute rotation on the vertical axis, in degrees.
Pitch Float Absolute rotation on the horizontal axis, in degrees.

Paddle Boat

Used to visually update whether boat paddles are turning. The server will update the Boat entity metadata to match the values here.

Packet ID State Bound To Field Name Field Type Notes
0x1C Play Server Left paddle turning Boolean
Right paddle turning Boolean

Right paddle turning is set to true when the left button or forward button is held, left paddle turning is set to true when the right button or forward button is held.

Pick Item

Used to swap out an empty space on the hotbar with the item in the given inventory slot. The Notchian client uses this for pick block functionality (middle click) to retrieve items from the inventory.

Packet ID State Bound To Field Name Field Type Notes
0x1D Play Server Slot to use VarInt See Inventory.

The server first searches the player's hotbar for an empty slot, starting from the current slot and looping around to the slot before it. If there are no empty slots, it starts a second search from the current slot and finds the first slot that does not contain an enchanted item. If there still are no slots that meet that criteria, then the server uses the currently selected slot.

After finding the appropriate slot, the server swaps the items and sends 3 packets:

Ping Request (play)

Packet ID State Bound To Field Name Field Type Notes
0x1E Play Server Payload Long May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.

Place Recipe

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

Packet ID State Bound To Field Name Field Type Notes
0x1F Play Server Window ID Byte
Recipe Identifier A recipe ID.
Make all Boolean Affects the amount of items processed; true if shift is down when clicked.

Player Abilities (serverbound)

The vanilla client sends this packet when the player starts/stops flying with the Flags parameter changed accordingly.

Packet ID State Bound To Field Name Field Type Notes
0x20 Play Server Flags Byte Bit mask. 0x02: is flying.

Player Action

Sent when the player mines a block. A Notchian server only accepts digging packets with coordinates within a 6-unit radius between the center of the block and the player's eyes.

Packet ID State Bound To Field Name Field Type Notes
0x21 Play Server Status VarInt Enum The action the player is taking against the block (see below).
Location Position Block position.
Face Byte Enum The face being hit (see below).
Sequence VarInt Block change sequence number (see #Acknowledge Block Change).

Status can be one of seven values:

Value Meaning Notes
0 Started digging Sent when the player starts digging a block. If the block was instamined or the player is in creative mode, the client will not send Status = Finished digging, and will assume the server completed the destruction. To detect this, it is necessary to calculate the block destruction speed server-side.
1 Cancelled digging Sent when the player lets go of the Mine Block key (default: left click). Face is always set to -Y.
2 Finished digging Sent when the client thinks it is finished.
3 Drop item stack Triggered by using the Drop Item key (default: Q) with the modifier to drop the entire selected stack (default: Control or Command, depending on OS). Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.
4 Drop item Triggered by using the Drop Item key (default: Q). Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.
5 Shoot arrow / finish eating Indicates that the currently held item should have its state updated such as eating food, pulling back bows, using buckets, etc. Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.
6 Swap item in hand Used to swap or assign an item to the second hand. Location is always set to 0/0/0, Face is always set to -Y. Sequence is always set to 0.

The Face field can be one of the following values, representing the face being hit:

Value Offset Face
0 -Y Bottom
1 +Y Top
2 -Z North
3 +Z South
4 -X West
5 +X East

Player Command

Sent by the client to indicate that it has performed certain actions: sneaking (crouching), sprinting, exiting a bed, jumping with a horse, and opening a horse's inventory while riding it.

Packet ID State Bound To Field Name Field Type Notes
0x22 Play Server Entity ID VarInt Player ID
Action ID VarInt Enum The ID of the action, see below.
Jump Boost VarInt Only used by the “start jump with horse” action, in which case it ranges from 0 to 100. In all other cases it is 0.

Action ID can be one of the following values:

ID Action
0 Start sneaking
1 Stop sneaking
2 Leave bed
3 Start sprinting
4 Stop sprinting
5 Start jump with horse
6 Stop jump with horse
7 Open vehicle inventory
8 Start flying with elytra

Leave bed is only sent when the “Leave Bed” button is clicked on the sleep GUI, not when waking up in the morning.

Open vehicle inventory is only sent when pressing the inventory key (default: E) while on a horse or chest boat — all other methods of opening such an inventory (involving right-clicking or shift-right-clicking it) do not use this packet.

Player Input

Packet ID State Bound To Field Name Field Type Notes
0x23 Play Server Sideways Float Positive to the left of the player.
Forward Float Positive forward.
Flags Unsigned Byte Bit mask. 0x1: jump, 0x2: unmount.

Also known as 'Input' packet.

Pong (play)

Response to the clientbound packet (Ping) with the same id.

Packet ID State Bound To Field Name Field Type Notes
0x24 Play Server ID Int id is the same as the ping packet

Change Recipe Book Settings

Replaces Recipe Book Data, type 1.

Packet ID State Bound To Field Name Field Type Notes
0x25 Play Server Book ID VarInt Enum 0: crafting, 1: furnace, 2: blast furnace, 3: smoker.
Book Open Boolean
Filter Active Boolean

Set Seen Recipe

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

Packet ID State Bound To Field Name Field Type Notes
0x26 Play Server Recipe ID Identifier

Rename Item

Sent as a player is renaming an item in an anvil (each keypress in the anvil UI sends a new Rename Item packet). If the new name is empty, then the item loses its custom name (this is different from setting the custom name to the normal name of the item). The item name may be no longer than 50 characters long, and if it is longer than that, then the rename is silently ignored.

Packet ID State Bound To Field Name Field Type Notes
0x27 Play Server Item name String (32767) The new name of the item.

Resource Pack Response (play)

Packet ID State Bound To Field Name Field Type Notes
0x28 Play Server
UUID UUID The unique identifier of the resource pack received in the Add Resource Pack (play) request.
Result VarInt Enum Result ID (see below).

Result can be one of the following values:

ID Result
0 Successfully downloaded
1 Declined
2 Failed to download
3 Accepted
4 Invalid URL
5 Failed to reload
6 Discarded


Seen Advancements

Packet ID State Bound To Field Name Field Type Notes
0x29 Play Server Action VarInt Enum 0: Opened tab, 1: Closed screen.
Tab ID Optional Identifier Only present if action is Opened tab.

Select Trade

When a player selects a specific trade offered by a villager NPC.

Packet ID State Bound To Field Name Field Type Notes
0x2A Play Server Selected slot VarInt The selected slot in the players current (trading) inventory.

Set Beacon Effect

Changes the effect of the current beacon.

Packet ID State Bound To Field Name Field Type Notes
0x2B Play Server
Has Primary Effect Boolean
Primary Effect Optional VarInt A Potion ID.
Has Secondary Effect Boolean
Secondary Effect Optional VarInt A Potion ID.

Set Held Item (serverbound)

Sent when the player changes the slot selection.

Packet ID State Bound To Field Name Field Type Notes
0x2C Play Server Slot Short The slot which the player has selected (0–8).

Program Command Block

Packet ID State Bound To Field Name Field Type Notes
0x2D Play Server
Location Position
Command String (32767)
Mode VarInt Enum One of SEQUENCE (0), AUTO (1), or REDSTONE (2).
Flags Byte 0x01: Track Output (if false, the output of the previous command will not be stored within the command block); 0x02: Is conditional; 0x04: Automatic.

Program Command Block Minecart

Packet ID State Bound To Field Name Field Type Notes
0x2E Play Server Entity ID VarInt
Command String (32767)
Track Output Boolean If false, the output of the previous command will not be stored within the command block.

Set Creative Mode Slot

While the user is in the standard inventory (i.e., not a crafting bench) in Creative mode, the player will send this packet.

Clicking in the creative inventory menu is quite different from non-creative inventory management. Picking up an item with the mouse actually deletes the item from the server, and placing an item into a slot or dropping it out of the inventory actually tells the server to create the item from scratch. (This can be verified by clicking an item that you don't mind deleting, then severing the connection to the server; the item will be nowhere to be found when you log back in.) As a result of this implementation strategy, the "Destroy Item" slot is just a client-side implementation detail that means "I don't intend to recreate this item.". Additionally, the long listings of items (by category, etc.) are a client-side interface for choosing which item to create. Picking up an item from such listings sends no packets to the server; only when you put it somewhere does it tell the server to create the item in that location.

This action can be described as "set inventory slot". Picking up an item sets the slot to item ID -1. Placing an item into an inventory slot sets the slot to the specified item. Dropping an item (by clicking outside the window) effectively sets slot -1 to the specified item, which causes the server to spawn the item entity, etc.. All other inventory slots are numbered the same as the non-creative inventory (including slots for the 2x2 crafting menu, even though they aren't visible in the vanilla client).

Packet ID State Bound To Field Name Field Type Notes
0x2F Play Server Slot Short Inventory slot.
Clicked Item Slot

Program Jigsaw Block

Sent when Done is pressed on the Jigsaw Block interface.

Packet ID State Bound To Field Name Field Type Notes
0x30 Play Server Location Position Block entity location
Name Identifier
Target Identifier
Pool Identifier
Final state String (32767) "Turns into" on the GUI, final_state in NBT.
Joint type String (32767) rollable if the attached piece can be rotated, else aligned.
Selection priority VarInt
Placement priority VarInt


Program Structure Block

Packet ID State Bound To Field Name Field Type Notes
0x31 Play Server
Location Position Block entity location.
Action VarInt Enum An additional action to perform beyond simply saving the given data; see below.
Mode VarInt Enum One of SAVE (0), LOAD (1), CORNER (2), DATA (3).
Name String (32767)
Offset X Byte Between -48 and 48.
Offset Y Byte Between -48 and 48.
Offset Z Byte Between -48 and 48.
Size X Byte Between 0 and 48.
Size Y Byte Between 0 and 48.
Size Z Byte Between 0 and 48.
Mirror VarInt Enum One of NONE (0), LEFT_RIGHT (1), FRONT_BACK (2).
Rotation VarInt Enum One of NONE (0), CLOCKWISE_90 (1), CLOCKWISE_180 (2), COUNTERCLOCKWISE_90 (3).
Metadata String (128)
Integrity Float Between 0 and 1.
Seed VarLong
Flags Byte 0x01: Ignore entities; 0x02: Show air; 0x04: Show bounding box.

Possible actions:

  • 0 - Update data
  • 1 - Save the structure
  • 2 - Load the structure
  • 3 - Detect size

The Notchian client uses update data to indicate no special action should be taken (i.e. the done button).

Update Sign

This message is sent from the client to the server when the “Done” button is pushed after placing a sign.

The server only accepts this packet after Open Sign Editor, otherwise this packet is silently ignored.

Packet ID State Bound To Field Name Field Type Notes
0x32 Play Server Location Position Block Coordinates.
Is Front Text Boolean Whether the updated text is in front or on the back of the sign
Line 1 String (384) First line of text in the sign.
Line 2 String (384) Second line of text in the sign.
Line 3 String (384) Third line of text in the sign.
Line 4 String (384) Fourth line of text in the sign.

Swing Arm

Sent when the player's arm swings.

Packet ID State Bound To Field Name Field Type Notes
0x33 Play Server Hand VarInt Enum Hand used for the animation. 0: main hand, 1: off hand.

Teleport To Entity

Teleports the player to the given entity. The player must be in spectator mode.

The Notchian client only uses this to teleport to players, but it appears to accept any type of entity. The entity does not need to be in the same dimension as the player; if necessary, the player will be respawned in the right world. If the given entity cannot be found (or isn't loaded), this packet will be ignored. It will also be ignored if the player attempts to teleport to themselves.

Packet ID State Bound To Field Name Field Type Notes
0x34 Play Server Target Player UUID UUID of the player to teleport to (can also be an entity UUID).

Use Item On

Packet ID State Bound To Field Name Field Type Notes
0x35 Play Server Hand VarInt Enum The hand from which the block is placed; 0: main hand, 1: off hand.
Location Position Block position.
Face VarInt Enum The face on which the block is placed (as documented at Player Action).
Cursor Position X Float The position of the crosshair on the block, from 0 to 1 increasing from west to east.
Cursor Position Y Float The position of the crosshair on the block, from 0 to 1 increasing from bottom to top.
Cursor Position Z Float The position of the crosshair on the block, from 0 to 1 increasing from north to south.
Inside block Boolean True when the player's head is inside of a block.
Sequence VarInt Block change sequence number (see #Acknowledge Block Change).

Upon placing a block, this packet is sent once.

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

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

Use Item

Sent when pressing the Use Item key (default: right click) with an item in hand.

Packet ID State Bound To Field Name Field Type Notes
0x36 Play Server Hand VarInt Enum Hand used for the animation. 0: main hand, 1: off hand.
Sequence VarInt Block change sequence number (see #Acknowledge Block Change).