Difference between revisions of "Protocol"

From wiki.vg
Jump to navigation Jump to search
m (Removing the (<packet>, <id>, <state>) things because they are never up to date)
m (https)
(249 intermediate revisions by 70 users not shown)
Line 5: Line 5:
 
   |ICON =  
 
   |ICON =  
 
   |HEADING = Heads up!
 
   |HEADING = Heads up!
   |CONTENT = This article is about the protocol for the latest '''stable''' release of Minecraft '''computer edition''' ([[Protocol version numbers|1.12, protocol 335]]). 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.17, protocol 755]]). 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… you still need to provide attribution to #mcdevs if you copy any of the contents of this page for publication elsewhere.
Line 47: Line 47:
 
  |-
 
  |-
 
  | Global palette
 
  | Global palette
  | 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/dictionary/palette mapping nonnegative integers to block states. Block state IDs are created in a linear fashion based off of order of assignment.  One block state ID allocated for each unique block state for a block; if a block has multiple properties then the number of allocated states is the product of the number of values for each property.  A current list of properties and state ID ranges is found on [https://pokechu22.github.io/Burger/1.16.5.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
Line 54: Line 56:
  
 
== Packet format ==
 
== Packet format ==
 +
 +
Packets cannot be larger than 2097151 bytes (the maximum that can be sent in a 3-byte VarInt).  For compressed packets, this applies to both the compressed length and uncompressed lengths.
  
 
=== Without compression ===
 
=== Without compression ===
Line 64: Line 68:
 
  | Length
 
  | Length
 
  | VarInt
 
  | VarInt
  | Length of packet data + length of the packet ID
+
  | Length of Packet ID + Data
 
  |-
 
  |-
 
  | Packet ID
 
  | Packet ID
Line 77: Line 81:
 
=== 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 97: Line 101:
 
  |rowspan="2"| Yes
 
  |rowspan="2"| Yes
 
  | Packet ID
 
  | Packet ID
  | Varint
+
  | VarInt
 
  | zlib compressed packet ID (see the sections below)
 
  | zlib compressed packet ID (see the sections below)
 
  |-
 
  |-
Line 109: Line 113:
 
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
 
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
  
If compressed, the uncompressed length of (Packet ID + Data) must be equal to or over the threshold set in the packet [[#Set Compression 2|Set Compression]], otherwise the receiving party will disconnect.
+
If compressed, the uncompressed length of (Packet ID + Data) must be equal to or over the threshold set in the packet [[#Set Compression|Set Compression]], otherwise the receiving party will disconnect.
  
 
Compression can be disabled by sending the packet [[#Set Compression|Set Compression]] with a negative Threshold, or not sending the Set Compression packet at all.
 
Compression can be disabled by sending the packet [[#Set Compression|Set Compression]] with a negative Threshold, or not sending the Set Compression packet at all.
Line 138: Line 142:
 
  | Protocol Version
 
  | Protocol Version
 
  | VarInt
 
  | VarInt
  | See [[protocol version numbers]] (currently 335 in Minecraft 1.12)
+
  | See [[protocol version numbers]] (currently 755 in Minecraft 1.17).
 
  |-
 
  |-
 
  | Server Address
 
  | Server Address
 
  | String (255)
 
  | String (255)
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information.
+
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a 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
 
  | 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
 
  | VarInt Enum
  | 1 for [[#Status|status]], 2 for [[#Login|login]]
+
  | 1 for [[#Status|status]], 2 for [[#Login|login]].
 
  |}
 
  |}
  
Line 172: Line 176:
 
  | Payload
 
  | Payload
 
  | Unsigned Byte
 
  | 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 ====
+
==== Response ====
 
 
Sent by the server when a vehicle or other object is created.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 193: Line 196:
 
  ! 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
+
  | String (32767)
  |  
+
  | See [[Server List Ping#Response]]; as with all strings this is prefixed by its length as a VarInt.
 +
|}
 +
 
 +
==== Pong ====
 +
 
 +
{| 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
+
  | Long
  | Double
+
  | Should be the same as sent by the client.
  |  
+
  |}
  |-
+
 
  | Y
+
=== Serverbound ===
  | Double
+
 
  |
+
==== Request ====
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | Z
+
  | 0x00
  | Double
+
  | Status
  |  
+
  | Server
  |-
+
  |colspan="3"| ''no fields''
| Pitch
 
| Angle
 
|
 
|-
 
| Yaw
 
| Angle
 
|
 
|-
 
| Data
 
| Int
 
| Meaning dependent on the value of the Type field, see [[Object Data]] for details.
 
|-
 
| Velocity X
 
| Short
 
|rowspan="3"| Same units as [[#Entity Velocity|Entity Velocity]].  Always sent, but only used when Data is greater than 0 (except for some entities which always ignore it; see [[Object Data]] for details).
 
|-
 
| Velocity Y
 
| Short
 
|-
 
| Velocity Z
 
| Short
 
 
  |}
 
  |}
  
==== Spawn Experience Orb ====
+
==== Ping ====
 
 
Spawns one or more experience orbs.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 255: Line 251:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x01
+
  | 0x01
  |rowspan="5"| Play
+
  | Status
|rowspan="5"| Client
+
  | Server
| Entity ID
+
  | Payload
| VarInt
+
  | Long
|
+
  | May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.
|-
 
| X
 
| Double
 
|
 
  |-
 
  | Y
 
| Double
 
  |  
 
  |-
 
| Z
 
| Double
 
|
 
|-
 
| Count
 
| Short
 
| The amount of experience this orb will reward once collected
 
 
  |}
 
  |}
  
==== Spawn Global Entity ====
+
== Login ==
 +
 
 +
The login process is as follows:
 +
 
 +
# C→S: [[#Handshake|Handshake]] with Next State set to 2 (login)
 +
# C→S: [[#Login Start|Login Start]]
 +
# S→C: [[#Encryption Request|Encryption Request]]
 +
# Client auth
 +
# C→S: [[#Encryption Response|Encryption Response]]
 +
# Server auth, both enable encryption
 +
# S→C: [[#Set Compression|Set Compression]] (optional)
 +
# S→C: [[#Login Success|Login Success]]
 +
 
 +
Set Compression, if present, must be sent before Login Success. Note that anything sent after Set Compression must use the [[#With_compression|Post Compression packet format]].
 +
 
 +
For unauthenticated ("cracked"/offline-mode) 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]]. 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 ===
  
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.
+
==== Disconnect (login) ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 291: Line 290:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x02
+
  | 0x00
  |rowspan="5"| Play
+
  | Login
  |rowspan="5"| Client
+
  | Client
  | Entity ID
+
  | Reason
| VarInt
+
  | [[Chat]]
| The EID of the thunderbolt
 
|-
 
| Type
 
| Byte Enum
 
| The global entity type, currently always 1 for thunderbolt
 
|-
 
| X
 
| Double
 
|
 
|-
 
| Y
 
| Double
 
|
 
|-
 
| Z
 
  | Double
 
 
  |  
 
  |  
 
  |}
 
  |}
  
==== Spawn Mob ====
+
==== Encryption Request ====
 
 
Sent by the server when a mob entity is spawned.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 327: Line 308:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="13"| 0x03
+
  |rowspan="5"| 0x01
  |rowspan="13"| Play
+
  |rowspan="5"| Login
  |rowspan="13"| Client
+
  |rowspan="5"| Client
  | Entity ID
+
  | Server ID
 +
| String (20)
 +
| Appears to be empty.
 +
|-
 +
| Public Key Length
 
  | VarInt
 
  | VarInt
  |  
+
  | Length of Public Key
 
  |-
 
  |-
  | Entity UUID
+
  | Public Key
  | UUID
+
  | Byte Array
  |  
+
  | The server's public key in bytes
 
  |-
 
  |-
  | Type
+
  | Verify Token Length
 
  | VarInt
 
  | VarInt
  | The type of mob. See [[Entities#Mobs]]
+
  | Length of Verify Token. Always 4 for Notchian servers.
 
  |-
 
  |-
  | X
+
  | Verify Token
  | Double
+
  | Byte Array
  |  
+
  | A sequence of random bytes generated by the server.
  |-
+
  |}
| Y
+
 
| Double
+
See [[Protocol Encryption]] for details.
|
+
 
|-
+
==== Login Success ====
| Z
 
| Double
 
|
 
|-
 
| Yaw
 
| Angle
 
|
 
|-
 
| Pitch
 
| Angle
 
|
 
|-
 
| Head Pitch
 
| Angle
 
|
 
|-
 
| Velocity X
 
| Short
 
| Same units as [[#Entity Velocity|Entity Velocity]]
 
|-
 
| Velocity Y
 
| Short
 
| Same units as [[#Entity Velocity|Entity Velocity]]
 
|-
 
| Velocity Z
 
| Short
 
| Same units as [[#Entity Velocity|Entity Velocity]]
 
|-
 
| Metadata
 
| [[Entities#Entity Metadata Format|Entity Metadata]]
 
|
 
|}
 
 
 
==== Spawn Painting ====
 
 
 
This packet shows location, name, and type of painting.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 395: Line 344:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x04
+
  |rowspan="2"| 0x02
  |rowspan="5"| Play
+
  |rowspan="2"| Login
  |rowspan="5"| Client
+
  |rowspan="2"| Client
  | Entity ID
+
  | UUID
| VarInt
 
|
 
|-
 
| Entity UUID
 
 
  | UUID
 
  | UUID
 
  |  
 
  |  
 
  |-
 
  |-
  | Title
+
  | Username
  | String (13)
+
  | String (16)
  | Name of the painting. Max length 13
+
  |  
 +
|}
 +
 
 +
This packet switches the connection state to [[#Play|play]].
 +
 
 +
{{Warning2|The (notchian) server might take a bit to fully transition to the Play state, so it's recommended to wait before sending Play packets, either by setting a timeout, or waiting for Play packets from the server (usually [[#Player Info|Player Info]]).
 +
 
 +
The notchian client doesn't send any (non-[[#Keep Alive|keep alive]]) packets until the next tick/[[#Time Update|time update]] packet.
 +
}}
 +
 
 +
==== Set Compression ====
 +
 
 +
Enables compression.  If compression is enabled, all following packets are encoded in the [[#With compression|compressed packet format]].  Negative or zero 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
 
  |-
 
  |-
  | Location
+
  | 0x03
  | Position
+
  | Login
  | Center coordinates (see below)
+
  | Client
  |-
+
  | Threshold
  | Direction
+
  | VarInt
  | Byte Enum
+
  | Maximum size of a packet before it is compressed.
| Direction the painting faces (North = 2, South = 0, West = 1, East = 3)
 
 
  |}
 
  |}
  
Calculating the center of an image: given a (width × height) grid of cells, with <code>(0, 0)</code> being the top left corner, the center is <code>(max(0, width / 2 - 1), height / 2)</code>. E.g. <code>(1, 0)</code> for a 2×1 painting, or <code>(1, 2)</code> for a 4×4 painting.
+
==== Login Plugin Request ====
 +
 
 +
Used to implement a custom handshaking flow together with [[#Login_Plugin_Response | Login Plugin Response]].
  
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):
+
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
+
  | VarInt
 +
  | Generated by the server - should be unique to the connection.
 
  |-
 
  |-
  | <code>Aztec</code>
+
  | Channel
  | 16
+
  | Identifier
  | 0
+
  | Name of the [[plugin channel]] used to send the data.
| 16
 
| 16
 
 
  |-
 
  |-
  | <code>Alban</code>
+
  | Data
  | 32
+
  | Byte Array
  | 0
+
  | Any data, depending on the channel. The length of this array must be inferred from the packet length.
  | 16
+
  |}
  | 16
+
 
 +
=== Serverbound ===
 +
 
 +
==== Login Start ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>Aztec2</code>
+
  | 0x00
  | 48
+
  | Login
  | 0
+
  | Server
  | 16
+
  | Name
  | 16
+
| String (16)
 +
| Player's Username.
 +
  |}
 +
 
 +
==== Encryption Response ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>Bomb</code>
+
  |rowspan="4"| 0x01
  | 64
+
|rowspan="4"| Login
  | 0
+
  |rowspan="4"| Server
  | 16
+
  | Shared Secret Length
  | 16
+
  | VarInt
 +
  | Length of Shared Secret.
 
  |-
 
  |-
  | <code>Plant</code>
+
  | Shared Secret
  | 80
+
  | Byte Array
  | 0
+
  | Shared Secret value, encrypted with the server's public key.
| 16
 
| 16
 
 
  |-
 
  |-
  | <code>Wasteland</code>
+
  | Verify Token Length
  | 96
+
  | VarInt
  | 0
+
  | Length of Verify Token.
| 16
 
| 16
 
 
  |-
 
  |-
  | <code>Pool</code>
+
  | Verify Token
  | 0
+
  | 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>Courbet</code>
+
  |rowspan="3"| 0x02
  | 32
+
|rowspan="3"| Login
  | 32
+
  |rowspan="3"| Server
  | 32
+
  | Message ID
  | 16
+
  | VarInt
 +
  | Should match ID from server.
 
  |-
 
  |-
  | <code>Sea</code>
+
  | Successful
| 64
+
| Boolean
| 32
+
| <code>true</code> if the client understands the request, <code>false</code> otherwise. When <code>false</code>, no payload follows.
| 32
 
| 16
 
 
  |-
 
  |-
  | <code>Sunset</code>
+
  | Data
  | 96
+
  | Optional Byte Array
  | 32
+
  | Any data, depending on the channel. The length of this array must be inferred from the packet length.
  | 32
+
  |}
  | 16
+
 
 +
== Play ==
 +
 
 +
=== Clientbound ===
 +
 
 +
==== Spawn Entity ====
 +
 
 +
Sent by the server when a vehicle or other non-living entity is created.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
  ! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | <code>Creebet</code>
+
  |rowspan="12"| 0x00
  | 128
+
|rowspan="12"| Play
  | 32
+
  |rowspan="12"| Client
  | 32
+
  | Entity ID
  | 16
+
  | VarInt
 +
  | EID of the entity.
 
  |-
 
  |-
  | <code>Wanderer</code>
+
  | Object UUID
  | 0
+
  | UUID
  | 64
+
  |  
| 16
 
| 32
 
 
  |-
 
  |-
  | <code>Graham</code>
+
  | Type
  | 16
+
  | VarInt
  | 64
+
  | The type of entity (same as in [[#Spawn Living Entity|Spawn Living Entity]]).
| 16
 
| 32
 
 
  |-
 
  |-
  | <code>Match</code>
+
  | X
  | 0
+
  | Double
  | 128
+
  |  
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>Bust</code>
+
  | Y
  | 32
+
  | Double
  | 128
+
  |  
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>Stage</code>
+
  | Z
  | 64
+
  | Double
  | 128
+
  |  
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>Void</code>
+
  | Pitch
  | 96
+
  | Angle
  | 128
+
  |  
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>SkullAndRoses</code>
+
  | Yaw
  | 128
+
  | Angle
  | 128
+
  |  
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>Wither</code>
+
  | Data
  | 160
+
  | Int
  | 128
+
  | Meaning dependent on the value of the Type field, see [[Object Data]] for details.
| 32
 
| 32
 
 
  |-
 
  |-
  | <code>Fighters</code>
+
  | Velocity X
  | 0
+
  | Short
  | 96
+
  |rowspan="3"| Same units as [[#Entity Velocity|Entity Velocity]]. Always sent, but only used when Data is greater than 0 (except for some entities which always ignore it; see [[Object Data]] for details).
| 64
 
  | 32
 
 
  |-
 
  |-
  | <code>Pointer</code>
+
  | Velocity Y
  | 0
+
  | Short
| 192
 
| 64
 
| 64
 
 
  |-
 
  |-
  | <code>Pigscene</code>
+
  | Velocity Z
  | 64
+
  | Short
| 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 Experience Orb ====
  
==== Spawn Player ====
+
Spawns one or more experience orbs.
 
 
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 569:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x05
+
  |rowspan="5"| 0x01
  |rowspan="8"| Play
+
  |rowspan="5"| Play
  |rowspan="8"| Client
+
  |rowspan="5"| Client
 
  | Entity ID
 
  | Entity ID
 
  | VarInt
 
  | VarInt
  | Player's EID
+
  |  
|-
 
| Player UUID
 
| UUID
 
| See below for notes on {{Minecraft Wiki|Server.properties#online-mode|offline mode}} and NPCs
 
 
  |-
 
  |-
 
  | X
 
  | X
Line 628: Line 588:
 
  |  
 
  |  
 
  |-
 
  |-
  | Yaw
+
  | Count
  | Angle
+
  | Short
  |  
+
  | The amount of experience this orb will reward once collected.
  |-
+
  |}
| Pitch
+
 
| Angle
+
==== Spawn Living Entity ====
|
+
 
|-
+
Sent by the server when a living entity is spawned.
| 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.
 
 
 
In offline mode, [[Wikipedia:Universally unique identifier#Versions 3 and 5 (namespace name-based)|UUID v3]] is used with the String <code>OfflinePlayer:&lt;player name&gt;</code>, encoded in UTF-8 (and case-sensitive).
 
 
 
For NPCs UUID v2 should be used. Note:
 
 
 
<+Grum> i will never confirm this as a feature you know that :)
 
 
 
In an example UUID, <code>xxxxxxxx-xxxx-Yxxx-xxxx-xxxxxxxxxxxx</code>, the UUID version is specified by <code>Y</code>. So, for UUID v3, <code>Y</code> will always be <code>3</code>, and for UUID v2, <code>Y</code> will always be <code>2</code>.
 
 
 
==== Animation (clientbound) ====
 
 
 
Sent whenever an entity should change animation.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 663: Line 605:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x06
+
  |rowspan="12"| 0x02
  |rowspan="2"| Play
+
  |rowspan="12"| Play
  |rowspan="2"| Client
+
  |rowspan="12"| Client
 
  | Entity ID
 
  | Entity ID
 
  | VarInt
 
  | VarInt
  | Player ID
+
  |  
 
  |-
 
  |-
  | Animation
+
  | Entity UUID
  | Unsigned Byte
+
  | UUID
  | Animation ID (see below)
+
  |  
|}
 
 
 
Animation can be one of the following values:
 
 
 
{| class="wikitable"
 
! ID
 
! Animation
 
 
  |-
 
  |-
  | 0
+
  | Type
  | Swing main arm
+
  | VarInt
 +
| The type of mob. See [[Entities#Mobs]].
 
  |-
 
  |-
  | 1
+
  | X
  | Take damage
+
| Double
 +
  |  
 
  |-
 
  |-
  | 2
+
  | Y
  | Leave bed
+
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|
 +
|-
 +
| Yaw
 +
| Angle
 +
|
 +
|-
 +
| Pitch
 +
| Angle
 +
|
 +
|-
 +
| Head Pitch
 +
| Angle
 +
  |  
 
  |-
 
  |-
  | 3
+
  | Velocity X
  | Swing offhand
+
  | Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]].
 
  |-
 
  |-
  | 4
+
  | Velocity Y
  | Critical effect
+
  | Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]].
 
  |-
 
  |-
  | 5
+
  | Velocity Z
  | Magic critical effect
+
  | Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]].
 
  |}
 
  |}
  
==== Statistics ====
+
==== Spawn Painting ====
  
Sent as a response to [[#Client_Status|Client Status 0x04]] (id 1).
+
This packet shows location, name, and type of painting.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
  ! Bound To  
+
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x07
+
  |rowspan="5"| 0x03
  |rowspan="3"| Play
+
  |rowspan="5"| Play
  |rowspan="3"| Client
+
  |rowspan="5"| Client
  |colspan="2"| Count
+
  | Entity ID
  |colspan="2"| VarInt
+
  | VarInt
  | Number of elements in the following array
+
  |  
 
  |-
 
  |-
  |rowspan="2"| Statistic
+
  | Entity UUID
| Name
+
  | UUID
|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 ====
 
 
 
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"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x08
+
  | Motive
|rowspan="3"| Play
 
|rowspan="3"| Client
 
| Entity ID
 
 
  | VarInt
 
  | VarInt
  | Entity ID of the entity breaking the block
+
  | Painting's ID, see below.
 
  |-
 
  |-
 
  | Location
 
  | Location
 
  | Position
 
  | Position
  | Block Position
+
  | Center coordinates (see below).
 
  |-
 
  |-
  | Destroy Stage
+
  | Direction
  | Byte
+
  | Byte Enum
  | 0–9 to set it, any other value to remove it
+
  | Direction the painting faces (North = 2, South = 0, West = 1, East = 3).
 
  |}
 
  |}
  
==== Update Block Entity ====
+
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.
  
Sets tile entity associated with the block at the given location.
+
List of paintings by coordinates in <code>paintings_kristoffer_zetterstrand.png</code> (where x and y are in pixels from the top left and width and height are in pixels or 16ths of a block):
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Name
  ! State
+
! ID
  ! Bound To
+
  ! x
  ! Field Name
+
  ! y
  ! Field Type
+
  ! width
  ! Notes
+
  ! height
 +
|-
 +
| <code>minecraft:kebab</code>
 +
| 0
 +
| 0
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:aztec</code>
 +
| 1
 +
| 16
 +
| 0
 +
| 16
 +
  | 16
 
  |-
 
  |-
  |rowspan="3"| 0x09
+
  | <code>minecraft:alban</code>
  |rowspan="3"| Play
+
  | 2
  |rowspan="3"| Client
+
  | 32
  | Location
+
  | 0
  | Position
+
  | 16
  |  
+
  | 16
 
  |-
 
  |-
  | Action
+
  | <code>minecraft:aztec2</code>
  | Unsigned Byte
+
  | 3
  | The type of update to perform, see below
+
  | 48
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | NBT Data
+
  | <code>minecraft:bomb</code>
  | [[NBT|NBT Tag]]
+
  | 4
  | 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)
+
| 64
  |}
+
  | 0
 
+
  | 16
''Action'' field:
+
| 16
 
 
* '''1''': Set data of a mob spawner (everything except for SpawnPotentials: current delay, min/max delay, mob to be spawned, spawn count, spawn range, etc.)
 
* '''2''': Set command block text (command and last execution status)
 
* '''3''': Set the level, primary, and secondary powers of a beacon
 
* '''4''': Set rotation and skin of mob head
 
* '''5''': 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"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x0A
+
  | <code>minecraft:plant</code>
  |rowspan="4"| Play
+
  | 5
  |rowspan="4"| Client
+
  | 80
  | Location
+
  | 0
  | Position
+
  | 16
  | Block coordinates
+
  | 16
 
  |-
 
  |-
  | Action ID (Byte 1)
+
  | <code>minecraft:wasteland</code>
  | Unsigned Byte
+
  | 6
  | Varies depending on block — see [[Block Actions]]
+
  | 96
 +
| 0
 +
| 16
 +
| 16
 
  |-
 
  |-
  | Action Param (Byte 2)
+
  | <code>minecraft:pool</code>
  | Unsigned Byte
+
  | 7
  | Varies depending on block — see [[Block Actions]]
+
  | 0
 +
| 32
 +
| 32
 +
| 16
 
  |-
 
  |-
  | Block Type
+
  | <code>minecraft:courbet</code>
  | VarInt
+
  | 8
  | The block type ID for the block, not including metadata/damage value.  This must match the block at the given coordinates.
+
  | 32
  |}
+
  | 32
 
+
  | 32
==== Block Change ====
+
  | 16
 
 
Fired whenever a block is changed within the render distance.
 
 
 
{{Warning2|Changing a block in a chunk that is not loaded is not a stable action.  The Notchian client currently uses a ''shared'' empty chunk which is modified for all block changes in unloaded chunks; while in 1.9 this chunk never renders in older versions the changed block will appear in all copies of the empty chunk. Servers should avoid sending block changes in unloaded chunks and clients should ignore such packets.}}
 
 
 
{| class="wikitable"
 
  ! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x0B
+
  | <code>minecraft:sea</code>
  |rowspan="2"| Play
+
  | 9
  |rowspan="2"| Client
+
  | 64
  | Location
+
  | 32
  | Position
+
  | 32
  | Block Coordinates
+
  | 16
 
  |-
 
  |-
  | Block ID
+
  | <code>minecraft:sunset</code>
| VarInt
+
  | 10
| 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>)
+
| 96
  |}
+
  | 32
 
+
  | 32
==== Boss Bar ====
+
  | 16
 
 
{| class="wikitable"
 
  ! Packet ID
 
  ! State
 
! Bound To
 
  !colspan="2"| Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="15"| 0x0C
+
  | <code>minecraft:creebet</code>
  |rowspan="15"| Play
+
  | 11
  |rowspan="15"| Client
+
  | 128
  |colspan="2"| UUID
+
  | 32
  | UUID
+
  | 32
  | Unique ID for this bar
+
  | 16
 
  |-
 
  |-
  |colspan="2"| Action
+
  | <code>minecraft:wanderer</code>
  | VarInt Enum
+
| 12
  | Determines the layout of the remaining packet
+
| 0
 +
| 64
 +
  | 16
 +
  | 32
 
  |-
 
  |-
  ! Action
+
  | <code>minecraft:graham</code>
  ! Field Name
+
  | 13
  !
+
  | 16
  !
+
  | 64
 +
| 16
 +
| 32
 
  |-
 
  |-
  |rowspan="5"| 0: add
+
  | <code>minecraft:match</code>
  | Title
+
| 14
  | [[Chat]]
+
| 0
  |  
+
  | 128
 +
  | 32
 +
  | 32
 
  |-
 
  |-
  | Health
+
  | <code>minecraft:bust</code>
  | Float
+
| 15
  | 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.
+
| 32
 +
  | 128
 +
  | 32
 +
| 32
 
  |-
 
  |-
  | Color
+
  | <code>minecraft:stage</code>
  | VarInt Enum
+
  | 16
  | Color ID (see below)
+
  | 64
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | Division
+
  | <code>minecraft:void</code>
  | VarInt Enum
+
  | 17
  | Type of division (see below)
+
  | 96
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | Flags
+
  | <code>skull_and_roses</code>
  | Unsigned Byte
+
  | 18
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music)
+
  | 128
 +
| 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | 1: remove
+
  | <code>minecraft:wither</code>
  | ''no fields''
+
  | 19
  | ''no fields''
+
  | 160
  | Removes this boss bar
+
  | 128
 +
| 32
 +
| 32
 
  |-
 
  |-
  | 2: update health
+
  | <code>minecraft:fighters</code>
  | Health
+
  | 20
  | Float
+
  | 0
  | as above
+
  | 96
 +
| 64
 +
| 32
 
  |-
 
  |-
  | 3: update title
+
  | <code>minecraft:pointer</code>
  | Title
+
  | 21
  | [[Chat]]
+
  | 0
  |  
+
  | 192
 +
| 64
 +
| 64
 
  |-
 
  |-
  |rowspan="2"| 4: update style
+
  | <code>minecraft:pigscene</code>
  | Color
+
| 22
  | VarInt Enum
+
| 64
  | Color ID (see below)
+
  | 192
 +
  | 64
 +
  | 64
 
  |-
 
  |-
  | Dividers
+
  | <code>minecraft:burning_skull</code>
  | VarInt Enum
+
  | 23
  | as above
+
  | 128
 +
| 192
 +
| 64
 +
| 64
 
  |-
 
  |-
  | 5: update flags
+
  | <code>minecraft:skeleton</code>
  | Flags
+
  | 24
  | Unsigned Byte
+
  | 192
  | as above
+
  | 64
 +
| 64
 +
| 48
 
  |-
 
  |-
 +
| <code>minecraft:donkey_kong</code>
 +
| 25
 +
| 192
 +
| 112
 +
| 64
 +
| 48
 
  |}
 
  |}
 +
 +
The {{Minecraft Wiki|Painting#Canvases|Minecraft Wiki article on paintings}} also provides a list of painting names to the actual images.
 +
 +
==== Spawn Player ====
 +
 +
This packet is sent by the server when a player comes into visible range, ''not'' when a player joins.
 +
 +
This packet must be sent after the [[#Player Info|Player Info]] packet that adds the player data for the client to use when spawning a player. If the Player Info for the player spawned by this packet is not present when this packet arrives, Notchian clients will not spawn the player entity. The Player Info packet includes skin/cape data.
 +
 +
Servers can, however, safely spawn player entities for players not in visible range. The client appears to handle it correctly.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Color
+
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  |rowspan="7"| 0x04
  | Pink
+
|rowspan="7"| Play
 +
|rowspan="7"| Client
 +
| Entity ID
 +
| VarInt
 +
  | Player's EID.
 
  |-
 
  |-
  | 1
+
  | Player UUID
  | Blue
+
  | UUID
 +
| See below for notes on {{Minecraft Wiki|Server.properties#online-mode|offline mode}} and NPCs.
 
  |-
 
  |-
  | 2
+
  | X
  | Red
+
| Double
 +
  |  
 
  |-
 
  |-
  | 3
+
  | Y
  | Green
+
| Double
 +
  |  
 
  |-
 
  |-
  | 4
+
  | Z
  | Yellow
+
| Double
 +
  |  
 
  |-
 
  |-
  | 5
+
  | Yaw
  | Purple
+
| Angle
 +
  |  
 
  |-
 
  |-
  | 6
+
  | Pitch
  | White
+
| Angle
 +
  |  
 
  |}
 
  |}
  
{| class="wikitable"
+
When in {{Minecraft Wiki|Server.properties#online-mode|online mode}}, the UUIDs must be valid and have valid skin blobs.
! ID
+
 
! Type of division
+
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 Notchain 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].
|-
+
 
| 0
+
For NPCs UUID v2 should be used. Note:
| No division
+
 
|-
+
  <+Grum> i will never confirm this as a feature you know that :)
  | 1
 
| 6 notches
 
|-
 
| 2
 
| 10 notches
 
|-
 
| 3
 
| 12 notches
 
|-
 
| 4
 
| 20 notches
 
  |}
 
  
==== Server Difficulty ====
+
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>.
  
Changes the difficulty setting in the client's option menu
+
==== Sculk Vibration Signal ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,000: Line 958:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x0D
+
  |rowspan="4"| 0x05
  |rowspan="1"| Play
+
  |rowspan="4"| Play
  |rowspan="1"| Client
+
  |rowspan="4"| Client
  | Difficulty
+
  | Source Position
  | Unsigned Byte
+
  | Position
  | 0: peaceful, 1: easy, 2: normal, 3: hard
+
  | Source position for the vibration.
 +
|-
 +
| Destination Identifier
 +
| Identifier
 +
| Identifier of the destination codec type.
 +
|-
 +
| Destination
 +
| Varies
 +
| Vanilla default destinations are a block position encoded as a [https://wiki.vg/Protocol#Data_types Position] for "block" or an entity id encoded as a VarInt for "entity".
 +
|-
 +
| Arrival Ticks
 +
| VarInt
 +
| Ticks for the signal to arrive at the destination.
 
  |}
 
  |}
 +
This packet shows a permanent particle.
  
==== Tab-Complete (clientbound) ====
+
==== Entity Animation (clientbound) ====
  
The server responds with a list of auto-completions of the last word sent to it. In the case of regular chat, this is a player username. Command names and parameters are also supported. The client sorts these alphabetically before listing them.
+
Sent whenever an entity should change animation.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,020: Line 991:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0E
+
  |rowspan="2"| 0x06
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
 
  |rowspan="2"| Client
 
  |rowspan="2"| Client
  | Count
+
  | Entity ID
 
  | VarInt
 
  | VarInt
  | Number of elements in the following array
+
  | Player ID.
 
  |-
 
  |-
  | Matches
+
  | Animation
  | Array of String (32767)
+
  | Unsigned Byte
  | One eligible command, note that each command is sent separately instead of in a single string, hence the need for Count
+
  | Animation ID (see below).
 
  |}
 
  |}
  
==== Chat Message (clientbound) ====
+
Animation can be one of the following values:
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Animation
 +
|-
 +
| 0
 +
| Swing main arm
 +
|-
 +
| 1
 +
| Take damage
 +
|-
 +
| 2
 +
| Leave bed
 +
|-
 +
| 3
 +
| Swing offhand
 +
|-
 +
| 4
 +
| Critical effect
 +
|-
 +
| 5
 +
| Magic critical effect
 +
|}
  
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.
+
==== Statistics ====
  
{{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.}}
+
Sent as a response to [[#Client_Status|Client Status 0x04]] (id 1). Will only send the changed values if previously requested.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
  ! Bound To
+
  ! Bound To  
  ! Field Name
+
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0F
+
  |rowspan="4"| 0x07
  |rowspan="2"| Play
+
  |rowspan="4"| Play
  |rowspan="2"| Client
+
  |rowspan="4"| Client
  | JSON Data
+
|colspan="2"| Count
  | [[Chat]]
+
|colspan="2"| VarInt
  | Limited to 32767 bytes
+
| Number of elements in the following array.
 +
|-
 +
|rowspan="3"| Statistic
 +
| Category ID
 +
|rowspan="3"| Array
 +
| VarInt
 +
| See below.
 +
|-
 +
  | Statistic ID
 +
  | VarInt
 +
  | See below.
 
  |-
 
  |-
  | Position
+
  | Value
  | Byte
+
  | VarInt
  | 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
+
  | The amount to set it to.
 
  |}
 
  |}
  
==== Multi Block Change ====
+
Categories (these are namespaced, but with <code>:</code> replaced with <code>.</code>):
 
 
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
+
  ! Name
! State
+
  ! ID
! Bound To
+
  ! Registry
!colspan="2"| Field Name
 
  !colspan="2"| Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="6"| 0x10
+
  | <code>minecraft.mined</code>
|rowspan="6"| Play
+
  | 0
|rowspan="6"| Client
+
  | Blocks
  |colspan="2"| Chunk X
 
|colspan="2"| Int
 
  | Chunk X coordinate
 
 
  |-
 
  |-
  |colspan="2"| Chunk Z
+
  | <code>minecraft.crafted</code>
  |colspan="2"| Int
+
  | 1
  | Chunk Z coordinate
+
  | Items
 
  |-
 
  |-
  |colspan="2"| Record Count
+
  | <code>minecraft.used</code>
  |colspan="2"| VarInt
+
  | 2
  | Number of elements in the following array, i.e. the number of blocks affected
+
  | Items
 
  |-
 
  |-
  |rowspan="3"| Record
+
  | <code>minecraft.broken</code>
| Horizontal Position
+
| 3
|rowspan="3"| Array
+
| Items
| 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
+
  | <code>minecraft.picked_up</code>
  | Unsigned Byte
+
  | 4
  | Y coordinate of the block
+
  | Items
 
  |-
 
  |-
  | Block ID
+
  | <code>minecraft.dropped</code>
  | VarInt
+
  | 5
  | 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>)
+
  | Items
 +
|-
 +
| <code>minecraft.killed</code>
 +
| 6
 +
| Entities
 +
|-
 +
| <code>minecraft.killed_by</code>
 +
| 7
 +
| Entities
 +
|-
 +
| <code>minecraft.custom</code>
 +
| 8
 +
| Custom
 
  |}
 
  |}
  
To decode the position into a world position:
+
Blocks, Items, and Entities use block (not block state), item, and entity ids.
 
 
<syntaxhighlight lang="java">
 
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
 
worldY = vertPos;
 
worldZ = (horizPos & 15) + (chunkZ * 16);
 
</syntaxhighlight>
 
 
 
==== Confirm Transaction (clientbound) ====
 
  
A packet from the server indicating whether a request from the client was accepted, or whether there was a conflict (due to lag).  If the packet was not accepted, the client must respond with a [[#Confirm Transaction (serverbound)|serverbound confirm transaction]] packet.
+
Custom has the following (unit only matters for clients):
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Name
! State
+
  ! ID
! Bound To
+
  ! Unit
! Field Name
 
  ! Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x11
+
  | <code>minecraft.leave_game</code>
|rowspan="3"| Play
+
  | 0
|rowspan="3"| Client
+
  | None
| Window ID
 
  | Byte
 
  | The ID of the window that the action occurred in
 
 
  |-
 
  |-
  | Action Number
+
  | <code>minecraft.play_one_minute</code>
  | Short
+
  | 1
  | 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.
+
  | Time
 
  |-
 
  |-
  | Accepted
+
  | <code>minecraft.time_since_death</code>
| Boolean
+
  | 2
  | Whether the action was accepted
+
  | Time
  |}
 
 
 
==== Close Window (clientbound) ====
 
 
 
This packet is sent from the server to the client when a window is forcibly closed, such as when a chest is destroyed while it's open.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  | 0x12
+
  | <code>minecraft.time_since_rest</code>
  | Play
+
  | 3
  | Client
+
  | Time
  | Window ID
+
  |-
  | Unsigned Byte
+
  | <code>minecraft.sneak_time</code>
  | This is the ID of the window that was closed. 0 for inventory.
+
  | 4
  |}
+
  | Time
 
 
==== Open Window ====
 
 
 
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| 0x13
+
  | <code>minecraft.walk_one_cm</code>
  |rowspan="5"| Play
+
  | 5
  |rowspan="5"| Client
+
  | Distance
| Window ID
 
| Unsigned Byte
 
| A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
 
 
  |-
 
  |-
  | Window Type
+
  | <code>minecraft.crouch_one_cm</code>
  | String (32)
+
  | 6
  | The window type to use for display. See [[Inventory]] for a list.
+
  | Distance
 
  |-
 
  |-
  | Window Title
+
  | <code>minecraft.sprint_one_cm</code>
  | [[Chat]]
+
  | 7
  | The title of the window
+
  | Distance
 
  |-
 
  |-
  | Number Of Slots
+
  | <code>minecraft.walk_on_water_one_cm</code>
  | Unsigned Byte
+
  | 8
  | Number of slots in the window (excluding the number of slots in the player inventory)
+
  | Distance
 
  |-
 
  |-
  | Entity ID
+
  | <code>minecraft.fall_one_cm</code>
  | Optional Int
+
  | 9
  | EntityHorse's EID. Only sent when Window Type is “EntityHorse”
+
  | Distance
|}
 
 
 
See [[Inventory]] for further information.
 
 
 
==== Window Items ====
 
[[File:Inventory-slots.png|thumb|The inventory slots]]
 
 
 
Sent by the server when items in multiple slots (in a window) are added/removed. This includes the main inventory, equipped armour and crafting slots.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x14
+
  | <code>minecraft.climb_one_cm</code>
|rowspan="3"| Play
+
  | 10
  |rowspan="3"| Client
+
  | Distance
  | Window ID
 
| Unsigned Byte
 
| The ID of window which items are being sent for. 0 for player inventory.
 
 
  |-
 
  |-
  | Count
+
  | <code>minecraft.fly_one_cm</code>
  | Short
+
  | 11
  | Number of elements in the following array
+
  | Distance
 
  |-
 
  |-
  | Slot Data
+
  | <code>minecraft.walk_under_water_one_cm</code>
| Array of [[Slot Data|Slot]]
+
  | 12
  |  
+
  | Distance
  |}
 
 
 
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 
 
 
==== Window Property ====
 
 
 
This packet is used to inform the client that part of a GUI window should be updated.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x15
+
  | <code>minecraft.minecart_one_cm</code>
|rowspan="3"| Play
+
  | 13
|rowspan="3"| Client
+
  | Distance
| Window ID
 
  | Unsigned Byte
 
  |  
 
 
  |-
 
  |-
  | Property
+
  | <code>minecraft.boat_one_cm</code>
  | Short
+
  | 14
  | The property to be updated, see below
+
  | Distance
 
  |-
 
  |-
  | Value
+
  | <code>minecraft.pig_one_cm</code>
| Short
+
  | 15
  | The new value for the property, see below
+
  | Distance
  |}
 
 
 
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"
 
 
  |-
 
  |-
  ! Window type
+
  | <code>minecraft.horse_one_cm</code>
  ! Property
+
  | 16
  ! Value
+
  | Distance
 
  |-
 
  |-
  |rowspan="4"| Furnace
+
  | <code>minecraft.aviate_one_cm</code>
  | 0: Fire icon (fuel left)
+
  | 17
  | counting from fuel burn time down to 0 (in-game ticks)
+
  | Distance
 
  |-
 
  |-
  | 1: Maximum fuel burn time
+
  | <code>minecraft.swim_one_cm</code>
  | fuel burn time or 0 (in-game ticks)
+
  | 18
 +
| Distance
 
  |-
 
  |-
  | 2: Progress arrow
+
  | <code>minecraft.strider_one_cm</code>
  | counting from 0 to maximum progress (in-game ticks)
+
  | 19
 +
| Distance
 
  |-
 
  |-
  | 3: Maximum progress
+
  | <code>minecraft.jump</code>
  | always 200 on the notchian server
+
  | 20
 +
| None
 
  |-
 
  |-
  |rowspan="10"| Enchantment Table
+
  | <code>minecraft.drop</code>
  | 0: Level requirement for top enchantment slot
+
  | 21
  |rowspan="3"| The enchantment's xp level requirement
+
  | None
 
  |-
 
  |-
  | 1: Level requirement for middle enchantment slot
+
  | <code>minecraft.damage_dealt</code>
 +
| 22
 +
| Damage
 
  |-
 
  |-
  | 2: Level requirement for bottom enchantment slot
+
  | <code>minecraft.damage_dealt_absorbed</code>
 +
| 23
 +
| Damage
 
  |-
 
  |-
  | 3: The enchantment seed
+
  | <code>minecraft.damage_dealt_resisted</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>).
+
| 24
 +
| Damage
 
  |-
 
  |-
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
+
  | <code>minecraft.damage_taken</code>
  |rowspan="3"| The enchantment id (set to -1 to hide it)
+
  | 25
 +
| Damage
 
  |-
 
  |-
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
+
  | <code>minecraft.damage_blocked_by_shield</code>
 +
| 26
 +
| Damage
 
  |-
 
  |-
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
+
  | <code>minecraft.damage_absorbed</code>
 +
| 27
 +
| Damage
 
  |-
 
  |-
  | 7: Enchantment level shown on mouse hover over the top slot
+
  | <code>minecraft.damage_resisted</code>
  |rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
+
  | 28
 +
| Damage
 
  |-
 
  |-
  | 8: Enchantment level shown on mouse hover over the middle slot
+
  | <code>minecraft.deaths</code>
 +
| 29
 +
| None
 
  |-
 
  |-
  | 9: Enchantment level shown on mouse hover over the bottom slot
+
  | <code>minecraft.mob_kills</code>
 +
| 30
 +
| None
 
  |-
 
  |-
  |rowspan="3"| Beacon
+
  | <code>minecraft.animals_bred</code>
  | 0: Power level
+
  | 31
  | 0-4, controls what effect buttons are enabled
+
  | None
 
  |-
 
  |-
  | 1: First potion effect
+
  | <code>minecraft.player_kills</code>
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
+
  | 32
 +
| None
 
  |-
 
  |-
  | 2: Second potion effect
+
  | <code>minecraft.fish_caught</code>
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
+
  | 33
 +
| None
 
  |-
 
  |-
  | Anvil
+
  | <code>minecraft.talked_to_villager</code>
  | 0: Repair cost
+
  | 34
  | The repair's cost in xp levels
+
  | None
 
  |-
 
  |-
  | Brewing Stand
+
  | <code>minecraft.traded_with_villager</code>
  | 0: Brew time
+
  | 35
  | 0–400, with 400 making the arrow empty, and 0 making the arrow full
+
  | None
|}
 
 
 
==== Set 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
 
 
  |-
 
  |-
  |rowspan="3"| 0x16
+
  | <code>minecraft.eat_cake_slice</code>
|rowspan="3"| Play
+
  | 36
|rowspan="3"| Client
+
  | None
  | 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.fill_cauldron</code>
  | Short
+
  | 37
  | The slot that should be updated
+
  | None
 
  |-
 
  |-
  | Slot Data
+
  | <code>minecraft.use_cauldron</code>
| [[Slot Data|Slot]]
+
  | 38
  |  
+
  | None
  |}
 
 
 
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.clean_armor</code>
  |rowspan="2"| Play
+
| 39
  |rowspan="2"| Client
+
| None
  | Item ID
+
|-
  | VarInt
+
| <code>minecraft.clean_banner</code>
  | Numeric ID of the item to apply a cooldown to.
+
| 40
 +
| None
 +
|-
 +
| <code>minecraft.clean_shulker_box</code>
 +
  | 41
 +
| None
 +
|-
 +
  | <code>minecraft.interact_with_brewingstand</code>
 +
| 42
 +
  | None
 +
  |-
 +
  | <code>minecraft.interact_with_beacon</code>
 +
| 43
 +
| None
 
  |-
 
  |-
  | Cooldown Ticks
+
  | <code>minecraft.inspect_dropper</code>
| VarInt
+
| 44
| Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
+
  | None
|}
 
 
 
==== Plugin Message (clientbound) ====
 
 
 
{{Main|Plugin channels}}
 
 
 
Mods and plugins can use this to send their data. Minecraft itself uses a number of [[plugin channel]]s. These internal channels are prefixed with <code>MC|</code>.
 
 
 
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 
 
 
{| class="wikitable"
 
  ! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x18
+
  | <code>minecraft.inspect_hopper</code>
|rowspan="2"| Play
+
  | 45
|rowspan="2"| Client
+
  | None
| Channel
 
  | String (20)
 
  | Name of the [[plugin channel]] used to send the data
 
 
  |-
 
  |-
  | Data
+
  | <code>minecraft.inspect_dispenser</code>
  | Byte Array
+
| 46
  | 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
  |}
+
|-
 
+
| <code>minecraft.play_noteblock</code>
==== Named Sound Effect ====
+
| 47
{{See also|#Sound Effect}}
+
| None
 
+
|-
Used to play a sound effect on the client. Custom sounds may be added by resource packs.
+
| <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
 +
  |}
 +
 
 +
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 Player Digging ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,417: Line 1,429:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x19
+
  |rowspan="4"| 0x08
  |rowspan="7"| Play
+
  |rowspan="4"| Play
  |rowspan="7"| Client
+
  |rowspan="4"| Client
  | Sound Name
+
  | Location
  | String (256)
+
  | Position
  | All sound effect names as of 1.12.0 can be seen [http://pokechu22.github.io/Burger/1.12.html#sounds here].
+
  | Position where the digging was happening.
 
  |-
 
  |-
  | Sound Category
+
  | Block
  | VarInt Enum
+
  | VarInt
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
  | Block state ID of the block that should be at that position now.
 
  |-
 
  |-
  | Effect Position X
+
  | Status
  | Int
+
  | VarInt enum
  | Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | Same as Player Digging.  Only Started digging (0), Cancelled digging (1), and Finished digging (2) are used.
 
  |-
 
  |-
  | Effect Position Y
+
  | Successful
  | Int
+
  | Boolean
  | Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | True if the digging succeeded; false if the client should undo any changes it made locally.
|-
 
| Effect Position Z
 
| Int
 
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 
|-
 
| Volume
 
| Float
 
| 1 is 100%, can be more
 
|-
 
| Pitch
 
| Float
 
| Float between 0.5 and 2.0 by Notchian clients
 
 
  |}
 
  |}
  
==== Disconnect (play) ====
+
==== Block Break Animation ====
 +
 
 +
0–9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
 +
 
 +
Block break animations can still be applied on air; the animation will remain visible although there is no block being broken.  However, if this is applied to a transparent block, odd graphical effects may happen, including water losing its transparency.  (An effect similar to this can be seen in normal gameplay when breaking ice blocks)
  
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.
+
If you need to display several break animations at the same time you have to give each of them a unique Entity ID. The entity ID does not need to correspond to an actual entity on the client. It is valid to use a randomly generated number.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,461: Line 1,465:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x1A
+
  |rowspan="3"| 0x09
  | Play
+
  |rowspan="3"| Play
  | Client
+
  |rowspan="3"| Client
  | Reason
+
  | Entity ID
  | [[Chat]]
+
  | VarInt
  | Displayed to the client when the connection terminates.
+
  | Entity 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.
 
  |}
 
  |}
  
==== Entity Status ====
+
==== Block Entity Data ====
  
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).
+
Sets the block entity associated with the block at the given location.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,481: Line 1,493:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x1B
+
  |rowspan="3"| 0x0A
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | Entity ID
+
  | Location
  | Int
+
  | Position
 
  |  
 
  |  
 
  |-
 
  |-
  | Entity Status
+
  | Action
  | Byte Enum
+
  | Unsigned Byte
  | See below
+
  | The type of update to perform, see below.
 +
|-
 +
| NBT Data
 +
| [[NBT|NBT Tag]]
 +
| 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).
 
  |}
 
  |}
  
See [[entities]] for a list of which statuses are valid for each type of entity.
+
''Action'' field:
 +
 
 +
* '''1''': Set data of a mob spawner (everything except for SpawnPotentials: current delay, min/max delay, mob to be spawned, spawn count, spawn range, etc.)
 +
* '''2''': Set command block text (command and last execution status)
 +
* '''3''': Set the level, primary, and secondary powers of a beacon
 +
* '''4''': Set rotation and skin of mob head
 +
* '''5''': Declare a conduit
 +
* '''6''': Set base color and patterns on a banner
 +
* '''7''': Set the data for a Structure tile entity
 +
* '''8''': Set the destination for a end gateway
 +
* '''9''': Set the text on a sign
 +
* '''10''': Unused
 +
* '''11''': Declare a bed
 +
* '''12''': Set data of a jigsaw block
 +
* '''13''': Set items in a campfire
 +
* '''14''': Beehive information
 +
 
 +
==== Block Action ====
  
==== Explosion ====
+
This packet is used for a number of actions and animations performed by blocks, usually non-persistent.
  
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
+
See [[Block Actions]] for a list of values.
  
Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x
+
{{Warning2|This packet uses a block ID, not a block state.}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,509: Line 1,542:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="9"| 0x1C
+
  |rowspan="4"| 0x0B
  |rowspan="9"| Play
+
  |rowspan="4"| Play
  |rowspan="9"| Client
+
  |rowspan="4"| Client
  | X
+
  | Location
  | Float
+
  | Position
  |  
+
  | Block coordinates.
 
  |-
 
  |-
  | Y
+
  | Action ID (Byte 1)
  | Float
+
  | Unsigned Byte
  |  
+
  | Varies depending on block — see [[Block Actions]].
 
  |-
 
  |-
  | Z
+
  | Action Param (Byte 2)
  | Float
+
  | Unsigned Byte
  |  
+
  | Varies depending on block — see [[Block Actions]].
 
  |-
 
  |-
  | Radius
+
  | Block Type
  | Float
+
  | VarInt
  | Currently unused in the client
+
  | The block type ID for the block. This must match the block at the given coordinates.
  |-
 
| Record Count
 
| Int
 
| Number of elements in the following array
 
|-
 
| Records
 
| Array of (Byte, Byte, Byte)
 
| Each record is 3 signed bytes long, each bytes are the XYZ (respectively) 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
 
 
  |}
 
  |}
  
==== Unload Chunk ====
+
==== Block Change ====
 +
 
 +
Fired whenever a block is changed within the render distance.
  
Tells the client to unload a chunk column.
+
{{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,561: Line 1,576:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x1D
+
  |rowspan="2"| 0x0C
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
 
  |rowspan="2"| Client
 
  |rowspan="2"| Client
  | Chunk X
+
  | Location
  | Int
+
  | Position
  | Block coordinate divided by 16, rounded down
+
  | Block Coordinates.
 
  |-
 
  |-
  | Chunk Z
+
  | Block ID
  | Int
+
  | VarInt
  | Block coordinate divided by 16, rounded down
+
  | The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}}. See that section for more information.
 
  |}
 
  |}
  
It is legal to send this packet even if the given chunk is not currently loaded.
+
==== Boss Bar ====  
 
 
==== Change Game State ====
 
 
 
Used for a wide variety of game state things, from whether to bed use to gamemode to demo messages.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,583: Line 1,594:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x1E
+
  |rowspan="14"| 0x0D
  |rowspan="2"| Play
+
  |rowspan="14"| Play
  |rowspan="2"| Client
+
  |rowspan="14"| Client
  | Reason
+
  |colspan="2"| UUID
  | Unsigned Byte
+
  | UUID
  | See below
+
  | Unique ID for this bar.
 
  |-
 
  |-
  | Value
+
  |colspan="2"| Action
| Float
+
  | VarInt Enum
  | Depends on Reason
+
  | Determines the layout of the remaining packet.
  |}
 
 
 
''Reason codes'':
 
 
 
{| class="wikitable"
 
! Reason
 
! Effect
 
! Value
 
 
  |-
 
  |-
  | 0
+
  ! Action
  | Invalid Bed
+
  ! Field Name
  | Would be used to switch between messages, but the only used message is 0 for invalid bed
+
  !
 +
!
 
  |-
 
  |-
  | 1
+
  |rowspan="5"| 0: add
  | End raining
+
| Title
 +
  | [[Chat]]
 
  |  
 
  |  
 
  |-
 
  |-
  | 2
+
  | Health
  | Begin raining
+
  | 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.
 
  |-
 
  |-
  | 3
+
  | Color
  | Change gamemode
+
  | VarInt Enum
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
+
  | Color ID (see below).
 
  |-
 
  |-
  | 4
+
  | Division
  | Exit end
+
  | VarInt Enum
  | 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.
+
  | Type of division (see below).
 
  |-
 
  |-
  | 5
+
  | Flags
  | Demo message
+
  | Unsigned Byte
  | 0: Show welcome to demo screen, 101: Tell movement controls, 102: Tell jump control, 103: Tell inventory control
+
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music), 0x04: create fog (previously was also controlled by 0x02).
|-
 
| 6
 
| Arrow hitting player
 
| Appears to be played when an arrow strikes another player in Multiplayer
 
 
  |-
 
  |-
  | 7
+
  | 1: remove
  | Fade value
+
  | ''no fields''
  | The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
+
  | ''no fields''
 +
| Removes this boss bar.
 
  |-
 
  |-
  | 8
+
  | 2: update health
  | Fade time
+
  | Health
  | Time in ticks for the sky to fade
+
  | Float
 +
| ''as above''
 
  |-
 
  |-
  | 10
+
  | 3: update title
  | Play elder guardian mob appearance (effect and sound)
+
  | Title
 +
| [[Chat]]
 
  |  
 
  |  
|}
 
 
==== Keep Alive (clientbound) ====
 
 
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same packet. If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x1F
+
  |rowspan="2"| 4: update style
  |rowspan="1"| Play
+
  | Color
  |rowspan="1"| Client
+
| VarInt Enum
  | Keep Alive ID
+
  | Color ID (see below).
  | VarInt
+
|-
  |  
+
  | Dividers
 +
  | VarInt Enum
 +
| ''as above''
 +
|-
 +
| 5: update flags
 +
| Flags
 +
| Unsigned Byte
 +
| ''as above''
 +
  |-
 
  |}
 
  |}
 
==== Chunk Data ====
 
{{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).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Color
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="9"| 0x20
+
  | 0
|rowspan="9"| Play
+
  | Pink
|rowspan="9"| Client
 
| Chunk X
 
| Int
 
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
 
  |-
 
  |-
  | Chunk Z
+
  | 1
  | Int
+
  | Blue
| Chunk coordinate (block coordinate divided by 16, rounded down)
 
 
  |-
 
  |-
  | Ground-Up Continuous
+
  | 2
  | Boolean
+
  | Red
| See [[Chunk Format#Ground-up continuous|Chunk Format]]
 
 
  |-
 
  |-
  | Primary Bit Mask
+
  | 3
  | VarInt
+
  | Green
| Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
 
|-
 
| Size
 
| VarInt
 
| Size of Data in bytes
 
 
  |-
 
  |-
  | Data
+
  | 4
  | Byte array
+
  | Yellow
| See [[Chunk Format#Data structure|data structure]] in Chunk Format
 
 
  |-
 
  |-
  | Number of block entities
+
  | 5
  | VarInt
+
  | Purple
| Length of the following array
 
 
  |-
 
  |-
  | Block entities
+
  | 6
  | Array of [[NBT|NBT Tag]]
+
  | White
| All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 
 
  |}
 
  |}
 
==== Effect ====
 
 
Sent when a client is to play a sound or particle effect.
 
 
By default, the Minecraft client adjusts the volume of sound effects based on distance. The final boolean field is used to disable this, and instead the effect is played from 2 blocks away in the correct direction. Currently this is only used for effect 1023 (wither spawn) and effect 1028 (enderdragon death); it is ignored on other effects.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Type of division
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x21
+
  | 0
|rowspan="4"| Play
+
  | No division
  |rowspan="4"| Client
+
  |-
  | Effect ID
+
  | 1
  | Int
+
  | 6 notches
  | The ID of the effect, see below
 
 
  |-
 
  |-
  | Location
+
  | 2
  | Position
+
  | 10 notches
| The location of the effect
 
 
  |-
 
  |-
  | Data
+
  | 3
  | Int
+
  | 12 notches
| Extra data for certain effects, see below
 
 
  |-
 
  |-
  | Disable Relative Volume
+
  | 4
  | Boolean
+
  | 20 notches
| See above
 
 
  |}
 
  |}
  
Effect IDs:
+
==== Server Difficulty ====
 +
 
 +
Changes the difficulty setting in the client's option menu
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Name
+
  ! State
  ! Data
+
! Bound To
 +
! Field Name
 +
  ! Field Type
 +
! Notes
 
  |-
 
  |-
  !colspan="3"| Sound
+
  |rowspan="2"| 0x0E
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Difficulty
 +
| Unsigned Byte
 +
| 0: peaceful, 1: easy, 2: normal, 3: hard.
 
  |-
 
  |-
  | 1000
+
  | Difficulty locked?
  | Dispenser dispenses
+
  | Boolean
  |  
+
  |
  |-
+
  |}
  | 1001
+
 
  | Dispenser fails to dispense
+
==== Chat Message (clientbound) ====
  |
+
 
 +
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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | 1002
+
  |rowspan="3"| 0x0F
  | Dispenser shoots
+
|rowspan="3"| Play
  |  
+
|rowspan="3"| Client
 +
| JSON Data
 +
  | [[Chat]]
 +
  | Limited to 262144 bytes.
 
  |-
 
  |-
  | 1003
+
  | Position
  | Ender eye launched
+
  | Byte
  |  
+
  | 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
 
  |-
 
  |-
  | 1004
+
  | Sender
  | Firework shot
+
  | 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.
 +
|}
 +
 
 +
==== 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
 
  |-
 
  |-
  | 1005
+
  |rowspan="1"| 0x10
  | Iron door opened
+
  |rowspan="1"| Play
  |  
+
  |rowspan="1"| Client
|-
+
  | Reset
  | 1006
+
  | Boolean
  | Wooden door opened
 
 
  |  
 
  |  
 +
|}
 +
 +
==== Tab-Complete (clientbound) ====
 +
 +
The server responds with a list of auto-completions of the last word sent to it. In the case of regular chat, this is a player username. Command names and parameters are also supported. The client sorts these alphabetically before listing them.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | 1007
+
  |rowspan="8"| 0x11
  | Wooden trapdoor opened
+
  |rowspan="8"| Play
  |  
+
  |rowspan="8"| Client
 
  |-
 
  |-
  | 1008
+
  |colspan="2"| ID
  | Fence gate opened
+
  |colspan="2"| VarInt
  |  
+
  | Transaction ID.
 
  |-
 
  |-
  | 1009
+
  |colspan="2"| Start
  | Fire extinguished
+
  |colspan="2"| VarInt
  |  
+
  | Start of the text to replace.
 
  |-
 
  |-
  | 1010
+
  |colspan="2"| Length
  | Play record
+
  |colspan="2"| VarInt
  | Special case, see below for more info
+
  | Length of the text to replace.
 
  |-
 
  |-
  | 1011
+
  |colspan="2"| Count
  | Iron door closed
+
  |colspan="2"| VarInt
  |  
+
  | Number of elements in the following array.
 
  |-
 
  |-
  | 1012
+
  |rowspan="3"| Matches
  | Wooden door closed
+
  | Match
  |  
+
  |rowspan="3"| Array
 +
| String (32767)
 +
| One eligible value to insert, note that each command is sent separately instead of in a single string, hence the need for Count.  Note that for instance this doesn't include a leading <code>/</code> on commands.
 
  |-
 
  |-
  | 1013
+
  | Has tooltip
  | Wooden trapdoor closed
+
  | Boolean
  |  
+
  | True if the following is present.
 
  |-
 
  |-
  | 1014
+
  | Tooltip
  | Fence gate closed
+
  | Optional [[Chat]]
  |  
+
  | Tooltip to display; only present if previous boolean is true.
 +
|}
 +
 
 +
==== Declare Commands ====
 +
 
 +
Lists all of the commands on the server, and how they are parsed.
 +
 
 +
This is a directed graph, with one root node.  Each redirect or child node must refer only to nodes that have already been declared.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1015
+
  |rowspan="3"| 0x12
  | Ghast warns
+
|rowspan="3"| Play
  |  
+
|rowspan="3"| Client
 +
| Count
 +
  | VarInt
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  | 1016
+
  | Nodes
  | Ghast shoots
+
  | Array of [[Command Data|Node]]
  |  
+
  | An array of nodes.
 
  |-
 
  |-
  | 1017
+
  | Root index
  | Enderdragon shoots
+
  | VarInt
  |  
+
  | Index of the <code>root</code> node in the previous array.
 +
|}
 +
 
 +
For more information on this packet, see the [[Command Data]] article.
 +
 
 +
==== Close Window (clientbound) ====
 +
 
 +
This packet is sent from the server to the client when a window is forcibly closed, such as when a chest is destroyed while it's open. The notchian client disregards the provided window ID and closes any active window.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1018
+
  | 0x13
  | Blaze shoots
+
  | Play
  |  
+
  | Client
  |-
+
  | Window ID
  | 1019
+
  | Unsigned Byte
  | Zombie attacks wood door
+
  | This is the ID of the window that was closed. 0 for inventory.
  |  
+
  |}
 +
 
 +
==== Window Items ====
 +
[[File:Inventory-slots.png|thumb|The inventory slots]]
 +
 
 +
Sent by the server when items in multiple slots (in a window) are added/removed. This includes the main inventory, equipped armour and crafting slots. This packet with Window ID set to "0" is sent during the player joining sequence to initialise the player's inventory.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1020
+
  |rowspan="3"| 0x14
  | Zombie attacks iron door
+
|rowspan="3"| Play
  |  
+
|rowspan="3"| Client
 +
| Window ID
 +
  | Unsigned Byte
 +
  | The ID of window which items are being sent for. 0 for player inventory.
 
  |-
 
  |-
  | 1021
+
  | Count
  | Zombie breaks wood door
+
  | Short
  |
+
  | Number of elements in the following array.
 
  |-
 
  |-
  | 1022
+
  | Slot Data
  | Wither breaks block
+
  | Array of [[Slot Data|Slot]]
|
 
|-
 
| 1023
 
| Wither spawned
 
 
  |  
 
  |  
 +
|}
 +
 +
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 +
 +
==== Window Property ====
 +
 +
This packet is used to inform the client that part of a GUI window should be updated.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1024
+
  |rowspan="3"| 0x15
  | Wither shoots
+
  |rowspan="3"| Play
  |
+
  |rowspan="3"| Client
|-
+
  | Window ID
  | 1025
+
  | Unsigned Byte
  | Bat takes off
+
  |  
  |
 
 
  |-
 
  |-
  | 1026
+
  | Property
  | Zombie infects
+
  | Short
  |
+
  | The property to be updated, see below.
 
  |-
 
  |-
  | 1027
+
  | Value
  | Zombie villager converted
+
  | 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.
 +
 
 +
{| class="wikitable"
 
  |-
 
  |-
  | 1028
+
  ! Window type
  | Ender dragon death
+
  ! Property
  |
+
  ! Value
 
  |-
 
  |-
  | 1029
+
  |rowspan="4"| Furnace
  | Anvil destroyed
+
  | 0: Fire icon (fuel left)
  |  
+
  | counting from fuel burn time down to 0 (in-game ticks)
 
  |-
 
  |-
  | 1030
+
  | 1: Maximum fuel burn time
| Anvil used
+
  | fuel burn time or 0 (in-game ticks)
  |  
 
 
  |-
 
  |-
  | 1031
+
  | 2: Progress arrow
| Anvil landed
+
  | counting from 0 to maximum progress (in-game ticks)
  |
 
 
  |-
 
  |-
  | 1032
+
  | 3: Maximum progress
| Portal travel
+
  | always 200 on the notchian server
  |  
 
 
  |-
 
  |-
  | 1033
+
  |rowspan="10"| Enchantment Table
  | Chorus flower grown
+
  | 0: Level requirement for top enchantment slot
  |
+
  |rowspan="3"| The enchantment's xp level requirement
 
  |-
 
  |-
  | 1034
+
  | 1: Level requirement for middle enchantment slot
| Chorus flower died
 
|
 
 
  |-
 
  |-
  | 1035
+
  | 2: Level requirement for bottom enchantment slot
| Brewing stand brewed
 
|
 
 
  |-
 
  |-
  | 1036
+
  | 3: The enchantment seed
  | Iron trapdoor opened
+
  | 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>).
  |
 
 
  |-
 
  |-
  | 1037
+
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
  | Iron trapdoor closed
+
  |rowspan="3"| The enchantment id (set to -1 to hide it), see below for values
|
 
 
  |-
 
  |-
  !colspan="3"| Particle
+
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
 
  |-
 
  |-
  | 2000
+
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
| Spawns 10 smoke particles, e.g. from a fire
 
| Direction, see below
 
 
  |-
 
  |-
  | 2001
+
  | 7: Enchantment level shown on mouse hover over the top slot
  | Block break + block break sound
+
  |rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
| {{Minecraft Wiki|Data values|Block ID}}
 
 
  |-
 
  |-
  | 2002/2007
+
  | 8: Enchantment level shown on mouse hover over the middle slot
| Splash potion. Particle effect + glass break sound.
 
| [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
 
 
  |-
 
  |-
  | 2003
+
  | 9: Enchantment level shown on mouse hover over the bottom slot
  | Eye of Ender entity break animation — particles and sound
+
  |-
  |  
+
  |rowspan="3"| Beacon
 +
| 0: Power level
 +
| 0-4, controls what effect buttons are enabled
 +
|-
 +
| 1: First potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
 +
|-
 +
| 2: Second potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
 +
|-
 +
| Anvil
 +
| 0: Repair cost
 +
| The repair's cost in xp levels
 
  |-
 
  |-
  | 2004
+
  |rowspan="2"| Brewing Stand
  | Mob spawn particle effect: smoke + flames
+
  | 0: Brew time
  |  
+
  | 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
 
  |-
 
  |-
  | 2005
+
  | 1: Fuel time
  | Bonemeal particles
+
  | 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
| How many particles to spawn (if set to 0, 15 are spawned)
 
 
  |-
 
  |-
  | 2006
+
  | Stonecutter
  | Dragon breath
+
  | 0: Selected recipe
  |
+
  | The index of the selected recipe. -1 means none is selected.
 
  |-
 
  |-
  | 3000
+
  | Loom
  | End gateway spawn
+
  | 0: Selected pattern
  |  
+
  | The index of the selected pattern. 0 means none is selected, 0 is also the internal id of the "base" pattern.
 
  |-
 
  |-
  | 3001
+
  | Lectern
  | Enderdragon growl
+
  | 0: Page number
  |
+
  | The current page number, starting from 0.
 
  |}
 
  |}
  
Smoke directions:
+
For an enchanting table, the following numerical IDs are used:
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Numerical ID
  ! Direction
+
  ! Enchantment ID
 +
! Enchantment Name
 
  |-
 
  |-
 
  | 0
 
  | 0
  | South-East
+
  | minecraft:protection
 +
| Protection
 
  |-
 
  |-
 
  | 1
 
  | 1
  | South
+
  | minecraft:fire_protection
 +
| Fire Protection
 
  |-
 
  |-
 
  | 2
 
  | 2
  | South-West
+
  | minecraft:feather_falling
 +
| Feather Falling
 
  |-
 
  |-
 
  | 3
 
  | 3
  | East
+
  | minecraft:blast_protection
 +
| Blast Protection
 
  |-
 
  |-
 
  | 4
 
  | 4
  | (Up or middle ?)
+
  | minecraft:projectile_protection
 +
| Projectile Protection
 
  |-
 
  |-
 
  | 5
 
  | 5
  | West
+
  | minecraft:respiration
 +
| Respiration
 
  |-
 
  |-
 
  | 6
 
  | 6
  | North-East
+
  | minecraft:aqua_affinity
 +
| Aqua Affinity
 
  |-
 
  |-
 
  | 7
 
  | 7
  | North
+
  | minecraft:thorns
 +
| Thorns
 
  |-
 
  |-
 
  | 8
 
  | 8
  | North-West
+
  | minecraft:depth_strider
  |}
+
| Depth Strider
 
+
|-
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.
+
  | 9
 
+
| minecraft:frost_walker
==== Particle ====
+
| Frost Walker
 
+
|-
Displays the named particle
+
| 10
 
+
| minecraft:binding_curse
{| class="wikitable"
+
| Curse of Binding
  ! Packet ID
+
|-
  ! State
+
| 11
  ! Bound To
+
  | minecraft:soul_speed
  ! Field Name
+
  | Soul Speed
  ! Field Type
+
  |-
  ! Notes
+
  | 12
 +
  | minecraft:sharpness
 +
  | Sharpness
 
  |-
 
  |-
  |rowspan="11"| 0x22
+
  | 13
|rowspan="11"| Play
+
  | minecraft:smite
|rowspan="11"| Client
+
  | Smite
| Particle ID
 
  | Int
 
  | See below
 
 
  |-
 
  |-
  | Long Distance
+
  | 14
  | Boolean
+
  | minecraft:bane_of_arthropods
  | If true, particle distance increases from 256 to 65536
+
  | Bane of Arthropods
 
  |-
 
  |-
  | X
+
  | 15
  | Float
+
  | minecraft:knockback
  | X position of the particle
+
  | Knockback
 
  |-
 
  |-
  | Y
+
  | 16
  | Float
+
  | minecraft:fire_aspect
  | Y position of the particle
+
  | Fire Aspect
 
  |-
 
  |-
  | Z
+
  | 17
  | Float
+
  | minecraft:looting
  | Z position of the particle
+
  | Looting
 
  |-
 
  |-
  | Offset X
+
  | 18
  | Float
+
  | minecraft:sweeping
  | This is added to the X position after being multiplied by random.nextGaussian()
+
  | Sweeping Edge
 
  |-
 
  |-
  | Offset Y
+
  | 19
  | Float
+
  | minecraft:efficiency
  | This is added to the Y position after being multiplied by random.nextGaussian()
+
  | Efficiency
 
  |-
 
  |-
  | Offset Z
+
  | 20
  | Float
+
  | minecraft:silk_touch
  | This is added to the Z position after being multiplied by random.nextGaussian()
+
  | Silk Touch
 
  |-
 
  |-
  | Particle Data
+
  | 21
  | Float
+
  | minecraft:unbreaking
  | The data of each particle
+
  | Unbreaking
 
  |-
 
  |-
  | Particle Count
+
  | 22
  | Int
+
  | minecraft:fortune
  | The number of particles to create
+
  | Fortune
 
  |-
 
  |-
  | Data
+
  | 23
  | Array of VarInt
+
  | minecraft:power
  | Length depends on particle. "iconcrack" has length of 2, "blockcrack", and "blockdust" have lengths of 1, the rest have 0.
+
  | Power
|}
 
 
 
Particle IDs:
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Particle Name
+
  | 24
  ! Particle ID
+
  | minecraft:punch
 +
| Punch
 
  |-
 
  |-
  | explode
+
  | 25
  | 0
+
  | minecraft:flame
 +
| Flame
 
  |-
 
  |-
  | largeexplode
+
  | 26
  | 1
+
  | minecraft:infinity
 +
| Infinity
 
  |-
 
  |-
  | hugeexplosion
+
  | 27
  | 2
+
  | minecraft:luck_of_the_sea
 +
| Luck of the Sea
 
  |-
 
  |-
  | fireworksSpark
+
  | 28
  | 3
+
  | minecraft:lure
 +
| Lure
 
  |-
 
  |-
  | bubble
+
  | 29
  | 4
+
  | minecraft:loyalty
 +
| Loyalty
 
  |-
 
  |-
  | splash
+
  | 30
  | 5
+
  | minecraft:impaling
 +
| Impaling
 
  |-
 
  |-
  | wake
+
  | 31
  | 6
+
  | minecraft:riptide
 +
| Riptide
 
  |-
 
  |-
  | suspended
+
  | 32
  | 7
+
  | minecraft:channeling
 +
| Channeling
 
  |-
 
  |-
  | depthsuspend
+
  | 33
  | 8
+
  | minecraft:multishot
 +
| Multishot
 
  |-
 
  |-
  | crit
+
  | 34
  | 9
+
  | minecraft:quick_charge
 +
| Quick Charge
 
  |-
 
  |-
  | magicCrit
+
  | 35
  | 10
+
  | minecraft:piercing
 +
| Piercing
 
  |-
 
  |-
  | smoke
+
  | 36
  | 11
+
  | minecraft:mending
 +
| Mending
 
  |-
 
  |-
  | largesmoke
+
  | 37
  | 12
+
  | minecraft:vanishing_curse
 +
| Curse of Vanishing
 +
|}
 +
 
 +
==== Set 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
 
  |-
 
  |-
  | spell
+
  |rowspan="3"| 0x16
  | 13
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| 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).
 
  |-
 
  |-
  | instantSpell
+
  | Slot
  | 14
+
  | Short
 +
| The slot that should be updated.
 
  |-
 
  |-
  | mobSpell
+
  | Slot Data
  | 15
+
  | [[Slot Data|Slot]]
 +
|
 +
|}
 +
 
 +
To set the cursor (the item currently dragged with the mouse), use -1 as Window ID and as Slot.
 +
 
 +
This packet can only be used to edit the hotbar of the player's inventory if window ID is set to 0 (slots 36 through 44).  If the window ID is set to -2, then any slot in the inventory can be used but no add item animation will be played.
 +
 
 +
==== Set Cooldown ====
 +
 
 +
Applies a cooldown period to all items with the given type.  Used by the Notchian server with enderpearls.  This packet should be sent when the cooldown starts and also when the cooldown ends (to compensate for lag), although the client will end the cooldown automatically. Can be applied to any item, note that interactions still get sent to the server with the item but the client does not play the animation nor attempt to predict results (i.e block placing).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | mobSpellAmbient
+
  |rowspan="2"| 0x17
  | 16
+
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Item ID
 +
| VarInt
 +
  | Numeric ID of the item to apply a cooldown to.
 
  |-
 
  |-
  | witchMagic
+
  | Cooldown Ticks
  | 17
+
  | VarInt
  |-
+
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
  | dripWater
+
  |}
| 18
+
 
  |-
+
==== Plugin Message (clientbound) ====
  | dripLava
+
 
  | 19
+
{{Main|Plugin channels}}
  |-
+
 
  | angryVillager
+
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.
  | 20
+
 
 +
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/]
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
  ! State
 +
  ! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | happyVillager
+
  |rowspan="2"| 0x18
  | 21
+
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Channel
 +
| Identifier
 +
  | Name of the [[plugin channel]] used to send the data.
 
  |-
 
  |-
  | townaura
+
  | Data
  | 22
+
  | Byte Array
 +
| Any data, depending on the channel. <code>minecraft:</code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
 +
|}
 +
 
 +
==== 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
 
  |-
 
  |-
  | note
+
  |rowspan="7"| 0x19
  | 23
+
|rowspan="7"| Play
 +
|rowspan="7"| Client
 +
| Sound Name
 +
| Identifier
 +
  | All sound effect names as of 1.16.5 can be seen [https://pokechu22.github.io/Burger/1.16.5.html#sounds here].
 
  |-
 
  |-
  | portal
+
  | Sound Category
  | 24
+
  | VarInt Enum
 +
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories]).
 
  |-
 
  |-
  | enchantmenttable
+
  | Effect Position X
  | 25
+
  | Int
 +
| Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part).
 
  |-
 
  |-
  | flame
+
  | Effect Position Y
  | 26
+
  | Int
 +
| Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part).
 
  |-
 
  |-
  | lava
+
  | Effect Position Z
  | 27
+
  | Int
 +
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part).
 
  |-
 
  |-
  | footstep
+
  | Volume
  | 28
+
  | Float
 +
| 1 is 100%, can be more.
 
  |-
 
  |-
  | cloud
+
  | Pitch
  | 29
+
  | Float
  |-
+
  | Float between 0.5 and 2.0 by Notchian clients.
| reddust
 
| 30
 
|-
 
| snowballpoof
 
| 31
 
|-
 
| snowshovel
 
| 32
 
|-
 
| slime
 
| 33
 
|-
 
| heart
 
| 34
 
|-
 
| barrier
 
| 35
 
|-
 
| iconcrack_(id)_(data)
 
| 36
 
|-
 
| blockcrack_(id+(data<<12))
 
| 37
 
|-
 
| blockdust_(id)
 
| 38
 
|-
 
| droplet
 
| 39
 
|-
 
| take
 
| 40
 
|-
 
| mobappearance
 
| 41
 
|-
 
| dragonbreath
 
| 42
 
|-
 
| endrod
 
| 43
 
|-
 
| damageindicator
 
| 44
 
|-
 
| sweepattack
 
| 45
 
|-
 
| fallingdust
 
| 46
 
 
  |}
 
  |}
  
==== Join Game ====
+
==== Disconnect (play) ====
  
See [[Protocol Encryption]] for information on logging in.
+
Sent by the server before it disconnects a client. The client assumes that the server has already closed the connection by the time the packet arrives.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,208: Line 2,323:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x23
+
  | 0x1A
  |rowspan="7"| Play
+
  | Play
  |rowspan="7"| Client
+
  | Client
  | Entity ID
+
  | Reason
| Int
+
  | [[Chat]]
| The player's Entity ID (EID)
+
  | Displayed to the client when the connection terminates.
|-
 
| Gamemode
 
| Unsigned Byte
 
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. Bit 3 (0x8) is the hardcore flag.
 
|-
 
| 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 ====
+
==== Entity Status ====
  
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
+
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,248: Line 2,339:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="13"| 0x24
+
  |rowspan="2"| 0x1B
  |rowspan="13"| Play
+
  |rowspan="2"| Play
  |rowspan="13"| Client
+
  |rowspan="2"| Client
  |colspan="2"| Item Damage
+
  | Entity ID
  |colspan="2"| VarInt
+
  | Int
  | The damage value (map ID) of the map being modified
+
  |  
 
  |-
 
  |-
  |colspan="2"| Scale
+
  | Entity Status
  |colspan="2"| Byte
+
  | Byte Enum
  | From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
+
  | See [[Entity statuses]] for a list of which statuses are valid for each type of entity.
|-
+
|}
|colspan="2"| Tracking Position
+
 
  |colspan="2"| Boolean
+
==== Explosion ====
  | Specifies whether the icons are shown
+
 
  |-
+
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
  |colspan="2"| Icon Count
+
 
  |colspan="2"| VarInt
+
Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x
  | Number of elements in the following array
+
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
  ! State
 +
  ! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| Icon
+
  |rowspan="9"| 0x1C
  | Direction And Type
+
  |rowspan="9"| Play
  |rowspan="3"| Array
+
  |rowspan="9"| Client
  | Byte
+
  | X
  | 0xF0 = Direction, 0x0F = Type
+
| Float
 +
  |  
 
  |-
 
  |-
  | X
+
  | Y
  | Byte
+
  | Float
 
  |  
 
  |  
 
  |-
 
  |-
 
  | Z
 
  | Z
  | Byte
+
  | Float
 
  |  
 
  |  
|-
 
|colspan="2"| Columns
 
|colspan="2"| Byte
 
| Number of columns updated
 
 
  |-
 
  |-
  |colspan="2"| Rows
+
  | Strength
  |colspan="2"| Optional Byte
+
  | Float
  | Only if Columns is more than 0; number of rows updated
+
  | A strength greater than or equal to 2.0 spawns a <code>minecraft:explosion_emitter</code> particle, while a lesser strength spawns a <code>minecraft:explosion</code> particle.
 
  |-
 
  |-
  |colspan="2"| X
+
  | Record Count
  |colspan="2"| Optional Byte
+
  | VarInt
  | Only if Columns is more than 0; x offset of the westernmost column
+
  | Number of elements in the following array.
 
  |-
 
  |-
  |colspan="2"| Z
+
  | Records
  |colspan="2"| Optional Byte
+
  | Array of (Byte, Byte, Byte)
  | Only if Columns is more than 0; z offset of the northernmost row
+
  | 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.
 
  |-
 
  |-
  |colspan="2"| Length
+
  | Player Motion Y
  |colspan="2"| Optional VarInt
+
  | Float
  | Only if Columns is more than 0; length of the following array
+
  | Y velocity of the player being pushed by the explosion.
 
  |-
 
  |-
  |colspan="2"| Data
+
  | Player Motion Z
  |colspan="2"| Optional Array of Unsigned Byte
+
  | Float
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
+
  | Z velocity of the player being pushed by the explosion.
 
  |}
 
  |}
  
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
+
==== Unload Chunk ====
  
Types are based off of rows and columns in <code>map_icons.png</code>:
+
Tells the client to unload a chunk column.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Icon type
+
  |rowspan="2"| 0x1D
  ! Result
+
  |rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Chunk X
 +
| Int
 +
| Block coordinate divided by 16, rounded down.
 
  |-
 
  |-
  | 0
+
  | Chunk Z
  | White arrow (players)
+
  | Int
  |-
+
  | Block coordinate divided by 16, rounded down.
  | 1
+
  |}
| Green arrow (item frames)
+
 
|-
+
It is legal to send this packet even if the given chunk is not currently loaded.
| 2
+
 
| Red arrow
+
==== Change Game State ====
|-
 
| 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 ====
 
  
This packet may be used to initialize an entity.
+
Used for a wide variety of game state things, from weather to bed use to gamemode to demo messages.
 
 
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,367: Line 2,447:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x25
+
  |rowspan="2"| 0x1E
  |rowspan="1"| Play
+
  |rowspan="2"| Play
  |rowspan="1"| Client
+
  |rowspan="2"| Client
  | Entity ID
+
  | Reason
  | VarInt
+
  | Unsigned Byte
  |  
+
  | See below.
 +
|-
 +
| Value
 +
| Float
 +
| Depends on Reason.
 
  |}
 
  |}
  
==== Entity Relative Move ====
+
''Reason codes'':
 
 
This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks [[#Entity Teleport|Entity Teleport]] should be sent instead.
 
 
 
This packet allows at most 8 blocks movement in any direction, because short range is from -32768 to 32767. And <code>32768 / (128 * 32)</code> = 8.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Reason
  ! State
+
  ! Effect
  ! Bound To
+
  ! Value
  ! Field Name
+
  |-
  ! Field Type
+
| 0
  ! Notes
+
| No respawn block available
 +
| Note: Sends message 'block.minecraft.spawn.not_valid'(You have no home bed or charged respawn anchor, or it was obstructed) to the client.
 +
|-
 +
| 1
 +
  | End raining
 +
  |
 
  |-
 
  |-
  |rowspan="5"| 0x26
+
  | 2
|rowspan="5"| Play
+
  | Begin raining
|rowspan="5"| Client
 
| Entity ID
 
  | VarInt
 
 
  |  
 
  |  
 
  |-
 
  |-
  | Delta X
+
  | 3
  | Short
+
  | Change gamemode
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
| 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 skycolor and lightning. <strong>[https://imgur.com/a/K6wSrkW You can see some level images here]</strong><br>Rain level starting from 0.
 
  |-
 
  |-
  | Delta Y
+
  | 8
  | Short
+
  | Thunder level change
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
+
  | Note: Seems to change both skycolor and lightning (same as Rain level change, but doesn't start rain). It also requires rain to render by notchian client. <br>Thunder level starting from 0.
 
  |-
 
  |-
  | Delta Z
+
  | 9
  | Short
+
  | Play pufferfish sting sound.
| Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
 
 
  |-
 
  |-
  | On Ground
+
  | 10
  | Boolean
+
  | 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).
 
  |}
 
  |}
  
==== Entity Look And Relative Move ====
+
==== Open Horse Window ====
  
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>)
+
This packet is used exclusively for opening the horse GUI. [[#Open Window|Open Window]] is used for all other GUIs.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,425: Line 2,526:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x27
+
  |rowspan="3"| 0x1F
  |rowspan="7"| Play
+
  |rowspan="3"| Play
  |rowspan="7"| Client
+
  |rowspan="3"| Client
  | Entity ID
+
  | Window ID?
 +
| Byte
 +
|
 +
|-
 +
| Number of slots?
 
  | VarInt
 
  | VarInt
  |  
+
  |
 
  |-
 
  |-
  | Delta X
+
  | Entity ID?
  | Short
+
  | Integer
| Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
  |
|-
 
| 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 ====
+
==== Initialize World Border ====  
 
 
This packet is sent by the server when an entity rotates.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,469: Line 2,552:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x28
+
  |rowspan="8"| 0x20
  |rowspan="4"| Play
+
  |rowspan="8"| Play
  |rowspan="4"| Client
+
  |rowspan="8"| Client
  | Entity ID
+
  | X
  | VarInt
+
  | Double
 
  |  
 
  |  
 
  |-
 
  |-
  | Yaw
+
  | Z
  | Angle
+
  | Double
  | New angle, not a delta
+
  |  
 
  |-
 
  |-
  | Pitch
+
  | Old Diameter
  | Angle
+
  | Double
  | New angle, not a delta
+
  | 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 ''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
 +
| 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 <code>/worldborder warning time</code>.
 
  |-
 
  |-
| On Ground
 
| Boolean
 
|
 
 
  |}
 
  |}
  
==== Vehicle Move (clientbound) ====
+
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>
 +
 
 +
==== Keep Alive (clientbound) ====
 +
 
 +
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same payload (see [[#Keep Alive (serverbound)|serverbound Keep Alive]]). 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.
  
Note that all fields use absolute positioning and do not allow for relative positioning.
+
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,501: Line 2,614:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x29
+
  | 0x21
  |rowspan="7"| Play
+
  | Play
  |rowspan="7"| Client
+
  | Client
  | X
+
  | Keep Alive ID
  | Double
+
  | Long
  | Absolute position (X coordinate)
+
  |  
  |-
+
  |}
| Y
+
 
| Double
+
==== Chunk Data ====
| Absolute position (Y coordinate)
+
{{Main|Chunk Format}}
|-
+
{{See also|#Unload Chunk}}
| 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 ====
+
{{Need Info|How do biomes work now?  The biome change happened at the same time as the seed change, but it's not clear how/if biomes could be computed given that it's not the actual seed...  ([https://www.reddit.com/r/Mojira/comments/e5at6i/a_discussion_for_the_changes_to_how_biomes_are/ /r/mojira discussion] which notes that it seems to be some kind of interpolation, and 3D biomes are only used in the nether)}}
  
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].
+
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimension the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.  This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with [[#Update Block Entity|Update Block Entity]] later).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,537: Line 2,638:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x2A
+
  |rowspan="11"| 0x22
  |rowspan="1"| Play
+
  |rowspan="11"| Play
  |rowspan="1"| Client
+
  |rowspan="11"| Client
  | Location
+
  | Chunk X
  | Position
+
  | Int
  |  
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
|}
 
 
 
==== Player Abilities (clientbound) ====
 
 
 
The latter 2 floats are used to indicate the field of view and flying speed respectively, while the first byte is used to determine the value of 4 booleans.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x2B
+
  | Chunk Z
|rowspan="3"| Play
+
  | Int
|rowspan="3"| Client
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
| Flags
 
  | Byte
 
  | Bit field, see below
 
 
  |-
 
  |-
  | Flying Speed
+
  | Bit Mask Length
  | Float
+
  | VarInt
  |  
+
  | Length of the following array
 
  |-
 
  |-
  | Field of View Modifier
+
  | Primary Bit Mask
  | Float
+
  | Array of Long
  | 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).
+
  | BitSet with bits (world height in blocks / 16) 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 the lowest y to 15 blocks above).
|}
 
 
 
About the flags:
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Field
+
  | Heightmaps
  ! Bit
+
  | [[NBT]]
 +
| Compound containing one long array named <code>MOTION_BLOCKING</code>, which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry totaling 36 longs). The Notchian server also adds a <code>WORLD_SURFACE</code> long array, the purpose of which is unknown, but it's not required for the chunk to be accepted.
 +
|-
 +
| Biomes length
 +
| VarInt
 +
| Size of the following array; should always be 1024.
 
  |-
 
  |-
  | Invulnerable
+
  | Biomes
  | 0x01
+
  | Array of VarInt
 +
| 1024 biome IDs, ordered by x then z then y, in 4&times;4&times;4 blocks.  See [[Chunk Format#Biomes|Chunk Format § Biomes]].
 +
|-
 +
| Size
 +
| VarInt
 +
| Size of Data in bytes
 
  |-
 
  |-
  | Flying
+
  | Data
  | 0x02
+
  | Byte array
 +
| See [[Chunk Format#Data structure|data structure]] in Chunk Format
 
  |-
 
  |-
  | Allow Flying
+
  | Number of block entities
  | 0x04
+
  | VarInt
 +
| Number of elements in the following array
 
  |-
 
  |-
  | Creative Mode
+
  | Block entities
  | 0x08
+
  | 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.
 
  |}
 
  |}
  
==== Combat Event ====
+
Note that the Notchian client requires an [[#Update View Position|Update View Position]] packet when it crosses a chunk border, otherwise it'll only display render distance + 2 chunks around the chunk it spawned in.
 +
 
 +
The compacted array format has been adjusted so that individual entries no longer span across multiple longs, affecting the main data array and heightmaps.
 +
 
 +
New format, 5 bits per block, containing the following references to blocks in a palette (not shown): <span style="border: solid 2px hsl(0, 90%, 60%)">1</span><span style="border: solid 2px hsl(30, 90%, 60%)">2</span><span style="border: solid 2px hsl(60, 90%, 60%)">2</span><span style="border: solid 2px hsl(90, 90%, 60%)">3</span><span style="border: solid 2px hsl(120, 90%, 60%)">4</span><span style="border: solid 2px hsl(150, 90%, 60%)">4</span><span style="border: solid 2px hsl(180, 90%, 60%)">5</span><span style="border: solid 2px hsl(210, 90%, 60%)">6</span><span style="border: solid 2px hsl(240, 90%, 60%)">6</span><span style="border: solid 2px hsl(270, 90%, 60%)">4</span><span style="border: solid 2px hsl(300, 90%, 60%)">8</span><span style="border: solid 2px hsl(330, 90%, 60%)">0</span><span style="border: solid 2px hsl(0, 90%, 30%)">7</span><span style="border: solid 2px hsl(30, 90%, 30%)">4</span><span style="border: solid 2px hsl(60, 90%, 30%)">3</span><span style="border: solid 2px hsl(90, 90%, 30%)">13</span><span style="border: solid 2px hsl(120, 90%, 30%)">15</span><span style="border: solid 2px hsl(150, 90%, 30%)">16</span><span style="border: solid 2px hsl(180, 90%, 30%)">9</span><span style="border: solid 2px hsl(210, 90%, 30%)">14</span><span style="border: solid 2px hsl(240, 90%, 30%)">10</span><span style="border: solid 2px hsl(270, 90%, 30%)">12</span><span style="border: solid 2px hsl(300, 90%, 30%)">0</span><span style="border: solid 2px hsl(330, 90%, 30%)">2</span>
 +
 
 +
<code>0020863148418841</code> <code><span style="outline: dashed 2px black">0000</span><span style="outline: solid 2px hsl(330, 90%, 60%)">00000</span><span style="outline: solid 2px hsl(300, 90%, 60%)">01000</span><span style="outline: solid 2px hsl(270, 90%, 60%)">00100</span><span style="outline: solid 2px hsl(240, 90%, 60%)">00110</span><span style="outline: solid 2px hsl(210, 90%, 60%)">00110</span><span style="outline: solid 2px hsl(180, 90%, 60%)">00101</span><span style="outline: solid 2px hsl(150, 90%, 60%)">00100</span><span style="outline: solid 2px hsl(120, 90%, 60%)">00100</span><span style="outline: solid 2px hsl(90, 90%, 60%)">00011</span><span style="outline: solid 2px hsl(60, 90%, 60%)">00010</span><span style="outline: solid 2px hsl(30, 90%, 60%)">00010</span><span style="outline: solid 2px hsl(0, 90%, 60%)">00001</span></code><br>
 +
<code>01018A7260F68C87</code> <code><span style="outline: dashed 2px black">0000</span><span style="outline: solid 2px hsl(330, 90%, 30%)">00010</span><span style="outline: solid 2px hsl(300, 90%, 30%)">00000</span><span style="outline: solid 2px hsl(270, 90%, 30%)">01100</span><span style="outline: solid 2px hsl(240, 90%, 30%)">01010</span><span style="outline: solid 2px hsl(210, 90%, 30%)">01110</span><span style="outline: solid 2px hsl(180, 90%, 30%)">01001</span><span style="outline: solid 2px hsl(150, 90%, 30%)">10000</span><span style="outline: solid 2px hsl(120, 90%, 30%)">01111</span><span style="outline: solid 2px hsl(90, 90%, 30%)">01101</span><span style="outline: solid 2px hsl(60, 90%, 30%)">00011</span><span style="outline: solid 2px hsl(30, 90%, 30%)">00100</span><span style="outline: solid 2px hsl(0, 90%, 30%)">00111</span></code>
 +
 
 +
==== Effect ====
 +
Sent when a client is to play a sound or particle effect.
 +
 
 +
By default, the Minecraft client adjusts the volume of sound effects based on distance. The final boolean field is used to disable this, and instead the effect is played from 2 blocks away in the correct direction. Currently this is only used for effect 1023 (wither spawn), effect 1028 (enderdragon death), and effect 1038 (end portal opening); it is ignored on other effects.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,599: Line 2,704:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x2C
+
  |rowspan="4"| 0x23
  |rowspan="8"| Play
+
  |rowspan="4"| Play
  |rowspan="8"| Client
+
  |rowspan="4"| Client
  |colspan="2"| Event
+
  | Effect ID
  | VarInt Enum
+
  | Int
  | Determines the layout of the remaining packet
+
  | The ID of the effect, see below.
 
  |-
 
  |-
  ! Event
+
| Location
  ! Field Name
+
| Position
  !  
+
| The location of the effect.
  !  
+
|-
 +
| Data
 +
| Int
 +
| Extra data for certain effects, see below.
 +
|-
 +
| Disable Relative Volume
 +
| Boolean
 +
| See above.
 +
|}
 +
 
 +
Effect IDs:
 +
 
 +
{| class="wikitable"
 +
  ! ID
 +
  ! Name
 +
  ! Data
 +
|-
 +
  !colspan="3"| Sound
 
  |-
 
  |-
  | 0: enter combat
+
  | 1000
  | ''no fields''
+
  | Dispenser dispenses
| ''no fields''
 
 
  |  
 
  |  
 
  |-
 
  |-
  |rowspan="2"| 1: end combat
+
  | 1001
| Duration
+
  | Dispenser fails to dispense
  | VarInt
 
 
  |  
 
  |  
 
  |-
 
  |-
  | Entity ID
+
  | 1002
  | Int
+
  | Dispenser shoots
 
  |  
 
  |  
 
  |-
 
  |-
  |rowspan="3"| 2: entity dead
+
  | 1003
| Player ID
+
  | Ender eye launched
  | VarInt
 
 
  |  
 
  |  
 
  |-
 
  |-
  | Entity ID
+
  | 1004
  | Int
+
  | Firework shot
 
  |  
 
  |  
 
  |-
 
  |-
  | Message
+
  | 1005
  | [[Chat]]
+
  | Iron door opened
 +
|
 +
|-
 +
| 1006
 +
| Wooden door opened
 
  |  
 
  |  
|}
 
 
==== Player List Item ====
 
 
Sent by the server to update the user list (<tab> in the client).
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="4"| Field Name
 
!colspan="3"| Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="19"| 0x2D
+
  | 1007
|rowspan="19"| Play
+
  | Wooden trapdoor opened
|rowspan="19"| Client
+
  |  
  |colspan="4"| Action
 
|colspan="3"| VarInt
 
  | Determines the rest of the Player format after the UUID
 
 
  |-
 
  |-
  |colspan="4"| Number Of Players
+
  | 1008
  |colspan="3"| VarInt
+
  | Fence gate opened
  | Number of elements in the following array
+
  |  
 
  |-
 
  |-
  |rowspan="17"| Player
+
  | 1009
|colspan="3"| UUID
+
  | Fire extinguished
  |rowspan="17"| Array
 
|colspan="2"| UUID
 
 
  |  
 
  |  
 
  |-
 
  |-
  ! Action
+
  | 1010
  !colspan="2"| Field Name
+
  | Play record
  !colspan="2"|  
+
  | Special case, see below for more info.
!
 
 
  |-
 
  |-
  |rowspan="10"| 0: add player
+
  | 1011
|colspan="2"| Name
+
  | Iron door closed
  |colspan="2"| String (16)
 
 
  |  
 
  |  
 
  |-
 
  |-
  |colspan="2"| Number Of Properties
+
  | 1012
  |colspan="2"| VarInt
+
  | Wooden door closed
  | Number of elements in the following array
+
  |  
 
  |-
 
  |-
  |rowspan="4"| Property
+
  | 1013
| Name
+
  | Wooden trapdoor closed
|rowspan="4"| Array
 
  | String (32767)
 
 
  |  
 
  |  
 
  |-
 
  |-
  | Value
+
  | 1014
  | String (32767)
+
  | Fence gate closed
 
  |  
 
  |  
  |-  
+
  |-
  | Is Signed
+
  | 1015
  | Boolean
+
  | Ghast warns
 
  |  
 
  |  
 
  |-
 
  |-
  | Signature
+
  | 1016
  | Optional String (32767)
+
  | Ghast shoots
  | Only if Is Signed is true
+
  |  
 
  |-
 
  |-
  |colspan="2"| Gamemode
+
  | 1017
  |colspan="2"| VarInt
+
  | Enderdragon shoots
 
  |  
 
  |  
 
  |-
 
  |-
  |colspan="2"| Ping
+
  | 1018
  |colspan="2"| VarInt
+
  | Blaze shoots
 
  |  
 
  |  
 
  |-
 
  |-
  |colspan="2"| Has Display Name
+
  | 1019
  |colspan="2"| Boolean
+
  | Zombie attacks wood door
 
  |  
 
  |  
 
  |-
 
  |-
  |colspan="2"| Display Name
+
  | 1020
|colspan="2"| Optional [[Chat]]
+
  | Zombie attacks iron door
| Only if Has Display Name is true
 
|-
 
| 1: update gamemode
 
|colspan="2"| Gamemode
 
|colspan="2"| VarInt
 
|
 
|-
 
  | 2: update latency
 
|colspan="2"| Ping
 
|colspan="2"| VarInt
 
 
  |  
 
  |  
 
  |-
 
  |-
  |rowspan="2"| 3: update display name
+
  | 1021
|colspan="2"| Has Display Name
+
  | Zombie breaks wood door
  |colspan="2"| Boolean
+
  |
  |  
 
 
  |-
 
  |-
  |colspan="2"| Display Name
+
  | 1022
  |colspan="2"| Optional [[Chat]]
+
  | Wither breaks block
  | Only send if Has Display Name is true
+
  |
 
  |-
 
  |-
  | 4: remove player
+
  | 1023
  |colspan="2"| ''no fields''
+
  | Wither spawned
|colspan="2"| ''no fields''
 
 
  |  
 
  |  
|}
 
 
The Property field looks as in the response of [[Mojang API#UUID -> Profile + Skin/Cape]], except of course using the protocol format instead of JSON. That is, each player will usually have one property with Name “textures” and Value being a base64-encoded JSON string as documented at [[Mojang API#UUID -> Profile + Skin/Cape]]. An empty properties array is also acceptable, and will cause clients to display the player with one of the two default skins depending on UUID.
 
 
==== Player Position And Look (clientbound) ====
 
 
Updates the player's position on the server. This packet will also close the “Downloading Terrain” screen when joining/respawning.
 
 
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 meters, the client will be kicked for “You moved too quickly :( (Hacking?)”.
 
 
Also if the fixed-point number of X or Z is set greater than <code>3.2E7D</code> the client will be kicked for “Illegal position”.
 
 
Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0, -1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.
 
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="7"| 0x2E
+
  | 1024
|rowspan="7"| Play
+
  | Wither shoots
|rowspan="7"| Client
+
  |
| X
 
  | Double
 
  | Absolute or relative position, depending on Flags
 
 
  |-
 
  |-
  | Y
+
  | 1025
  | Double
+
  | Bat takes off
  | Absolute or relative position, depending on Flags
+
  |
 
  |-
 
  |-
  | Z
+
  | 1026
  | Double
+
  | Zombie infects
  | Absolute or relative position, depending on Flags
+
  |
 
  |-
 
  |-
  | Yaw
+
  | 1027
  | Float
+
  | Zombie villager converted
  | Absolute or relative rotation on the X axis, in degrees
+
  |
 
  |-
 
  |-
  | Pitch
+
  | 1028
  | Float
+
  | Ender dragon death
  | Absolute or relative rotation on the Y axis, in degrees
+
  |
 
  |-
 
  |-
  | Flags
+
  | 1029
  | Byte
+
  | Anvil destroyed
  | Bit field, see below
+
  |  
 
  |-
 
  |-
  | Teleport ID
+
  | 1030
  | VarInt
+
  | Anvil used
  | Client should confirm this packet with [[#Teleport Confirm|Teleport Confirm]] containing the same Teleport ID
+
  |  
|}
 
 
 
About the Flags field:
 
 
 
<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"
 
 
  |-
 
  |-
  ! Field
+
  | 1031
  ! Bit
+
  | Anvil landed
 +
|
 
  |-
 
  |-
  | X
+
  | 1032
  | 0x01
+
| Portal travel
 +
  |  
 
  |-
 
  |-
  | Y
+
  | 1033
  | 0x02
+
| Chorus flower grown
 +
|
 +
|-
 +
| 1034
 +
| Chorus flower died
 +
|
 +
|-
 +
| 1035
 +
| Brewing stand brewed
 +
  |
 
  |-
 
  |-
  | Z
+
  | 1036
  | 0x04
+
| Iron trapdoor opened
 +
  |  
 
  |-
 
  |-
  | Y_ROT
+
  | 1037
  | 0x08
+
| Iron trapdoor closed
 +
  |
 
  |-
 
  |-
  | X_ROT
+
  | 1038
  | 0x10
+
  | End portal created in overworld
  |}
+
  |
 
 
==== 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"| 0x2F
+
  | 1039
|rowspan="2"| Play
+
  | Phantom bites
|rowspan="2"| Client
+
  |
| Entity ID
 
  | VarInt
 
  | Sleeping player's EID
 
 
  |-
 
  |-
  | Location
+
  | 1040
  | Position
+
  | Zombie converts to drowned
  | Block location of the head part of the bed
+
  |
|}
 
 
 
==== Unlock Recipes ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="8"| 0x30
+
  | 1041
  |rowspan="8"| Play
+
  | Husk converts to zombie by drowning
  |rowspan="8"| Client
+
  |
 
  |-
 
  |-
  | Action
+
  | 1042
  | VarInt
+
  | Grindstone used
  | 0: init, 1: add, 2: remove
+
  |
 
  |-
 
  |-
  | Crafting Book Open
+
  | 1043
  | Boolean
+
  | Book page turned
  | If true, then the crafting book will be open when the player opens its inventory.
+
  |
 
  |-
 
  |-
| Filtering Craftable
 
| Boolean
 
| If true, then the filtering option is active when the players opens its inventory.
 
 
  |-
 
  |-
  | Array size 1
+
  !colspan="3"| Particle
| VarInt
 
| Number of elements in the following array
 
 
  |-
 
  |-
  | Recipe IDs
+
  | 1500
  | Array of VarInt
+
  | Composter composts
 
  |
 
  |
 
  |-
 
  |-
  | Array size 2
+
  | 1501
  | Optional VarInt
+
  | Lava converts block (either water to stone, or removes existing blocks such as torches)
  | Number of elements in the following array, only present if mode is 0 (init)
+
  |
 
  |-
 
  |-
  | Recipe IDs
+
  | 1502
  | Optional Array of VarInt, only present if mode is 0 (init)
+
  | Redstone torch burns out
 +
|
 +
|-
 +
| 1503
 +
| Ender eye placed
 
  |
 
  |
|}
 
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"| 0x31
+
  | 2000
  |rowspan="2"| Play
+
| Spawns 10 smoke particles, e.g. from a fire
  |rowspan="2"| Client
+
| Direction, see below.
  | Count
+
|-
  | VarInt
+
  | 2001
  | Number of elements in the following array
+
| Block break + block break sound
 +
  | Block state, as an index into the global palette.
 +
|-
 +
  | 2002
 +
  | Splash potion. Particle effect + glass break sound.
 +
  | RGB color as an integer (e.g. 8364543 for #7FA1FF).
 
  |-
 
  |-
  | Entity IDs
+
  | 2003
  | Array of VarInt
+
  | Eye of Ender entity break animation — particles and sound
  | The list of entities of destroy
+
  |  
|}
 
 
 
==== Remove Entity Effect ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x32
+
  | 2004
|rowspan="2"| Play
+
  | Mob spawn particle effect: smoke + flames
|rowspan="2"| Client
 
| Entity ID
 
  | VarInt
 
 
  |  
 
  |  
 
  |-
 
  |-
  | Effect ID
+
  | 2005
  | Byte
+
  | Bonemeal particles
  | See {{Minecraft Wiki|Status effect#List of effects|this table}}
+
  | How many particles to spawn (if set to 0, 15 are spawned).
|}
 
 
 
==== Resource Pack Send ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x33
+
  | 2006
  |rowspan="2"| Play
+
| Dragon breath
  |rowspan="2"| Client
+
  |
  | URL
+
|-
  | String (32767)
+
  | 2007
  | The URL to the resource pack.
+
  | 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
 +
  |
 
  |-
 
  |-
  | Hash
+
  | 3005
  | String (40)
+
  | Copper scrape oxidation
  | 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 ====
+
Smoke directions:
 
 
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"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Direction
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x34
+
  | 0
  |rowspan="4"| Play
+
  | Down
|rowspan="4"| Client
 
| Dimension
 
| Int Enum
 
| -1: The Nether, 0: The Overworld, 1: The End
 
 
  |-
 
  |-
  | Difficulty
+
  | 1
  | Unsigned Byte
+
  | Up
| 0: Peaceful, 1: Easy, 2: Normal, 3: Hard
 
 
  |-
 
  |-
  | Gamemode
+
  | 2
  | Unsigned Byte
+
  | North
  | 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
+
|-
 +
  | 3
 +
| South
 +
|-
 +
| 4
 +
| West
 
  |-
 
  |-
  | Level Type
+
  | 5
  | String (16)
+
  | East
| 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).
+
Play record: This is actually a special case within this packet. You can start/stop a record at a specific location. Use a valid {{Minecraft Wiki|Music Discs|Record ID}} to start a record (or overwrite a currently playing one), any other value will stop the record.  See [[Data Generators]] for information on item IDs.
  
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.}}
+
==== Particle ====
  
==== Entity Head Look ====
+
Displays the named particle
 
 
Changes the direction an entity's head is facing.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,020: Line 3,036:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x35
+
  |rowspan="11"| 0x24
  |rowspan="2"| Play
+
  |rowspan="11"| Play
  |rowspan="2"| Client
+
  |rowspan="11"| Client
  | Entity ID
+
  | Particle ID
  | VarInt
+
  | Int
  |  
+
  | The particle ID listed in [[#Particle|the particle data type]].
 
  |-
 
  |-
  | Head Yaw
+
  | Long Distance
  | Angle
+
  | Boolean
  | New angle, not a delta
+
  | If true, particle distance increases from 256 to 65536.
|}
 
 
 
==== 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"| 0x36
+
  | X
  |rowspan="2"| Play
+
| Double
  |rowspan="2"| Client
+
| X position of the particle.
  | Has id
+
|-
  | Boolean
+
  | Y
  | Indicates if the next field is present
+
| Double
 +
  | Y position of the particle.
 +
|-
 +
  | Z
 +
  | Double
 +
  | Z position of the particle.
 
  |-
 
  |-
  | Optional Identifier
+
  | Offset X
  | String (32767)
+
  | Float
  | See below
+
  | This is added to the X position after being multiplied by <code>random.nextGaussian()</code>.
|}
 
 
 
The Identifier can be one of the following:
 
 
 
{| class="wikitable"
 
! Optional Identifier
 
 
  |-
 
  |-
  | minecraft:story/root
+
  | Offset Y
 +
| Float
 +
| This is added to the Y position after being multiplied by <code>random.nextGaussian()</code>.
 
  |-
 
  |-
  | minecraft:nether/root
+
  | Offset Z
 +
| Float
 +
| This is added to the Z position after being multiplied by <code>random.nextGaussian()</code>.
 
  |-
 
  |-
  | minecraft:end/root
+
  | Particle Data
 +
| Float
 +
| The data of each particle.
 
  |-
 
  |-
  | minecraft:adventure/root
+
  | Particle Count
 +
| Int
 +
| The number of particles to create.
 
  |-
 
  |-
  | minecraft:husbandry/root
+
  | Data
 +
| Varies
 +
| The variable data listed in [[#Particle|the particle data type]].
 
  |}
 
  |}
  
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
+
==== Update Light ====
  
==== World Border ====
+
Updates light levels for a chunk.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,081: Line 3,093:
 
  ! Bound To
 
  ! Bound To
 
  !colspan="2"| Field Name
 
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="18"| 0x37
+
  |rowspan="17"| 0x25
  |rowspan="18"| Play
+
  |rowspan="17"| Play
  |rowspan="18"| Client
+
  |rowspan="17"| Client
  |colspan="2"| Action
+
  |colspan="2"| Chunk X
  | VarInt Enum
+
  |colspan="2"| VarInt
  | Determines the format of the rest of the packet
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  ! Action
+
  |colspan="2"| Chunk Z
  ! Field Name
+
  |colspan="2"| VarInt
  !
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
!
 
 
  |-
 
  |-
  | 0: set size
+
  |colspan="2"| Trust Edges
  | Diameter
+
  |colspan="2"| Boolean
| Double
+
  | If edges should be trusted for light updates.
  | Length of a single side of the world border, in meters
 
 
  |-
 
  |-
  |rowspan="3"| 1: lerp size
+
  |colspan="2"| Length 1
  | Old Diameter
+
  |colspan="2"| VarInt
| Double
+
  | Length of the following array
  | Current length of a single side of the world border, in meters
 
 
  |-
 
  |-
  | New Diameter
+
  |colspan="2"| Sky Light Mask
  | Double
+
  |colspan="2"| Array of Long
  | Target length of a single side of the world border, in meters
+
  | BitSet containing bits for each sections in the world + 2 (lowest bit 16-1 blocks below min world height, highest 1-16 above max world height)
 
  |-
 
  |-
  | Speed
+
  |colspan="2"| Length 2
  | VarLong
+
  |colspan="2"| VarInt
  | 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.
+
  | Length of the following array
 
  |-
 
  |-
  |rowspan="2"| 2: set center
+
  |colspan="2"| Block Light Mask
  | X
+
  |colspan="2"| Array of Long
| Double
+
  | BitSet containing bits for each sections in the world + 2, same order as sky light
  |  
 
 
  |-
 
  |-
  | Z
+
  |colspan="2"| Length 3
  | Double
+
  |colspan="2"| VarInt
  |  
+
  | Length of the following array
 
  |-
 
  |-
  |rowspan="8"| 3: initialize
+
  |colspan="2"| Empty Sky Light Mask
  | X
+
  |colspan="2"| Array of Long
| Double
+
  | BitSet containing a variable amount of bits (see sky/block light) which indicates sections that have 0 for all their sky light values
  |  
 
 
  |-
 
  |-
  | Z
+
  |colspan="2"| Length 4
  | Double
+
  |colspan="2"| VarInt
  |  
+
  | Length of the following array
 
  |-
 
  |-
  | Old Diameter
+
  |colspan="2"| Empty Block Light Mask
  | Double
+
  |colspan="2"| Array of Long
  | Current length of a single side of the world border, in meters
+
  | BitSet containing a variable amount of bits (see sky/block light) which indicates sections that have 0 for all their block light values
 
  |-
 
  |-
  | New Diameter
+
  |colspan="2"| Sky Light array count
  | Double
+
  |colspan="2"| VarInt
  | Target length of a single side of the world border, in meters
+
  | Number of entries in the following array
 
  |-
 
  |-
  | Speed
+
  |rowspan="2"| Sky Light arrays
| VarLong
+
  | Length
  | 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"| Array
  |-
 
| Portal Teleport Boundary
 
 
  | VarInt
 
  | VarInt
  | Resulting coordinates from a portal teleport are limited to ±value. Usually 29999984.
+
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | Warning Time
+
  | Sky Light array
  | VarInt
+
  | Array of 2048 bytes
  | In seconds as set by <code>/worldborder warning time</code>
+
  | 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.
 
  |-
 
  |-
  | Warning Blocks
+
  |colspan="2"| Block Light array count
  | VarInt
+
  |colspan="2"| VarInt
  | In meters
+
  | Number of entries in the following array
 
  |-
 
  |-
  |rowspan="1"| 4: set warning time
+
  |rowspan="2"| Block Light arrays
  | Warning Time
+
  | Length
 +
|rowspan="2"| Array
 
  | VarInt
 
  | VarInt
  | In seconds as set by <code>/worldborder warning time</code>
+
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  |rowspan="1"| 5: set warning blocks
+
  | Block Light array
  | Warning Blocks
+
  | Array of 2048 bytes
  | VarInt
+
  | 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.
  | In meters
 
 
  |}
 
  |}
  
The Notchian client determines how solid to display the warning by comparing to whichever is higher, the warning distance or whichever is lower, the distance from the current diameter to the target diameter or the place the border will be after warningTime seconds. In pseudocode:
+
==== Join Game ====
  
<syntaxhighlight lang="java">
+
See [[Protocol Encryption]] for information on logging in.
distance = max(min(resizeSpeed * 1000 * warningTime, abs(targetDiameter - currentDiameter)), warningDistance);
 
if (playerDistance < distance) {
 
    warning = 1.0 - playerDistance / distance;
 
} else {
 
    warning = 0.0;
 
}
 
</syntaxhighlight>
 
 
 
==== 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).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,196: Line 3,184:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x38
+
  |rowspan="16"| 0x26
  |rowspan="1"| Play
+
  |rowspan="16"| Play
  |rowspan="1"| Client
+
  |rowspan="16"| Client
  | Camera ID
+
  | Entity ID
 +
| Int
 +
| The player's Entity ID (EID).
 +
|-
 +
| Is hardcore
 +
| Boolean
 +
|
 +
|-
 +
| Gamemode
 +
| Unsigned Byte
 +
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
 +
|-
 +
| Previous Gamemode
 +
| Byte
 +
| 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included. The previous gamemode. Defaults to -1 if there is no previous gamemode. (More information needed)
 +
|-
 +
| World Count
 
  | VarInt
 
  | VarInt
  | ID of the entity to set the client's camera to
+
  | Size of the following array.
  |}
+
|-
 
+
| World Names
The notchian also loads certain shaders for given entities:
+
| Array of Identifier
 +
| Identifiers for all worlds on the server.
 +
|-
 +
| Dimension Codec
 +
| [[NBT|NBT Tag Compound]]
 +
| The full extent of these is still unknown, but the tag represents a dimension and biome registry. See below for the vanilla default.
 +
|-
 +
| Dimension
 +
| [[NBT|NBT Tag Compound]]
 +
| Valid dimensions are defined per dimension registry sent before this. The structure of this tag is a dimension type (see below).
 +
|-
 +
| World Name
 +
| Identifier
 +
| Name of the world 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
 +
|-
 +
| 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).
 +
|-
 +
| 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.
 +
|-
 +
| Enable respawn screen
 +
| Boolean
 +
| Set to false when the doImmediateRespawn gamerule is true.
 +
|-
 +
| Is Debug
 +
  | Boolean
 +
| True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
 +
|-
 +
| Is Flat
 +
| Boolean
 +
| True if the world is a {{Minecraft Wiki|superflat}} world; flat worlds have different void fog and a horizon at y=0 instead of y=63.
 +
|}
  
* 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
 
  
==== Held Item Change (clientbound) ====
+
The '''Dimension Codec''' NBT Tag Compound ([https://gist.githubusercontent.com/BomBardyGamer/c075a7a34b51f2df9d5aabdd2a762f4f/raw/c7352784dfadbca00d2282aeca04ed80081bfb09/dimension_codec.snbt Default value in SNBT]) includes two registries: "minecraft:dimension_type" and "minecraft:worldgen/biome".
 +
 
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| minecraft:dimension_type
 +
| TAG_Compound
 +
| The dimension type registry (see below).
 +
|-
 +
| minecraft:worldgen/biome
 +
| TAG_Compound
 +
| The biome registry (see below).
 +
|}
  
Sent to change the player's slot selection.
+
Dimension type registry:
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  !Name
  ! State
+
  !Type
  ! Bound To
+
  !style="width: 250px;" colspan="2"| Notes
  ! Field Name
+
|-
  ! Field Type
+
  | type
  ! Notes
+
  | TAG_String
 +
  | The name of the registry. Always "minecraft:dimension_type".
 
  |-
 
  |-
  |rowspan="1"| 0x39
+
  | value
|rowspan="1"| Play
+
  | TAG_List
|rowspan="1"| Client
+
  | List of dimension types registry entries (see below).
| Slot
 
  | Byte
 
  | The slot which the player has selected (0–8)
 
 
  |}
 
  |}
  
==== Display Scoreboard ====
+
Dimension type registry entry:
 
 
This is sent to the client when it should display a scoreboard.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  !Name
  ! State
+
  !Type
  ! Bound To
+
  !style="width: 250px;" colspan="2"| Notes
  ! Field Name
+
|-
  ! Field Type
+
  | name
  ! Notes
+
  | TAG_String
 +
  | The name of the dimension type (for example, "minecraft:overworld").
 
  |-
 
  |-
  |rowspan="2"| 0x3A
+
  | id
|rowspan="2"| Play
+
  | TAG_Int
|rowspan="2"| Client
+
  | The protocol ID of the dimension (matches the index of the element in the registry list).
| Position
 
  | Byte
 
  | The position of the scoreboard. 0: list, 1: sidebar, 2: below name.
 
 
  |-
 
  |-
  | Score Name
+
  | element
  | String (16)
+
  | TAG_Compound
  | The unique name for the scoreboard to be displayed.
+
  | The dimension type (see below).
 
  |}
 
  |}
  
==== Entity Metadata ====
+
Dimension type:
 
 
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.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Name
  ! State
+
  ! Type
  ! Bound To
+
  !style="width: 250px;" colspan="2"| Meaning
  ! Field Name
+
  ! Values
  ! Field Type
+
|-
  ! Notes
+
| piglin_safe
 +
| TAG_Byte
 +
  |colspan="2"| Whether piglins shake and transform to zombified piglins.
 +
  | 1: true, 0: false.
 
  |-
 
  |-
  |rowspan="2"| 0x3B
+
  | natural
  |rowspan="2"| Play
+
  | TAG_Byte
  |rowspan="2"| Client
+
  |colspan="2"| When false, compasses spin randomly. When true, nether portals can spawn zombified piglins.
| Entity ID
+
  | 1: true, 0: false.
| VarInt
 
  |  
 
 
  |-
 
  |-
  | Metadata
+
  | ambient_light
  | [[Entities#Entity Metadata Format|Entity Metadata]]
+
  | TAG_Float
  |  
+
  |colspan="2"| How much light the dimension has.
  |}
+
  | 0.0 to 1.0.
 
 
==== Attach Entity ====
 
 
 
This packet is sent when an entity has been {{Minecraft Wiki|Lead|leashed}} to another entity.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x3C
+
  | fixed_time
  |rowspan="2"| Play
+
| Optional TAG_Long
  |rowspan="2"| Client
+
|colspan="2"| If set, the time of the day is the specified value.
  | Attached Entity ID
+
| If set, 0 to 24000.
  | Int
+
|-
  | Attached entity's EID
+
| infiniburn
 +
| TAG_String
 +
|colspan="2"| A resource location defining what block tag to use for infiniburn.
 +
| "" or minecraft resource "minecraft:...".
 +
|-
 +
| respawn_anchor_works
 +
| TAG_Byte
 +
|colspan="2"| Whether players can charge and use respawn anchors.
 +
| 1: true, 0: false.
 +
|-
 +
| has_skylight
 +
| TAG_Byte
 +
|colspan="2"| Whether the dimension has skylight access or not.
 +
| 1: true, 0: false.
 +
|-
 +
| bed_works
 +
| TAG_Byte
 +
|colspan="2"| Whether players can use a bed to sleep.
 +
| 1: true, 0: false.
 +
|-
 +
| effects
 +
| TAG_String
 +
|colspan="2"| ?
 +
| "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" or something else.
 +
|-
 +
| has_raids
 +
| TAG_Byte
 +
|colspan="2"| Whether players with the Bad Omen effect can cause a raid.
 +
| 1: true, 0: false.
 +
|-
 +
| min_y
 +
  | TAG_Int
 +
|colspan="2"| The minimum Y level.
 +
  |
 +
|-
 +
| height
 +
| TAG_Int
 +
|colspan="2"| The maximum height.
 +
  |
 +
  |-
 +
| logical_height
 +
| TAG_Int
 +
|colspan="2"| The maximum height to which chorus fruits and nether portals can bring players within this dimension.
 +
| 0-256.
 +
|-
 +
| coordinate_scale
 +
| TAG_Float
 +
|colspan="2"| The multiplier applied to coordinates when traveling to the dimension.
 +
| 0.00001 - 30000000.0
 +
|-
 +
| ultrawarm
 +
| TAG_Byte
 +
|colspan="2"| Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also causes lava to spread thinner.
 +
  | 1: true, 0: false.
 
  |-
 
  |-
  | Holding Entity ID
+
  | has_ceiling
  | Int
+
  | TAG_Byte
  | ID of the entity holding the lead. Set to -1 to detach.
+
  |colspan="2"| Whether the dimension has a bedrock ceiling or not. When true, causes lava to spread faster.
 +
| 1: true, 0: false.
 
  |}
 
  |}
  
==== Entity Velocity ====
+
Biome registry:
 +
 
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| type
 +
| TAG_String
 +
| The name of the registry. Always "minecraft:worldgen/biome".
 +
|-
 +
| value
 +
| TAG_List
 +
| List of biome registry entries (see below).
 +
|}
  
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).
+
Biome registry entry:
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  !Name
! State
+
  !Type
! Bound To
+
  !style="width: 250px;" colspan="2"| Notes
! Field Name
 
  ! Field Type
 
  ! Notes
 
|-
 
|rowspan="4"| 0x3D
 
|rowspan="4"| Play
 
|rowspan="4"| Client
 
| Entity ID
 
| VarInt
 
|
 
 
  |-
 
  |-
  | Velocity X
+
  | name
  | Short
+
  | TAG_String
  | Velocity on the X axis
+
  | The name of the biome (for example, "minecraft:ocean").
 
  |-
 
  |-
  | Velocity Y
+
  | id
  | Short
+
  | TAG_Int
  | Velocity on the Y axis
+
  | The protocol ID of the biome (matches the index of the element in the registry list).
 
  |-
 
  |-
  | Velocity Z
+
  | element
  | Short
+
  | TAG_Compound
  | Velocity on the Z axis
+
  | The biome properties (see below).
 
  |}
 
  |}
  
==== Entity Equipment ====
+
Biome properties:
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  !colspan="2"|Name
  ! State
+
  !colspan="2"|Type
  ! Bound To
+
  !style="width: 250px;" colspan="2"| Meaning
  ! Field Name
+
  !colspan="2"|Values
  ! Field Type
+
|-
  ! Notes
+
|colspan="2"|precipitation
 +
|colspan="2"|TAG_String
 +
|colspan="2"| The type of precipitation in the biome.
 +
|colspan="2"|"rain", "snow", or "none".
 +
|-
 +
|colspan="2"| depth
 +
|colspan="2"| TAG_Float
 +
|colspan="2"| The depth factor of the biome.
 +
|colspan="2"| The default values vary between 1.5 and -1.8.
 +
|-
 +
|colspan="2"| temperature
 +
|colspan="2"| TAG_Float
 +
|colspan="2"| The temperature factor of the biome.
 +
|colspan="2"| The default values vary between 2.0 and -0.5.
 +
|-
 +
|colspan="2"| scale
 +
|colspan="2"| TAG_Float
 +
|colspan="2"| ?
 +
|colspan="2"| The default values vary between 1.225 and 0.0.
 +
|-
 +
|colspan="2"| downfall
 +
|colspan="2"| TAG_Float
 +
|colspan="2"| ?
 +
|colspan="2"| The default values vary between 1.0 and 0.0.
 +
|-
 +
|colspan="2"| category
 +
|colspan="2"| TAG_String
 +
|colspan="2"| The category of the biome.
 +
|colspan="2"| Known values are "ocean", "plains", "desert", "forest", "extreme_hills", "taiga", "swamp", "river", "nether", "the_end", "icy", "mushroom", "beach", "jungle", "mesa", "savanna", and "none".
 +
|-
 +
|colspan="2"| temperature_modifier
 +
|colspan="2"| Optional TAG_String
 +
|colspan="2"| ?
 +
|colspan="2"| The only known value is "frozen".
 +
|-
 +
|rowspan="11"| effects
 +
| sky_color
 +
|rowspan="11"| TAG_Compound
 +
| TAG_Int
 +
|colspan="2"| The color of the sky.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| water_fog_color
 +
| TAG_Int
 +
|colspan="2"| Possibly the tint color when swimming.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| fog_color
 +
| TAG_Int
 +
|colspan="2"| Possibly the color of the fog effect when looking past the view distance.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| water_color
 +
| TAG_Int
 +
|colspan="2"| The tint color of the water blocks.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| foliage_color
 +
| Optional TAG_Int
 +
|colspan="2"| The tint color of the grass.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| grass_color
 +
| Optional TAG_Int
 +
| colspan="2"| ?
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| grass_color_modifier
 +
| Optional TAG_String
 +
|colspan="2"| Unknown, likely affects foliage color.
 +
| If set, known values are "swamp" and "dark_forest".
 +
|-
 +
| music
 +
| Optional TAG_Compound
 +
|colspan="2"| Music properties for the biome.
 +
| If present, contains the fields: replace_current_music (TAG_Byte), sound (TAG_String), max_delay (TAG_Int), min_delay (TAG_Int).
 +
|-
 +
| ambient_sound
 +
| Optional TAG_String
 +
  |colspan="2"| Ambient soundtrack.
 +
  | If present, the ID of a soundtrack. Example: "minecraft:ambient.basalt_deltas.loop".
 
  |-
 
  |-
  |rowspan="3"| 0x3E
+
  | additions_sound
  |rowspan="3"| Play
+
  | Optional TAG_Compound
  |rowspan="3"| Client
+
  |colspan="2"| Additional ambient sound that plays randomly.
| Entity ID
+
  | If present, contains the fields: sound (TAG_String), tick_chance (TAG_Double).
| VarInt
 
  | Entity's EID
 
 
  |-
 
  |-
  | Slot
+
  | mood_sound
  | VarInt Enum
+
  | Optional TAG_Compound
  | Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet)
+
  |colspan="2"| Additional ambient sound that plays at an interval.
 +
| If present, contains the fields: sound (TAG_String), tick_delay (TAG_Int), offset (TAG_Double), block_search_extent (TAG_Int).
 
  |-
 
  |-
  | Item
+
  | particle
  | [[Slot Data|Slot]]
+
  | Optional TAG_Compound
  |  
+
|colspan="2"| Particles that appear randomly in the biome.
 +
  | If present, contains the fields: probability (TAG_Float), options (TAG_Compound). The "options" compound contains the field "type" (TAG_String), which identifies the particle type.
 
  |}
 
  |}
  
==== Set Experience ====
+
==== Map Data ====
  
Sent by the server when the client should change experience levels.
+
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,369: Line 3,544:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x3F
+
  |rowspan="17"| 0x27
  |rowspan="3"| Play
+
  |rowspan="17"| Play
  |rowspan="3"| Client
+
  |rowspan="17"| Client
  | Experience bar
+
  |colspan="2"| Map ID
  | Float
+
  |colspan="2"| VarInt
  | Between 0 and 1
+
  | Map ID of the map being modified
 
  |-
 
  |-
  | Level
+
  |colspan="2"| Scale
  | VarInt
+
  |colspan="2"| Byte
  |  
+
  | From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
 
  |-
 
  |-
  | Total Experience
+
  |colspan="2"| Locked
| VarInt
+
  |colspan="2"| Boolean
  | See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion
+
  | True if the map has been locked in a cartography table
  |}
+
|-
 
+
|colspan="2"| Tracking Position
==== Update Health ====
+
  |colspan="2"| Boolean
 
+
  | Specifies whether player and item frame icons are shown
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"| 0x40
+
  |colspan="2"| Icon Count
  |rowspan="3"| Play
+
  |colspan="2"| VarInt
  |rowspan="3"| Client
+
  | Number of elements in the following array. Only present if "Tracking Position" is true.
| Health
 
| Float
 
| 0 or less = dead, 20 = full HP
 
 
  |-
 
  |-
  | Food
+
  |rowspan="6"| Icon
| VarInt
+
  | Type
  | 0–20
+
  |rowspan="6"| Array
  |-
+
  | VarInt enum
| Food Saturation
+
  | See below
  | 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"| 0x41
+
  | X
  |rowspan="4"| Play
+
| Byte
  |rowspan="4"| Client
+
  | Map coordinates: -128 for furthest left, +127 for furthest right
  | Objective Name
+
  |-
  | String (16)
+
  | Z
  | An unique name for the objective
+
  | Byte
 +
  | Map coordinates: -128 for highest, +127 for lowest
 
  |-
 
  |-
  | Mode
+
  | Direction
 
  | Byte
 
  | Byte
  | 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
+
  | 0-15
 +
|-
 +
| Has Display Name
 +
| Boolean
 +
|
 +
|-
 +
| Display Name
 +
| Optional [[Chat]]
 +
| Only present if previous Boolean is true
 +
|-
 +
|colspan="2"| Columns
 +
|colspan="2"| Unsigned Byte
 +
| Number of columns updated
 +
|-
 +
|colspan="2"| Rows
 +
|colspan="2"| Optional Byte
 +
| Only if Columns is more than 0; number of rows updated
 +
|-
 +
|colspan="2"| X
 +
|colspan="2"| Optional Byte
 +
| Only if Columns is more than 0; x offset of the westernmost column
 +
|-
 +
|colspan="2"| Z
 +
|colspan="2"| Optional Byte
 +
| Only if Columns is more than 0; z offset of the northernmost row
 
  |-
 
  |-
  | Objective Value
+
  |colspan="2"| Length
  | Optional String (32)
+
  |colspan="2"| Optional VarInt
  | Only if mode is 0 or 2. The text to be displayed for the score
+
  | Only if Columns is more than 0; length of the following array
 
  |-
 
  |-
  | Type
+
  |colspan="2"| Data
  | Optional String (16)
+
  |colspan="2"| Optional Array of Unsigned Byte
  | Only if mode is 0 or 2. “integer” or “hearts”
+
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
 
  |}
 
  |}
  
==== Set Passengers ====
+
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
 +
 
 +
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="3"| 0x42
+
  ! Icon type
  |rowspan="3"| Play
+
  ! Result
|rowspan="3"| Client
 
| Entity ID
 
| VarInt
 
| Vehicle's EID
 
 
  |-
 
  |-
  | Passenger Count
+
  | 0
  | VarInt
+
  | White arrow (players)
| Number of elements in the following array
 
 
  |-
 
  |-
  | Passengers
+
  | 1
  | Array of VarInt
+
  | Green arrow (item frames)
| EIDs of entity's passengers
 
|}
 
 
 
==== Teams ====
 
 
 
Creates and updates teams.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="23"| 0x43
+
  | 2
|rowspan="23"| Play
+
  | Red arrow
|rowspan="23"| Client
 
|colspan="2"| Team Name
 
| String (16)
 
  | A unique name for the team. (Shared with scoreboard).
 
 
  |-
 
  |-
  |colspan="2"| Mode
+
  | 3
| Byte
+
  | Blue arrow
  | Determines the layout of the remaining packet
 
 
  |-
 
  |-
  |rowspan="9"| 0: create team
+
  | 4
| Team Display Name
+
  | White cross
| String (32)
 
  |  
 
 
  |-
 
  |-
  | Team Prefix
+
  | 5
  | String (16)
+
  | Red pointer
| Displayed before the names of players that are part of this team
 
 
  |-
 
  |-
  | Team Suffix
+
  | 6
  | String (16)
+
  | White circle (off-map players)
| Displayed after the names of players that are part of this team
 
 
  |-
 
  |-
  | Friendly Flags
+
  | 7
  | Byte
+
  | Small white circle (far-off-map players)
| Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team
 
 
  |-
 
  |-
  | Name Tag Visibility
+
  | 8
  | String Enum (32)
+
  | Mansion
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
 
 
  |-
 
  |-
  | Collision Rule
+
  | 9
  | String Enum (32)
+
  | Temple
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 
 
  |-
 
  |-
  | Color
+
  | 10
  | Byte
+
  | White Banner
| For colors, the same [[Chat]] colors (0-15).  -1 indicates RESET/no color.
 
 
  |-
 
  |-
  | Entity Count
+
  | 11
  | VarInt
+
  | Orange Banner
| Number of elements in the following array
 
 
  |-
 
  |-
  | Entities
+
  | 12
  | Array of String (40)
+
  | Magenta Banner
| Identifiers for the entities in this team.  For players, this is their username; for other entities, it is their UUID.
 
 
  |-
 
  |-
  | 1: remove team
+
  | 13
| ''no fields''
+
  | Light Blue Banner
| ''no fields''
 
  |  
 
 
  |-
 
  |-
  |rowspan="7"| 2: update team info
+
  | 14
| Team Display Name
+
  | Yellow Banner
| String (32)
 
  |  
 
 
  |-
 
  |-
  | Team Prefix
+
  | 15
  | String (16)
+
  | Lime Banner
| Displayed before the names of entities that are part of this team
 
 
  |-
 
  |-
  | Team Suffix
+
  | 16
| String (16)
+
  | Pink Banner
  | Displayed after the names of entities that are part of this team
 
 
  |-
 
  |-
  | Friendly Flags
+
  | 17
  | Byte
+
  | Gray Banner
| Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible entities on same team
 
 
  |-
 
  |-
  | Name Tag Visibility
+
  | 18
  | String Enum (32)
+
  | Light Gray Banner
  | <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
+
  |-
 +
| 19
 +
| Cyan Banner
 +
|-
 +
| 20
 +
| Purple Banner
 
  |-
 
  |-
  | Collision Rule
+
  | 21
  | String Enum (32)
+
  | Blue Banner
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 
 
  |-
 
  |-
  | Color
+
  | 22
  | Byte
+
  | Brown Banner
| For colors, the same [[Chat]] colors (0-15).  -1 indicates RESET/no color.
 
 
  |-
 
  |-
  |rowspan="2"| 3: add players to team
+
  | 23
| Entity Count
+
  | Green Banner
| VarInt
 
  | Number of elements in the following array
 
 
  |-
 
  |-
  | Entities
+
  | 24
  | Array of String (40)
+
  | Red Banner
| 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
+
  | 25
| Entity Count
+
  | Black Banner
| VarInt
 
  | Number of elements in the following array
 
 
  |-
 
  |-
  | Entities
+
  | 26
  | Array of String (40)
+
  | Treasure marker
| Identifiers for the entities removed.  For players, this is their username; for other entities, it is their UUID.
 
 
  |}
 
  |}
  
==== Update Score ====
+
==== Trade List ====
  
This is sent to the client when it should update a scoreboard item.  
+
The list of trades a villager NPC is offering.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,598: Line 3,721:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x44
+
  |rowspan="18"| 0x28
  |rowspan="4"| Play
+
  |rowspan="18"| Play
  |rowspan="4"| Client
+
  |rowspan="18"| Client
  | Entity Name
+
  |-
  | String (40)
+
  | colspan="2" | Window ID
  | The entity whose score this is.  For players, this is their username; for other entities, it is their UUID.
+
| colspan="2" | VarInt
 +
  | The ID of the window that is open; this is an int rather than a byte.
 
  |-
 
  |-
  | Action
+
  | colspan="2" | Size
  | Byte
+
  | colspan="2" | Byte
  | 0 to create/update an item. 1 to remove an item.
+
  | The number of trades in the following array.
 
  |-
 
  |-
  | Objective Name
+
  | rowspan="11" | Trades
  | String (16)
+
  | Input item 1
  | The name of the objective the score belongs to
+
  | rowspan="11" | 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.
 
  |-
 
  |-
  | Value
+
  | Output item
  | Optional VarInt
+
| [[Slot]]
  | The score to be displayed next to the entry. Only sent when Action does not equal 1.
+
| The item the player will receive from this villager trade.
 +
|-
 +
| Has second item
 +
| Boolean
 +
| Whether there is a second item.
 +
|-
 +
| Input item 2
 +
  | Optional [[Slot]]
 +
  | The second item the player has to supply for this villager trade; only present if has a second item is true.
 +
|-
 +
| Trade disabled
 +
| Boolean
 +
| True if the trade is disabled; false if the trade is enabled.
 +
|-
 +
| Number of trade uses
 +
| Integer
 +
| 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
 +
| Integer
 +
| Number of times this trade can be used before it's exhausted.
 +
|-
 +
| XP
 +
| Integer
 +
| Amount of XP both the player and the villager will earn each time the trade is used.
 +
|-
 +
| Special Price
 +
| Integer
 +
| 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
 +
| Integer
 +
| Can be zero or a positive number. Causes the price to increase when a trade is used repeatedly.
 +
|-
 +
|colspan="2"| Villager level
 +
|colspan="2"| VarInt
 +
| Appears on the trade GUI; meaning comes from the translation key <code>merchant.level.</code> + level.
 +
1: Novice, 2: Apprentice, 3: Journeyman, 4: Expert, 5: Master.
 +
|-
 +
|colspan="2"| Experience
 +
|colspan="2"| VarInt
 +
| Total experience for this villager (always 0 for the wandering trader).
 +
|-
 +
|colspan="2"| Is regular villager
 +
|colspan="2"| Boolean
 +
| True if this is a regular villager; false for the wandering trader.  When false, hides the villager level and some other GUI elements.
 +
|-
 +
|colspan="2"| Can restock
 +
|colspan="2"| 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.
 
  |}
 
  |}
  
==== Spawn Position ====
+
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]]
 +
{{-}}
 +
 
 +
==== 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 [[#Entity Teleport|Entity Teleport]] should be sent instead.
  
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 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,634: Line 3,822:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x45
+
  |rowspan="5"| 0x29
  |rowspan="1"| Play
+
  |rowspan="5"| Play
  |rowspan="1"| Client
+
  |rowspan="5"| Client
  | Location
+
  | Entity ID
  | Position
+
  | VarInt
  | Spawn location
+
  |  
  |}
+
  |-
 
+
| Delta X
==== Time Update ====
+
| Short
 
+
| Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>.
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.
+
|-
 
+
  | Delta Y
The time of day is based on the timestamp modulo 24000. 0 is sunrise, 6000 is noon, 12000 is sunset, and 18000 is midnight.
+
  | Short
 
+
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>.
The default SMP server increments the time by <code>20</code> every second.
 
 
 
{| class="wikitable"
 
  ! Packet ID
 
  ! State
 
  ! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x46
+
  | Delta Z
|rowspan="2"| Play
+
  | Short
|rowspan="2"| Client
+
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>.
| World Age
 
  | Long
 
  | In ticks; not changed by server commands
 
 
  |-
 
  |-
  | Time of day
+
  | On Ground
  | Long
+
  | Boolean
  | The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time
+
  |  
 
  |}
 
  |}
  
==== Title ====
+
==== 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. (<code>-32768 / (32 * 128) == -8</code>)
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,676: Line 3,854:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="10"| 0x47
+
  |rowspan="7"| 0x2A
  |rowspan="10"| Play
+
  |rowspan="7"| Play
  |rowspan="10"| Client
+
  |rowspan="7"| Client
  |colspan="2"| Action
+
  | Entity ID
  | VarInt Enum
+
  | VarInt
 
  |  
 
  |  
 
  |-
 
  |-
  ! Action
+
  | Delta X
  ! Field Name
+
  | Short
  !
+
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>.
!
 
 
  |-
 
  |-
  | 0: set title
+
  | Delta Y
  | Title Text
+
  | Short
| [[Chat]]
+
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>.
  |  
 
 
  |-
 
  |-
  | 1: set subtitle
+
  | Delta Z
  | Subtitle Text
+
  | Short
  | [[Chat]]
+
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>.
|
 
|-
 
| 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
+
  | Yaw
| Fade In
+
  | Angle
  | Int
+
  | New angle, not a delta.
  | Ticks to spend fading in
 
 
  |-
 
  |-
  | Stay
+
  | Pitch
  | Int
+
  | Angle
  | Ticks to keep the title displayed
+
  | New angle, not a delta.
 
  |-
 
  |-
  | Fade Out
+
  | On Ground
  | Int
+
  | Boolean
| 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.
+
==== Entity Rotation ====
  
The title is visible on screen for Fade In + Stay + Fade Out ticks.
+
This packet is sent by the server when an entity rotates.
 
 
==== Sound Effect ====
 
 
 
This packet is used to play a number of hardcoded sound events. For custom sounds, use [[#Named Sound Effect|Named Sound Effect]].
 
 
 
{{Warning|Numeric sound effect IDs are liable to change between versions}}
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,749: Line 3,902:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x48
+
  |rowspan="4"| 0x2B
  |rowspan="7"| Play
+
  |rowspan="4"| Play
  |rowspan="7"| Client
+
  |rowspan="4"| Client
  | Sound ID
+
  | Entity ID
 
  | VarInt
 
  | VarInt
  | ID of hardcoded sound event ([http://pokechu22.github.io/Burger/1.12.html#sounds events] as of 1.12.0)
+
  |  
 
  |-
 
  |-
  | Sound Category
+
  | Yaw
  | VarInt Enum
+
  | Angle
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
  | New angle, not a delta.
 
  |-
 
  |-
  | Effect Position X
+
  | Pitch
  | Int
+
  | Angle
  | Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  | New angle, not a delta.
 
  |-
 
  |-
  | Effect Position Y
+
  | On Ground
  | Int
+
  | Boolean
  | Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
+
  |  
|-
 
| Effect Position Z
 
| Int
 
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 
|-
 
| Volume
 
| Float
 
| 1.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 ====
+
==== Vehicle Move (clientbound) ====
  
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.
+
Note that all fields use absolute positioning and do not allow for relative positioning.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,794: Line 3,934:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x49
+
  |rowspan="5"| 0x2C
  |rowspan="2"| Play
+
  |rowspan="5"| Play
  |rowspan="2"| Client
+
  |rowspan="5"| Client
  | Header
+
  | X
  | [[Chat]]
+
  | Double
  | To remove the header, send a empty translatable component: {"translate":""}
+
  | 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.
 
  |-
 
  |-
  | Footer
+
  | Pitch
  | [[Chat]]
+
  | Float
  | To remove the footer, send a empty translatable component: {"translate":""}
+
  | Absolute rotation on the horizontal axis, in degrees.
 
  |}
 
  |}
  
==== Collect Item ====
+
==== Open Book ====
  
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.
+
Sent when a player right clicks with a signed book. This tells the client to open the book GUI.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,818: Line 3,970:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x4A
+
| 0x2D
 +
| Play
 +
| Client
 +
| Hand
 +
| VarInt enum
 +
| 0: Main hand, 1: Off hand .
 +
|}
 +
 
 +
==== Open Window ====
 +
 
 +
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.  For horses, use [[#Open Horse Window|Open Horse Window]].
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
  |rowspan="3"| 0x2E
 
  |rowspan="3"| Play
 
  |rowspan="3"| Play
 
  |rowspan="3"| Client
 
  |rowspan="3"| Client
  | Collected Entity ID
+
  | Window ID
 
  | VarInt
 
  | VarInt
  |  
+
  | A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
  |-  
+
  |-
  | Collector Entity ID
+
  | Window Type
 
  | VarInt
 
  | VarInt
  |  
+
  | The window type to use for display. Contained in the <code>minecraft:menu</code> registry; see [[Inventory]] for the different values.
  |-  
+
  |-
  | Pickup Item Count
+
  | Window Title
  | VarInt
+
  | [[Chat]]
  | Seems to be 1 for XP orbs, otherwise the number of items in the stack.
+
  | The title of the window.
 
  |}
 
  |}
  
==== Entity Teleport ====
+
==== Open Sign Editor ====
  
This packet is sent by the server when an entity moves more than 4 blocks.
+
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].  There must already be a sign at the given location (which the client does not do automatically) - send a [[#Block Change|Block Change]] first.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,846: Line 4,018:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x4B
+
  | 0x2F
  |rowspan="7"| Play
+
  | Play
  |rowspan="7"| Client
+
  | Client
  | Entity ID
+
  | Location
| VarInt
+
  | Position
|
 
|-
 
| X
 
  | Double
 
 
  |  
 
  |  
 +
|}
 +
 +
==== Ping ====
 +
 +
Unknown what this packet does just yet, not used by the Notchian server or client. Most likely added as a replacement to the removed window confirmation packet.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Y
+
  | 0x30
  | Double
+
  | Play
  |  
+
  | Client
  |-
+
  | ID
  | Z
+
  | Int
| Double
+
  |
|
 
|-
 
| Yaw
 
| Angle
 
| New angle, not a delta
 
|-
 
| Pitch
 
| Angle
 
| New angle, not a delta
 
|-
 
| On Ground
 
| Boolean
 
  |  
 
 
  |}
 
  |}
  
==== Advancements ====
+
==== Craft Recipe Response ====
 +
 
 +
Response to the serverbound packet ([[#Craft Recipe Request|Craft Recipe Request]]), with the same recipe ID.  Appears to be used to notify the UI.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,884: Line 4,054:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="9"| 0x4C
+
  |rowspan="2"| 0x31
  |rowspan="9"| Play
+
  |rowspan="2"| Play
  |rowspan="9"| Client
+
  |rowspan="2"| Client
  |colspan="2"| Reset/Clear
+
  | Window ID
  |colspan="2"| Boolean
+
  | Byte
  | Whether to reset/clear the current advancements
+
  |
 
  |-
 
  |-
  |colspan="2"| Mapping size
+
  | Recipe
|colspan="2"| VarInt
 
| Size of the following array
 
|-
 
|rowspan="2"| Advancement mapping
 
| Key
 
|rowspan="2"| Array
 
| Identifier
 
| The identifier of the advancement
 
|-
 
| Value
 
| Advancement
 
| See below
 
|-
 
|colspan="2"| List size
 
|colspan="2"| VarInt
 
| Size of the following array
 
|-
 
|colspan="2"| Identifiers
 
|colspan="2"| Array of Identifier
 
| The identifiers of the advancements that should be removed
 
|-
 
|colspan="2"| Progress size
 
|colspan="2"| VarInt
 
| Size of the following array
 
|-
 
|rowspan="2"| Progress mapping
 
| Key
 
|rowspan="2"| Array
 
 
  | Identifier
 
  | Identifier
  | The identifier of the advancement
+
  | A recipe ID.
|-
 
| Value
 
| Advancement progress
 
| See below
 
 
  |}
 
  |}
  
Advancement structure:
+
==== Player Abilities (clientbound) ====
 +
 
 +
The latter 2 floats are used to indicate the field of view and flying speed respectively, while the first byte is used to determine the value of 4 booleans.
  
 
{| class="wikitable"
 
{| class="wikitable"
  !colspan="2"| Field Name
+
  ! Packet ID
  !colspan="2"| Field Type
+
! State
 +
! Bound To
 +
! Field Name
 +
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |colspan="2"| Has parent
+
  |rowspan="3"| 0x32
  |colspan="2"| Boolean
+
  |rowspan="3"| Play
  | Indicates whether the next field exists.
+
  |rowspan="3"| Client
 +
| Flags
 +
| Byte
 +
| Bit field, see below.
 
  |-
 
  |-
  |colspan="2"| Parent id
+
  | Flying Speed
  |colspan="2"| Optional Identifier
+
  | Float
  | The identifier of the parent advancement.
+
  | 0.05 by default.
 
  |-
 
  |-
  |colspan="2"| Has display
+
  | Field of View Modifier
  |colspan="2"| Boolean
+
| Float
  | Indicates whether the next field exists
+
  | Modifies the field of view, like a speed potion. A Notchian server will use the same value as the movement speed sent in the [[#Entity_Properties|Entity Properties]] packet, which defaults to 0.1 for players.
 +
  |}
 +
 
 +
About the flags:
 +
 
 +
{| class="wikitable"
 
  |-
 
  |-
  |colspan="2"| Display data
+
  ! Field
  |colspan="2"| Optional advancement display
+
  ! Bit
| See below.
 
 
  |-
 
  |-
  |colspan="2"| Number of criteria
+
  | Invulnerable
|colspan="2"| VarInt
+
  | 0x01
  | Size of the following array
 
 
  |-
 
  |-
  |rowspan="2"| Criteria
+
  | Flying
| Key
+
  | 0x02
|rowspan="2"| Array
 
| Identifier
 
  | The identifier of the criterion
 
 
  |-
 
  |-
  | Value
+
  | Allow Flying
  | '''Void'''
+
  | 0x04
| There is ''no'' content written here.  Perhaps this will be expanded in the future?
 
 
  |-
 
  |-
  |colspan="2"| Array length
+
  | Creative Mode (Instant Break)
|colspan="2"| VarInt
+
  | 0x08
| Number of arrays in the following array
 
|-
 
|rowspan="2"| Requirements
 
| Array length 2
 
|rowspan="2"| Array
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Requirement
 
| Array of String
 
  | Array of required criteria
 
 
  |}
 
  |}
  
Advancement display:
+
==== End Combat Event ====
 +
 
 +
Unused by the Notchain client.  This data was once used for twitch.tv metadata circa 1.8.f
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Field Name
+
! Packet ID
 +
! State
 +
! Bound To
 +
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | Title
+
  |rowspan="2"| 0x33
  | Chat
+
|rowspan="2"| Play
  |
+
|rowspan="2"| Client
 +
| Duration
 +
  | VarInt
 +
  | Length of the combat in ticks.
 
  |-
 
  |-
  | Description
+
  | Entity ID
| Chat
+
  | Int
  |
+
  | ID of the primary opponent of the ended combat, or -1 if there is no obvious primary opponent.
  |-
 
| Icon
 
| [[Slot]]
 
|
 
|-
 
| Frame type
 
| VarInt enum
 
| 0 = <code>task</code>, 1 = <code>challenge</code>, 2 = <code>goal</code>
 
|-
 
| Flags
 
| Integer
 
| 0x1: has background texture; 0x2: <code>show_toast</code>; 0x4: <code>hidden</code>
 
|-
 
| Background texture
 
| Optional Identifier
 
| Background texture location.  Only if flags indicates it.
 
|-
 
| X coord
 
| Float
 
|
 
|-
 
| Y coord
 
| Float
 
|
 
 
  |}
 
  |}
  
Advancement progress:
+
==== Enter Combat Event ====
 +
 
 +
Unused by the Notchain client.  This data was once used for twitch.tv metadata circa 1.8.
  
 
{| class="wikitable"
 
{| class="wikitable"
  !colspan="2"| Field Name
+
  ! Packet ID
  !colspan="2"| Field Type
+
! State
 +
! Bound To
 +
! Field Name
 +
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |colspan="2"| Size
+
  |rowspan="1"| 0x34
  |colspan="2"| VarInt
+
  |rowspan="1"| Play
| Size of the following array
+
  |rowspan="1"| Client
|-
+
  |colspan="3"| ''no fields''
  |rowspan="2"| Criteria
 
  | Criterion identifier
 
|rowspan="2"| Array
 
| Identifier
 
| The identifier of the criterion.
 
|-
 
| Criterion progress
 
| Criterion progress
 
|
 
 
  |}
 
  |}
  
Criterion progress:
+
==== Death Combat Event ====
 +
 
 +
Used to send a respawn screen.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 
  ! Field Name
 
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | Achieved
+
  |rowspan="3"| 0x35
  | Boolean
+
|rowspan="3"| Play
  | If true, next field is present
+
|rowspan="3"| Client
 +
| Player ID
 +
| VarInt
 +
| Entity ID of the player that died (should match the client's entity ID).
 +
|-
 +
| Entity ID
 +
  | Int
 +
  | The killing entity's ID, or -1 if there is no obvious killer.
 
  |-
 
  |-
  | Date of achieving
+
  | Message
  | Optional Long
+
  | [[Chat]]
  | As returned by [https://docs.oracle.com/javase/6/docs/api/java/util/Date.html#getTime() <code>Date.getTime</code>]
+
  | The death message.
 
  |}
 
  |}
  
==== Entity Properties ====
+
==== Player Info ====
  
Sets {{Minecraft Wiki|Attribute|attributes}} on the given entity.
+
Sent by the server to update the user list (<tab> in the client).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,070: Line 4,196:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  !colspan="4"| Field Name
  !colspan="2"| Field Type
+
  !colspan="3"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x4D
+
  |rowspan="19"| 0x36
  |rowspan="6"| Play
+
  |rowspan="19"| Play
  |rowspan="6"| Client
+
  |rowspan="19"| Client
  |colspan="2"| Entity ID
+
  |colspan="4"| Action
  |colspan="2"| VarInt
+
|colspan="3"| VarInt
  |  
+
| Determines the rest of the Player format after the UUID.
 +
|-
 +
|colspan="4"| Number Of Players
 +
|colspan="3"| VarInt
 +
| Number of elements in the following array.
 +
|-
 +
|rowspan="17"| Player
 +
|colspan="3"| UUID
 +
|rowspan="17"| Array
 +
|colspan="2"| UUID
 +
|
 +
|-
 +
! Action
 +
!colspan="2"| Field Name
 +
!colspan="2"|  
 +
!
 +
|-
 +
|rowspan="10"| 0: add player
 +
|colspan="2"| Name
 +
  |colspan="2"| String (16)
 +
  |  
 
  |-
 
  |-
 
  |colspan="2"| Number Of Properties
 
  |colspan="2"| Number Of Properties
  |colspan="2"| Int
+
  |colspan="2"| VarInt
  | Number of elements in the following array
+
  | Number of elements in the following array.
 
  |-
 
  |-
 
  |rowspan="4"| Property
 
  |rowspan="4"| Property
  | Key
+
  | Name
 
  |rowspan="4"| Array
 
  |rowspan="4"| Array
  | String (64)
+
  | String (32767)
  | See below
+
  |  
 
  |-
 
  |-
 
  | Value
 
  | Value
  | Double
+
  | String (32767)
  | See below
+
  |  
 +
|-
 +
| Is Signed
 +
| Boolean
 +
|
 +
|-
 +
| Signature
 +
| Optional String (32767)
 +
| Only if Is Signed is true.
 
  |-
 
  |-
  | Number Of Modifiers
+
  |colspan="2"| Gamemode
  | VarInt
+
  |colspan="2"| VarInt
  | Number of elements in the following array
+
  |  
 
  |-
 
  |-
  | Modifiers
+
  |colspan="2"| Ping
| Array of Modifier Data
+
  |colspan="2"| VarInt
  | See {{Minecraft Wiki|Attribute#Modifiers}}. Modifier Data defined below.
+
  | Measured in milliseconds.
  |}
 
 
 
Known Key values (see also {{Minecraft Wiki|Attribute#Modifiers}}):
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Key
+
  |colspan="2"| Has Display Name
  ! Default
+
  |colspan="2"| Boolean
  ! Min
+
  |
! Max
 
! Label
 
 
  |-
 
  |-
  | generic.maxHealth
+
  |colspan="2"| Display Name
  | 20.0
+
  |colspan="2"| Optional [[Chat]]
| 0.0
+
  | Only if Has Display Name is true.
  | 1024.0
 
| Max Health
 
 
  |-
 
  |-
  | generic.followRange
+
  | 1: update gamemode
  | 32.0
+
|colspan="2"| Gamemode
  | 0.0
+
|colspan="2"| VarInt
  | 2048.0
+
|
  | Follow Range
+
|-
 +
  | 2: update latency
 +
  |colspan="2"| Ping
 +
  |colspan="2"| VarInt
 +
  | Measured in milliseconds.
 
  |-
 
  |-
  | generic.knockbackResistance
+
  |rowspan="2"| 3: update display name
  | 0.0
+
  |colspan="2"| Has Display Name
  | 0.0
+
  |colspan="2"| Boolean
| 1.0
+
  |  
  | Knockback Resistance
 
 
  |-
 
  |-
  | generic.movementSpeed
+
  |colspan="2"| Display Name
  | 0.699999988079071
+
  |colspan="2"| Optional [[Chat]]
| 0.0
+
  | Only send if Has Display Name is true.
  | 1024.0
 
| Movement Speed
 
 
  |-
 
  |-
  | generic.attackDamage
+
  | 4: remove player
  | 2.0
+
  |colspan="2"| ''no fields''
| 0.0
+
  |colspan="2"| ''no fields''
| 2048.0
+
  |  
| Attack Damage
+
  |}
|-
 
| generic.attackSpeed
 
| 4.0
 
| 0.0
 
| 1024.0
 
| Attack Speed
 
|-
 
| generic.flyingSpeed
 
| 0.4000000059604645
 
| 0.0
 
| 1024.0
 
| Flying Speed
 
|-
 
| horse.jumpStrength
 
| 0.7
 
| 0.0
 
  | 2.0
 
| Jump Strength
 
|-
 
| zombie.spawnReinforcements
 
| 0.0
 
| 0.0
 
| 1.0
 
  | Spawn Reinforcements Chance
 
  |}
 
  
''Modifier Data'' structure:
+
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.
 
 
{| class="wikitable"
 
|-
 
! 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
+
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.
+
==== Face Player ====
  
==== 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,208: Line 4,312:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x4E
+
  |rowspan="8"| 0x37
  |rowspan="5"| Play
+
  |rowspan="8"| Play
  |rowspan="5"| Client
+
  |rowspan="8"| Client
  | Entity ID
+
  |-
  | VarInt
+
| 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.
 
  |-
 
  |-
  | Effect ID
+
  | Target z
  | Byte
+
  | Double
  | See {{Minecraft Wiki|Status effect#List of effects|this table}}
+
  | z coordinate of the point to face towards.
 
  |-
 
  |-
  | Amplifier
+
  | Is entity
  | Byte
+
  | Boolean
  | Notchian client displays effect level as Amplifier + 1
+
  | If true, additional information about an entity is provided.
 
  |-
 
  |-
  | Duration
+
  | Entity ID
  | VarInt
+
  | Optional VarInt
  | Seconds
+
  | Only if is entity is true &mdash; the entity to face towards.
 
  |-
 
  |-
  | Flags
+
  | Entity feet/eyes
  | Byte
+
  | Optional VarInt 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.
 +
 
 +
==== Player Position And Look (clientbound) ====
 +
 
 +
Updates the player's position on the server. This packet will also close the “Downloading Terrain” screen when joining/respawning.
  
* 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.
+
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?).
* 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 ===
+
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”.
  
==== 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,251: Line 4,367:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x00
+
  |rowspan="8"| 0x38
  | Play
+
  |rowspan="8"| Play
  | Server
+
  |rowspan="8"| Client
  | Teleport ID
+
  | X
  | VarInt
+
  | Double
  | The ID given by the [[#Player Position And Look (clientbound)|Player Position And Look]] packet
+
  | Absolute or relative position, depending on Flags.
  |}
+
  |-
 
+
| Y
==== Prepare Crafting Grid ====
+
  | Double
 
+
  | Absolute or relative position, depending on Flags.
{| class="wikitable"
 
  ! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
  !colspan="2"| Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="12"| 0x01
+
  | Z
|rowspan="12"| Play
+
  | Double
|rowspan="12"| Server
+
  | Absolute or relative position, depending on Flags.
  |colspan="2"| Window ID
 
|colspan="2"| Byte
 
  | The window id.
 
 
  |-
 
  |-
  |colspan="2"| Action number
+
  | Yaw
  |colspan="2"| Short
+
  | Float
  | The transaction number. Will be send to the client in a Confirm Transaction packet.
+
  | Absolute or relative rotation on the X axis, in degrees.
 
  |-
 
  |-
  |colspan="2"| Array size
+
  | Pitch
  |colspan="2"| Short
+
  | Float
  | Number of elements in the following array
+
  | Absolute or relative rotation on the Y axis, in degrees.
 
  |-
 
  |-
  |rowspan="3"| Return Entry
+
  | Flags
| Item
 
|rowspan="3"| Array
 
| Slot
 
| The item stack that will be put in the inventory slot
 
|-
 
| Crafting Slot
 
 
  | Byte
 
  | Byte
  | The crafting slot index in the active container
+
  | Bit field, see below.
 
  |-
 
  |-
  | Player Slot
+
  | Teleport ID
  | Byte
+
  | VarInt
  | The player slot index in the player inventory
+
  | Client should confirm this packet with [[#Teleport Confirm|Teleport Confirm]] containing the same Teleport ID.
 
  |-
 
  |-
  |colspan="2"| Array Size
+
  | Dismount Vehicle
|colspan="2"| Short
+
  | Boolean
| Number of elements in the following array
+
  | True if the player should dismount their vehicle.
|-
 
|rowspan="3"| Prepare Entry
 
| Item
 
|rowspan="3"| Array
 
| Slot
 
  | The item stack that will be put in the crafting slot
 
  |-
 
| Crafting Slot
 
| Byte
 
| The crafting slot index in the active container
 
|-
 
| Player Slot
 
| Byte
 
| The player slot index in the player inventory
 
 
  |}
 
  |}
  
This packet is send when a player clicks a recipe in the crafting book that is craftable (white border).
+
About the Flags field:
  
1. Return Entries:
+
<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
* All the items on the crafting slot are set to null/empty.
 
* Every entry item stack will be added to the player inventory, to the specific player slot.
 
 
 
2. Prepare Entries:
 
* All the items on the player inventory slots their quantity is decreased by 1.
 
* Every entry item stack will be put in the proper crafting grid slot.
 
 
 
The server will send a Confirm Transaction packet back to the client with the provided transaction id.
 
 
 
 
 
==== Tab-Complete (serverbound) ====
 
 
 
Sent when the user presses ''tab'' while writing text.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x02
+
! Field
  |rowspan="4"| Play
+
! Bit
  |rowspan="4"| Server
+
  |-
  | Text
+
  | X
  | String (32767)
+
  | 0x01
  | All text behind the cursor (e.g. to the left of the cursor in left-to-right languages like English)
+
  |-
 +
  | Y
 +
  | 0x02
 
  |-
 
  |-
  | Assume Command
+
  | Z
  | Boolean
+
  | 0x04
| 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
+
  | Y_ROT
| Boolean
+
  | 0x08
  |  
 
 
  |-
 
  |-
  | Looked At Block
+
  | X_ROT
  | Optional Position
+
  | 0x10
| The position of the block being looked at. Only sent if Has Position is true.
 
 
  |}
 
  |}
  
==== Chat Message (serverbound) ====
+
==== Unlock Recipes ====
 
 
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,376: Line 4,438:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x03
+
  |rowspan="14"| 0x39
  |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 ====
 
 
 
Sent when the client is ready to complete login and when the client is ready to respawn after death.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x04
+
  | Action
  |rowspan="1"| Play
+
| VarInt
  |rowspan="1"| Server
+
| 0: init, 1: add, 2: remove.
  | Action ID
+
|-
  | VarInt Enum
+
| Crafting Recipe Book Open
  | See below
+
  | Boolean
  |}
+
| If true, then the crafting recipe book will be open when the player opens its inventory.
 
+
|-
''Action ID'' values:
+
| Crafting Recipe Book Filter Active
 
+
| Boolean
{| class="wikitable"
+
| 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.
 
  |-
 
  |-
  ! Action ID
+
  | Recipe IDs
  ! Action
+
  | Array of Identifier
 +
|
 
  |-
 
  |-
  | 0
+
  | Array size 2
  | Perform respawn
+
| Optional VarInt
 +
  | Number of elements in the following array, only present if mode is 0 (init).
 
  |-
 
  |-
  | 1
+
  | Recipe IDs
  | Request stats
+
  | 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.
  
==== Client Settings ====
+
==== Destroy Entity ====
  
Sent when the player connects, or when settings are changed.
+
Sent by the server when an entity is to be destroyed on the client.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,430: Line 4,511:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x05
+
  |rowspan="1"| 0x3A
  |rowspan="6"| Play
+
  |rowspan="1"| Play
  |rowspan="6"| Server
+
  |rowspan="1"| Client
| Locale
+
  | Entity ID
| String (16)
+
  | VarInt
| e.g. en_GB
+
  | The ID of the entity to be destroyed
|-
 
| View Distance
 
| Byte
 
| Client-side render distance, in chunks
 
|-
 
| 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:
+
==== Remove Entity Effect ====
 
 
* 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.
 
 
 
==== 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,482: Line 4,529:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x06
+
  |rowspan="2"| 0x3B
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Server
+
  |rowspan="2"| Client
  | Window ID
+
  | Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Effect ID
 
  | Byte
 
  | Byte
  | The ID of the window that the action occurred in
+
  | See {{Minecraft Wiki|Status effect#Effect IDs|this table}}.
|-
+
  |}
| Action Number
 
| Short
 
| 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.
 
|-
 
| Accepted
 
| Boolean
 
| Whether the action was accepted
 
  |}
 
  
==== Enchant Item ====
+
==== Resource Pack Send ====  
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,508: Line 4,551:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x07
+
  |rowspan="4"| 0x3C
  |rowspan="2"| Play
+
  |rowspan="4"| Play
  |rowspan="2"| Server
+
  |rowspan="4"| Client
  | Window ID
+
  | URL
  | Byte
+
  | String (32767)
  | The ID of the enchantment table window sent by [[#Open Window|Open Window]]
+
  | The URL to the resource pack.
 +
|-
 +
| Hash
 +
| String (40)
 +
| 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
 +
|-
 +
| 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.
 
  |-
 
  |-
  | Enchantment
+
  | Forced Message
  | Byte
+
  | [[Chat]]
  | The position of the enchantment on the enchantment table window, starting with 0 as the topmost one
+
  | This is sent with the force resourcepack popup.
 
  |}
 
  |}
  
==== Click Window ====
+
==== Respawn ====
  
This packet is sent by the player when it clicks on a slot in a window.
+
To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,532: Line 4,583:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x08
+
  |rowspan="8"| 0x3D
  |rowspan="6"| Play
+
  |rowspan="8"| Play
  |rowspan="6"| Server
+
  |rowspan="8"| Client
  | Window ID
+
  | Dimension
  | Unsigned Byte
+
  | [[NBT|NBT Tag Compound]]
  | The ID of the window which was clicked. 0 for player inventory.
+
  | |Valid dimensions are defined per dimension registry sent in [[#Join Game|Join Game]]
 
  |-
 
  |-
  | Slot
+
  | World Name
  | Short
+
  | Identifier
  | The clicked slot number, see below
+
  | Name of the world being spawned into
 
  |-
 
  |-
  | Button
+
  | Hashed seed
  | Byte
+
  | Long
  | The button used in the click, see below
+
| First 8 bytes of the SHA-256 hash of the world's seed. Used client side for biome noise
 +
|-
 +
| Gamemode
 +
| Unsigned Byte
 +
  | 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
 +
|-
 +
| Previous Gamemode
 +
| Unsigned Byte
 +
| 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included. The previous gamemode. (More information needed)
 
  |-
 
  |-
  | Action Number
+
  | Is Debug
  | Short
+
  | 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)]].
+
  | True if the world is a {{Minecraft Wiki|debug mode}} world; debug mode worlds cannot be modified and have predefined blocks.
 
  |-
 
  |-
  | Mode
+
  | Is Flat
  | VarInt Enum
+
  | Boolean
  | Inventory operation mode, see below
+
  | 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.
 
  |-
 
  |-
  | Clicked item
+
  | Copy metadata
  | [[Slot Data|Slot]]
+
  | Boolean
  | The clicked slot. Has to be empty (item ID = -1) for drop mode.
+
  | If false, metadata is reset on the respawned player entity. Set to true for dimension changes (including the dimension change triggered by sending client status perform respawn to exit the end poem/credits), and false for normal respawns.
 
  |}
 
  |}
  
See [[Inventory]] for further information about how slots are indexed.
+
{{Need Info|Does the new World Name field resolve this same-dimension issue?}}
 +
 
 +
{{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 ====
  
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.
+
Changes the direction an entity's head is facing.
  
The distinct type of click performed by the client is determined by the combination of the Mode and Button fields.
+
While sending the Entity Look packet changes the vertical rotation of the head, sending this packet appears to be necessary to rotate the head horizontally.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Mode
+
  ! Packet ID
  ! Button
+
  ! State
  ! Slot
+
  ! Bound To
  ! Trigger
+
  ! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  !rowspan="2"| 0
+
  |rowspan="2"| 0x3E
  | 0
+
|rowspan="2"| Play
  | Normal
+
|rowspan="2"| Client
  | Left mouse click
+
  | Entity ID
 +
  | VarInt
 +
  |  
 
  |-
 
  |-
  | 1
+
  | Head Yaw
  | Normal
+
  | Angle
  | Right mouse click
+
  | New angle, not a delta.
  |-
+
  |}
  !rowspan="2"| 1
+
   
| 0
+
==== Multi Block Change ====
  | Normal
+
 
  | Shift + left mouse click
+
Fired whenever 2 or more blocks are changed within the same chunk on the same tick.
  |-
+
 
  | 1
+
{{Warning|Changing blocks in chunks not loaded by the client is unsafe (see note on [[#Block Change|Block Change]]).}}
  | Normal
+
 
  | Shift + right mouse click ''(identical behavior)''
+
{| class="wikitable"
 +
  ! Packet ID
 +
  ! State
 +
  ! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  !rowspan="5"| 2
+
  |rowspan="4"| 0x3F
  | 0
+
|rowspan="4"| Play
  | Normal
+
|rowspan="4"| Client
  | Number key 1
+
  | 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).
 
  |-
 
  |-
  | 1
+
  |  
  | Normal
+
  | Boolean
  | Number key 2
+
  | Always inverse the preceding Update Light packet's "Trust Edges" bool
 
  |-
 
  |-
  | 2
+
  | Blocks array size
  | Normal
+
  | VarInt
  | Number key 3
+
  | Number of elements in the following array.
 
  |-
 
  |-
  |
+
  | Blocks
  |
+
  | Array of VarLong
  |
+
  | Each entry is composed of the block state id, shifted right by 12, and the relative block position in the chunk section (4 bits for x, z, and y, from left to right).
  |-
+
  |}
| 8
+
 
| Normal
+
Chunk section position is encoded:
  | Number key 9
+
<syntaxhighlight lang="java">
  |-
+
((sectionX & 0x3FFFFF) << 42) | (sectionY & 0xFFFFF) | ((sectionZ & 0x3FFFFF) << 20);
  !rowspan="1"| 3
+
</syntaxhighlight>
  | 2
+
and decoded:
  | Normal
+
<syntaxhighlight lang="java">
  | Middle click, only defined for creative players in non-player inventories.
+
sectionX = long >> 42;
 +
sectionY = long << 44 >> 44;
 +
sectionZ = long << 22 >> 42;
 +
</syntaxhighlight>
 +
 
 +
Blocks are encoded:
 +
<syntaxhighlight lang="java">
 +
blockStateId << 12 | (blockLocalX << 8 | blockLocalZ << 4 | blockLocalY)
 +
//Uses the local position of the given block position relative to its respective chunk section
 +
</syntaxhighlight>
 +
 
 +
==== 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="4"| 4
+
  |rowspan="2"| 0x40
  | 0
+
|rowspan="2"| Play
  | Normal*
+
|rowspan="2"| Client
  | Drop key (Q) (* Clicked item is different, see above)
+
  | Has id
 +
  | Boolean
 +
  | Indicates if the next field is present.
 
  |-
 
  |-
  | 1
+
  | Optional Identifier
  | Normal*
+
  | String (32767)
  | Ctrl + Drop key (Ctrl-Q) ''(drops full stack)''
+
| See below.
 +
  |}
 +
 
 +
The Identifier can be one of the following:
 +
 
 +
{| class="wikitable"
 +
! Optional Identifier
 
  |-
 
  |-
  | 0
+
  | minecraft:story/root
| -999
 
| Left click outside inventory holding nothing ''(no-op)''
 
 
  |-
 
  |-
  | 1
+
  | minecraft:nether/root
| -999
 
| Right click outside inventory holding nothing ''(no-op)''
 
 
  |-
 
  |-
  !rowspan="9"| 5
+
  | minecraft:end/root
| 0
 
| -999
 
| Starting left mouse drag
 
 
  |-
 
  |-
  | 4
+
  | minecraft:adventure/root
| -999
 
| Starting right mouse drag
 
 
  |-
 
  |-
  | 8
+
  | minecraft:husbandry/root
| -999
+
  |}
| 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])
+
 
|-
+
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
| 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.  (Note: the vanilla client will still incorrectly send this for non-creative players - see [https://bugs.mojang.com/browse/MC-46584 MC-46584])
 
|-
 
| 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.  (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):
 
 
 
# 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.
 
 
 
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.
 
 
 
==== 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.
+
==== Action Bar ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,700: Line 4,754:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x09
+
  |rowspan="1"| 0x41
  | Play
+
  |rowspan="1"| Play
  | Server
+
  |rowspan="1"| Client
  | Window ID
+
  | Action bar text
  | Unsigned Byte
+
  | [[Chat]]
  | This is the ID of the window that was closed. 0 for player inventory.
+
  | Displays a message above the hotbar (the same as position 2 in [[#Chat Message (clientbound)|Chat Message (clientbound)]].
 
  |}
 
  |}
  
==== Plugin Message (serverbound) ====
+
==== World Border Center ====  
 
 
{{Main|Plugin channels}}
 
 
 
Mods and plugins can use this to send their data. Minecraft itself uses a number of [[plugin channel]]s. These internal channels are prefixed with <code>MC|</code>.
 
 
 
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 
 
 
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,726: Line 4,772:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0A
+
  |rowspan="2"| 0x42
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
  |rowspan="2"| Server
+
  |rowspan="2"| Client
  | Channel
+
  | X
  | String (20)
+
  | Double
  | Name of the [[plugin channel]] used to send the data
+
  |  
 
  |-
 
  |-
  | Data
+
  | Z
  | Byte Array
+
  | Double
  | 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 ====
+
==== World Border Lerp Size ====  
 
 
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.
 
 
 
Note that middle-click in creative mode is interpreted by the client and sent as a [[#Creative Inventory Action|Creative Inventory Action]] packet instead.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,754: Line 4,794:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x0B
+
  |rowspan="3"| 0x43
  |rowspan="6"| Play
+
  |rowspan="3"| Play
  |rowspan="6"| Server
+
  |rowspan="3"| Client
  | Target
+
  | Old Diameter
  | VarInt
+
  | Double
  |  
+
  | Current length of a single side of the world border, in meters.
 
  |-
 
  |-
  | Type
+
  | New Diameter
  | VarInt Enum
+
  | Double
  | 0: interact, 1: attack, 2: interact at
+
  | Target length of a single side of the world border, in meters.
 
  |-
 
  |-
  | Target X
+
  | Speed
  | Optional Float
+
  | 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.
 +
|}
 +
 
 +
==== World Border Size ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Target Y
+
  |rowspan="1"| 0x44
| Optional Float
+
  |rowspan="1"| Play
  | Only if Type is interact at
+
  |rowspan="1"| Client
|-
+
  | Diameter
  | Target Z
+
  | Double
| Optional Float
+
  | Length of a single side of the world border, in meters.
| Only if Type is interact at
 
|-
 
  | Hand
 
  | Optional VarInt Enum
 
  | Only if Type is interact or interact at; 0: main hand, 1: off hand
 
 
  |}
 
  |}
  
==== Keep Alive (serverbound) ====
+
==== World Border Warning Delay ====  
 
 
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,794: Line 4,838:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x0C
+
  |rowspan="1"| 0x45
  | Play
+
  |rowspan="1"| Play
  | Server
+
  |rowspan="1"| Client
  | Keep Alive ID
+
  | Warning Time
 
  | VarInt
 
  | VarInt
  |  
+
  | In seconds as set by <code>/worldborder warning time</code>.
 
  |}
 
  |}
  
==== Player ====
+
==== World Border Warning Reach ====  
 
 
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,818: Line 4,856:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x0D
+
  |rowspan="1"| 0x46
 
  |rowspan="1"| Play
 
  |rowspan="1"| Play
  |rowspan="1"| Server
+
  |rowspan="1"| Client
  | On Ground
+
  | Warning Blocks
  | Boolean
+
  | VarInt
  | True if the client is on the ground, false otherwise
+
  | In meters.
 
  |}
 
  |}
  
==== Player Position ====
+
==== Camera ====
  
Updates the player's XYZ position on the server.
+
Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.
  
Checking for moving too fast is achieved like this:
+
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).
  
* Each server tick, the player's current position is stored
+
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.
* 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.
+
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).
 
 
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,850: Line 4,882:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x0E
+
  | 0x47
  |rowspan="4"| Play
+
  | Play
  |rowspan="4"| Server
+
  | Client
  | X
+
  | Camera ID
  | Double
+
  | 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
 
|-
 
| On Ground
 
| Boolean
 
| True if the client is on the ground, false otherwise
 
 
  |}
 
  |}
  
==== Player Position And Look (serverbound) ====
+
The notchian client also loads certain shaders for given entities:
 +
 
 +
* 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
 +
 
 +
==== Held Item Change (clientbound) ====
  
A combination of [[#Player Look|Player Look]] and [[#Player Position|Player Position]].
+
Sent to change the player's slot selection.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,882: Line 4,909:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x0F
+
  | 0x48
  |rowspan="6"| Play
+
  | Play
  |rowspan="6"| Server
+
  | Client
  | X
+
  | Slot
  | Double
+
  | Byte
  | Absolute position
+
  | The slot which the player has selected (0–8).
|-
 
| 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 ====
+
==== Update View Position ====
[[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
+
{{Need Info|Why is this even needed? Is there a better name for it? My guess is that it's something to do with logical behavior with latency, but it still seems weird.}}
  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:
+
Updates the client's location.  This is used to determine what chunks should remain loaded and if a chunk load should be ignored; chunks outside of the view distance may be unloaded.
  
x = -cos(pitch) * sin(yaw)
+
Sent 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,945: Line 4,933:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x10
+
  |rowspan="2"| 0x49
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Server
+
  |rowspan="2"| Client
  | Yaw
+
  | Chunk X
  | Float
+
  | VarInt
  | Absolute rotation on the X Axis, in degrees
+
  | Chunk X coordinate of the player's position.
 
  |-
 
  |-
  | Pitch
+
  | Chunk Z
  | Float
+
  | VarInt
  | Absolute rotation on the Y Axis, in degrees
+
  | Chunk Z coordinate of the player's position.
|-
 
| On Ground
 
| Boolean
 
| True if the client is on the ground, False otherwise
 
 
  |}
 
  |}
  
==== Vehicle Move (serverbound) ====
+
==== Update View 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. Does not appear to be used by the dedicated server, as <code>view-distance</code> in server.properties cannot be changed at runtime.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 4,973: Line 4,957:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x11
+
  | 0x4A
  |rowspan="7"| Play
+
  | Play
  |rowspan="7"| Server
+
  | Client
  | X
+
  | View Distance
  | Double
+
  | 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
 
 
  |}
 
  |}
 +
 +
==== Spawn Position ====
  
==== Steer Boat ====
+
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.
 
 
Used to ''visually'' update whether boat paddles are turning. The server will update the [[Entities#Boat|Boat entity metadata]] to match the values here.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,009: Line 4,977:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x12
+
  |rowspan="2"| 0x4B
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
  |rowspan="2"| Server
+
  |rowspan="2"| Client
  | Right paddle turning
+
  | Location
  | Boolean
+
  | Position
  |
+
  | Spawn location.
 
  |-
 
  |-
  | Left paddle turning
+
  | Angle
  | Boolean
+
  | 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 Scoreboard ====
  
==== Player Abilities (serverbound) ====
+
This is sent to the client when it should display a scoreboard.
 
 
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.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,037: Line 5,001:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x13
+
  |rowspan="2"| 0x4C
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Server
+
  |rowspan="2"| Client
  | Flags
+
  | Position
 
  | Byte
 
  | Byte
  | Bit mask. 0x08: damage disabled (god mode), 0x04: can fly, 0x02: is flying, 0x01: is Creative
+
  | The position of the scoreboard. 0: list, 1: sidebar, 2: below name, 3 - 18: team specific sidebar, indexed as 3 + team color.
 
  |-
 
  |-
  | Flying Speed
+
  | Score Name
  | Float
+
  | String (16)
|
+
  | The unique name for the scoreboard to be displayed.
|-
 
| Walking Speed
 
| Float
 
  |  
 
 
  |}
 
  |}
  
==== Player Digging ====
+
==== Entity Metadata ====
  
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).
+
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.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,065: Line 5,025:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x14
+
  |rowspan="2"| 0x4D
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Server
+
  |rowspan="2"| Client
  | Status
+
  | Entity ID
  | VarInt Enum
+
  | VarInt
  | The action the player is taking against the block (see below)
+
  |  
 
  |-
 
  |-
  | Location
+
  | Metadata
  | Position
+
  | [[Entities#Entity Metadata Format|Entity Metadata]]
| Block position
+
  |  
|-
 
| Face
 
| Byte Enum
 
  | The face being hit (see below)
 
 
  |}
 
  |}
  
Status can be one of seven values:
+
==== Attach Entity ====
 +
 
 +
This packet is sent when an entity has been {{Minecraft Wiki|Lead|leashed}} to another entity.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Value
+
  ! Packet ID
  ! Meaning
+
  ! State
  ! Notes
+
! Bound To
 +
! Field Name
 +
! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | 0
+
  |rowspan="2"| 0x4E
  | Started digging
+
|rowspan="2"| Play
  |  
+
|rowspan="2"| Client
 +
| Attached Entity ID
 +
  | Int
 +
  | Attached entity's EID.
 
  |-
 
  |-
  | 1
+
  | Holding Entity ID
  | Cancelled digging
+
  | Int
  | Sent when the player lets go of the Mine Block key (default: left click)
+
  | ID of the entity holding the lead. Set to -1 to detach.
|-
 
| 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: depends on OS). Location is always set to 0/0/0, Face is always set to -Y.
 
|-
 
| 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.
 
|-
 
| 5
 
| Shoot arrow / finish eating
 
| Location is always set to 0/0/0, Face is always set to Special.
 
|-
 
| 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.
 
 
  |}
 
  |}
  
The Face field can be one of the following values, representing the face being hit (or the Special value used for “shoot arrow / finish eating”):
+
==== Entity Velocity ====
 +
 
 +
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).
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Value
+
  |rowspan="4"| 0x4F
  ! Offset
+
  |rowspan="4"| Play
  ! Face
+
  |rowspan="4"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 
  |-
 
  |-
  | 0
+
  | Velocity X
  | -Y
+
  | Short
  | Bottom
+
  | Velocity on the X axis.
 
  |-
 
  |-
  | 1
+
  | Velocity Y
  | +Y
+
  | Short
  | Top
+
  | Velocity on the Y axis.
 
  |-
 
  |-
  | 2
+
  | Velocity Z
| -Z
+
  | Short
  | North
+
  | Velocity on the Z axis.
|-
 
| 3
 
  | +Z
 
| South
 
|-
 
| 4
 
| -X
 
| West
 
|-
 
| 5
 
| +X
 
| East
 
|-
 
| 255
 
| —
 
| Special
 
 
  |}
 
  |}
  
==== Entity Action ====
+
==== Entity Equipment ====
 
 
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"
 
{| class="wikitable"
Line 5,162: Line 5,099:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x15
+
  |rowspan="3"| 0x50
 
  |rowspan="3"| Play
 
  |rowspan="3"| Play
  |rowspan="3"| Server
+
  |rowspan="3"| Client
  | Entity ID
+
  |colspan="2"| Entity ID
  | VarInt
+
  |colspan="2"| VarInt
  | Player ID
+
  | Entity's EID.
 
  |-
 
  |-
  | Action ID
+
  |rowspan="2"| Equipment
  | VarInt Enum
+
| Slot
  | The ID of the action, see below
+
|rowspan="2"| 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.
 
  |-
 
  |-
  | Jump Boost
+
  | Item
  | VarInt
+
  | [[Slot Data|Slot]]
  | 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:
+
==== Set Experience ====
 +
 
 +
Sent by the server when the client should change experience levels.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Action
+
  ! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 0
+
  |rowspan="3"| 0x51
  | Start sneaking
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Experience bar
 +
| Float
 +
  | Between 0 and 1.
 
  |-
 
  |-
  | 1
+
  | Level
  | Stop sneaking
+
| VarInt
 +
  |  
 
  |-
 
  |-
  | 2
+
  | Total Experience
  | Leave bed
+
  | VarInt
  |-
+
  | See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion.
| 3
+
  |}
  | Start sprinting
+
 
|-
+
==== Update Health ====
| 4
+
 
| Stop sprinting
+
Sent by the server to update/set the health of the player it is sent to.
|-
+
 
| 5
+
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.
| Start jump with horse
 
|-
 
| 6
 
| Stop jump with horse
 
|-
 
| 7
 
| Open horse 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 due today time.
 
 
 
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,230: Line 5,163:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x16
+
  |rowspan="3"| 0x52
 
  |rowspan="3"| Play
 
  |rowspan="3"| Play
  |rowspan="3"| Server
+
  |rowspan="3"| Client
  | Sideways
+
  | Health
 
  | Float
 
  | Float
  | Positive to the left of the player
+
  | 0 or less = dead, 20 = full HP.
 
  |-
 
  |-
  | Forward
+
  | Food
 +
| VarInt
 +
| 0–20.
 +
|-
 +
| Food Saturation
 
  | Float
 
  | Float
  | Positive forward
+
  | Seems to vary from 0.0 to 5.0 in integer increments.
|-
 
| Flags
 
| Unsigned Byte
 
| Bit mask. 0x1: jump, 0x2: unmount
 
 
  |}
 
  |}
  
Also known as 'Input' packet.
+
==== Scoreboard Objective ====
  
==== Crafting Book Data ====
+
This is sent to the client when it should create a new {{Minecraft Wiki|scoreboard}} objective or remove one.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,254: Line 5,187:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x17
+
  |rowspan="4"| 0x53
  |rowspan="5"| Play
+
  |rowspan="4"| Play
  |rowspan="5"| Server
+
  |rowspan="4"| Client
  |colspan="2"| Type
+
  | Objective Name
  | VarInt
+
  | String (16)
  | Determines the format of the rest of the packet
+
  | A unique name for the objective.
 
  |-
 
  |-
  ! Type
+
  | Mode
  ! Field Name
+
  | Byte
  !
+
  | 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
!
 
 
  |-
 
  |-
  | 0: Displayed Recipe
+
  | Objective Value
  | Recipe ID
+
  | Optional Chat
| Int
+
  | Only if mode is 0 or 2. The text to be displayed for the score.
  | The internal id of the displayed recipe.
 
 
  |-
 
  |-
  |rowspan="2"| 1: Crafting Book Status
+
  | Type
  | Crafting Book Open
+
  | Optional VarInt enum
  | Boolean
+
  | Only if mode is 0 or 2. 0 = "integer", 1 = "hearts".
| Whether the player has the crafting book currently openened/active.
 
|-
 
| Crafting Filter
 
| Boolean
 
| Whether the player has the crafting filter option currently active.
 
 
  |}
 
  |}
  
The Crafting Book Status type is send when the player closes its inventory.
+
==== Set Passengers ====
 
 
==== Resource Pack Status ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,297: Line 5,221:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x18
+
  |rowspan="3"| 0x54
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Server
+
  |rowspan="3"| Client
  | Result
+
| Entity ID
  | VarInt Enum
+
| VarInt
  | 0: successfully loaded, 1: declined, 2: failed download, 3: accepted
+
| Vehicle's EID.
 +
|-
 +
  | Passenger Count
 +
  | VarInt
 +
  | Number of elements in the following array.
 +
|-
 +
| Passengers
 +
| Array of VarInt
 +
| EIDs of entity's passengers.
 
  |}
 
  |}
  
==== Advancement Tab ====
+
==== Teams ====
 +
 
 +
Creates and updates teams.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,311: Line 5,245:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x19
+
  |rowspan="23"| 0x55
  |rowspan="2"| Play
+
  |rowspan="23"| Play
  |rowspan="2"| Server
+
  |rowspan="23"| Client
  | Action
+
  |colspan="2"| Team Name
  | VarInt enum
+
  | String (16)
  | 0: Opened tab, 1: Closed screen
+
  | A unique name for the team. (Shared with scoreboard).
 
  |-
 
  |-
  | Tab ID
+
  |colspan="2"| Mode
| Optional identifier
+
  | Byte
  | Only present if action is Opened tab
+
  | Determines the layout of the remaining packet.
  |}
 
 
 
==== Held Item Change (serverbound) ====
 
 
 
Sent when the player changes the slot selection
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x1A
+
  |rowspan="9"| 0: create team
  |rowspan="1"| Play
+
  | Team Display Name
|rowspan="1"| Server
+
  | Chat
| Slot
+
  |  
| Short
 
  | The slot which the player has selected (0–8)
 
  |}
 
 
 
==== Creative Inventory Action ====
 
 
 
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"| 0x1B
+
  | Friendly Flags
|rowspan="2"| Play
+
  | Byte
|rowspan="2"| Server
+
  | Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team.
| Slot
 
  | Short
 
  | Inventory slot
 
 
  |-
 
  |-
  | Clicked Item
+
  | Name Tag Visibility
  | [[Slot Data|Slot]]
+
  | String Enum (32)
  |  
+
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>.
  |}
+
  |-
 
+
  | Collision Rule
==== Update Sign ====
+
| String Enum (32)
 
+
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>.
{{anchor|Update Sign (serverbound)}}This message is sent from the client to the server when the “Done” button is pushed after placing a sign.
+
|-
 
+
  | Team Color
The server only accepts this packet after [[#Open Sign Editor|Open Sign Editor]], otherwise this packet is silently ignored.
+
  | VarInt enum
 
+
  | Used to color the name of players on the team; see below.
{| class="wikitable"
 
  ! Packet ID
 
  ! State
 
  ! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| 0x1C
+
  | Team Prefix
|rowspan="5"| Play
+
  | Chat
|rowspan="5"| Server
+
  | Displayed before the names of players that are part of this team.
| Location
 
  | Position
 
  | Block Coordinates
 
 
  |-
 
  |-
  | Line 1
+
  | Team Suffix
  | String (384)
+
  | Chat
  | First line of text in the sign
+
  | Displayed after the names of players that are part of this team.
 
  |-
 
  |-
  | Line 2
+
  | Entity Count
  | String (384)
+
  | VarInt
  | Second line of text in the sign
+
  | Number of elements in the following array.
 
  |-
 
  |-
  | Line 3
+
  | Entities
  | String (384)
+
  | Array of String (40)
  | Third line of text in the sign
+
  | Identifiers for the entities in this team.  For players, this is their username; for other entities, it is their UUID.
 
  |-
 
  |-
  | Line 4
+
  | 1: remove team
  | String (384)
+
  | ''no fields''
  | Fourth line of text in the sign
+
  | ''no fields''
  |}
+
  |  
 
 
==== Animation (serverbound) ====
 
 
 
Sent when the player's arm swings.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  | 0x1D
+
  |rowspan="7"| 2: update team info
| Play
+
  | Team Display Name
  | Server
+
  | Chat
| Hand
+
  |  
| VarInt Enum
 
  | Hand used for the animation. 0: main hand, 1: off hand.
 
|}
 
 
 
==== Spectate ====
 
 
 
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
 
 
  |-
 
  |-
  |rowspan="1"| 0x1E
+
  | Friendly Flags
|rowspan="1"| Play
+
  | Byte
|rowspan="1"| Server
+
  | Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible entities on same team.
| Target Player
 
  | UUID
 
  | UUID of the player to teleport to (can also be an entity UUID)
 
|}
 
 
 
==== Player Block Placement ====
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Packet ID
+
  | Name Tag Visibility
  ! State
+
| String Enum (32)
  ! Bound To
+
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
  ! Field Name
+
|-
  ! Field Type
+
| Collision Rule
  ! Notes
+
| String Enum (32)
 +
  | <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 +
  |-
 +
  | Team Color
 +
  | VarInt enum
 +
  | Used to color the name of players on the team; see below.
 
  |-
 
  |-
  |rowspan="6"| 0x1F
+
  | Team Prefix
|rowspan="6"| Play
+
  | Chat
|rowspan="6"| Server
+
  | Displayed before the names of players that are part of this team.
| Location
 
  | Position
 
  | Block position
 
 
  |-
 
  |-
  | Face
+
  | Team Suffix
  | VarInt Enum
+
  | Chat
  | The face on which the block is placed (as documented at [[#Player Digging|Player Digging]])
+
  | Displayed after the names of players that are part of this team.
 
  |-
 
  |-
  | Hand
+
  |rowspan="2"| 3: add entities to team
  | VarInt Enum
+
| Entity Count
  | The hand from which the block is placed; 0: main hand, 1: off hand
+
  | VarInt
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  | Cursor Position X
+
  | Entities
  | Float
+
  | Array of String (40)
  | The position of the crosshair on the block, from 0 to 1 increasing from west to east
+
  | Identifiers for the added entities.  For players, this is their username; for other entities, it is their UUID.
 
  |-
 
  |-
  | Cursor Position Y
+
  |rowspan="2"| 4: remove entities from team
  | Float
+
| Entity Count
  | The position of the crosshair on the block, from 0 to 1 increasing from bottom to top
+
  | VarInt
 +
  | Number of elements in the following array.
 
  |-
 
  |-
  | Cursor Position Z
+
  | Entities
  | Float
+
  | Array of String (40)
  | The position of the crosshair on the block, from 0 to 1 increasing from north to south
+
  | Identifiers for the removed entities.  For players, this is their username; for other entities, it is their UUID.
 
  |}
 
  |}
  
In normal operation (i.e. placing a block), this packet is sent once, with the values set normally.
+
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.
 
 
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.
 
 
 
This packet has a special case where X, Y, Z, and Face are all -1. (Note that Y is unsigned so set to 255.) This special packet indicates that the currently held item for the player should have its state updated such as eating food, pulling back bows, using buckets, etc.
 
 
 
Special note on using buckets: When using buckets, the Notchian client might send two packets: first a normal and then a special case. The first normal packet is sent when you're looking at a block (e.g. the water you want to scoop up). This normal packet does not appear to do anything with a Notchian server. The second, special case packet appears to perform the action — based on current position/orientation and with a distance check — it appears that buckets can only be used within a radius of 6 units.
 
 
 
==== Use Item ====
 
 
 
Sent when pressing the Use Item key (default: right click) with an item in hand.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Formatting
  ! Bound To
+
  |-
  ! Field Name
+
| 0-15
  ! Field Type
+
| Color formatting, same values as [[Chat]] colors.
  ! Notes
+
|-
 +
| 16
 +
| Obfuscated
 +
|-
 +
| 17
 +
| Bold
 +
|-
 +
| 18
 +
| Strikethrough
 +
|-
 +
| 19
 +
| Underlined
 +
  |-
 +
  | 20
 +
  | Italic
 
  |-
 
  |-
  | 0x20
+
  | 21
  | Play
+
  | Reset
| Server
 
| Hand
 
| VarInt Enum
 
| Hand used for the animation. 0: main hand, 1: off hand.
 
 
  |}
 
  |}
  
== Status ==
+
==== Update Score ====
{{Main|Server List Ping}}
 
  
=== Clientbound ===
+
This is sent to the client when it should update a scoreboard item.
 
 
==== Response ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,537: Line 5,390:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  |rowspan="4"| 0x56
  |rowspan="1"| Status
+
  |rowspan="4"| Play
  |rowspan="1"| Client
+
  |rowspan="4"| Client
  | JSON Response
+
  | Entity Name
  | String (32767)
+
  | String (40)
  | See [[Server List Ping#Response]]
+
  | The entity whose score this is.  For players, this is their username; for other entities, it is their UUID.
  |}
+
|-
 
+
| Action
==== Pong ====
+
| Byte
 
+
| 0 to create/update an item. 1 to remove an item.
{| class="wikitable"
+
|-
  ! Packet ID
+
| Objective Name
 +
| String (16)
 +
| The name of the objective the score belongs to.
 +
|-
 +
| Value
 +
| Optional VarInt
 +
| The score to be displayed next to the entry. Only sent when Action does not equal 1.
 +
  |}
 +
 
 +
==== Set Title SubTitle ====  
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
Line 5,555: Line 5,420:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x01
+
  |rowspan="1"| 0x57
  |rowspan="1"| Status
+
  |rowspan="1"| Play
 
  |rowspan="1"| Client
 
  |rowspan="1"| Client
  | Payload
+
  | Subtitle Text
  | Long
+
  | [[Chat]]
  | Should be the same as sent by the client
+
  |
 
  |}
 
  |}
  
=== Serverbound ===
+
==== Time Update ====
 +
 
 +
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.
  
==== Request ====
+
The default SMP server increments the time by <code>20</code> every second.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,575: Line 5,444:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  |rowspan="2"| 0x58
  | Status
+
  |rowspan="2"| Play
| Server
+
  |rowspan="2"| Client
  |colspan="3"| ''no fields''
+
| 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.
 
  |}
 
  |}
  
==== Ping ====
+
==== Set Title Text ====  
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,591: Line 5,466:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x01
+
  |rowspan="1"| 0x59
  |rowspan="1"| Status
+
  |rowspan="1"| Play
  |rowspan="1"| Server
+
  |rowspan="1"| Client
  | Payload
+
  | Title Text
  | Long
+
  | [[Chat]]
  | May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.
+
  |
 
  |}
 
  |}
  
== Login ==
+
==== Set Title Times ====  
  
The login process is as follows:
+
{| class="wikitable"
 
 
# C→S: [[#Handshake|Handshake]] with Next State set to 2 (login)
 
# C→S: [[#Login Start|Login Start]]
 
# S→C: [[#Encryption Request|Encryption Request]]
 
# Client auth
 
# C→S: [[#Encryption Response|Encryption Response]]
 
# Server auth, both enable encryption
 
# S→C: [[#Set Compression|Set Compression]] (optional)
 
# S→C: [[#Login Success|Login Success]]
 
 
 
Set Compression, if present, must be sent before Login Success. Note that anything sent after Set Compression must use the [[#With_compression|Post Compression packet format]].
 
 
 
For unauthenticated and localhost connections (either of the two conditions is enough for an unencrypted connection) there is no encryption. In that case [[#Login Start|Login Start]] is directly followed by [[#Login Success|Login Success]].
 
 
 
See [[Protocol Encryption]] for details.
 
 
 
=== Clientbound ===
 
 
 
==== Disconnect (login) ====
 
 
 
{| class="wikitable"
 
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 5,630: Line 5,484:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  |rowspan="3"| 0x5A
  |rowspan="1"| Login
+
  |rowspan="3"| Play
  |rowspan="1"| Client
+
  |rowspan="3"| Client
  | Reason
+
  | Fade In
  | [[Chat]]
+
  | Int
  |  
+
  | Ticks to spend fading in.
 +
|-
 +
| Stay
 +
| Int
 +
| Ticks to keep the title displayed.
 +
|-
 +
| Fade Out
 +
| Int
 +
| Ticks to spend out, not when to start fading out.
 
  |}
 
  |}
  
==== Encryption Request ====
+
==== Entity Sound Effect ====
 +
 
 +
Plays a sound effect from an entity.
 +
 
 +
{{warning2|The pitch and volume fields in this packet are ignored.  See [https://bugs.mojang.com/browse/MC-138832 MC-138832] for more information.}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,648: Line 5,514:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x01
+
  |rowspan="5"| 0x5B
  |rowspan="5"| Login
+
  |rowspan="5"| Play
 
  |rowspan="5"| Client
 
  |rowspan="5"| Client
  | Server ID
+
  | Sound ID
| String (20)
 
| Appears to be empty
 
|-
 
| Public Key Length
 
 
  | VarInt
 
  | VarInt
  | Length of Public Key
+
  | ID of hardcoded sound event ([https://pokechu22.github.io/Burger/1.16.5.html#sounds events] as of 1.16.5).
 
  |-
 
  |-
  | Public Key
+
  | Sound Category
  | Byte Array
+
  | VarInt Enum
  |  
+
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories]).
 
  |-
 
  |-
  | Verify Token Length
+
  | Entity ID
 
  | VarInt
 
  | VarInt
  | Length of Verify Token. Always 4 for Notchian servers.
+
  |
 
  |-
 
  |-
  | Verify Token
+
  | Volume
  | Byte Array
+
  | Float
  | A sequence of random bytes generated by the server
+
  | 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients.
|}
 
 
 
See [[Protocol Encryption]] for details.
 
 
 
==== Login Success ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x02
+
  | Pitch
  |rowspan="2"| Login
+
  | Float
  |rowspan="2"| Client
+
  | Float between 0.5 and 2.0 by Notchian clients.
| UUID
 
| String (36)
 
| Unlike in other packets, this field contains the UUID as a string with hyphens.
 
|-
 
| Username
 
| String (16)
 
|
 
 
  |}
 
  |}
  
This packet switches the connection state to [[#Play|play]].
+
==== Sound Effect ====
  
==== Set Compression ====
+
This packet is used to play a number of hardcoded sound events. For custom sounds, use [[#Named Sound Effect|Named Sound Effect]].
  
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).
+
{{Warning|Numeric sound effect IDs are liable to change between versions}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,710: Line 5,552:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x03
+
  |rowspan="7"| 0x5C
  |rowspan="1"| Login
+
  |rowspan="7"| Play
  |rowspan="1"| Client
+
  |rowspan="7"| Client
  | Threshold
+
  | Sound ID
 
  | VarInt
 
  | VarInt
  | Maximum size of a packet before it is compressed
+
  | ID of hardcoded sound event ([https://pokechu22.github.io/Burger/1.16.5.html#sounds events] as of 1.16.5).
  |}
+
|-
 
+
| Sound Category
=== Serverbound ===
+
| VarInt Enum
 +
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories]).
 +
|-
 +
| Effect Position X
 +
| Int
 +
| Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part).
 +
|-
 +
| Effect Position Y
 +
| Int
 +
| Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part).
 +
|-
 +
| Effect Position Z
 +
| Int
 +
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part).
 +
|-
 +
| Volume
 +
| Float
 +
| 1.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.
 +
|}
  
==== Login Start  ====
+
==== Stop Sound ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,730: Line 5,594:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x00
+
  |rowspan="3"| 0x5D
  |rowspan="1"| Login
+
  |rowspan="3"| Play
  |rowspan="1"| Server
+
  |rowspan="3"| Client
  | Name
+
| Flags
  | String (16)
+
| Byte
  | Player's Username
+
| Controls which fields are present.
 +
|-
 +
| Source
 +
| Optional VarInt enum
 +
| Only if flags is 3 or 1 (bit mask 0x1).  See below.  If not present, then sounds from all sources are cleared.
 +
|-
 +
| Sound
 +
  | Optional Identifier
 +
  | Only if flags is 2 or 3 (bit mask 0x2).  A sound effect name, see [[#Named Sound Effect|Named Sound Effect]].  If not present, then all sounds are cleared.
 +
  |}
 +
 
 +
Categories:
 +
 
 +
{| class="wikitable"
 +
! Name !! Value
 +
|-
 +
| master || 0
 +
|-
 +
| music || 1
 +
|-
 +
| record || 2
 +
|-
 +
| weather || 3
 +
|-
 +
| block || 4
 +
|-
 +
| hostile || 5
 +
|-
 +
| neutral || 6
 +
|-
 +
| player || 7
 +
|-
 +
| ambient || 8
 +
|-
 +
| voice || 9
 
  |}
 
  |}
  
==== Encryption Response ====
+
==== Player 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.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 5,748: Line 5,648:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x01
+
  |rowspan="2"| 0x5E
  |rowspan="4"| Login
+
  |rowspan="2"| Play
  |rowspan="4"| Server
+
  |rowspan="2"| Client
  | Shared Secret Length
+
  | Header
  | VarInt
+
  | [[Chat]]
  | Length of Shared Secret
+
  | To remove the header, send a empty text component: <code>{"text":""}</code>.
 
  |-
 
  |-
  | Shared Secret
+
  | Footer
  | Byte Array
+
  | [[Chat]]
  |  
+
  | To remove the footer, send a empty text component: <code>{"text":""}</code>.
 +
|}
 +
 
 +
==== NBT Query Response ====
 +
 
 +
Sent in response to [[#Query Block NBT|Query Block NBT]] or [[#Query Entity NBT|Query Entity NBT]].
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Verify Token Length
+
  |rowspan="2"| 0x5F
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Transaction ID
 
  | VarInt
 
  | VarInt
  | Length of Verify Token
+
  | Can be compared to the one sent in the original query packet.
 
  |-
 
  |-
  | Verify Token
+
  | NBT
  | Byte Array
+
  | [[NBT|NBT Tag]]
  |  
+
  | The NBT of the block or entity.  May be a TAG_END (0) in which case no NBT is present.
 
  |}
 
  |}
  
See [[Protocol Encryption]] for details.
+
==== Collect 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 [[#Player Position|Player Position]] (and [[#Player Position And Look|Player Position And Look]]) 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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x60
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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.
 +
|}
 +
 
 +
==== Entity Teleport ====
 +
 
 +
This packet is sent by the server when an entity moves more than 8 blocks.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x61
 +
|rowspan="7"| Play
 +
|rowspan="7"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| X
 +
| Double
 +
|
 +
|-
 +
| Y
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|
 +
|-
 +
| Yaw
 +
| Angle
 +
| New angle, not a delta.
 +
|-
 +
| Pitch
 +
| Angle
 +
| New angle, not a delta.
 +
|-
 +
| On Ground
 +
| Boolean
 +
|
 +
|}
 +
 
 +
==== Advancements ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="9"| 0x62
 +
|rowspan="9"| Play
 +
|rowspan="9"| Client
 +
|colspan="2"| Reset/Clear
 +
|colspan="2"| Boolean
 +
| Whether to reset/clear the current advancements.
 +
|-
 +
|colspan="2"| Mapping size
 +
|colspan="2"| VarInt
 +
| Size of the following array.
 +
|-
 +
|rowspan="2"| Advancement mapping
 +
| Key
 +
|rowspan="2"| Array
 +
| Identifier
 +
| The identifier of the advancement.
 +
|-
 +
| Value
 +
| Advancement
 +
| See below
 +
|-
 +
|colspan="2"| List size
 +
|colspan="2"| VarInt
 +
| Size of the following array.
 +
|-
 +
|colspan="2"| Identifiers
 +
|colspan="2"| Array of Identifier
 +
| The identifiers of the advancements that should be removed.
 +
|-
 +
|colspan="2"| Progress size
 +
|colspan="2"| VarInt
 +
| Size of the following array.
 +
|-
 +
|rowspan="2"| Progress mapping
 +
| Key
 +
|rowspan="2"| Array
 +
| 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"| Boolean
 +
| Indicates whether the next field exists.
 +
|-
 +
|colspan="2"| Parent id
 +
|colspan="2"| Optional Identifier
 +
| The identifier of the parent advancement.
 +
|-
 +
|colspan="2"| Has display
 +
|colspan="2"| Boolean
 +
| Indicates whether the next field exists.
 +
|-
 +
|colspan="2"| Display data
 +
|colspan="2"| Optional advancement display
 +
| See below.
 +
|-
 +
|colspan="2"| Number of criteria
 +
|colspan="2"| VarInt
 +
| Size of the following array.
 +
|-
 +
|rowspan="2"| Criteria
 +
| Key
 +
|rowspan="2"| Array
 +
| Identifier
 +
| The identifier of the criterion.
 +
|-
 +
| Value
 +
| '''Void'''
 +
| There is ''no'' content written here. Perhaps this will be expanded in the future?
 +
|-
 +
|colspan="2"| Array length
 +
|colspan="2"| VarInt
 +
| Number of arrays in the following array.
 +
|-
 +
|rowspan="2"| Requirements
 +
| Array length 2
 +
|rowspan="2"| Array
 +
| VarInt
 +
| Number of elements in the following array.
 +
|-
 +
| Requirement
 +
| Array of String
 +
| Array of required criteria.
 +
|}
 +
 
 +
Advancement display:
 +
 
 +
{| class="wikitable"
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| Title
 +
| Chat
 +
|
 +
|-
 +
| Description
 +
| Chat
 +
|
 +
|-
 +
| Icon
 +
| [[Slot]]
 +
|
 +
|-
 +
| Frame type
 +
| VarInt enum
 +
| 0 = <code>task</code>, 1 = <code>challenge</code>, 2 = <code>goal</code>.
 +
|-
 +
| Flags
 +
| Integer
 +
| 0x1: has background texture; 0x2: <code>show_toast</code>; 0x4: <code>hidden</code>.
 +
|-
 +
| Background texture
 +
| Optional Identifier
 +
| Background texture location.  Only if flags indicates it.
 +
|-
 +
| X coord
 +
| Float
 +
|
 +
|-
 +
| Y coord
 +
| Float
 +
|
 +
|}
 +
 
 +
Advancement progress:
 +
 
 +
{| class="wikitable"
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|colspan="2"| Size
 +
|colspan="2"| VarInt
 +
| Size of the following array.
 +
|-
 +
|rowspan="2"| Criteria
 +
| Criterion identifier
 +
|rowspan="2"| Array
 +
| Identifier
 +
| The identifier of the criterion.
 +
|-
 +
| Criterion progress
 +
| Criterion progress
 +
|
 +
|}
 +
 
 +
Criterion progress:
 +
 
 +
{| class="wikitable"
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| Achieved
 +
| Boolean
 +
| If true, next field is present.
 +
|-
 +
| Date of achieving
 +
| Optional Long
 +
| As returned by [https://docs.oracle.com/javase/6/docs/api/java/util/Date.html#getTime() <code>Date.getTime</code>].
 +
|}
 +
 
 +
==== Entity Properties ====
 +
 
 +
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"| 0x63
 +
|rowspan="6"| Play
 +
|rowspan="6"| Client
 +
|colspan="2"| Entity ID
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
|colspan="2"| Number Of Properties
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array.
 +
|-
 +
|rowspan="4"| Property
 +
| Key
 +
|rowspan="4"| 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 {{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
 +
| 0.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.attack_damage
 +
| 2.0
 +
| 0.0
 +
| 2048.0
 +
| Attack Damage.
 +
|-
 +
| generic.attack_speed
 +
| 4.0
 +
| 0.0
 +
| 1024.0
 +
| Attack Speed.
 +
|-
 +
| generic.flying_speed
 +
| 0.4
 +
| 0.0
 +
| 1024.0
 +
| Flying Speed.
 +
|-
 +
| generic.armor
 +
| 0.0
 +
| 0.0
 +
| 30.0
 +
| Armor.
 +
|-
 +
| generic.armor_toughness
 +
| 0.0
 +
| 0.0
 +
| 20.0
 +
| Armor Toughness.
 +
|-
 +
| generic.attack_knockback
 +
| 0.0
 +
| 0.0
 +
| 5.0
 +
| &mdash;
 +
|-
 +
| generic.luck
 +
| 0.0
 +
| -1024.0
 +
| 1024.0
 +
| Luck.
 +
|-
 +
| horse.jump_strength
 +
| 0.7
 +
| 0.0
 +
| 2.0
 +
| Jump Strength.
 +
|-
 +
| zombie.spawn_reinforcements
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Spawn Reinforcements Chance.
 +
|-
 +
| 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).
 +
|}
 +
 
 +
Unknown attributes will cause a game crash ([https://bugs.mojang.com/browse/MC-150405 MC-150405]) due to the default minimum being larger than the default value.
 +
 
 +
''Modifier Data'' structure:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! 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 ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x64
 +
|rowspan="5"| Play
 +
|rowspan="5"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Effect ID
 +
| Byte
 +
| See {{Minecraft Wiki|Status effect#Effect IDs|this table}}.
 +
|-
 +
| Amplifier
 +
| Byte
 +
| Notchian client displays effect level as Amplifier + 1.
 +
|-
 +
| Duration
 +
| VarInt
 +
| Duration in ticks.
 +
|-
 +
| Flags
 +
| Byte
 +
| Bit field, 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 [[Entities#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.
 +
 
 +
==== Declare Recipes ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x65
 +
|rowspan="4"| Play
 +
|rowspan="4"| Client
 +
|colspan="2"| Num Recipes
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array.
 +
|-
 +
|rowspan="3"| Recipe
 +
| Type
 +
|rowspan="3"| Array
 +
| Identifier
 +
| The recipe type, see below.
 +
|-
 +
| Recipe ID
 +
| Identifier
 +
|
 +
|-
 +
| Data
 +
| Optional, varies
 +
| Additional data for the recipe.  For some types, there will be no data.
 +
|}
 +
 
 +
Recipe types:
 +
 
 +
{| class="wikitable"
 +
! Type
 +
! Description
 +
! Data
 +
|-
 +
| <code>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
 +
    | String
 +
    | Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
 +
    |-
 +
    | Ingredient count
 +
    | VarInt
 +
    | Number of elements in the following array.
 +
    |-
 +
    | Ingredients
 +
    | Array of Ingredient.
 +
    |
 +
    |-
 +
    | Result
 +
    | [[Slot]]
 +
    |
 +
    |}
 +
|-
 +
| <code>crafting_shaped</code>
 +
| 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
 +
    |-
 +
    | Width
 +
    | VarInt
 +
    |
 +
    |-
 +
    | Height
 +
    | VarInt
 +
    |
 +
    |-
 +
    | Group
 +
    | String
 +
    | Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
 +
    |-
 +
    | Ingredients
 +
    | Array of Ingredient
 +
    | Length is <code>width * height</code>. Indexed by <code>x + (y * width)</code>.
 +
    |-
 +
    | Result
 +
    | [[Slot]]
 +
    |
 +
    |}
 +
|-
 +
| <code>crafting_special_armordye</code>
 +
| Recipe for dying leather armor
 +
|rowspan="14"| None
 +
|-
 +
| <code>crafting_special_bookcloning</code>
 +
| Recipe for copying contents of written books
 +
|-
 +
| <code>crafting_special_mapcloning</code>
 +
| Recipe for copying maps
 +
|-
 +
| <code>crafting_special_mapextending</code>
 +
| Recipe for adding paper to maps
 +
|-
 +
| <code>crafting_special_firework_rocket</code>
 +
| Recipe for making firework rockets
 +
|-
 +
| <code>crafting_special_firework_star</code>
 +
| Recipe for making firework stars
 +
|-
 +
| <code>crafting_special_firework_star_fade</code>
 +
| Recipe for making firework stars fade between multiple colors
 +
|-
 +
| <code>crafting_special_repairitem</code>
 +
| Recipe for repairing items via crafting
 +
|-
 +
| <code>crafting_special_tippedarrow</code>
 +
| Recipe for crafting tipped arrows
 +
|-
 +
| <code>crafting_special_bannerduplicate</code>
 +
| Recipe for copying banner patterns
 +
|-
 +
| <code>crafting_special_banneraddpattern</code>
 +
| Recipe for adding patterns to banners
 +
|-
 +
| <code>crafting_special_shielddecoration</code>
 +
| Recipe for applying a banner's pattern to a shield
 +
|-
 +
| <code>crafting_special_shulkerboxcoloring</code>
 +
| Recipe for recoloring a shulker box
 +
|-
 +
| <code>crafting_special_suspiciousstew</code>
 +
|
 +
|-
 +
| <code>smelting</code>
 +
| Smelting recipe
 +
|rowspan="4"| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Group
 +
    | String
 +
    | Used to group similar recipes together in the recipe book.
 +
    |-
 +
    | Ingredient
 +
    | Ingredient
 +
    |
 +
    |-
 +
    | Result
 +
    | [[Slot]]
 +
    |
 +
    |-
 +
    | Experience
 +
    | Float
 +
    |
 +
    |-
 +
    | Cooking time
 +
    | VarInt
 +
    |
 +
    |}
 +
|-
 +
| <code>blasting</code>
 +
| Blast furnace recipe
 +
|-
 +
| <code>smoking</code>
 +
| Smoker recipe
 +
|-
 +
| <code>campfire_cooking</code>
 +
| Campfire recipe
 +
|-
 +
| <code>stonecutting</code>
 +
| Stonecutter recipe
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Group
 +
    | String
 +
    | Used to group similar recipes together in the recipe book.  Tag is present in recipe JSON.
 +
    |-
 +
    | Ingredient
 +
    | Ingredient
 +
    |
 +
    |-
 +
    | Result
 +
    | [[Slot]]
 +
    |
 +
    |}
 +
|-
 +
| <code>smithing</code>
 +
| Smithing table recipe
 +
| As follows:
 +
  {| class="wikitable"
 +
    ! Name
 +
    ! Type
 +
    ! Description
 +
    |-
 +
    | Base
 +
    | Ingredient
 +
    | First item.
 +
    |-
 +
    | Addition
 +
    | Ingredient
 +
    | Second item.
 +
    |-
 +
    | Result
 +
    | [[Slot]]
 +
    |
 +
    |}
 +
|}
 +
 
 +
Ingredient is defined as:
 +
 
 +
{| class="wikitable"
 +
! 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.
 +
|}
 +
 
 +
==== Tags ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x66
 +
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| colspan="2"| Length of the array
 +
| colspan="2"| VarInt
 +
|
 +
|-
 +
|rowspan="2"| Array of tags
 +
| Tag type
 +
|rowspan="2"| Array
 +
| Identifier
 +
| Tag identifier (Vanilla required tags are <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)
 +
|
 +
|}
 +
 
 +
Tags look like:
 +
 
 +
{| class="wikitable"
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|colspan="2"| Length
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="3"| Tags
 +
| Tag name
 +
|rowspan="3"| Array
 +
| Identifier
 +
|
 +
|-
 +
| Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Entries
 +
| Array of VarInt
 +
| Numeric ID of the given type (block, item, etc.).
 +
|}
 +
 
 +
More information on tags is available at: https://minecraft.gamepedia.com/Tag
 +
 
 +
And a list of all tags is here: https://minecraft.gamepedia.com/Tag#List_of_tags
 +
 
 +
=== Serverbound ===
 +
 
 +
==== Teleport Confirm ====
 +
 
 +
Sent by client as confirmation of [[#Player Position And Look (clientbound)|Player Position And Look]].
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x00
 +
| Play
 +
| Server
 +
| Teleport ID
 +
| VarInt
 +
| The ID given by the [[#Player Position And Look (clientbound)|Player Position And Look]] packet.
 +
|}
 +
 
 +
==== Query Block NBT ====
 +
 
 +
Used when <kbd>Shift</kbd>+<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
 +
| VarInt
 +
| An incremental ID so that the client can verify that the response matches.
 +
|-
 +
| Location
 +
| Position
 +
| The location of the block to check.
 +
|}
 +
 
 +
==== Set 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
 +
| Byte
 +
| 0: peaceful, 1: easy, 2: normal, 3: hard .
 +
|}
 +
 
 +
==== Chat Message (serverbound) ====
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x03
 +
| Play
 +
| Server
 +
| 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
 +
|-
 +
| 0x04
 +
| Play
 +
| Server
 +
| Action ID
 +
| VarInt 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 Settings ====
 +
 
 +
Sent when the player connects, or when settings are changed.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x05
 +
|rowspan="7"| Play
 +
|rowspan="7"| Server
 +
| Locale
 +
| String (16)
 +
| e.g. <code>en_GB</code>.
 +
|-
 +
| View Distance
 +
| Byte
 +
| Client-side render distance, in chunks.
 +
|-
 +
| 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.
 +
|-
 +
| Disable text filtering
 +
| Boolean
 +
| Disables filtering of text on signs and written book titles. Currently always true (i.e. the filtering is disabled)
 +
|}
 +
 
 +
''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.
 +
 
 +
==== Tab-Complete (serverbound) ====
 +
 
 +
Sent when the client needs to tab-complete a <code>minecraft:ask_server</code> suggestion type.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x06
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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 <code>/</code> (e.g. to the left of the cursor in left-to-right languages like English).
 +
|}
 +
 
 +
==== Click Window 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"| 0x07
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Window ID
 +
| Byte
 +
| The ID of the window sent by [[#Open Window|Open Window]].
 +
|-
 +
| Button ID
 +
| 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 Window ====
 +
 
 +
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="8"| 0x08
 +
|rowspan="8"| Play
 +
|rowspan="8"| Server
 +
|colspan="2" | Window ID
 +
|colspan="2" | Unsigned Byte
 +
|colspan="2" | The ID of the window which was clicked. 0 for player inventory.
 +
|-
 +
|colspan="2" | Slot
 +
|colspan="2" | Short
 +
|colspan="2" | The clicked slot number, see below.
 +
|-
 +
|colspan="2" | Button
 +
|colspan="2" | Byte
 +
|colspan="2" | The button used in the click, see below.
 +
|-
 +
|colspan="2" | Mode
 +
|colspan="2" | VarInt Enum
 +
|colspan="2" | Inventory operation mode, see below.
 +
|-
 +
| colspan="2"| Length of the array
 +
| colspan="2"| VarInt
 +
|
 +
|-
 +
|rowspan="2"| Array of slots
 +
| Slot number
 +
|rowspan="2"| Array
 +
| Short
 +
|
 +
|-
 +
| Slot data
 +
| Slot
 +
| New data for this slot
 +
|-
 +
|colspan="2" | Clicked item
 +
|colspan="2" | [[Slot Data|Slot]]
 +
|colspan="2" | The clicked slot. Has to be empty (item ID = -1) for drop mode. Is always empty for mode 2 and mode 5 packets.
 +
|}
 +
 
 +
See [[Inventory]] for further information about how slots are indexed.
 +
 
 +
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="5"| 2
 +
| 0
 +
| Normal
 +
| Number key 1
 +
|-
 +
| 1
 +
| Normal
 +
| Number key 2
 +
|-
 +
| 2
 +
| Normal
 +
| Number key 3
 +
|-
 +
| ⋮
 +
| ⋮
 +
| ⋮
 +
|-
 +
| 8
 +
| Normal
 +
| Number key 9
 +
|-
 +
! 3
 +
| 2
 +
| Normal
 +
| Middle click, only defined for creative players in non-player inventories.
 +
|-
 +
!rowspan="1"| 4
 +
| 0
 +
| Normal*
 +
| 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.  (Note: the vanilla client will still incorrectly send this for non-creative players - see [https://bugs.mojang.com/browse/MC-46584 MC-46584])
 +
|-
 +
| 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.  (Note: the vanilla client will still incorrectly send this for non-creative players - see [https://bugs.mojang.com/browse/MC-46584 MC-46584])
 +
|-
 +
| 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.  (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):
 +
 
 +
# 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 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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x09
 +
| Play
 +
| Server
 +
| Window ID
 +
| Unsigned Byte
 +
| This is the ID of the window that was closed. 0 for player inventory.
 +
|}
 +
 
 +
==== Plugin Message (serverbound) ====
 +
 
 +
{{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"| 0x0A
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Channel
 +
| Identifier
 +
| Name of the [[plugin channel]] used to send the data.
 +
|-
 +
| Data
 +
| Byte Array
 +
| Any data, depending on the channel. <code>minecraft:</code> channels are documented [[plugin channel|here]]. The length of this array must be inferred from the packet length.
 +
|}
 +
 
 +
==== Edit Book ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x0B
 +
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| New book
 +
| [[Slot]]
 +
|
 +
|-
 +
| Is signing
 +
| Boolean
 +
| True if the player is signing the book; false if the player is saving a draft.
 +
|-
 +
| Hand
 +
| VarInt enum
 +
| 0: Main hand, 1: Off hand.
 +
|}
 +
 
 +
When editing a draft, the [[NBT]] section of the Slot contains this:
 +
 
 +
<pre>
 +
TAG_Compound(<nowiki>''</nowiki>): 1 entry
 +
{
 +
  TAG_List('pages'): 2 entries
 +
  {
 +
    TAG_String(0): 'Something on Page 1'
 +
    TAG_String(1): 'Something on Page 2'
 +
  }
 +
}
 +
</pre>
 +
 
 +
When signing the book, it instead looks like this:
 +
 
 +
<pre>
 +
TAG_Compound(<nowiki>''</nowiki>): 3 entires
 +
{
 +
  TAG_String('author'): 'Steve'
 +
  TAG_String('title'): 'A Wonderful Book'
 +
  TAG_List('pages'): 2 entries
 +
  {
 +
    TAG_String(0): 'Something on Page 1'
 +
    TAG_String(1): 'Something on Page 2'
 +
  }
 +
}
 +
</pre>
 +
 
 +
==== Query Entity NBT ====
 +
 
 +
Used when <kbd>Shift</kbd>+<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"| 0x0C
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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 Entity ====
 +
 
 +
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 [[#Creative Inventory Action|Creative Inventory Action]] packet instead.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x0D
 +
|rowspan="7"| Play
 +
|rowspan="7"| 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.
 +
|}
 +
 
 +
==== Generate Structure ====
 +
 
 +
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"| 0x0E
 +
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Location
 +
| Position
 +
| Block entity location.
 +
|-
 +
| Levels
 +
| VarInt
 +
| Value of the levels slider/max depth to generate.
 +
|-
 +
| Keep Jigsaws
 +
| Boolean
 +
|
 +
|}
 +
 
 +
==== Keep Alive (serverbound) ====
 +
 
 +
The server will frequently send out a 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
 +
|-
 +
| 0x0F
 +
| 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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x10
 +
| Play
 +
| Server
 +
| Locked
 +
| Boolean
 +
|
 +
|}
 +
 
 +
==== Player Position ====
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x11
 +
|rowspan="4"| Play
 +
|rowspan="4"| 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.
 +
|}
 +
 
 +
==== Player Position And Rotation (serverbound) ====
 +
 
 +
A combination of [[#Player Rotation|Player Rotation]] and [[#Player Position|Player Position]].
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="6"| 0x12
 +
|rowspan="6"| Play
 +
|rowspan="6"| 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.
 +
|}
 +
 
 +
==== 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"| 0x13
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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.
 +
|}
 +
 
 +
==== Player Movement ====
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x14
 +
| Play
 +
| Server
 +
| On Ground
 +
| Boolean
 +
| True if the client is on the ground, false otherwise.
 +
|}
 +
 
 +
==== Vehicle Move (serverbound) ====
 +
 
 +
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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x15
 +
|rowspan="5"| Play
 +
|rowspan="5"| 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.
 +
|}
 +
 
 +
==== Steer Boat ====
 +
 
 +
Used to ''visually'' update whether boat paddles are turning.  The server will update the [[Entities#Boat|Boat entity metadata]] to match the values here.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x16
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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 Notchain 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
 +
|-
 +
| 0x17
 +
| Play
 +
| Server
 +
| Slot to use
 +
| VarInt
 +
| See [[Inventory]].
 +
|}
 +
 
 +
The server will first search the player's hotbar for an empty slot, starting from the current slot and looping around to the slot before it.  If there are no empty slots, it will start a second search from the current slot and find the first slot that does not contain an enchanted item.  If there still are no slots that meet that criteria, then the server will use the currently selected slot.
 +
 
 +
After finding the appropriate slot, the server swaps the items and then send 3 packets:
 +
 
 +
* [[Protocol#Set slot|Set Slot]], with window ID set to -2 and slot set to the newly chosen slot and the item set to the item that is now in that slot (which was previously at the slot the client requested)
 +
* Set Slot, with window ID set to -2 and slot set to the slot the player requested, with the item that is now in that slot and was previously on the hotbar slot
 +
* [[Protocol#Held_Item_Change_.28clientbound.29|Held Item Change]], with the slot set to the newly chosen slot.
 +
 
 +
==== Craft Recipe Request ====
 +
 
 +
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"| 0x18
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x19
 +
| Play
 +
| Server
 +
| Flags
 +
| Byte
 +
| Bit mask. 0x02: is flying.
 +
|}
 +
 
 +
==== Player Digging ====
 +
 
 +
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).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x1A
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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).
 +
|}
 +
 
 +
Status can be one of seven values:
 +
 
 +
{| class="wikitable"
 +
! Value
 +
! Meaning
 +
! Notes
 +
|-
 +
| 0
 +
| Started digging
 +
|
 +
|-
 +
| 1
 +
| Cancelled digging
 +
| Sent when the player lets go of the Mine Block key (default: left click).
 +
|-
 +
| 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: depends on OS). Location is always set to 0/0/0, Face is always set to -Y.
 +
|-
 +
| 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.
 +
|-
 +
| 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.
 +
|-
 +
| 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.
 +
|}
 +
 
 +
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
 +
|}
 +
 
 +
==== Entity Action ====
 +
 
 +
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"| 0x1B
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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:
 +
 
 +
{| 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 horse 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 due today time.
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x1C
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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 ====
 +
 
 +
A response to the ping packet sync to the main thread. Unknown what this is used for, this is ignored by the Notchian client and server. Most likely added as a replacement to the removed window confirmation packet.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x1D
 +
| Play
 +
| Server
 +
| ID
 +
| Int
 +
|
 +
|}
 +
 
 +
==== Set Recipe Book State ====
 +
 
 +
Replaces Recipe Book Data, type 1.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x1E
 +
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Book ID
 +
| VarInt enum
 +
| 0: crafting, 1: furnace, 2: blast furnace, 3: smoker.
 +
|-
 +
| Book Open
 +
| Boolean
 +
|
 +
|-
 +
| Filter Active
 +
| Boolean
 +
|
 +
|}
 +
 
 +
==== Set Displayed Recipe ====
 +
 
 +
Replaces Recipe Book Data, type 0.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x1F
 +
| Play
 +
| Server
 +
| Recipe ID
 +
| Identifier
 +
|
 +
|}
 +
 
 +
==== Name Item ====
 +
 
 +
Sent as a player is renaming an item in an anvil (each keypress in the anvil UI sends a new Name Item packet).  If the new name is empty, then the item loses its custom name (this is different from setting the custom name to the normal name of the item).  The item name may be no longer than 35 characters long, and if it is longer than that, then the rename is silently ignored.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x20
 +
| Play
 +
| Server
 +
| Item name
 +
| String (32767)
 +
| The new name of the item.
 +
|}
 +
 
 +
==== Resource Pack Status ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x21
 +
| Play
 +
| Server
 +
| Result
 +
| VarInt Enum
 +
| 0: successfully loaded, 1: declined, 2: failed download, 3: accepted.
 +
|}
 +
 
 +
==== Advancement Tab ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x22
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x23
 +
| Play
 +
| Server
 +
| Selected slot
 +
| VarInt
 +
| The selected slot in the players current (trading) inventory. (Was a full Integer for the plugin message).
 +
|}
 +
 
 +
==== Set Beacon Effect ====
 +
 
 +
Changes the effect of the current beacon.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x24
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Primary Effect
 +
| VarInt
 +
| A [https://minecraft.gamepedia.com/Data_values#Potions Potion ID]. (Was a full Integer for the plugin message).
 +
|-
 +
| Secondary Effect
 +
| VarInt
 +
| A [https://minecraft.gamepedia.com/Data_values#Potions Potion ID]. (Was a full Integer for the plugin message).
 +
|}
 +
 
 +
==== Held Item Change (serverbound) ====
 +
 
 +
Sent when the player changes the slot selection
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x25
 +
| Play
 +
| Server
 +
| Slot
 +
| Short
 +
| The slot which the player has selected (0–8).
 +
|}
 +
 
 +
==== Update Command Block ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x26
 +
|rowspan="5"| Play
 +
|rowspan="5"| 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.
 +
|}
 +
 
 +
==== Update Command Block Minecart ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x27
 +
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Command
 +
| String
 +
|
 +
|-
 +
| Track Output
 +
| Boolean
 +
| If false, the output of the previous command will not be stored within the command block.
 +
|}
 +
 
 +
==== Creative Inventory Action ====
 +
 
 +
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"| 0x28
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Slot
 +
| Short
 +
| Inventory slot.
 +
|-
 +
| Clicked Item
 +
| [[Slot Data|Slot]]
 +
|
 +
|}
 +
 
 +
==== Update 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="6"| 0x29
 +
|rowspan="6"| Play
 +
|rowspan="6"| Server
 +
| Location
 +
| Position
 +
| Block entity location
 +
|-
 +
| Name
 +
| Identifier
 +
|
 +
|-
 +
| Target
 +
| Identifier
 +
|
 +
|-
 +
| Pool
 +
| Identifier
 +
|
 +
|-
 +
| Final state
 +
| String
 +
| "Turns into" on the GUI, <code>final_state</code> in NBT.
 +
|-
 +
| Joint type
 +
| String
 +
| <code>rollable</code> if the attached piece can be rotated, else <code>aligned</code>.
 +
|}
 +
 
 +
==== Update Structure Block ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="17"| 0x2A
 +
|rowspan="17"| Play
 +
|rowspan="17"| 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
 +
|
 +
|-
 +
| Offset X || Byte
 +
| Between -32 and 32.
 +
|-
 +
| Offset Y || Byte
 +
| Between -32 and 32.
 +
|-
 +
| Offset Z || Byte
 +
| Between -32 and 32.
 +
|-
 +
| Size X || Byte
 +
| Between 0 and 32.
 +
|-
 +
| Size Y || Byte
 +
| Between 0 and 32.
 +
|-
 +
| Size Z || Byte
 +
| Between 0 and 32.
 +
|-
 +
| 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
 +
|
 +
|-
 +
| 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 ====
 +
 
 +
{{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 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="5"| 0x2B
 +
|rowspan="5"| Play
 +
|rowspan="5"| Server
 +
| Location
 +
| Position
 +
| Block Coordinates.
 +
|-
 +
| 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.
 +
|}
 +
 
 +
==== Animation (serverbound) ====
 +
 
 +
Sent when the player's arm swings.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x2C
 +
| Play
 +
| Server
 +
| Hand
 +
| VarInt Enum
 +
| Hand used for the animation. 0: main hand, 1: off hand.
 +
|}
 +
 
 +
==== Spectate ====
 +
 
 +
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
 +
|-
 +
| 0x2D
 +
| Play
 +
| Server
 +
| Target Player
 +
| UUID
 +
| UUID of the player to teleport to (can also be an entity UUID).
 +
|}
 +
 
 +
==== Player Block Placement ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x2E
 +
|rowspan="7"| Play
 +
|rowspan="7"| 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 Digging|Player Digging]]).
 +
|-
 +
| 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.
 +
|}
 +
 
 +
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
 +
|-
 +
| 0x2F
 +
| Play
 +
| Server
 +
| Hand
 +
| VarInt Enum
 +
| Hand used for the animation. 0: main hand, 1: off hand.
 +
|}
  
 
[[Category:Protocol Details]]
 
[[Category:Protocol Details]]
 
[[Category:Minecraft Modern]]
 
[[Category:Minecraft Modern]]

Revision as of 03:53, 15 June 2021

Heads up!

This article is about the protocol for the latest stable release of Minecraft Java Edition (1.17, protocol 755). 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… you still need to provide attribution to #mcdevs if you copy any of the contents of this page for publication elsewhere.

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 Encoded as a String with max length of 262144.
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) n 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 represents the signed integer part (number to the left of the decimal point) and the rest represents the fractional part (to the right). Floating points (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 points, their fractional precision is greater for higher values. This makes them ideal for representing global coordinates of an entity in Minecraft, as it's more important to store the integer part accurately than position them more precisely within a single block (or meter).

Coordinates are often represented as a 32-bit integer, where 5 of the least-significant bits are dedicated to the fractional part, and the rest store the integer part.

Java lacks support for fractional integers directly, but you can represent them as integers. To convert from a double to this integer representation, use the following formulas:

 abs_int = (int) (double * 32.0D);

And back again:

 double = (double) (abs_int / 32.0D);

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.

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”.
Global palette A table/dictionary/palette mapping nonnegative integers to block states. Block state IDs are created in a linear fashion based off of order of assignment. One block state ID allocated for each unique block state for a block; if a block has multiple properties then the number of allocated states is the product of the number of values for each property. A current list of properties and state ID ranges is found on 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.

Packet format

Packets cannot be larger than 2097151 bytes (the maximum that can be sent in a 3-byte VarInt). For compressed packets, this applies to both the compressed length and uncompressed lengths.

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)

The length given by the Packet Length field is the number of bytes that remain in that packet, including the Data Length field.

If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.

If compressed, the uncompressed length of (Packet ID + Data) must be equal to or over the threshold set in the packet Set Compression, otherwise the receiving party will disconnect.

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 755 in Minecraft 1.17).
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.

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

Response

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

Pong

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

Request

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

Ping

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

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 localhost connections (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 Chat

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)

This packet switches the connection state to play.

Warning.png The (notchian) server might take a bit to fully transition to the Play state, so it's recommended to wait before sending Play packets, either by setting a timeout, or waiting for Play packets from the server (usually Player Info).

The notchian client doesn't send any (non-keep alive) packets until the next tick/time update packet.

Set Compression

Enables compression. If compression is enabled, all following packets are encoded in the compressed packet format. Negative or zero 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 Any data, depending on the channel. The length of this array must be inferred from the packet length.

Serverbound

Login Start

Packet ID State Bound To Field Name Field Type Notes
0x00 Login Server Name String (16) Player's Username.

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 understands the request, false otherwise. When false, no payload follows.
Data Optional Byte Array Any data, depending on the channel. The length of this array must be inferred from the packet length.

Play

Clientbound

Spawn Entity

Sent by the server when a vehicle or other non-living entity is created.

Packet ID State Bound To Field Name Field Type Notes
0x00 Play Client Entity ID VarInt EID of the entity.
Object UUID UUID
Type VarInt The type of entity (same as in Spawn Living Entity).
X Double
Y Double
Z Double
Pitch Angle
Yaw Angle
Data Int Meaning dependent on the value of the Type field, see Object Data for details.
Velocity X Short Same units as 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.

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

Spawn Living Entity

Sent by the server when a living entity is spawned.

Packet ID State Bound To Field Name Field Type Notes
0x02 Play Client Entity ID VarInt
Entity UUID UUID
Type VarInt The type of mob. See Entities#Mobs.
X Double
Y Double
Z Double
Yaw Angle
Pitch Angle
Head Pitch Angle
Velocity X Short Same units as Entity Velocity.
Velocity Y Short Same units as Entity Velocity.
Velocity Z Short Same units as Entity Velocity.

Spawn Painting

This packet shows location, name, and type of painting.

Packet ID State Bound To Field Name Field Type Notes
0x03 Play Client Entity ID VarInt
Entity UUID UUID
Motive VarInt Painting's ID, see below.
Location Position Center coordinates (see below).
Direction Byte Enum Direction the painting faces (North = 2, South = 0, West = 1, East = 3).

Calculating the center of an image: given a (width × height) grid of cells, with (0, 0) being the top left corner, the center is (max(0, width / 2 - 1), height / 2). E.g. (1, 0) for a 2×1 painting, or (1, 2) for a 4×4 painting.

List of paintings by coordinates in paintings_kristoffer_zetterstrand.png (where x and y are in pixels from the top left and width and height are in pixels or 16ths of a block):

Name ID x y width height
minecraft:kebab 0 0 0 16 16
minecraft:aztec 1 16 0 16 16
minecraft:alban 2 32 0 16 16
minecraft:aztec2 3 48 0 16 16
minecraft:bomb 4 64 0 16 16
minecraft:plant 5 80 0 16 16
minecraft:wasteland 6 96 0 16 16
minecraft:pool 7 0 32 32 16
minecraft:courbet 8 32 32 32 16
minecraft:sea 9 64 32 32 16
minecraft:sunset 10 96 32 32 16
minecraft:creebet 11 128 32 32 16
minecraft:wanderer 12 0 64 16 32
minecraft:graham 13 16 64 16 32
minecraft:match 14 0 128 32 32
minecraft:bust 15 32 128 32 32
minecraft:stage 16 64 128 32 32
minecraft:void 17 96 128 32 32
skull_and_roses 18 128 128 32 32
minecraft:wither 19 160 128 32 32
minecraft:fighters 20 0 96 64 32
minecraft:pointer 21 0 192 64 64
minecraft:pigscene 22 64 192 64 64
minecraft:burning_skull 23 128 192 64 64
minecraft:skeleton 24 192 64 64 48
minecraft:donkey_kong 25 192 112 64 48

The Minecraft Wiki article on paintings also provides a list of painting names to the actual images.

Spawn Player

This packet is sent by the server when a player comes into visible range, not when a player joins.

This packet must be sent after the Player Info packet that adds the player data for the client to use when spawning a player. If the Player Info for the player spawned by this packet is not present when this packet arrives, Notchian clients will not spawn the player entity. The Player Info packet includes skin/cape data.

Servers can, however, safely spawn player entities for players not in visible range. The client appears to handle it correctly.

Packet ID State Bound To Field Name Field Type Notes
0x04 Play Client Entity ID VarInt Player's EID.
Player UUID UUID See below for notes on offline mode and NPCs.
X Double
Y Double
Z Double
Yaw Angle
Pitch Angle

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

Sculk Vibration Signal

Packet ID State Bound To Field Name Field Type Notes
0x05 Play Client Source Position Position Source position for the vibration.
Destination Identifier Identifier Identifier of the destination codec type.
Destination Varies Vanilla default destinations are a block position encoded as a Position for "block" or an entity id encoded as a VarInt for "entity".
Arrival Ticks VarInt Ticks for the signal to arrive at the destination.

This packet shows a permanent particle.

Entity Animation (clientbound)

Sent whenever an entity should change animation.

Packet ID State Bound To Field Name Field Type Notes
0x06 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
1 Take damage
2 Leave bed
3 Swing offhand
4 Critical effect
5 Magic critical effect

Statistics

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

Packet ID State Bound To Field Name Field Type Notes
0x07 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 Player Digging

Packet ID State Bound To Field Name Field Type Notes
0x08 Play Client Location Position Position where the digging was happening.
Block VarInt Block state ID of the block that should be at that position now.
Status VarInt enum Same as Player Digging. Only Started digging (0), Cancelled digging (1), and Finished digging (2) are used.
Successful Boolean True if the digging succeeded; false if the client should undo any changes it made locally.

Block Break Animation

0–9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.

Block break animations can still be applied on air; the animation will remain visible although there is no block being broken. However, if this is applied to a transparent block, odd graphical effects may happen, including water losing its transparency. (An effect similar to this can be seen in normal gameplay when breaking ice blocks)

If you need to display several break animations at the same time you have to give each of them a unique Entity ID. The entity ID does not need to correspond to an actual entity on the client. It is valid to use a randomly generated number.

Packet ID State Bound To Field Name Field Type Notes
0x09 Play Client Entity ID VarInt Entity 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
0x0A Play Client Location Position
Action Unsigned Byte The type of update to perform, see below.
NBT Data NBT Tag Data to set. May be a TAG_END (0), in which case the block entity at the given location is removed (though this is not required since the client will remove the block entity automatically on chunk unload or block removal).

Action field:

  • 1: Set data of a mob spawner (everything except for SpawnPotentials: current delay, min/max delay, mob to be spawned, spawn count, spawn range, etc.)
  • 2: Set command block text (command and last execution status)
  • 3: Set the level, primary, and secondary powers of a beacon
  • 4: Set rotation and skin of mob head
  • 5: Declare a conduit
  • 6: Set base color and patterns on a banner
  • 7: Set the data for a Structure tile entity
  • 8: Set the destination for a end gateway
  • 9: Set the text on a sign
  • 10: Unused
  • 11: Declare a bed
  • 12: Set data of a jigsaw block
  • 13: Set items in a campfire
  • 14: Beehive information

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.

Warning.png This packet uses a block ID, not a block state.

Packet ID State Bound To Field Name Field Type Notes
0x0B Play Client Location Position Block coordinates.
Action ID (Byte 1) Unsigned Byte 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. This must match the block at the given coordinates.

Block Change

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
0x0C Play Client Location Position Block Coordinates.
Block ID VarInt The new block state ID for the block as given in the global palette. See that section for more information.

Boss Bar

Packet ID State Bound To Field Name Field Type Notes
0x0D 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 Chat
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 Chat
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

Server Difficulty

Changes the difficulty setting in the client's option menu

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

Chat Message (clientbound)

Identifying the difference between Chat/System Message is important as it helps respect the user's chat visibility options. See processing chat for more info about these positions.

Packet ID State Bound To Field Name Field Type Notes
0x0F Play Client JSON Data Chat Limited to 262144 bytes.
Position Byte 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
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.

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
0x10 Play Client Reset Boolean

Tab-Complete (clientbound)

The server responds with a list of auto-completions of the last word sent to it. In the case of regular chat, this is a player username. Command names and parameters are also supported. The client sorts these alphabetically before listing them.

Packet ID State Bound To Field Name Field Type Notes
0x11 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 Chat Tooltip to display; only present if previous boolean is true.

Declare Commands

Lists all of the commands on the server, and how they are parsed.

This is a directed graph, with one root node. Each redirect or child node must refer only to nodes that have already been declared.

Packet ID State Bound To Field Name Field Type Notes
0x12 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 Window (clientbound)

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

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

Window Items

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. This packet with Window ID set to "0" is sent during the player joining sequence to initialise the player's inventory.

Packet ID State Bound To Field Name Field Type Notes
0x14 Play Client Window ID Unsigned Byte The ID of window which items are being sent for. 0 for player inventory.
Count Short Number of elements in the following array.
Slot Data Array of Slot

See inventory windows for further information about how slots are indexed.

Window Property

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

Packet ID State Bound To Field Name Field Type Notes
0x15 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 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
0x16 Play Client 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 Short The slot that should be updated.
Slot Data Slot

To set the cursor (the item currently dragged with the mouse), use -1 as Window ID and as Slot.

This packet can only be used to edit the hotbar of the player's inventory if window ID is set to 0 (slots 36 through 44). If the window ID is set to -2, then any slot in the inventory can be used but no add item animation will be played.

Set Cooldown

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

Packet ID State Bound To Field Name Field Type Notes
0x17 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.

Plugin Message (clientbound)

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 documentation on this: https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/

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 Any data, depending on the channel. minecraft: channels are documented here. The length of this array must be inferred from the packet length.

Named Sound Effect

See also: #Sound Effect

Used to play a sound effect on the client. Custom sounds may be added by resource packs.

Packet ID State Bound To Field Name Field Type Notes
0x19 Play Client Sound Name Identifier All sound effect names as of 1.16.5 can be seen here.
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 is 100%, can be more.
Pitch Float Float between 0.5 and 2.0 by Notchian clients.

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
0x1A Play Client 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).

Packet ID State Bound To Field Name Field Type Notes
0x1B 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
0x1C Play Client X Float
Y Float
Z Float
Strength Float A strength greater than or equal to 2.0 spawns a minecraft:explosion_emitter particle, while a lesser strength spawns a minecraft:explosion particle.
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.

Unload Chunk

Tells the client to unload a chunk column.

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

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

Change Game State

Used for a wide variety of game state things, from weather to bed use to gamemode to demo messages.

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

Reason codes:

Reason Effect Value
0 No respawn block available Note: Sends message 'block.minecraft.spawn.not_valid'(You have no home bed or charged respawn anchor, or it was obstructed) to the client.
1 End raining
2 Begin raining
3 Change gamemode 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 skycolor and lightning. You can see some level images here
Rain level starting from 0.
8 Thunder level change Note: Seems to change both skycolor and lightning (same as Rain level change, but doesn't start rain). It also requires rain to render by notchian client.
Thunder level starting from 0.
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).

Open Horse Window

This packet is used exclusively for opening the horse GUI. Open Window is used for all other GUIs.

Packet ID State Bound To Field Name Field Type Notes
0x1F Play Client Window ID? Byte
Number of slots? VarInt
Entity ID? Integer

Initialize World Border

Packet ID State Bound To Field Name Field Type Notes
0x20 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;
}

Keep Alive (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). If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.

The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.

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

Chunk Data

Main article: Chunk Format
See also: #Unload Chunk
Huh.png The following information needs to be added to this page:
How do biomes work now? The biome change happened at the same time as the seed change, but it's not clear how/if biomes could be computed given that it's not the actual seed... (/r/mojira discussion which notes that it seems to be some kind of interpolation, and 3D biomes are only used in the nether)

The server only sends skylight information for chunk pillars in the Overworld, it's up to the client to know in which dimension 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 later).

Packet ID State Bound To Field Name Field Type Notes
0x22 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)
Bit Mask Length VarInt Length of the following array
Primary Bit Mask Array of Long BitSet with bits (world height in blocks / 16) 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 the lowest y to 15 blocks above).
Heightmaps NBT Compound containing one long array named MOTION_BLOCKING, which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry totaling 36 longs). The Notchian server also adds a WORLD_SURFACE long array, the purpose of which is unknown, but it's not required for the chunk to be accepted.
Biomes length VarInt Size of the following array; should always be 1024.
Biomes Array of VarInt 1024 biome IDs, ordered by x then z then y, in 4×4×4 blocks. See Chunk Format § Biomes.
Size VarInt Size of Data in bytes
Data Byte array See data structure in Chunk Format
Number of block entities VarInt Number of elements in the following array
Block entities Array of NBT Tag All block entities in the chunk. Use the x, y, and z tags in the NBT to determine their positions.

Note that the Notchian client requires an Update View Position packet when it crosses a chunk border, otherwise it'll only display render distance + 2 chunks around the chunk it spawned in.

The compacted array format has been adjusted so that individual entries no longer span across multiple longs, affecting the main data array and heightmaps.

New format, 5 bits per block, containing the following references to blocks in a palette (not shown): 122344566480743131516914101202

0020863148418841 0000000000100000100001100011000101001000010000011000100001000001
01018A7260F68C87 0000000100000001100010100111001001100000111101101000110010000111

Effect

Sent when a client is to play a sound or particle effect.

By default, the Minecraft client adjusts the volume of sound effects based on distance. The final boolean field is used to disable this, and instead the effect is played from 2 blocks away in the correct direction. Currently this is only used for effect 1023 (wither spawn), 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
0x23 Play Client Effect ID Int The ID of the effect, see below.
Location Position The location of the effect.
Data Int Extra data for certain effects, see below.
Disable Relative Volume Boolean See above.

Effect IDs:

ID Name Data
Sound
1000 Dispenser dispenses
1001 Dispenser fails to dispense
1002 Dispenser shoots
1003 Ender eye launched
1004 Firework shot
1005 Iron door opened
1006 Wooden door opened
1007 Wooden trapdoor opened
1008 Fence gate opened
1009 Fire extinguished
1010 Play record Special case, see below for more info.
1011 Iron door closed
1012 Wooden door closed
1013 Wooden trapdoor closed
1014 Fence gate closed
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, as an index into the global palette.
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

Play record: This is actually a special case within this packet. You can start/stop a record at a specific location. Use a valid Record ID to start a record (or overwrite a currently playing one), any other value will stop the record. See Data Generators for information on item IDs.

Particle

Displays the named particle

Packet ID State Bound To Field Name Field Type Notes
0x24 Play Client Particle ID Int The particle ID listed in the particle data type.
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().
Particle Data Float The data of each particle.
Particle Count Int The number of particles to create.
Data Varies The variable data listed in the particle data type.

Update Light

Updates light levels for a chunk.

Packet ID State Bound To Field Name Field Type Notes
0x25 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)
Trust Edges Boolean If edges should be trusted for light updates.
Length 1 VarInt Length of the following array
Sky Light Mask Array of Long BitSet containing bits for each sections in the world + 2 (lowest bit 16-1 blocks below min world height, highest 1-16 above max world height)
Length 2 VarInt Length of the following array
Block Light Mask Array of Long BitSet containing bits for each sections in the world + 2, same order as sky light
Length 3 VarInt Length of the following array
Empty Sky Light Mask Array of Long BitSet containing a variable amount of bits (see sky/block light) which indicates sections that have 0 for all their sky light values
Length 4 VarInt Length of the following array
Empty Block Light Mask Array of Long BitSet containing a variable amount of bits (see sky/block light) which indicates sections that have 0 for all their block light values
Sky Light array count VarInt Number of entries in the following array
Sky Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Sky Light array Array of 2048 bytes There is 1 array for each bit set to true in the sky light mask, starting with the lowest value. Half a byte per light value.
Block Light array count VarInt Number of entries in the following array
Block Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Block Light array Array of 2048 bytes There is 1 array for each bit set to true in the block light mask, starting with the lowest value. Half a byte per light value.

Join Game

See Protocol Encryption for information on logging in.

Packet ID State Bound To Field Name Field Type Notes
0x26 Play Client Entity ID Int The player's Entity ID (EID).
Is hardcore Boolean
Gamemode Unsigned Byte 0: Survival, 1: Creative, 2: Adventure, 3: Spectator.
Previous Gamemode Byte 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included. The previous gamemode. Defaults to -1 if there is no previous gamemode. (More information needed)
World Count VarInt Size of the following array.
World Names Array of Identifier Identifiers for all worlds on the server.
Dimension Codec NBT Tag Compound The full extent of these is still unknown, but the tag represents a dimension and biome registry. See below for the vanilla default.
Dimension NBT Tag Compound Valid dimensions are defined per dimension registry sent before this. The structure of this tag is a dimension type (see below).
World Name Identifier Name of the world 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
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).
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.
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.


The Dimension Codec NBT Tag Compound (Default value in SNBT) includes two registries: "minecraft:dimension_type" and "minecraft:worldgen/biome".

Name Type Notes
minecraft:dimension_type TAG_Compound The dimension type registry (see below).
minecraft:worldgen/biome TAG_Compound The biome registry (see below).

Dimension type registry:

Name Type Notes
type TAG_String The name of the registry. Always "minecraft:dimension_type".
value TAG_List List of dimension types registry entries (see below).

Dimension type registry entry:

Name Type Notes
name TAG_String The name of the dimension type (for example, "minecraft:overworld").
id TAG_Int The protocol ID of the dimension (matches the index of the element in the registry list).
element TAG_Compound The dimension type (see below).

Dimension type:

Name Type Meaning Values
piglin_safe TAG_Byte Whether piglins shake and transform to zombified piglins. 1: true, 0: false.
natural TAG_Byte When false, compasses spin randomly. When true, nether portals can spawn zombified piglins. 1: true, 0: false.
ambient_light TAG_Float How much light the dimension has. 0.0 to 1.0.
fixed_time Optional TAG_Long If set, the time of the day is the specified value. If set, 0 to 24000.
infiniburn TAG_String A resource location defining what block tag to use for infiniburn. "" or minecraft resource "minecraft:...".
respawn_anchor_works TAG_Byte Whether players can charge and use respawn anchors. 1: true, 0: false.
has_skylight TAG_Byte Whether the dimension has skylight access or not. 1: true, 0: false.
bed_works TAG_Byte Whether players can use a bed to sleep. 1: true, 0: false.
effects TAG_String ? "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" or something else.
has_raids TAG_Byte Whether players with the Bad Omen effect can cause a raid. 1: true, 0: false.
min_y TAG_Int The minimum Y level.
height TAG_Int The maximum height.
logical_height TAG_Int The maximum height to which chorus fruits and nether portals can bring players within this dimension. 0-256.
coordinate_scale TAG_Float The multiplier applied to coordinates when traveling to the dimension. 0.00001 - 30000000.0
ultrawarm TAG_Byte Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also causes lava to spread thinner. 1: true, 0: false.
has_ceiling TAG_Byte Whether the dimension has a bedrock ceiling or not. When true, causes lava to spread faster. 1: true, 0: false.

Biome registry:

Name Type Notes
type TAG_String The name of the registry. Always "minecraft:worldgen/biome".
value TAG_List List of biome registry entries (see below).

Biome registry entry:

Name Type Notes
name TAG_String The name of the biome (for example, "minecraft:ocean").
id TAG_Int The protocol ID of the biome (matches the index of the element in the registry list).
element TAG_Compound The biome properties (see below).

Biome properties:

Name Type Meaning Values
precipitation TAG_String The type of precipitation in the biome. "rain", "snow", or "none".
depth TAG_Float The depth factor of the biome. The default values vary between 1.5 and -1.8.
temperature TAG_Float The temperature factor of the biome. The default values vary between 2.0 and -0.5.
scale TAG_Float ? The default values vary between 1.225 and 0.0.
downfall TAG_Float ? The default values vary between 1.0 and 0.0.
category TAG_String The category of the biome. Known values are "ocean", "plains", "desert", "forest", "extreme_hills", "taiga", "swamp", "river", "nether", "the_end", "icy", "mushroom", "beach", "jungle", "mesa", "savanna", and "none".
temperature_modifier Optional TAG_String ? The only known value is "frozen".
effects sky_color TAG_Compound TAG_Int The color of the sky. Example: 8364543, which is #7FA1FF in RGB.
water_fog_color TAG_Int Possibly the tint color when swimming. Example: 8364543, which is #7FA1FF in RGB.
fog_color TAG_Int Possibly the color of the fog effect when looking past the view distance. Example: 8364543, which is #7FA1FF in RGB.
water_color TAG_Int The tint color of the water blocks. Example: 8364543, which is #7FA1FF in RGB.
foliage_color Optional TAG_Int The tint color of the grass. Example: 8364543, which is #7FA1FF in RGB.
grass_color Optional TAG_Int ? Example: 8364543, which is #7FA1FF in RGB.
grass_color_modifier Optional TAG_String Unknown, likely affects foliage color. If set, known values are "swamp" and "dark_forest".
music Optional TAG_Compound Music properties for the biome. If present, contains the fields: replace_current_music (TAG_Byte), sound (TAG_String), max_delay (TAG_Int), min_delay (TAG_Int).
ambient_sound Optional TAG_String Ambient soundtrack. If present, the ID of a soundtrack. Example: "minecraft:ambient.basalt_deltas.loop".
additions_sound Optional TAG_Compound Additional ambient sound that plays randomly. If present, contains the fields: sound (TAG_String), tick_chance (TAG_Double).
mood_sound Optional TAG_Compound Additional ambient sound that plays at an interval. If present, contains the fields: sound (TAG_String), tick_delay (TAG_Int), offset (TAG_Double), block_search_extent (TAG_Int).
particle Optional TAG_Compound Particles that appear randomly in the biome. If present, contains the fields: probability (TAG_Float), options (TAG_Compound). The "options" compound contains the field "type" (TAG_String), which identifies the particle type.

Map Data

Updates a rectangular area on a map item.

Packet ID State Bound To Field Name Field Type Notes
0x27 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
Tracking Position Boolean Specifies whether player and item frame icons are shown
Icon Count VarInt Number of elements in the following array. Only present if "Tracking Position" is true.
Icon Type 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 Chat Only present if previous Boolean is true
Columns Unsigned Byte Number of columns updated
Rows Optional 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

Trade List

The list of trades a villager NPC is offering.

Packet ID State Bound To Field Name Field Type Notes
0x28 Play Client
Window ID VarInt The ID of the window that is open; this is an int rather than a byte.
Size Byte 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.
Has second item Boolean Whether there is a second item.
Input item 2 Optional Slot The second item the player has to supply for this villager trade; only present if has a second item is true.
Trade disabled Boolean True if the trade is disabled; false if the trade is enabled.
Number of trade uses Integer 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 Integer Number of times this trade can be used before it's exhausted.
XP Integer Amount of XP both the player and the villager will earn each time the trade is used.
Special Price Integer 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 Integer Can be zero or a positive number. Causes the price to increase when a trade is used repeatedly.
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

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 Entity Teleport should be sent instead.

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

Packet ID State Bound To Field Name Field Type Notes
0x29 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

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
0x2A 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

Entity Rotation

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

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

Vehicle Move (clientbound)

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

Packet ID State Bound To Field Name Field Type Notes
0x2C 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
0x2D Play Client Hand VarInt enum 0: Main hand, 1: Off hand .

Open Window

This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory. For horses, use Open Horse Window.

Packet ID State Bound To Field Name Field Type Notes
0x2E Play Client Window ID VarInt A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
Window Type VarInt The window type to use for display. Contained in the minecraft:menu registry; see Inventory for the different values.
Window Title Chat The title of the window.

Open Sign Editor

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

Packet ID State Bound To Field Name Field Type Notes
0x2F Play Client Location Position

Ping

Unknown what this packet does just yet, not used by the Notchian server or client. Most likely added as a replacement to the removed window confirmation packet.

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

Craft Recipe Response

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

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

Player Abilities (clientbound)

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

Packet ID State Bound To Field Name Field Type Notes
0x32 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 Entity Properties 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

End Combat Event

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

Packet ID State Bound To Field Name Field Type Notes
0x33 Play Client Duration VarInt Length of the combat in ticks.
Entity ID Int ID of the primary opponent of the ended combat, or -1 if there is no obvious primary opponent.

Enter Combat Event

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

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

Death Combat Event

Used to send a respawn screen.

Packet ID State Bound To Field Name Field Type Notes
0x35 Play Client Player ID VarInt Entity ID of the player that died (should match the client's entity ID).
Entity ID Int The killing entity's ID, or -1 if there is no obvious killer.
Message Chat The death message.

Player Info

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

Packet ID State Bound To Field Name Field Type Notes
0x36 Play Client Action VarInt Determines the rest of the Player format after the UUID.
Number Of Players VarInt Number of elements in the following array.
Player UUID Array UUID
Action Field Name
0: add player 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.
Gamemode VarInt
Ping VarInt Measured in milliseconds.
Has Display Name Boolean
Display Name Optional Chat Only if Has Display Name is true.
1: update gamemode Gamemode VarInt
2: update latency Ping VarInt Measured in milliseconds.
3: update display name Has Display Name Boolean
Display Name Optional Chat Only send if Has Display Name is true.
4: remove player no fields no fields

The Property field looks as in the response of Mojang API#UUID -> Profile + Skin/Cape, except of course using the protocol format instead of JSON. That is, each player will usually have one property with Name “textures” and Value being a base64-encoded JSON string as documented at Mojang API#UUID -> Profile + Skin/Cape. An empty properties array is also acceptable, and will cause clients to display the player with one of the two default skins depending on UUID.

Ping values correspond with icons in the following way:

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

Face Player

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

Packet ID State Bound To Field Name Field Type Notes
0x37 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.

Player Position And Look (clientbound)

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 3.2E7D the client will be kicked for “Illegal position”.

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

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

Packet ID State Bound To Field Name Field Type Notes
0x38 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 Bit field, see below.
Teleport ID VarInt Client should confirm this packet with Teleport Confirm containing the same Teleport ID.
Dismount Vehicle Boolean True if the player should dismount their vehicle.

About the Flags field:

<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
Field Bit
X 0x01
Y 0x02
Z 0x04
Y_ROT 0x08
X_ROT 0x10

Unlock Recipes

Packet ID State Bound To Field Name Field Type Notes
0x39 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.

Destroy Entity

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

Packet ID State Bound To Field Name Field Type Notes
0x3A Play Client Entity ID VarInt The ID of the entity to be destroyed

Remove Entity Effect

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

Resource Pack Send

Packet ID State Bound To Field Name Field Type Notes
0x3C Play Client URL String (32767) The URL to the resource pack.
Hash String (40) A 40 character hexadecimal and lowercase SHA-1 hash of the resource pack file. (must be lower case in order to work)
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
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.
Forced Message Chat This is sent with the force resourcepack popup.

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.

Packet ID State Bound To Field Name Field Type Notes
0x3D Play Client Dimension NBT Tag Compound Valid dimensions are defined per dimension registry sent in Join Game
World Name Identifier Name of the world 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
Gamemode Unsigned Byte 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
Previous Gamemode Unsigned Byte 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included. The previous gamemode. (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.
Copy metadata Boolean If false, metadata is reset on the respawned player entity. Set to true for dimension changes (including the dimension change triggered by sending client status perform respawn to exit the end poem/credits), and false for normal respawns.
Huh.png The following information needs to be added to this page:
Does the new World Name field resolve this same-dimension issue?

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

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.

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
0x3E Play Client Entity ID VarInt
Head Yaw Angle New angle, not a delta.

Multi Block Change

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

Packet ID State Bound To Field Name Field Type Notes
0x3F 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).
Boolean Always inverse the preceding Update Light packet's "Trust Edges" bool
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 right 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

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.

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

The Identifier can be one of the following:

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

Action Bar

Packet ID State Bound To Field Name Field Type Notes
0x41 Play Client Action bar text Chat Displays a message above the hotbar (the same as position 2 in Chat Message (clientbound).

World Border Center

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

World Border Lerp Size

Packet ID State Bound To Field Name Field Type Notes
0x43 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.

World Border Size

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

World Border Warning Delay

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

World Border Warning Reach

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

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
0x47 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

Held Item Change (clientbound)

Sent to change the player's slot selection.

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

Update View Position

Huh.png The following information needs to be added to this page:
Why is this even needed? Is there a better name for it? My guess is that it's something to do with logical behavior with latency, but it still seems weird.

Updates the client's location. This is used to determine what chunks should remain loaded and if a chunk load should be ignored; chunks outside of the view distance may be unloaded.

Sent 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
0x49 Play Client Chunk X VarInt Chunk X coordinate of the player's position.
Chunk Z VarInt Chunk Z coordinate of the player's position.

Update View Distance

Sent by the integrated singleplayer server when changing render distance. Does not appear to be used by the dedicated server, as view-distance in server.properties cannot be changed at runtime.

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

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
0x4B Play Client Location Position Spawn location.
Angle Float The angle at which to respawn at.

Display Scoreboard

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

Packet ID State Bound To Field Name Field Type Notes
0x4C Play Client Position Byte 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 (16) The unique name for the scoreboard to be displayed.

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
0x4D Play Client Entity ID VarInt
Metadata Entity Metadata

Attach Entity

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

Packet ID State Bound To Field Name Field Type Notes
0x4E 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.

Entity Velocity

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

Packet ID State Bound To Field Name Field Type Notes
0x4F 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.

Entity Equipment

Packet ID State Bound To Field Name Field Type Notes
0x50 Play Client Entity ID VarInt Entity's EID.
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
0x51 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.

Update Health

Sent by the server to update/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. Players logging in 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
0x52 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.

Scoreboard Objective

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
0x53 Play Client Objective Name String (16) 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 Chat 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".

Set Passengers

Packet ID State Bound To Field Name Field Type Notes
0x54 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.

Teams

Creates and updates teams.

Packet ID State Bound To Field Name Field Type Notes
0x55 Play Client Team Name String (16) A unique name for the team. (Shared with scoreboard).
Mode Byte Determines the layout of the remaining packet.
0: create team Team Display Name Chat
Friendly Flags Byte Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team.
Name Tag Visibility String Enum (32) always, hideForOtherTeams, hideForOwnTeam, never.
Collision Rule String Enum (32) always, pushOtherTeams, pushOwnTeam, never.
Team Color VarInt enum Used to color the name of players on the team; see below.
Team Prefix Chat Displayed before the names of players that are part of this team.
Team Suffix Chat 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 (40) 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 Chat
Friendly Flags Byte Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible entities on same team.
Name Tag Visibility String Enum (32) always, hideForOtherTeams, hideForOwnTeam, never
Collision Rule String Enum (32) always, pushOtherTeams, pushOwnTeam, never
Team Color VarInt enum Used to color the name of players on the team; see below.
Team Prefix Chat Displayed before the names of players that are part of this team.
Team Suffix Chat 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 (40) 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 (40) 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 Chat 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
0x56 Play Client Entity Name String (40) The entity whose score this is. For players, this is their username; for other entities, it is their UUID.
Action Byte 0 to create/update an item. 1 to remove an item.
Objective Name String (16) The name of the objective the score belongs to.
Value Optional VarInt The score to be displayed next to the entry. Only sent when Action does not equal 1.

Set Title SubTitle

Packet ID State Bound To Field Name Field Type Notes
0x57 Play Client Subtitle Text Chat

Time Update

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
0x58 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
0x59 Play Client Title Text Chat

Set Title Times

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

Entity Sound Effect

Plays a sound effect from an entity.

Warning.png The pitch and volume fields in this packet are ignored. See MC-138832 for more information.

Packet ID State Bound To Field Name Field Type Notes
0x5B Play Client Sound ID VarInt ID of hardcoded sound event (events as of 1.16.5).
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.

Sound Effect

This packet is used to play a number of hardcoded sound events. For custom sounds, use Named Sound Effect.

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

Packet ID State Bound To Field Name Field Type Notes
0x5C Play Client Sound ID VarInt ID of hardcoded sound event (events as of 1.16.5).
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.

Stop Sound

Packet ID State Bound To Field Name Field Type Notes
0x5D 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 Named 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

Player 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
0x5E Play Client Header Chat To remove the header, send a empty text component: {"text":""}.
Footer Chat To remove the footer, send a empty text component: {"text":""}.

NBT Query Response

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

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

Collect 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 Player Position (and Player Position And Look) 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
0x60 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.

Entity Teleport

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
0x61 Play Client Entity ID VarInt
X Double
Y Double
Z Double
Yaw Angle New angle, not a delta.
Pitch Angle New angle, not a delta.
On Ground Boolean

Advancements

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

Advancement structure:

Field Name Field Type Notes
Has parent Boolean Indicates whether the next field exists.
Parent id Optional Identifier The identifier of the parent advancement.
Has display Boolean Indicates whether the next field exists.
Display data Optional advancement display See below.
Number of criteria VarInt Size of the following array.
Criteria Key Array Identifier The identifier of the criterion.
Value Void There is no content written here. Perhaps this will be expanded in the future?
Array length VarInt Number of arrays in the following array.
Requirements Array length 2 Array VarInt Number of elements in the following array.
Requirement Array of String Array of required criteria.

Advancement display:

Field Name Field Type Notes
Title Chat
Description Chat
Icon Slot
Frame type VarInt enum 0 = task, 1 = challenge, 2 = goal.
Flags Integer 0x1: has background texture; 0x2: show_toast; 0x4: 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.

Entity Properties

Sets attributes on the given entity.

Packet ID State Bound To Field Name Field Type Notes
0x63 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 0.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.attack_damage 2.0 0.0 2048.0 Attack Damage.
generic.attack_speed 4.0 0.0 1024.0 Attack Speed.
generic.flying_speed 0.4 0.0 1024.0 Flying Speed.
generic.armor 0.0 0.0 30.0 Armor.
generic.armor_toughness 0.0 0.0 20.0 Armor Toughness.
generic.attack_knockback 0.0 0.0 5.0
generic.luck 0.0 -1024.0 1024.0 Luck.
horse.jump_strength 0.7 0.0 2.0 Jump Strength.
zombie.spawn_reinforcements 0.0 0.0 1.0 Spawn Reinforcements Chance.
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).

Unknown attributes will cause a game crash (MC-150405) due to the default minimum being larger than the default value.

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
0x64 Play Client Entity ID VarInt
Effect ID Byte See this table.
Amplifier Byte Notchian client displays effect level as Amplifier + 1.
Duration VarInt Duration in ticks.
Flags Byte Bit field, 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.

Declare Recipes

Packet ID State Bound To Field Name Field Type Notes
0x65 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 Optional, varies Additional data for the recipe. For some types, there will be no data.

Recipe types:

Type Description Data
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 Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
Ingredient count VarInt Number of elements in the following array.
Ingredients Array of Ingredient.
Result Slot
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
Width VarInt
Height VarInt
Group String Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
Ingredients Array of Ingredient Length is width * height. Indexed by x + (y * width).
Result Slot
crafting_special_armordye Recipe for dying leather armor None
crafting_special_bookcloning Recipe for copying contents of written books
crafting_special_mapcloning Recipe for copying maps
crafting_special_mapextending Recipe for adding paper to maps
crafting_special_firework_rocket Recipe for making firework rockets
crafting_special_firework_star Recipe for making firework stars
crafting_special_firework_star_fade Recipe for making firework stars fade between multiple colors
crafting_special_repairitem Recipe for repairing items via crafting
crafting_special_tippedarrow Recipe for crafting tipped arrows
crafting_special_bannerduplicate Recipe for copying banner patterns
crafting_special_banneraddpattern Recipe for adding patterns to banners
crafting_special_shielddecoration Recipe for applying a banner's pattern to a shield
crafting_special_shulkerboxcoloring Recipe for recoloring a shulker box
crafting_special_suspiciousstew
smelting Smelting recipe As follows:
Name Type Description
Group String Used to group similar recipes together in the recipe book.
Ingredient Ingredient
Result Slot
Experience Float
Cooking time VarInt
blasting Blast furnace recipe
smoking Smoker recipe
campfire_cooking Campfire recipe
stonecutting Stonecutter recipe As follows:
Name Type Description
Group String Used to group similar recipes together in the recipe book. Tag is present in recipe JSON.
Ingredient Ingredient
Result Slot
smithing Smithing table recipe As follows:
Name Type Description
Base Ingredient First item.
Addition Ingredient Second item.
Result Slot

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.

Tags

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

Tags 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 ID of the given type (block, item, etc.).

More information on tags is available at: https://minecraft.gamepedia.com/Tag

And a list of all tags is here: https://minecraft.gamepedia.com/Tag#List_of_tags

Serverbound

Teleport Confirm

Sent by client as confirmation of Player Position And Look.

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

Query Block NBT

Used when Shift+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.

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

Chat Message (serverbound)

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 /, 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, "chat.type.text" 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 processing chat for more information.

Packet ID State Bound To Field Name Field Type Notes
0x03 Play Server Message String (256) The client sends the raw input, not a Chat component.

Client Status

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

Action ID values:

Action ID Action 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 Settings

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

Packet ID State Bound To Field Name Field Type Notes
0x05 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 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.
Disable text filtering Boolean Disables filtering of text on signs and written book titles. Currently always true (i.e. the filtering is disabled)

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.

Tab-Complete (serverbound)

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

Packet ID State Bound To Field Name Field Type Notes
0x06 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).

Click Window 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
0x07 Play Server Window ID Byte The ID of the window sent by Open Window.
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 Window

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
0x08 Play Server Window ID Unsigned Byte The ID of the window which was clicked. 0 for player inventory.
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
Array of slots Slot number Array Short
Slot data Slot New data for this slot
Clicked item Slot The clicked slot. Has to be empty (item ID = -1) for drop mode. Is always empty for mode 2 and mode 5 packets.

See Inventory for further information about how slots are indexed.

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
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)
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. (Note: the vanilla client will still incorrectly send this for non-creative players - see MC-46584)
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. (Note: the vanilla client will still incorrectly send this for non-creative players - see MC-46584)
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. (Note: the vanilla client will still incorrectly send this for non-creative players - see 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):

  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 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 packet for the inventory.

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

Plugin Message (serverbound)

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
0x0A Play Server Channel Identifier Name of the plugin channel used to send the data.
Data Byte Array Any data, depending on the channel. minecraft: channels are documented here. The length of this array must be inferred from the packet length.

Edit Book

Packet ID State Bound To Field Name Field Type Notes
0x0B Play Server New book Slot
Is signing Boolean True if the player is signing the book; false if the player is saving a draft.
Hand VarInt enum 0: Main hand, 1: Off hand.

When editing a draft, the NBT section of the Slot contains this:

TAG_Compound(''): 1 entry
{
  TAG_List('pages'): 2 entries
  {
    TAG_String(0): 'Something on Page 1'
    TAG_String(1): 'Something on Page 2'
  }
}

When signing the book, it instead looks like this:

TAG_Compound(''): 3 entires
{
  TAG_String('author'): 'Steve'
  TAG_String('title'): 'A Wonderful Book'
  TAG_List('pages'): 2 entries
  {
    TAG_String(0): 'Something on Page 1'
    TAG_String(1): 'Something on Page 2'
  }
}

Query Entity NBT

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

Packet ID State Bound To Field Name Field Type Notes
0x0C 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 Entity

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 Creative Inventory Action packet instead.

Packet ID State Bound To Field Name Field Type Notes
0x0D 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.

Generate Structure

Sent when Generate is pressed on the Jigsaw Block interface.

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

Keep Alive (serverbound)

The server will frequently send out a 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
0x0F 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
0x10 Play Server Locked Boolean

Player Position

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 (Δx, Δy, Δz)
  • Total movement distance squared is computed as Δx² + Δy² + Δz²
  • The expected movement distance squared is computed as velocityX² + veloctyY² + velocityZ²
  • 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×107, 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”.

Packet ID State Bound To Field Name Field Type Notes
0x11 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.

Player Position And Rotation (serverbound)

A combination of Player Rotation and Player Position.

Packet ID State Bound To Field Name Field Type Notes
0x12 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.

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
0x13 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.

Player Movement

This packet as well as Player Position, Player Look, and 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.

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

Vehicle Move (serverbound)

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

Packet ID State Bound To Field Name Field Type Notes
0x15 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.

Steer 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
0x16 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 Notchain 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
0x17 Play Server Slot to use VarInt See Inventory.

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

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

  • Set Slot, with window ID set to -2 and slot set to the newly chosen slot and the item set to the item that is now in that slot (which was previously at the slot the client requested)
  • Set Slot, with window ID set to -2 and slot set to the slot the player requested, with the item that is now in that slot and was previously on the hotbar slot
  • Held Item Change, with the slot set to the newly chosen slot.

Craft Recipe Request

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
0x18 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
0x19 Play Server Flags Byte Bit mask. 0x02: is flying.

Player Digging

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

Packet ID State Bound To Field Name Field Type Notes
0x1A 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).

Status can be one of seven values:

Value Meaning Notes
0 Started digging
1 Cancelled digging Sent when the player lets go of the Mine Block key (default: left click).
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: depends on OS). Location is always set to 0/0/0, Face is always set to -Y.
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.
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.
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.

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

Entity Action

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
0x1B 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 horse 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 due today time.

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

Packet ID State Bound To Field Name Field Type Notes
0x1C 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

A response to the ping packet sync to the main thread. Unknown what this is used for, this is ignored by the Notchian client and server. Most likely added as a replacement to the removed window confirmation packet.

Packet ID State Bound To Field Name Field Type Notes
0x1D Play Server ID Int

Set Recipe Book State

Replaces Recipe Book Data, type 1.

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

Set Displayed Recipe

Replaces Recipe Book Data, type 0.

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

Name Item

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

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

Resource Pack Status

Packet ID State Bound To Field Name Field Type Notes
0x21 Play Server Result VarInt Enum 0: successfully loaded, 1: declined, 2: failed download, 3: accepted.

Advancement Tab

Packet ID State Bound To Field Name Field Type Notes
0x22 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
0x23 Play Server Selected slot VarInt The selected slot in the players current (trading) inventory. (Was a full Integer for the plugin message).

Set Beacon Effect

Changes the effect of the current beacon.

Packet ID State Bound To Field Name Field Type Notes
0x24 Play Server Primary Effect VarInt A Potion ID. (Was a full Integer for the plugin message).
Secondary Effect VarInt A Potion ID. (Was a full Integer for the plugin message).

Held Item Change (serverbound)

Sent when the player changes the slot selection

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

Update Command Block

Packet ID State Bound To Field Name Field Type Notes
0x26 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.

Update Command Block Minecart

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

Creative Inventory Action

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
0x28 Play Server Slot Short Inventory slot.
Clicked Item Slot

Update Jigsaw Block

Sent when Done is pressed on the Jigsaw Block interface.

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

Update Structure Block

Packet ID State Bound To Field Name Field Type Notes
0x2A 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
Offset X Byte Between -32 and 32.
Offset Y Byte Between -32 and 32.
Offset Z Byte Between -32 and 32.
Size X Byte Between 0 and 32.
Size Y Byte Between 0 and 32.
Size Z Byte Between 0 and 32.
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
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
0x2B Play Server Location Position Block Coordinates.
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.

Animation (serverbound)

Sent when the player's arm swings.

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

Spectate

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
0x2D Play Server Target Player UUID UUID of the player to teleport to (can also be an entity UUID).

Player Block Placement

Packet ID State Bound To Field Name Field Type Notes
0x2E 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 Digging).
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.

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
0x2F Play Server Hand VarInt Enum Hand used for the animation. 0: main hand, 1: off hand.