Difference between revisions of "Protocol"

From wiki.vg
Jump to navigation Jump to search
m
(→‎Chunk Data: Document my findings/headaches)
(459 intermediate revisions by 74 users not shown)
Line 1: Line 1:
This page presents a dissection of the current stable [http://minecraft.net/game/ Minecraft] protocol. The current pre-release protocol is documented [[Pre-release_protocol|elsewhere]]. The protocol for Pocket Minecraft is substantially different, and is documented at [[Pocket Minecraft Protocol]].
+
{{Box
 +
  |BORDER = #9999FF
 +
  |BACKGROUND = #99CCFF
 +
  |WIDTH = 100%
 +
  |ICON =
 +
  |HEADING = Heads up!
 +
  |CONTENT = This article is about the protocol for the latest '''stable''' release of Minecraft '''computer edition''' ([[Protocol version numbers|1.14.4, protocol 498]]). For the computer edition pre-releases, see [[Pre-release protocol]]. For Pocket Edition, see [[Pocket Edition Protocol Documentation]].
 +
}}
  
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 irc.freenode.net]).
+
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 [ircs://chat.freenode.net:6697/mcdevs #mcdevs on chat.freenode.net] ([http://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.
  
{{Warning|As of 1.7 strings are now UTF-8 (prefixed with a VarInt giving the string's length in bytes) instead of UTF-16.}}
+
The changes between versions may be viewed at [[Protocol History]].
  
{{Warning|As of 1.7.6 all UUIDs used in the protocol now contain '-'. The session server still returns them without}}
+
== Definitions ==
  
The changes between versions may be viewed at [[Protocol History]]
+
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|Handshaking]], and state is switched using the packets [[#Handshake|Handshake]] and [[#Login Success|Login Success]].
  
== Definitions ==
+
=== Data types ===
 +
 
 +
{{:Data types}} <!-- Transcluded contents of Data types article in here — go to that page if you want to edit it -->
 +
 
 +
=== Other definitions ===
  
=== Data types ===
+
{| class="wikitable"
 +
|-
 +
! 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 {{Minecraft Wiki|Entity|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 [https://pokechu22.github.io/Burger/1.14.4.html burger].
  
<!-- Transcluded contents of data types page in here - go to that page if you want to edit it -->
+
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
 +
| The official implementation of vanilla Minecraft as developed and released by Mojang.
 +
|}
  
{{:Data Types}}
+
== Packet format ==
  
=== Other definitions ===
+
=== Without compression ===
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
! Field Name
! Term
+
! Field Type
! Definition
+
! Notes
|-
+
|-
| Player
+
| Length
| When used in the singular, Player always refers to the client connected to the server
+
| VarInt
|-
+
| Length of packet data + length of the packet ID
| Entity
+
|-
| Entity refers to any item, player, mob, minecart or boat in the world. This definition is subject to change as Notch extends the protocol
+
| Packet ID
|-
+
| VarInt
| EID
+
|  
| An EID - or Entity ID - is a unique 4-byte integer used to identify a specific entity
+
|-
|-
+
| Data
| XYZ
+
| Byte Array
| In this document, the axis names are the same as those used by Notch. Y points upwards, X points South, and Z points West.
+
| Depends on the connection state and packet ID, see the sections below
|-
+
|}
!colspan="2"|See also: [[Units of Measurement]]
 
|}
 
  
== Packets ==
+
=== With compression ===
  
=== Protocol Version ===
+
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.
1.7.2 - 4
 
  
1.7.6 - 5
+
{| class=wikitable
 +
! 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
 +
|-
 +
|rowspan="2"| Yes
 +
| Packet ID
 +
| VarInt
 +
| zlib compressed packet ID (see the sections below)
 +
|-
 +
| Data
 +
| Byte Array
 +
| zlib compressed packet data (see the sections below)
 +
|}
  
== Packet format ==
+
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|Set Compression]], otherwise the receiving party will disconnect.
  
{| class="wikitable"
+
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.
! Field Name !! Field Type !! Notes
 
|-
 
| Length || VarInt || Length of packet data + length of the packet ID
 
|-
 
| Packet ID || VarInt ||
 
|-
 
| Data || ||
 
|}
 
  
 
== Handshaking ==
 
== 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 ===
 
=== Serverbound ===
  
 
==== Handshake ====
 
==== Handshake ====
 +
 
This causes the server to switch into the target state.
 
This causes the server to switch into the target state.
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x00 || rowspan=4 | Handshake || rowspan=4 | Server
+
! Bound To
| Protocol Version || VarInt || (4 as of 1.7.2)
+
! Field Name
|-
+
! Field Type
| Server Address (hostname or IP) || String || localhost
+
! Notes
|-  
+
|-
| Server Port || Unsigned Short|| 25565
+
|rowspan="4"| 0x00
|-
+
|rowspan="4"| Handshaking
| Next state || VarInt || 1 for status, 2 for login
+
|rowspan="4"| Server
|}
+
| Protocol Version
 +
| VarInt
 +
| See [[protocol version numbers]] (currently 498 in Minecraft 1.14.4)
 +
|-
 +
| Server Address
 +
| String (255)
 +
| Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
 +
|-  
 +
| Server Port
 +
| Unsigned Short
 +
| Default is 25565.  The Notchian server does not use this information.
 +
|-
 +
| Next State
 +
| VarInt Enum
 +
| 1 for [[#Status|status]], 2 for [[#Login|login]]
 +
|}
 +
 
 +
==== Legacy Server List Ping ====
 +
 
 +
{{Warning|This packet uses a nonstandard format. It is never length-prefixed, and the packet ID is an Unsigned Byte instead of a VarInt.}}
 +
 
 +
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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0xFE
 +
| Handshaking
 +
| Server
 +
| Payload
 +
| Unsigned Byte
 +
| always 1 (<code>0x01</code>)
 +
|}
 +
 
 +
See [[Server List Ping#1.6]] for the details of the protocol that follows this packet.
  
 
== Play ==
 
== Play ==
Line 83: Line 183:
 
=== Clientbound ===
 
=== Clientbound ===
  
==== Keep Alive ====
+
==== Spawn Object ====
 +
 
 +
Sent by the server when a vehicle or other object is created.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="12"| 0x00
 +
|rowspan="12"| Play
 +
|rowspan="12"| Client
 +
| Entity ID
 +
| VarInt
 +
| EID of the object
 +
|-
 +
| Object UUID
 +
| UUID
 +
|
 +
|-
 +
| Type
 +
| VarInt
 +
| The type of object (same as in [[#Spawn Mob|Spawn Mob]])
 +
|-
 +
| X
 +
| Double
 +
|
 +
|-
 +
| Y
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|
 +
|-
 +
| Pitch
 +
| Angle
 +
|
 +
|-
 +
| Yaw
 +
| Angle
 +
|
 +
|-
 +
| Data
 +
| Int
 +
| Meaning dependent on the value of the Type field, see [[Object Data]] for details.
 +
|-
 +
| Velocity X
 +
| Short
 +
|rowspan="3"| Same units as [[#Entity Velocity|Entity Velocity]].  Always sent, but only used when Data is greater than 0 (except for some entities which always ignore it; see [[Object Data]] for details).
 +
|-
 +
| Velocity Y
 +
| Short
 +
|-
 +
| Velocity Z
 +
| Short
 +
|}
 +
 
 +
==== Spawn Experience Orb ====
 +
 
 +
Spawns one or more experience orbs.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x01
 +
|rowspan="5"| Play
 +
|rowspan="5"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| X
 +
| Double
 +
|
 +
|-
 +
| Y
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|
 +
|-
 +
| Count
 +
| Short
 +
| The amount of experience this orb will reward once collected
 +
|}
 +
 
 +
==== Spawn Global Entity ====
 +
 
 +
With this packet, the server notifies the client of thunderbolts striking within a 512 block radius around the player. The coordinates specify where exactly the thunderbolt strikes.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x02
 +
|rowspan="5"| Play
 +
|rowspan="5"| Client
 +
| Entity ID
 +
| VarInt
 +
| 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 ====
 +
 
 +
Sent by the server when a mob entity is spawned.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="13"| 0x03
 +
|rowspan="13"| Play
 +
|rowspan="13"| 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|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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x04
 +
|rowspan="5"| Play
 +
|rowspan="5"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Entity UUID
 +
| UUID
 +
|
 +
|-
 +
| Motive
 +
| VarInt
 +
| Panting'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 <code>(0, 0)</code> being the top left corner, the center is <code>(max(0, width / 2 - 1), height / 2)</code>. E.g. <code>(1, 0)</code> for a 2×1 painting, or <code>(1, 2)</code> for a 4×4 painting.
 +
 
 +
List of paintings by coordinates in <code>paintings_kristoffer_zetterstrand.png</code> (where x and y are in pixels from the top left and width and height are in pixels or 16ths of a block):
 +
 
 +
{| class="wikitable"
 +
! Name
 +
! ID
 +
! x
 +
! y
 +
! width
 +
! height
 +
|-
 +
| <code>minecraft:kebab</code>
 +
| 0
 +
| 0
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:aztec</code>
 +
| 1
 +
| 16
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:alban</code>
 +
| 2
 +
| 32
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:aztec2</code>
 +
| 3
 +
| 48
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:bomb</code>
 +
| 4
 +
| 64
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:plant</code>
 +
| 5
 +
| 80
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:wasteland</code>
 +
| 6
 +
| 96
 +
| 0
 +
| 16
 +
| 16
 +
|-
 +
| <code>minecraft:pool</code>
 +
| 7
 +
| 0
 +
| 32
 +
| 32
 +
| 16
 +
|-
 +
| <code>minecraft:courbet</code>
 +
| 8
 +
| 32
 +
| 32
 +
| 32
 +
| 16
 +
|-
 +
| <code>minecraft:sea</code>
 +
| 9
 +
| 64
 +
| 32
 +
| 32
 +
| 16
 +
|-
 +
| <code>minecraft:sunset</code>
 +
| 10
 +
| 96
 +
| 32
 +
| 32
 +
| 16
 +
|-
 +
| <code>minecraft:creebet</code>
 +
| 11
 +
| 128
 +
| 32
 +
| 32
 +
| 16
 +
|-
 +
| <code>minecraft:wanderer</code>
 +
| 12
 +
| 0
 +
| 64
 +
| 16
 +
| 32
 +
|-
 +
| <code>minecraft:graham</code>
 +
| 13
 +
| 16
 +
| 64
 +
| 16
 +
| 32
 +
|-
 +
| <code>minecraft:match</code>
 +
| 14
 +
| 0
 +
| 128
 +
| 32
 +
| 32
 +
|-
 +
| <code>minecraft:bust</code>
 +
| 15
 +
| 32
 +
| 128
 +
| 32
 +
| 32
 +
|-
 +
| <code>minecraft:stage</code>
 +
| 16
 +
| 64
 +
| 128
 +
| 32
 +
| 32
 +
|-
 +
| <code>minecraft:void</code>
 +
| 17
 +
| 96
 +
| 128
 +
| 32
 +
| 32
 +
|-
 +
| <code>skull_and_roses</code>
 +
| 18
 +
| 128
 +
| 128
 +
| 32
 +
| 32
 +
|-
 +
| <code>minecraft:wither</code>
 +
| 19
 +
| 160
 +
| 128
 +
| 32
 +
| 32
 +
|-
 +
| <code>minecraft:fighters</code>
 +
| 20
 +
| 0
 +
| 96
 +
| 64
 +
| 32
 +
|-
 +
| <code>minecraft:pointer</code>
 +
| 21
 +
| 0
 +
| 192
 +
| 64
 +
| 64
 +
|-
 +
| <code>minecraft:pigscene</code>
 +
| 22
 +
| 64
 +
| 192
 +
| 64
 +
| 64
 +
|-
 +
| <code>minecraft:burning_skull</code>
 +
| 23
 +
| 128
 +
| 192
 +
| 64
 +
| 64
 +
|-
 +
| <code>minecraft:skeleton</code>
 +
| 24
 +
| 192
 +
| 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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="8"| 0x05
 +
|rowspan="8"| Play
 +
|rowspan="8"| Client
 +
| Entity ID
 +
| VarInt
 +
| Player's EID
 +
|-
 +
| Player UUID
 +
| UUID
 +
| See below for notes on {{Minecraft Wiki|Server.properties#online-mode|offline mode}} and NPCs
 +
|-
 +
| X
 +
| Double
 +
|
 +
|-
 +
| Y
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|
 +
|-
 +
| Yaw
 +
| Angle
 +
|
 +
|-
 +
| Pitch
 +
| Angle
 +
|
 +
|-
 +
| Metadata
 +
| [[Entities#Entity Metadata Format|Entity Metadata]]
 +
|
 +
|}
 +
 
 +
When in {{Minecraft Wiki|Server.properties#online-mode|online mode}}, the UUIDs must be valid and have valid skin blobs.
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x06
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
| Player ID
 +
|-
 +
| Animation
 +
| Unsigned Byte
 +
| Animation ID (see below)
 +
|}
 +
 
 +
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
 +
|}
 +
 
 +
==== Statistics ====
 +
 
 +
Sent as a response to [[#Client_Status|Client Status 0x04]] (id 1).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x07
 +
|rowspan="4"| Play
 +
|rowspan="4"| Client
 +
|colspan="2"| Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="2"| Statistic
 +
| Category ID
 +
|rowspan="2"| Array
 +
| VarInt
 +
| See below
 +
|-
 +
| Statistic ID
 +
| VarInt
 +
| See below
 +
|-
 +
|colspan="2"| Value
 +
|colspan="2"| VarInt
 +
| The amount to set it to
 +
|}
 +
 
 +
Categories (these are namespaced, but with <code>:</code> replaced with <code>.</code>):
 +
 
 +
{| class="wikitable"
 +
! Name
 +
! ID
 +
! Registry
 +
|-
 +
| <code>minecraft.mined</code>
 +
| 0
 +
| Blocks
 +
|-
 +
| <code>minecraft.crafted</code>
 +
| 1
 +
| Items
 +
|-
 +
| <code>minecraft.used</code>
 +
| 2
 +
| Items
 +
|-
 +
| <code>minecraft.broken</code>
 +
| 3
 +
| Items
 +
|-
 +
| <code>minecraft.picked_up</code>
 +
| 4
 +
| Items
 +
|-
 +
| <code>minecraft.dropped</code>
 +
| 5
 +
| Items
 +
|-
 +
| <code>minecraft.killed</code>
 +
| 6
 +
| Entities
 +
|-
 +
| <code>minecraft.killed_by</code>
 +
| 7
 +
| Entities
 +
|-
 +
| <code>minecraft.custom</code>
 +
| 8
 +
| Custom
 +
|}
 +
 
 +
Blocks, Items, and Entities use block (not block state), item, and entity ids.
 +
 
 +
Custom has the following (unit only matters for clients):
 +
 
 +
{| class="wikitable"
 +
! Name
 +
! ID
 +
! Unit
 +
|-
 +
| <code>minecraft.leave_game</code>
 +
| 0
 +
| None
 +
|-
 +
| <code>minecraft.play_one_minute</code>
 +
| 1
 +
| Time
 +
|-
 +
| <code>minecraft.time_since_death</code>
 +
| 2
 +
| Time
 +
|-
 +
| <code>minecraft.sneak_Time</code>
 +
| 3
 +
| Time
 +
|-
 +
| <code>minecraft.walk_one_cm</code>
 +
| 4
 +
| Distance
 +
|-
 +
| <code>minecraft.crouch_one_cm</code>
 +
| 5
 +
| Distance
 +
|-
 +
| <code>minecraft.sprint_one_cm</code>
 +
| 6
 +
| Distance
 +
|-
 +
| <code>minecraft.swim_one_cm</code>
 +
| 7
 +
| Distance
 +
|-
 +
| <code>minecraft.fall_one_cm</code>
 +
| 8
 +
| Distance
 +
|-
 +
| <code>minecraft.climb_one_cm</code>
 +
| 9
 +
| Distance
 +
|-
 +
| <code>minecraft.fly_one_cm</code>
 +
| 10
 +
| Distance
 +
|-
 +
| <code>minecraft.dive_one_cm</code>
 +
| 11
 +
| Distance
 +
|-
 +
| <code>minecraft.minecart_one_cm</code>
 +
| 12
 +
| Distance
 +
|-
 +
| <code>minecraft.boat_one_cm</code>
 +
| 13
 +
| Distance
 +
|-
 +
| <code>minecraft.pig_one_cm</code>
 +
| 14
 +
| Distance
 +
|-
 +
| <code>minecraft.horse_one_cm</code>
 +
| 15
 +
| Distance
 +
|-
 +
| <code>minecraft.aviate_one_cm</code>
 +
| 16
 +
| Distance
 +
|-
 +
| <code>minecraft.jump</code>
 +
| 17
 +
| None
 +
|-
 +
| <code>minecraft.drop</code>
 +
| 18
 +
| None
 +
|-
 +
| <code>minecraft.damage_dealt</code>
 +
| 19
 +
| Damage
 +
|-
 +
| <code>minecraft.damage_taken</code>
 +
| 20
 +
| Damage
 +
|-
 +
| <code>minecraft.deaths</code>
 +
| 21
 +
| None
 +
|-
 +
| <code>minecraft.mob_kills</code>
 +
| 22
 +
| None
 +
|-
 +
| <code>minecraft.animals_bred</code>
 +
| 23
 +
| None
 +
|-
 +
| <code>minecraft.player_kills</code>
 +
| 24
 +
| None
 +
|-
 +
| <code>minecraft.fish_caught</code>
 +
| 25
 +
| None
 +
|-
 +
| <code>minecraft.talked_to_villager</code>
 +
| 26
 +
| None
 +
|-
 +
| <code>minecraft.traded_with_villager</code>
 +
| 27
 +
| None
 +
|-
 +
| <code>minecraft.eat_cake_slice</code>
 +
| 28
 +
| None
 +
|-
 +
| <code>minecraft.fill_cauldron</code>
 +
| 29
 +
| None
 +
|-
 +
| <code>minecraft.use_cauldron</code>
 +
| 30
 +
| None
 +
|-
 +
| <code>minecraft.clean_armor</code>
 +
| 31
 +
| None
 +
|-
 +
| <code>minecraft.clean_banner</code>
 +
| 32
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_brewingstand</code>
 +
| 33
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_beacon</code>
 +
| 34
 +
| None
 +
|-
 +
| <code>minecraft.inspect_dropper</code>
 +
| 35
 +
| None
 +
|-
 +
| <code>minecraft.inspect_hopper</code>
 +
| 36
 +
| None
 +
|-
 +
| <code>minecraft.inspect_dispenser</code>
 +
| 37
 +
| None
 +
|-
 +
| <code>minecraft.play_noteblock</code>
 +
| 38
 +
| None
 +
|-
 +
| <code>minecraft.tune_noteblock</code>
 +
| 39
 +
| None
 +
|-
 +
| <code>minecraft.pot_flower</code>
 +
| 40
 +
| None
 +
|-
 +
| <code>minecraft.trigger_trapped_chest</code>
 +
| 41
 +
| None
 +
|-
 +
| <code>minecraft.open_enderchest</code>
 +
| 42
 +
| None
 +
|-
 +
| <code>minecraft.enchant_item</code>
 +
| 43
 +
| None
 +
|-
 +
| <code>minecraft.play_record</code>
 +
| 44
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_furnace</code>
 +
| 45
 +
| None
 +
|-
 +
| <code>minecraft.interact_with_crafting_table</code>
 +
| 46
 +
| None
 +
|-
 +
| <code>minecraft.open_chest</code>
 +
| 47
 +
| None
 +
|-
 +
| <code>minecraft.sleep_in_bed</code>
 +
| 48
 +
| None
 +
|-
 +
| <code>minecraft.open_shulker_box</code>
 +
| 49
 +
| None
 +
|}
 +
 
 +
Units:
 +
 
 +
* None: just a normal number (formatted with 0 decimal places)
 +
* Damage: value is 10 times the normal amount
 +
* Distance: a distance in centimeters (hundredths of blocks)
 +
* Time: a time span in ticks
 +
 
 +
==== Block Break Animation ====
 +
 
 +
0–9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
 +
 
 +
Block break animations can still be applied on air; the animation will remain visible although there is no block being broken.  However, if this is applied to a transparent block, odd graphical effects may happen, including water losing its transparency.  (An effect similar to this can be seen in normal gameplay when breaking ice blocks)
 +
 
 +
If you need to display several break animations at the same time you have to give each of them a unique Entity ID. The entity ID does not need to correspond to an actual entity on the client. It is valid to use a randomly generated number.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x08
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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
 +
|}
 +
 
 +
==== Update Block Entity ====
 +
 
 +
Sets the block entity associated with the block at the given location.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x09
 +
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Location
 +
| Position
 +
|
 +
|-
 +
| Action
 +
| Unsigned Byte
 +
| 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)
 +
|}
 +
 
 +
''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
 +
 
 +
==== Block Action ====
 +
 
 +
This packet is used for a number of actions and animations performed by blocks, usually non-persistent.
 +
 
 +
See [[Block Actions]] for a list of values.
 +
 
 +
{{Warning2|This packet uses a block ID, not a block state.  Unfortunately, block IDs are not directly included in the output from [[Data Generators]], but can manually be calculated.}}
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x0A
 +
|rowspan="4"| Play
 +
|rowspan="4"| 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.
 +
 
 +
{{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
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Location
 +
| Position
 +
| Block Coordinates
 +
|-
 +
| Block ID
 +
| VarInt
 +
| 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.
 +
|}
 +
 
 +
==== Boss Bar ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="14"| 0x0C
 +
|rowspan="14"| Play
 +
|rowspan="14"| Client
 +
|colspan="2"| UUID
 +
| UUID
 +
| Unique ID for this bar
 +
|-
 +
|colspan="2"| Action
 +
| VarInt Enum
 +
| Determines the layout of the remaining packet
 +
|-
 +
! Action
 +
! Field Name
 +
!
 +
!
 +
|-
 +
|rowspan="5"| 0: add
 +
| Title
 +
| [[Chat]]
 +
|
 +
|-
 +
| Health
 +
| Float
 +
| From 0 to 1. Values greater than 1 do not crash a Notchian client, and start [https://i.johni0702.de/nA.png rendering part of a second health bar] at around 1.5.
 +
|-
 +
| 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]]
 +
|
 +
|-
 +
|rowspan="2"| 4: update style
 +
| Color
 +
| VarInt Enum
 +
| Color ID (see below)
 +
|-
 +
| Dividers
 +
| VarInt Enum
 +
| as above
 +
|-
 +
| 5: update flags
 +
| Flags
 +
| Unsigned Byte
 +
| as above
 +
|-
 +
|}
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Color
 +
|-
 +
| 0
 +
| Pink
 +
|-
 +
| 1
 +
| Blue
 +
|-
 +
| 2
 +
| Red
 +
|-
 +
| 3
 +
| Green
 +
|-
 +
| 4
 +
| Yellow
 +
|-
 +
| 5
 +
| Purple
 +
|-
 +
| 6
 +
| White
 +
|}
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Type of division
 +
|-
 +
| 0
 +
| No division
 +
|-
 +
| 1
 +
| 6 notches
 +
|-
 +
| 2
 +
| 10 notches
 +
|-
 +
| 3
 +
| 12 notches
 +
|-
 +
| 4
 +
| 20 notches
 +
|}
 +
 
 +
==== Server Difficulty ====
 +
 
 +
Changes the difficulty setting in the client's option menu
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x0D
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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 [[Chat#Processing chat|processing chat]] for more info about these positions.
 +
 
 +
{{warning2|Game info accepts json formatting but does not display it, although the deprecated §-based formatting works.  This is not an issue when using the [[#Title|Title]] packet, so prefer that packet for displaying information in that slot.  See [https://bugs.mojang.com/browse/MC-119145 MC-119145] for more information.}}
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x0E
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| JSON Data
 +
| [[Chat]]
 +
| Limited to 32767 bytes
 +
|-
 +
| Position
 +
| Byte
 +
| 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
 +
|}
  
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.
+
==== Multi Block Change ====
 +
 
 +
Fired whenever 2 or more blocks are changed within the same chunk on the same tick.
 +
 
 +
{{Warning|Changing blocks in chunks not loaded by the client is unsafe (see note on [[#Block Change|Block Change]]).}}
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Keep Alive ID || Int ||
+
!colspan="2"| Field Name
|}
+
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="6"| 0x0F
 +
|rowspan="6"| Play
 +
|rowspan="6"| Client
 +
|colspan="2"| Chunk X
 +
|colspan="2"| Int
 +
| Chunk X coordinate
 +
|-
 +
|colspan="2"| Chunk Z
 +
|colspan="2"| Int
 +
| Chunk Z coordinate
 +
|-
 +
|colspan="2"| Record Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array, i.e. the number of blocks affected
 +
|-
 +
|rowspan="3"| Record
 +
| Horizontal Position
 +
|rowspan="3"| Array
 +
| Unsigned Byte
 +
| 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
 +
| Unsigned Byte
 +
| Y coordinate of the block
 +
|-
 +
| Block ID
 +
| VarInt
 +
| 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.
 +
|}
 +
 
 +
To decode the position into a world position:
 +
 
 +
<syntaxhighlight lang="java">
 +
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
 +
worldY = vertPos;
 +
worldZ = (horizPos & 15) + (chunkZ * 16);
 +
</syntaxhighlight>
 +
 
 +
==== Tab-Complete (clientbound) ====
  
==== Join Game ====
+
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.
See [[Protocol Encryption]] for information on logging in.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x01 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || Int || The player's Entity ID
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| Gamemode || Unsigned Byte || 0: survival, 1: creative, 2: adventure. Bit 3 (0x8) is the hardcore flag
+
! Notes
|-
+
|-
| Dimension || Byte || -1: nether, 0: overworld, 1: end
+
|rowspan="8"| 0x10
|-
+
|rowspan="8"| Play
| Difficulty || Unsigned Byte || 0 thru 3 for Peaceful, Easy, Normal, Hard
+
|rowspan="8"| Client
|-
+
|-
| Max Players || Unsigned Byte || Used by the client to draw the player list
+
|colspan="2"| ID
|-
+
|colspan="2"| VarInt
| Level Type || String || default, flat, largeBiomes, amplified, default_1_1
+
| Transaction ID
|}
+
|-
{{Warning|If the Dimension isn't valid then the client will crash}}
+
|colspan="2"| Start
 +
|colspan="2"| VarInt
 +
| Start of the text to replace
 +
|-
 +
|colspan="2"| Length
 +
|colspan="2"| VarInt
 +
| Length of the text to replace
 +
|-
 +
|colspan="2"| Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="3"| Matches
 +
| Match
 +
|rowspan="3"| Array
 +
| String (32767)
 +
| One eligible value to insert, note that each command is sent separately instead of in a single string, hence the need for Count.  Note that for instance this doesn't include a leading <code>/</code> on commands.
 +
|-
 +
| Has tooltip
 +
| Boolean
 +
| True if the following is present
 +
|-
 +
| Tooltip
 +
| Optional [[Chat]]
 +
| Tooltip to display; only present if previous boolean is true
 +
|}
 +
 
 +
==== Declare Commands ====
 +
 
 +
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.
  
==== Chat Message ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x02 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| JSON Data || String || [[Chat]], Limited to 32767 bytes
+
! Field Name
|}
+
! Field Type
{{Warning|Malformed JSON will disconnect the client}}
+
! Notes
 +
|-
 +
|rowspan="3"| 0x11
 +
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Nodes
 +
| Array of [[Command Data|Node]]
 +
| An array of nodes
 +
|-
 +
| Root index
 +
| VarInt
 +
| Index of the <code>root</code> node in the previous array
 +
|}
  
==== Time Update ====
+
For more information on this packet, see the [[Command Data]] article.
 +
 
 +
==== 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.
  
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.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x12
 +
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Window ID
 +
| Byte
 +
| The ID of the window that the action occurred in
 +
|-
 +
| Action Number
 +
| Short
 +
| Every action that is to be accepted has a unique number. This number is an incrementing integer (starting at 0) with separate counts for each window ID.
 +
|-
 +
| Accepted
 +
| Boolean
 +
| Whether the action was accepted
 +
|}
  
The time of day is based on the timestamp modulo 24000. 0 is sunrise, 6000 is noon, 12000 is sunset, and 18000 is midnight.
+
==== Close Window (clientbound) ====
  
The default SMP server increments the time by <code>20</code> every second.
+
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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x03 || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Age of the world || Long || In ticks; not changed by server commands
+
! Field Name
|-
+
! Field Type
| 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
+
! Notes
|}
+
|-
 +
| 0x13
 +
| Play
 +
| Client
 +
| Window ID
 +
| Unsigned Byte
 +
| This is the ID of the window that was closed. 0 for inventory.
 +
|}
 +
 
 +
==== Window Items ====
 +
[[File:Inventory-slots.png|thumb|The inventory slots]]
 +
 
 +
Sent by the server when items in multiple slots (in a window) are added/removed. This includes the main inventory, equipped armour and crafting slots.
  
==== Entity Equipment ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x04 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| EntityID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Slot || Short || Equipment slot: 0=held, 1-4=armor slot (1 - boots, 2 - leggings, 3 - chestplate, 4 - helmet) ** The game crashes if send a packet with value 4 in 1.7.10, indicating there's an ArrayOutOfBoundsException. Needs further investigation. **
+
! Notes
|-
+
|-
| Item || [[Slot_Data|Slot]] || Item in slot format
+
|rowspan="3"| 0x14
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| 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 Data|Slot]]
 +
|  
 +
|}
  
==== Spawn Position ====
+
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 +
 
 +
==== Window Property ====
  
Sent by the server after login to specify the coordinates of the spawn point (the point at which players spawn at, and which the compass points to). It can be sent at any time to update the point compasses point at.
+
This packet is used to inform the client that part of a GUI window should be updated.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x05 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| X || Int || Spawn X in block coordinates
+
! Field Name
|-
+
! Field Type
| Y || Int || Spawn Y in block coordinates
+
! Notes
|-
+
|-
| Z || Int || Spawn Z in block coordinates
+
|rowspan="3"| 0x15
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Window ID
 +
| Unsigned Byte
 +
|  
 +
|-
 +
| Property
 +
| Short
 +
| The property to be updated, see below
 +
|-
 +
| Value
 +
| Short
 +
| The new value for the property, see below
 +
|}
  
==== Update Health ====
+
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.
  
Sent by the server to update/set the health of the player it is sent to.
+
{| class="wikitable"
 +
|-
 +
! Window type
 +
! Property
 +
! Value
 +
|-
 +
|rowspan="4"| Furnace
 +
| 0: Fire icon (fuel left)
 +
| counting from fuel burn time down to 0 (in-game ticks)
 +
|-
 +
| 1: Maximum fuel burn time
 +
| fuel burn time or 0 (in-game ticks)
 +
|-
 +
| 2: Progress arrow
 +
| counting from 0 to maximum progress (in-game ticks)
 +
|-
 +
| 3: Maximum progress
 +
| always 200 on the notchian server
 +
|-
 +
|rowspan="10"| Enchantment Table
 +
| 0: Level requirement for top enchantment slot
 +
|rowspan="3"| The enchantment's xp level requirement
 +
|-
 +
| 1: Level requirement for middle enchantment slot
 +
|-
 +
| 2: Level requirement for bottom enchantment slot
 +
|-
 +
| 3: The enchantment seed
 +
| Used for drawing the enchantment names (in [[Wikipedia:Standard Galactic Alphabet|SGA]]) clientside.  The same seed ''is'' used to calculate enchantments, but some of the data isn't sent to the client to prevent easily guessing the entire list (the seed value here is the regular seed bitwise and <code>0xFFFFFFF0</code>).
 +
|-
 +
| 4: Enchantment ID shown on mouse hover over top enchantment slot
 +
|rowspan="3"| The enchantment id (set to -1 to hide it), see below for values
 +
|-
 +
| 5: Enchantment ID shown on mouse hover over middle enchantment slot
 +
|-
 +
| 6: Enchantment ID shown on mouse hover over bottom enchantment slot
 +
|-
 +
| 7: Enchantment level shown on mouse hover over the top slot
 +
|rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
 +
|-
 +
| 8: Enchantment level shown on mouse hover over the middle slot
 +
|-
 +
| 9: Enchantment level shown on mouse hover over the bottom slot
 +
|-
 +
|rowspan="3"| Beacon
 +
| 0: Power level
 +
| 0-4, controls what effect buttons are enabled
 +
|-
 +
| 1: First potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
 +
|-
 +
| 2: Second potion effect
 +
| {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
 +
|-
 +
| Anvil
 +
| 0: Repair cost
 +
| The repair's cost in xp levels
 +
|-
 +
|rowspan="2"| Brewing Stand
 +
| 0: Brew time
 +
| 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
 +
|-
 +
| 1: Fuel time
 +
| 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
 +
|}
  
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.
+
For an enchanting table, the following numerical IDs are used:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Numerical ID
|-
+
! Enchantment ID
| rowspan=3 | 0x06 || rowspan=3 | Play || rowspan=3 | Client
+
! Enchantment Name
| Health || Float || 0 or less = dead, 20 = full HP
+
|-
|-
+
| 0
| Food || Short || 0 - 20
+
| minecraft:protection
|-  
+
| Protection
| Food Saturation || Float || Seems to vary from 0.0 to 5.0 in integer increments
+
|-
|}
+
| 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:sharpness
 +
| Sharpness
 +
|-
 +
| 12
 +
| minecraft:smite
 +
| Smite
 +
|-
 +
| 13
 +
| minecraft:bane_of_arthropods
 +
| Bane of Arthropods
 +
|-
 +
| 14
 +
| minecraft:knockback
 +
| Knockback
 +
|-
 +
| 15
 +
| minecraft:fire_aspect
 +
| Fire Aspect
 +
|-
 +
| 16
 +
| minecraft:looting
 +
| Looting
 +
|-
 +
| 17
 +
| minecraft:sweeping
 +
| Sweeping Edge
 +
|-
 +
| 18
 +
| minecraft:efficiency
 +
| Efficiency
 +
|-
 +
| 19
 +
| minecraft:silk_touch
 +
| Silk Touch
 +
|-
 +
| 20
 +
| minecraft:unbreaking
 +
| Unbreaking
 +
|-
 +
| 21
 +
| minecraft:fortune
 +
| Fortune
 +
|-
 +
| 22
 +
| minecraft:power
 +
| Power
 +
|-
 +
| 23
 +
| minecraft:punch
 +
| Punch
 +
|-
 +
| 24
 +
| minecraft:flame
 +
| Flame
 +
|-
 +
| 25
 +
| minecraft:infinity
 +
| Infinity
 +
|-
 +
| 26
 +
| minecraft:luck_of_the_sea
 +
| Luck of the Sea
 +
|-
 +
| 27
 +
| minecraft:lure
 +
| Lure
 +
|-
 +
| 28
 +
| minecraft:loyalty
 +
| Loyalty
 +
|-
 +
| 29
 +
| minecraft:impaling
 +
| Impaling
 +
|-
 +
| 30
 +
| minecraft:riptide
 +
| Riptide
 +
|-
 +
| 31
 +
| minecraft:channeling
 +
| Channeling
 +
|-
 +
| 32
 +
| minecraft:mending
 +
| Mending
 +
|-
 +
| 33
 +
| minecraft:vanishing_curse
 +
| Curse of Vanishing
 +
|}
  
==== Respawn ====
+
==== Set Slot ====
  
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.
+
Sent by the server when an item in a slot (in a window) is added/removed.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x07 || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Dimension || Int || -1: The Nether, 0: The Overworld, 1: The End
+
! Field Name
|-
+
! Field Type
| Difficulty || Unsigned Byte || 0 thru 3 for Peaceful, Easy, Normal, Hard.
+
! Notes
|-
+
|-
| Gamemode || Unsigned Byte || 0: survival, 1: creative, 2: adventure. The hardcore flag is not included
+
|rowspan="3"| 0x16
|-
+
|rowspan="3"| Play
| Level Type || String || Same as [[Protocol#Join_Game|Join Game]]
+
|rowspan="3"| Client
|}
+
| Window ID
{{Warning|If the Dimension isn't valid then the client will crash}}
+
| 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 Data|Slot]]
 +
|  
 +
|}
  
{{Warning|Avoid changing player's dimension to same dimension they were already in, weird bugs can occur i.e. such player will be unable to attack other players in new world (fixes after their death and respawn)}}
+
To set the cursor (the item currently dragged with the mouse), use -1 as Window ID and as Slot.
  
==== Player Position And Look ====
+
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.
  
Updates the players position on the server.
+
==== Set Cooldown ====
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 units will result in the client being 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.
+
Applies a cooldown period to all items with the given type.  Used by the Notchian server with enderpearls. This packet should be sent when the cooldown starts and also when the cooldown ends (to compensate for lag), although the client will end the cooldown automatically. Can be applied to any item, note that interactions still get sent to the server with the item but the client does not play the animation nor attempt to predict results (i.e block placing).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x17
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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) ====
  
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
+
{{Main|Plugin channels}}
  
The yaw of player (in degrees), standing at point (x0,z0) and looking towards point (x,z) one can be calculated with:
+
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.
  l = x-x0
 
  w = z-z0
 
  c = sqrt( l*l + w*w )
 
  alpha1 = -arcsin(l/c)/PI*180
 
  alpha2 =  arccos(w/c)/PI*180
 
  if alpha2 > 90 then
 
    yaw = 180 - alpha1
 
  else
 
    yaw = alpha1
 
  
You can get a unit vector from a given yaw/pitch via:
+
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/]
  x = -cos(pitch) * sin(yaw)
 
  y = -sin(pitch)
 
  z =  cos(pitch) * cos(yaw)
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6| 0x08 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| X || Double || Absolute position
+
! Field Name
|-
+
! Field Type
| Y || Double || Absolute position (eyes pos)
+
! Notes
|-
+
|-
| Z || Double || Absolute position
+
|rowspan="2"| 0x18
|-
+
|rowspan="2"| Play
| Yaw || Float || Absolute rotation on the X Axis, in degrees
+
|rowspan="2"| Client
|-
+
| Channel
| Pitch || Float || Absolute rotation on the Y Axis, in degrees
+
| Identifier
|-
+
| Name of the [[plugin channel]] used to send the data
| On Ground || Bool || True if the client is on the ground, False otherwise
+
|-
|}
+
| 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.
 +
|}
  
==== Held Item Change ====
+
==== Named Sound Effect ====
 +
{{See also|#Sound Effect}}
  
Sent to change the player's slot selection
+
Used to play a sound effect on the client. Custom sounds may be added by resource packs.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x09 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Slot || Byte || The slot which the player has selected (0-8)
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x19
 +
|rowspan="7"| Play
 +
|rowspan="7"| Client
 +
| Sound Name
 +
| Identifier
 +
| All sound effect names as of 1.14.4 can be seen [https://pokechu22.github.io/Burger/1.14.4.html#sounds here].
 +
|-
 +
| Sound Category
 +
| VarInt Enum
 +
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
 +
|-
 +
| Effect Position X
 +
| Int
 +
| Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Effect Position Y
 +
| Int
 +
| Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Effect Position Z
 +
| Int
 +
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Volume
 +
| Float
 +
| 1 is 100%, can be more
 +
|-
 +
| Pitch
 +
| Float
 +
| Float between 0.5 and 2.0 by Notchian clients
 +
|}
  
==== Use Bed ====
+
==== Disconnect (play) ====
  
This packet tells that a player goes to bed.
+
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.
  
The client with the matching Entity ID will go into bed mode.
+
{| class="wikitable"
 +
! 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 ====
  
This Packet is sent to all nearby players including the one sent to bed.
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x0A || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Player ID
+
! Field Name
|-
+
! Field Type
| X || Int || Bed headboard X as block coordinate
+
! Notes
|-
+
|-
| Y || Unsigned Byte || Bed headboard Y as block coordinate
+
|rowspan="2"| 0x1B
|-
+
|rowspan="2"| Play
| Z || Int || Bed headboard Z as block coordinate
+
|rowspan="2"| Client
|}
+
| Entity ID
 +
| Int
 +
|  
 +
|-
 +
| Entity Status
 +
| Byte Enum
 +
| See below
 +
|}
 +
 
 +
See [[Entity statuses]] for a list of which statuses are valid for each type of entity.
 +
 
 +
==== Explosion ====
  
==== Animation ====
+
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
  
Sent whenever an entity should change animation.
+
Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x0B || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || VarInt || Player ID
+
! Field Name
|-
+
! Field Type
| Animation || Unsigned Byte || Animation ID
+
! Notes
|}
+
|-
 +
|rowspan="9"| 0x1C
 +
|rowspan="9"| Play
 +
|rowspan="9"| Client
 +
| X
 +
| Float
 +
|
 +
|-
 +
| Y
 +
| Float
 +
|
 +
|-
 +
| Z
 +
| Float
 +
|
 +
|-
 +
| Radius
 +
| Float
 +
| Currently unused in the client
 +
|-
 +
| 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
 +
|}
  
Animation can be one of the following values:
+
==== Unload Chunk ====
 +
 
 +
Tells the client to unload a chunk column.
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Animation
+
! Packet ID
|-
+
! State
| 0 || Swing arm
+
! Bound To
|-
+
! Field Name
| 1 || Damage animation
+
! Field Type
|-
+
! Notes
| 2 || Leave bed
+
|-
|-
+
|rowspan="2"| 0x1D
| 3 || Eat food
+
|rowspan="2"| Play
|-
+
|rowspan="2"| Client
| 4 || Critical effect
+
| Chunk X
|-
+
| Int
| 5 || Magic critical effect
+
| Block coordinate divided by 16, rounded down
|-
+
|-
| 102 || (unknown)
+
| Chunk Z
|-
+
| Int
| 104 || Crouch
+
| Block coordinate divided by 16, rounded down
|-
+
|}
| 105 || Uncrouch
 
|}
 
  
==== Spawn Player ====
+
It is legal to send this packet even if the given chunk is not currently loaded.
 +
 
 +
==== Change Game State ====
 +
 
 +
Used for a wide variety of game state things, from whether to bed use to gamemode to demo messages.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x1E
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Reason
 +
| Unsigned Byte
 +
| See below
 +
|-
 +
| Value
 +
| Float
 +
| Depends on Reason
 +
|}
  
This packet is sent by the server when a player comes into visible range, '''not''' when a player joins.
+
''Reason codes'':
  
Servers can, however, safely spawn player entities for players not in visible range. The client appears to handle it correctly.
+
{| class="wikitable"
 +
! Reason
 +
! Effect
 +
! Value
 +
|-
 +
| 0
 +
| Invalid Bed
 +
| Would be used to switch between messages, but the only used message is 0 for invalid bed
 +
|-
 +
| 1
 +
| End raining
 +
|
 +
|-
 +
| 2
 +
| Begin raining
 +
|
 +
|-
 +
| 3
 +
| Change gamemode
 +
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
 +
|-
 +
| 4
 +
| Exit end
 +
| 0: Immediately send Client Status of respawn without showing end credits; 1: Show end credits and respawn at the end (or when esc is pressed).  1 is sent if the player has not yet received the "The end?" advancement, while if they do have it 0 is used.
 +
|-
 +
| 5
 +
| Demo message
 +
| 0: Show welcome to demo screen, 101: Tell movement controls, 102: Tell jump control, 103: Tell inventory control
 +
|-
 +
| 6
 +
| Arrow hitting player
 +
| Appears to be played when an arrow strikes another player in Multiplayer
 +
|-
 +
| 7
 +
| Fade value
 +
| The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
 +
|-
 +
| 8
 +
| Fade time
 +
| Time in ticks for the sky to fade
 +
|-
 +
| 9
 +
| Play pufferfish sting sound
 +
|-
 +
| 10
 +
| Play elder guardian mob appearance (effect and sound)
 +
|
 +
|}
  
When in online-mode the uuids must be valid and have valid skin blobs, in offline-mode uuid v3 is used.
+
==== Open Horse Window ====
  
For NPCs UUID v2 should be used. Note:
+
This packet is used exclusively for opening the horse GUI.  [[#Open Window|Open Window]] is used for all other GUIs.
  <+Grum> i will never confirm this as a feature you know that :)
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! colspan=2 | Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=14 | 0x0C || rowspan=14 | Play || rowspan=14 | Client
+
! Bound To
| colspan=2 | Entity ID || VarInt || Player's Entity ID
+
! Field Name
|-
+
! Field Type
| colspan=2 | Player UUID || String || Player's UUID
+
! Notes
|-
+
|-
| colspan=2 | Player Name || String || Player's Name
+
|rowspan="3"| 0x1F
|-
+
|rowspan="3"| Play
| colspan=2 | Data count || VarInt ||  
+
|rowspan="3"| Client
|-
+
| Window ID?
| rowspan=3 | Data
+
| Byte
| Name || String || Name of the property as return by the session server's /hasJoined. E.g: textures
+
|
|-
+
|-
| Value || String || Value of the property (base64) as return by the session server's /hasJoined
+
| Number of slots?
|-
+
| VarInt
| Signature || String || Signature of the property (base64) as return by the session server's /hasJoined.
+
|
|-
+
|-
| colspan=2 | X || Int || Player X as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
| Entity ID?
|-
+
| Integer
| colspan=2 | Y || Int || Player X as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|
|-
+
|}
| colspan=2 | Z || Int || Player X as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
 
|-
+
==== Keep Alive (clientbound) ====
| colspan=2 | Yaw || Byte || Player rotation as a packed byte
 
|-
 
| colspan=2 | Pitch || Byte || Player rotation as a packet byte
 
|-
 
| colspan=2 | Current Item || Short || The item the player is currently holding. Note that this should be 0 for "no item", unlike -1 used in other packets. A negative value crashes clients.
 
|-
 
| colspan=2 | Metadata || [[Entities#Entity_Metadata_Format|Metadata]] || The client will crash if no metadata is sent
 
|}
 
{{Warning|The client will crash if no metadata is sent}}
 
{{Warning|The client will disconnect if both UUID and Name are empty}}
 
  
==== Collect Item ====
+
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.
  
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 & Look packet sent by the client.
+
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x0D || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Collected Entity ID || Int ||
+
! Field Name
|-
+
! Field Type
| Collector Entity ID || Int ||
+
! Notes
|}
+
|-
 +
|rowspan="1"| 0x20
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Keep Alive ID
 +
| Long
 +
|  
 +
|}
  
==== Spawn Object ====
+
==== Chunk Data ====
 +
{{Main|Chunk Format}}
 +
{{See also|#Unload Chunk}}
  
Sent by the server when an Object/Vehicle is created.
+
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 !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=8| 0x0E || rowspan=8 | Play || rowspan=8 | Client
+
! Bound To
| Entity ID || VarInt || Entity ID of the object
+
! Field Name
|-
+
! Field Type
| Type || Byte || The type of object (See [[Entities#Objects|Objects]])
+
! Notes
|-
+
|-
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
|rowspan="9"| 0x21
|-
+
|rowspan="9"| Play
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="9"| Client
|-
+
| Chunk X
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
| Int
|-
+
| Chunk coordinate (block coordinate divided by 16, rounded down)
| Pitch || Byte || The pitch in steps of 2p/256
+
|-
|-
+
| Chunk Z
| Yaw || Byte || The yaw in steps of 2p/256
+
| Int
|-
+
| Chunk coordinate (block coordinate divided by 16, rounded down)
| Data || [[Object_Data|Object Data]] ||
+
|-
|}
+
| Full chunk
 +
| Boolean
 +
| See [[Chunk Format#Full chunk|Chunk Format]]
 +
|-
 +
| Primary Bit Mask
 +
| VarInt
 +
| Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
 +
|-
 +
| Heightmaps
 +
| [[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.
 +
|-  
 +
| Size
 +
| VarInt
 +
| Size of Data in bytes
 +
|-
 +
| Data
 +
| Byte array
 +
| See [[Chunk Format#Data structure|data structure]] in Chunk Format
 +
|-
 +
| Number of block entities
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Block entities
 +
| Array of [[NBT|NBT Tag]]
 +
| All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 +
|}
  
==== Spawn Mob ====
+
Note that the Notchian client requires an [[#Update View Position|Update View Position]] packet when it crosses a chunk border, otherwise it'll only display render distance + 2 chunks around the chunk it spawned in.
 +
 
 +
==== Effect ====
 +
 
 +
Sent when a client is to play a sound or particle effect.
 +
 
 +
By default, the Minecraft client adjusts the volume of sound effects based on distance. The final boolean field is used to disable this, and instead the effect is played from 2 blocks away in the correct direction. Currently this is only used for effect 1023 (wither spawn) and effect 1028 (enderdragon death); it is ignored on other effects.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x22
 +
|rowspan="4"| Play
 +
|rowspan="4"| 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
 +
|}
  
Sent by the server when a Mob Entity is Spawned
+
Effect IDs:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! ID
|-
+
! Name
| rowspan=12 | 0x0F || rowspan=12 | Play || rowspan=12 | Client
+
! Data
| Entity ID || VarInt || Entity's ID
+
|-
|-
+
!colspan="3"| Sound
| Type || Unsigned Byte || The type of mob. See [[Entities#Mobs|Mobs]]
+
|-
|-
+
| 1000
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
| Dispenser dispenses
|-
+
|
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|-
|-
+
| 1001
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
| Dispenser fails to dispense
|-
+
|
| Yaw || Byte || The yaw in steps of 2p/256
+
|-
|-
+
| 1002
| Pitch || Byte || The pitch in steps of 2p/256
+
| Dispenser shoots
|-
+
|
| Head Pitch || Byte || The pitch in steps of 2p/256
+
|-
|-
+
| 1003
| Velocity X || Short ||
+
| Ender eye launched
|-
+
|
| Velocity Y || Short ||
+
|-
|-
+
| 1004
| Velocity Z || Short ||
+
| Firework shot
|-
+
|
| Metadata || [[Entities#Entity_Metadata_Format|Metadata]] ||
+
|-
|}
+
| 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
 +
|
 +
|-
 +
!colspan="3"| Particle
 +
|-
 +
| 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.
 +
| [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
 +
|-
 +
| 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
 +
| [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
 +
|-
 +
| 3000
 +
| End gateway spawn
 +
|
 +
|-
 +
| 3001
 +
| Enderdragon growl
 +
|
 +
|}
  
==== Spawn Painting ====
+
Smoke directions:
  
This packet shows location, name, and type of painting.
+
{| class="wikitable"
 +
! ID
 +
! Direction
 +
|-
 +
| 0
 +
| South-East
 +
|-
 +
| 1
 +
| South
 +
|-
 +
| 2
 +
| South-West
 +
|-
 +
| 3
 +
| East
 +
|-
 +
| 4
 +
| (Up or middle ?)
 +
|-
 +
| 5
 +
| West
 +
|-
 +
| 6
 +
| North-East
 +
|-
 +
| 7
 +
| North
 +
|-
 +
| 8
 +
| North-West
 +
|}
  
Calculating the center of an image: given a (width x height) grid of cells, with (0, 0) being the top left corner, the center is (max(0, width / 2 - 1), height / 2). E.g.
+
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.
  
2x1 (1, 0)
+
==== Particle ====
4x4 (1, 2)
 
  
 +
Displays the named particle
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x10 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || VarInt || Entity's ID
+
! Field Name
|-
+
! Field Type
| Title || String || Name of the painting. Max length 13
+
! Notes
|-
+
|-
| X || Int || Center X coordinate
+
|rowspan="11"| 0x23
|-
+
|rowspan="11"| Play
| Y || Int || Center Y coordinate
+
|rowspan="11"| Client
|-
+
| Particle ID
| Z || Int || Center Z coordinate
+
| Int
|-
+
| The particle ID listed in [[#Particle|the particle data type]].
| Direction || Int || Direction the painting faces (0 -z, 1 -x, 2 +z, 3 +x)
+
|-
|}
+
| Long Distance
 +
| Boolean
 +
| If true, particle distance increases from 256 to 65536
 +
|-
 +
| X
 +
| Float
 +
| X position of the particle
 +
|-
 +
| Y
 +
| Float
 +
| Y position of the particle
 +
|-
 +
| Z
 +
| Float
 +
| 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 [[#Particle|the particle data type]].
 +
|}
  
==== Spawn Experience Orb ====
+
==== Update Light ====
  
Spawns one or more experience orbs.
+
Updates light levels for a chunk.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x11 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Entity ID || VarInt || Entity's ID
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
! Notes
|-
+
|-
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="10"| 0x24
|-
+
|rowspan="10"| Play
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="10"| Client
|-
+
|colspan="2"| Chunk X
| Count || Short || The amount of experience this orb will reward once collected
+
|colspan="2"| VarInt
|}
+
| Chunk coordinate (block coordinate divided by 16, rounded down)
 +
|-
 +
|colspan="2"| Chunk Z
 +
|colspan="2"| VarInt
 +
| Chunk coordinate (block coordinate divided by 16, rounded down)
 +
|-
 +
|colspan="2"| Sky Light Mask
 +
|colspan="2"| VarInt
 +
| Mask containing 18 bits, with the lowest bit corresponding to chunk section -1 (in the void, y=-16 to y=-1) and the highest bit for chunk section 16 (above the world, y=256 to y=271)
 +
|-
 +
|colspan="2"| Block Light Mask
 +
|colspan="2"| VarInt
 +
| Mask containing 18 bits, with the same order as sky light
 +
|-
 +
|colspan="2"| Empty Sky Light Mask
 +
|colspan="2"| VarInt
 +
| Mask containing 18 bits, which indicates sections that have 0 for all their sky light values.  If a section is set in both this mask and the main sky light mask, it is ignored for this mask and it is included in the sky light arrays (the notchian server does not create such masks).  If it is only set in this mask, it is not included in the sky light arrays.
 +
|-
 +
|colspan="2"| Empty Block Light Mask
 +
|colspan="2"| VarInt
 +
| Mask containing 18 bits, which indicates sections that have 0 for all their block light values.  If a section is set in both this mask and the main block light mask, it is ignored for this mask and it is included in the block light arrays (the notchian server does not create such masks).  If it is only set in this mask, it is not included in the block light arrays.
 +
|-
 +
|rowspan="2"| Sky Light arrays
 +
| Length
 +
|rowspan="2"| 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.
 +
|-
 +
|rowspan="2"| Block Light arrays
 +
| Length
 +
|rowspan="2"| 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.
 +
|}
 +
 
 +
Individual block or sky light arrays are is given for each block with increasing x coordinates, within rows of increasing z coordinates, within layers of increasing y coordinates. Even-indexed items (those with an even x coordinate, starting at 0) are packed into the low bits, odd-indexed into the high bits.
  
==== Entity Velocity ====
+
==== Join Game ====
  
Velocity is believed to be in units of 1/8000 of a block per server tick (50ms);
+
See [[Protocol Encryption]] for information on logging in.
for example, -1343 would move (-1343 / 8000) = -0.167875 blocks per tick (or -3,3575 blocks per second).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x12 || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Velocity X || Short || Velocity on the X axis
+
! Notes
|-
+
|-
| Velocity Y || Short || Velocity on the Y axis
+
|rowspan="7"| 0x25
|-
+
|rowspan="7"| Play
| Velocity Z || Short || Velocity on the Z axis
+
|rowspan="7"| Client
|}
+
| Entity ID
 +
| Int
 +
| The player's Entity ID (EID)
 +
|-
 +
| 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.
 +
|-
 +
| Max Players
 +
| Unsigned Byte
 +
| Was once used by the client to draw the player list, but now is ignored
 +
|-
 +
| Level Type
 +
| String Enum (16)
 +
| default, flat, largeBiomes, amplified, customized, buffet, default_1_1
 +
|-
 +
| 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.
 +
|}
  
==== Destroy Entities ====
+
==== Map Data ====
  
Sent by the server when an list of Entities is to be destroyed on the client.
+
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x13 || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Count || Byte || Length of following array
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| Entity IDs || Array of Int || The list of entities of destroy
+
! Notes
|}
+
|-
 +
|rowspan="17"| 0x26
 +
|rowspan="17"| Play
 +
|rowspan="17"| Client
 +
|colspan="2"| Map ID
 +
|colspan="2"| VarInt
 +
| Map ID of the map being modified
 +
|-
 +
|colspan="2"| Scale
 +
|colspan="2"| Byte
 +
| From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
 +
|-
 +
|colspan="2"| Tracking Position
 +
|colspan="2"| Boolean
 +
| Specifies whether player and item frame icons are shown
 +
|-
 +
|colspan="2"| Locked
 +
|colspan="2"| Boolean
 +
| True if the map has been locked in a cartography table
 +
|-
 +
|colspan="2"| Icon Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="6"| Icon
 +
| Type
 +
|rowspan="6"| Array
 +
| VarInt enum
 +
| See below
 +
|-
 +
| 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
 +
|-
 +
|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
 +
|-
 +
|colspan="2"| Length
 +
|colspan="2"| Optional VarInt
 +
| Only if Columns is more than 0; length of the following array
 +
|-
 +
|colspan="2"| Data
 +
|colspan="2"| Optional Array of Unsigned Byte
 +
| Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
 +
|}
  
==== Entity ====
+
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"
 +
|-
 +
! 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
 +
|}
  
Most entity-related packets are subclasses of this packet. When sent from the server to the client, it may initialize the entry.
+
==== Trade List ====
  
For player entities, either this packet or any move/look packet is sent every game tick.
+
The list of trades a villager NPC is offering.
So the meaning of this packet is basically that the entity did not move/look since the last such packet.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x14 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
!colspan="2"| Field Name
|}
+
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="18"| 0x27
 +
|rowspan="18"| Play
 +
|rowspan="18"| Client
 +
|-
 +
| colspan="2" | Window ID
 +
| colspan="2" | VarInt
 +
| The ID of the window that is open; this is an int rather than a byte.
 +
|-
 +
| colspan="2" | Size
 +
| colspan="2" | Byte
 +
| The number of trades in the following array
 +
|-
 +
| rowspan="11" | Trades
 +
| Input item 1
 +
| rowspan="11" | Array
 +
| [[Slot]]
 +
| The first item the villager is buying
 +
|-
 +
| Output item
 +
| [[Slot]]
 +
| The item the villager is selling
 +
|-
 +
| Has second item
 +
| Boolean
 +
| Whether there is a second item
 +
|-
 +
| Input item 2
 +
| Optional [[Slot]]
 +
| The second item the villager is buying; only present if they have a second item.
 +
|-
 +
| 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
 +
|-
 +
| Maximum number of trade uses
 +
| Integer
 +
| Number of times this trade can be used
 +
|-
 +
| XP
 +
| Integer
 +
|
 +
|-
 +
| Special Price
 +
| Integer
 +
|
 +
|-
 +
| Price Multiplier
 +
| Float
 +
|
 +
|-
 +
| Demand
 +
| Integer
 +
|
 +
|-
 +
|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.
 +
|}
 +
 
 +
[[File:1.14-merchant-slots.png|thumb|The merchant UI, for reference]]
 +
{{-}}
  
 
==== Entity Relative Move ====
 
==== Entity Relative Move ====
  
This packet is sent by the server when an entity moves less then 4 blocks; if an entity moves more than 4 blocks Entity Teleport should be sent instead.
+
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 four blocks movement in any direction, because byte range is from -128 to 127.
+
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 !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4| 0x15 || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| DX || Byte || Change in X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
! Notes
|-
+
|-
| DY || Byte || Change in Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="5"| 0x28
|-
+
|rowspan="5"| Play
| DZ || Byte || Change in Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="5"| Client
|}
+
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Delta X
 +
| Short
 +
| 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>
 +
|-
 +
| On Ground
 +
| Boolean
 +
|
 +
|}
 +
 
 +
==== Entity Look And Relative Move ====
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x29
 +
|rowspan="7"| Play
 +
|rowspan="7"| Client
 +
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Delta X
 +
| Short
 +
| 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 ====
 
==== Entity Look ====
  
This packet is sent by the server when an entity rotates.  Example: "Yaw" field 64 means a 90 degree turn.
+
This packet is sent by the server when an entity rotates.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x2A
 +
|rowspan="4"| Play
 +
|rowspan="4"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Yaw
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| Pitch
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| On Ground
 +
| Boolean
 +
|
 +
|}
 +
 
 +
==== Entity ====
 +
 
 +
This packet may be used to initialize an entity.
 +
 
 +
For player entities, either this packet or any move/look packet is sent every game tick. So the meaning of this packet is basically that the entity did not move/look since the last such packet.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x16 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Yaw || Byte || The X Axis rotation as a fraction of 360
+
! Notes
|-
+
|-
| Pitch || Byte || The Y Axis rotation as a fraction of 360
+
|rowspan="1"| 0x2B
|}
+
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Entity ID
 +
| VarInt
 +
|  
 +
|}
  
==== Entity Look and Relative Move ====
+
==== Vehicle Move (clientbound) ====
  
This packet is sent by the server when an entity rotates and moves.
+
Note that all fields use absolute positioning and do not allow for relative positioning.
Since a byte range is limited from -128 to 127, and movement is offset of fixed-point numbers,
 
this packet allows at most four blocks movement in any direction. (-128/32 == -4)
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x17 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| DX || Byte || Change in X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
! Notes
|-
+
|-
| DY || Byte || Change in Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="5"| 0x2C
|-
+
|rowspan="5"| Play
| DZ || Byte || Change in Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="5"| Client
|-
+
| X
| Yaw || Byte || The X Axis rotation as a fraction of 360
+
| Double
|-
+
| Absolute position (X coordinate)
| Pitch || Byte || The Y Axis rotation as a fraction of 360
+
|-
|}
+
| 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
 +
|}
  
==== Entity Teleport ====
+
==== Open Book ====
  
This packet is sent by the server when an entity moves more than 4 blocks.
+
Sent when a player right clicks with a signed book. This tells the client to open the book GUI.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x18 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
! Notes
|-
+
|-
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="1"| 0x2D
|-
+
|rowspan="1"| Play
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="1"| Client
|-
+
| Hand
| Yaw || Byte || The X Axis rotation as a fraction of 360
+
| VarInt enum
|-
+
| 0: Main hand, 1: Off hand
| Pitch || Byte || The Y Axis rotation as a fraction of 360
+
|}
|}
 
  
==== Entity Head Look ====
+
==== Open Window ====
  
Changes the direction an entity's head is facing.
+
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.  For horses, use [[#Open Horse Window|Open Horse Window]].
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x19 || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Head Yaw || Byte || Head yaw in steps of 2p/256
+
! Notes
|}
+
|-
 +
|rowspan="3"| 0x2E
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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 <code>minecraft:menu</code> regisry; see [[Inventory]] for the different values.
 +
|-
 +
| Window Title
 +
| [[Chat]]
 +
| The title of the window
 +
|}
 +
 
 +
==== Open Sign Editor ====
 +
 
 +
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].  There must already be a sign at the given location (which the client does not do automatically) - send a [[#Block Change|Block Change]] first.
  
==== Entity Status ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x1A || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Entity Status || Byte || See below
+
! Notes
|}
+
|-
 +
|rowspan="1"| 0x2F
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Location
 +
| Position
 +
|  
 +
|}
 +
 
 +
==== Craft Recipe Response ====
 +
 
 +
Response to the serverbound packet ([[#Craft Recipe Request|Craft Recipe Request]]), with the same recipe ID.  Appears to be used to notify the UI.
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
! Packet ID
! Entity Status !! Meaning
+
! State
|-
+
! Bound To
| 0 || Something related to living entities?
+
! Field Name
|-
+
! Field Type
| 1 || Something related to the player entity?
+
! Notes
|-
+
|-
| 2 || Living Entity hurt
+
|rowspan="2"| 0x30
|-
+
|rowspan="2"| Play
| 3 || Living Entity dead
+
|rowspan="2"| Client
|-
+
| Window ID
| 4 || Iron Golem throwing up arms
+
| Byte
|-
+
|
| 6 || Wolf/Ocelot/Horse taming - Spawn "heart" particles
+
|-
|-
+
| Recipe
| 7 || Wolf/Ocelot/Horse tamed - Spawn "smoke" particles
+
| Identifier
|-
+
| A recipe ID
| 8 || Wolf shaking water - Trigger the shaking animation
+
|}
|-
 
| 9 || (of self) Eating accepted by server
 
|-
 
| 10 || Sheep eating grass
 
|-
 
| 11 || Iron Golem handing over a rose
 
|-
 
| 12 || Villager mating - Spawn "heart" particles
 
|-
 
| 13 || Spawn particles indicating that a villager is angry and seeking revenge
 
|-
 
| 14 || Spawn happy particles near a villager
 
|-
 
| 15 || Witch animation - Spawn "magic" particles
 
|-
 
| 16 || Zombie converting into a villager by shaking violently
 
|-
 
| 17 || Firework exploding
 
|-
 
| 18 || Animal in love (ready to mate) - Spawn "heart" particles
 
|}
 
  
==== Attach Entity ====
+
==== Player Abilities (clientbound) ====
  
This packet is sent when a player has been attached to an entity (e.g. Minecart)
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x1B || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Vehicle ID || Int || Vechicle's Entity ID
+
! Notes
|-
+
|-
| Leash || Bool || If true leashes the entity to the vehicle
+
|rowspan="3"| 0x31
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| 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 [[Protocol#Entity_Properties|Entity Properties]] packet, which defaults to 0.1 for players.
 +
|}
 +
 
 +
About the flags:
  
==== Entity Metadata ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
|-
|-
+
! Field
| rowspan=2 | 0x1C || rowspan=2 | Play || rowspan=2 | Client
+
! Bit
| Entity ID || Int || Entity's ID
+
|-
|-
+
| Invulnerable
| Metadata || [[Entities#Entity_Metadata_Format|Metadata]] ||  
+
| 0x01
|}
+
|-
 +
| Flying
 +
| 0x02
 +
|-
 +
| Allow Flying
 +
| 0x04
 +
|-
 +
| Creative Mode (Instant Break)
 +
| 0x08
 +
|}
 +
 
 +
==== Combat Event ====
  
==== Entity Effect ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x1D || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
!colspan="2"| Field Name
|-
+
! Field Type
| Effect ID || Byte || See [[http://www.minecraftwiki.net/wiki/Potion_effect#Parameters]]
+
! Notes
|-
+
|-
| Amplifier || Byte ||  
+
|rowspan="8"| 0x32
|-
+
|rowspan="8"| Play
| Duration || Short ||
+
|rowspan="8"| Client
|}
+
|colspan="2"| Event
 +
| VarInt Enum
 +
| Determines the layout of the remaining packet
 +
|-
 +
! Event
 +
! Field Name
 +
!
 +
!
 +
|-
 +
| 0: enter combat
 +
| ''no fields''
 +
| ''no fields''
 +
|
 +
|-
 +
|rowspan="2"| 1: end combat
 +
| Duration
 +
| VarInt
 +
|  
 +
|-
 +
| Entity ID
 +
| Int
 +
|  
 +
|-
 +
|rowspan="3"| 2: entity dead
 +
| Player ID
 +
| VarInt
 +
|  
 +
|-
 +
| Entity ID
 +
| Int
 +
|  
 +
|-
 +
| Message
 +
| [[Chat]]
 +
|
 +
|}
 +
 
 +
==== Player Info ====
 +
 
 +
Sent by the server to update the user list (<tab> in the client).
  
==== Remove Entity Effect ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x1E || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
!colspan="4"| Field Name
|-
+
!colspan="3"| Field Type
| Effect ID || Byte ||
+
! Notes
|}
+
|-
 +
|rowspan="19"| 0x33
 +
|rowspan="19"| Play
 +
|rowspan="19"| Client
 +
|colspan="4"| Action
 +
|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"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="4"| Property
 +
| Name
 +
|rowspan="4"| Array
 +
| String (32767)
 +
|
 +
|-
 +
| Value
 +
| String (32767)
 +
|
 +
|-
 +
| Is Signed
 +
| Boolean
 +
|
 +
|-
 +
| Signature
 +
| Optional String (32767)
 +
| Only if Is Signed is true
 +
|-
 +
|colspan="2"| Gamemode
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
|colspan="2"| Ping
 +
|colspan="2"| VarInt
 +
| Measured in milliseconds
 +
|-
 +
|colspan="2"| Has Display Name
 +
|colspan="2"| Boolean
 +
|
 +
|-
 +
|colspan="2"| Display Name
 +
|colspan="2"| Optional [[Chat]]
 +
| 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
 +
| Measured in milliseconds
 +
|-
 +
|rowspan="2"| 3: update display name
 +
|colspan="2"| Has Display Name
 +
|colspan="2"| Boolean
 +
|  
 +
|-
 +
|colspan="2"| Display Name
 +
|colspan="2"| Optional [[Chat]]
 +
| Only send if Has Display Name is true
 +
|-
 +
| 4: remove player
 +
|colspan="2"| ''no fields''
 +
|colspan="2"| ''no fields''
 +
|  
 +
|}
  
==== Set Experience ====
+
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 ====
  
Sent by the server when the client should change experience levels.
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x1F || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Experience bar || Float || Between 0 and 1
+
! Field Name
|-
+
! Field Type
| Level || Short ||
+
! Notes
|-
+
|-
| Total Experience || Short ||
+
|rowspan="8"| 0x34
|}
+
|rowspan="8"| Play
 +
|rowspan="8"| 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 &mdash; the entity to face towards
 +
|-
 +
| Entity feet/eyes
 +
| Optional VarInt enum
 +
| Whether to look at the entity's eyes or feet.  Same values and meanings as before, just for the entity's head/feet.
 +
|}
 +
 
 +
If the entity given by entity ID cannot be found, this packet should be treated as if is entity was false.
 +
 
 +
==== 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.
  
==== Entity Properties ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x20 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Count || Int || Length of following array
+
! Notes
|-
+
|-
| Properties || Array of Property Data ||
+
|rowspan="7"| 0x35
|}
+
|rowspan="7"| Play
 +
|rowspan="7"| 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|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.
  
'''Property Data''' structure:
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! Field Name !! Field Type !! Notes
+
! Field
|-
+
! Bit
| Key || String ||  
+
|-
|-
+
| X
| Value || Double ||  
+
| 0x01
|-
+
|-
| List Length || Short || Number of list elements that follow.
+
| Y
|-
+
| 0x02
| Modifiers || Array of Modifier Data || http://www.minecraftwiki.net/wiki/Attribute#Modifiers
+
|-
|}
+
| Z
 +
| 0x04
 +
|-
 +
| Y_ROT
 +
| 0x08
 +
|-
 +
| X_ROT
 +
| 0x10
 +
|}
 +
 
 +
==== Unlock Recipes ====
  
Known key values:
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
! Packet ID
! Key !! Default !! Min !! Max !! Label
+
! State
|-
+
! Bound To
| generic.maxHealth || 20.0 || 0.0 || Double.MaxValue || Max Health
+
! Field Name
|-
+
! Field Type
| generic.followRange || 32.0 || 0.0 || 2048.0 || Follow Range
+
! Notes
|-
+
|-
| generic.knockbackResistance || 0.0 || 0.0 || 1.0 || Knockback Resistance
+
|rowspan="10"| 0x36
|-
+
|rowspan="10"| Play
| generic.movementSpeed || 0.699999988079071 || 0.0 || Double.MaxValue || Movement Speed
+
|rowspan="10"| Client
|-
+
|-
| generic.attackDamage || 2.0 || 0.0 || Double.MaxValue ||
+
| Action
|-
+
| VarInt
| horse.jumpStrength || 0.7 || 0.0 || 2.0 || Jump Strength
+
| 0: init, 1: add, 2: remove
|-
+
|-
| zombie.spawnReinforcements || 0.0 || 0.0 || 1.0 || Spawn Reinforcements Chance
+
| 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.
 +
|-
 +
| Array size 1
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Recipe IDs
 +
| Array of Identifier
 +
|
 +
|-
 +
| Array size 2
 +
| Optional VarInt
 +
| Number of elements in the following array, only present if mode is 0 (init)
 +
|-
 +
| Recipe IDs
 +
| Optional Array of Identifier, only present if mode is 0 (init)
 +
|
 +
|}
 +
Action:
 +
* 0 (init) = All the recipes in the list 2 will added to the recipe book. All the recipes in list 1 will be tagged as displayed, recipes that aren't tagged will be shown in the notification. VERIFY LIST ORDER?
 +
* 1 (add) = All the recipes in the list are added and their icon will be shown in the notification.
 +
* 2 (remove) = Remove all the recipes in the list. This allows them to re-displayed when they are readded.
 +
 
 +
==== Destroy Entities ====
 +
 
 +
Sent by the server when a list of entities is to be destroyed on the client.
  
'''Modifier Data''' structure:
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
! Packet ID
! Field Name !! Field Type !! Notes
+
! State
|-
+
! Bound To
| UUID || 128-bit integer ||
+
! Field Name
|-
+
! Field Type
| Amount || Double ||
+
! Notes
|-
+
|-
| Operation || Byte ||
+
|rowspan="2"| 0x37
|}
+
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Entity IDs
 +
| Array of VarInt
 +
| The list of entities of destroy
 +
|}
  
==== Chunk Data ====
+
==== Remove Entity Effect ====
  
Chunks are not unloaded by the client automatically. To unload chunks, send this packet with ground-up continuous=true and no 16^3 chunks (eg. primary bit mask=0). The server does not send skylight information for nether-chunks, it's up to the client to know if the player is currently in the nether. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x38
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Effect ID
 +
| Byte
 +
| See {{Minecraft Wiki|Status effect#List of effects|this table}}
 +
|}
  
See also: [[SMP Map Format]]
+
==== Resource Pack Send ====
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=7 | 0x21 || rowspan=7 | Play || rowspan=7 | Client
+
! Bound To
| Chunk X || Int || Chunk X coordinate
+
! Field Name
|-
+
! Field Type
| Chunk Z || Int || Chunk Z coordinate
+
! Notes
|-
+
|-
| Ground-Up continuous || Boolean || This is True if the packet represents all sections in this vertical column, where the primary bit map specifies exactly which sections are included, and which are air
+
|rowspan="2"| 0x39
|-
+
|rowspan="2"| Play
| Primary bit map || Unsigned Short || Bitmask with 1 for every 16x16x16 section which data follows in the compressed data.
+
|rowspan="2"| Client
|-
+
| URL
| Add bit map || Unsigned Short || Same as above, but this is used exclusively for the 'add' portion of the payload
+
| String (32767)
|-
+
| The URL to the resource pack.
| Compressed size || Int || Size of compressed chunk data
+
|-
|-
+
| Hash
| Compressed data || Byte array || The chunk data is compressed using Zlib Deflate
+
| 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
 +
|}
 +
 
 +
==== 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.
  
==== Multi Block Change ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x22 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Chunk X || Int || Chunk X coordinate
+
! Field Name
|-
+
! Field Type
| Chunk Z || Int || Chunk Z Coordinate
+
! Notes
|-
+
|-
| Record count || Short || The number of blocks affected
+
|rowspan="3"| 0x3A
|-
+
|rowspan="3"| Play
| Data size || Int ||  The total size of the data, in bytes. Should always be 4*record count
+
|rowspan="3"| Client
|-
+
| Dimension
| Records || Array of Records ||
+
| Int Enum
|}
+
| -1: The Nether, 0: The Overworld, 1: The End
 +
|-
 +
| Gamemode
 +
| Unsigned Byte
 +
| 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
 +
|-
 +
| Level Type
 +
| String (16)
 +
| Same as [[#Join Game|Join Game]]
 +
|}
 +
 
 +
{{Warning2|Avoid changing player's dimension to same dimension they were already in unless they are dead. If you change the dimension to one they are already in, weird bugs can occur, such as the player being unable to attack other players in new world (until they die and respawn).
 +
 
 +
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.
  
'''Record'''
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
! Packet ID
! Bit mask !! Width !! Meaning
+
! State
|-
+
! Bound To
| 00 00 00 0F || 4 bits || Block metadata
+
! Field Name
|-
+
! Field Type
| 00 00 FF F0 || 12 bits || Block ID
+
! Notes
|-
+
|-
| 00 FF 00 00 || 8 bits || Y co-ordinate
+
|rowspan="2"| 0x3B
|-
+
|rowspan="2"| Play
| 0F 00 00 00 || 4 bits || Z co-ordinate, relative to chunk
+
|rowspan="2"| Client
|-
+
| Entity ID
| F0 00 00 00 || 4 bits || X co-ordinate, relative to chunk
+
| VarInt
|}
+
|  
 +
|-
 +
| Head Yaw
 +
| Angle
 +
| New angle, not a delta
 +
|}
 +
 
 +
==== Select Advancement Tab ====
 +
 
 +
Sent by the server to indicate that the client should switch advancement tab. Sent either when the client switches tab in the GUI or when an advancement in another tab is made.
  
==== Block Change ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x23 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| X || Int || Block X Coordinate
+
! Field Name
|-
+
! Field Type
| Y || Unsigned Byte || Block Y Coordinate
+
! Notes
|-
+
|-
| Z || Int || Block Z Coordinate
+
|rowspan="2"| 0x3C
|-
+
|rowspan="2"| Play
| Block ID || VarInt || The new block ID for the block
+
|rowspan="2"| Client
|-
+
| Has id
| Block Metadata || Unsigned Byte || The new metadata for the block
+
| Boolean
|}
+
| Indicates if the next field is present
 +
|-
 +
| Optional Identifier
 +
| String (32767)
 +
| See below
 +
|}
  
==== Block Action ====
+
The Identifier can be one of the following:
 +
 
 +
{| class="wikitable"
 +
! Optional Identifier
 +
|-
 +
| minecraft:story/root
 +
|-
 +
| minecraft:nether/root
 +
|-
 +
| minecraft:end/root
 +
|-
 +
| minecraft:adventure/root
 +
|-
 +
| minecraft:husbandry/root
 +
|}
  
This packet is used for a number of things:
+
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
* <div class="li">Chests opening and closing
 
* Pistons pushing and pulling
 
* Note blocks playing
 
  
See Also: [[Block Actions]]
+
==== World Border ====
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x24 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| X || Int || Block X Coordinate
+
!colspan="2"| Field Name
|-
+
! Field Type
| Y || Short || Block Y Coordinate
+
! Notes
|-
+
|-
| Z || Int || Block Z Coordinate
+
|rowspan="18"| 0x3D
|-
+
|rowspan="18"| Play
| Byte 1 || Unsigned Byte || Varies depending on block - see [[Block_Actions]]
+
|rowspan="18"| Client
|-
+
|colspan="2"| Action
| Byte 2 || Unsigned Byte || Varies depending on block - see [[Block_Actions]]
+
| VarInt Enum
|-
+
| Determines the format of the rest of the packet
| Block Type || VarInt || The block type for the block
+
|-
|}
+
! Action
 +
! Field Name
 +
!
 +
!
 +
|-
 +
| 0: set size
 +
| Diameter
 +
| Double
 +
| Length of a single side of the world border, in meters
 +
|-
 +
|rowspan="3"| 1: lerp size
 +
| 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 ''milli''seconds until New Diameter is reached. It appears that Notchian server does not sync world border speed to game ticks, so it gets out of sync with server lag. If the world border is not moving, this is set to 0.
 +
|-
 +
|rowspan="2"| 2: set center
 +
| X
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|  
 +
|-
 +
|rowspan="8"| 3: initialize
 +
| 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 ''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 Time
 +
| VarInt
 +
| In seconds as set by <code>/worldborder warning time</code>
 +
|-
 +
| Warning Blocks
 +
| VarInt
 +
| In meters
 +
|-
 +
|rowspan="1"| 4: set warning time
 +
| Warning Time
 +
| VarInt
 +
| In seconds as set by <code>/worldborder warning time</code>
 +
|-
 +
|rowspan="1"| 5: set warning blocks
 +
| Warning Blocks
 +
| VarInt
 +
| In meters
 +
|}
 +
 
 +
The Notchian client determines how solid to display the warning by comparing to whichever is higher, the warning distance or whichever is lower, the distance from the current diameter to the target diameter or the place the border will be after warningTime seconds. In pseudocode:
 +
 
 +
<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>
  
==== Block Break Animation ====
+
==== Camera ====
  
0-9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
+
Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.
  
You can also set an animation to air! The animation will still be visible.
+
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 you need to display several break animations at the same time you have to give each of them a unique Entity ID.
+
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.
  
Also if you set the coordinates to a special block like water, it won't show the actual break animation, but some other interesting effects. (Water will lose its transparency)
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x25 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Entity ID || VarInt || Entity's ID
+
! Field Name
|-
+
! Field Type
| X || Int || rowspan=3 | Block Position
+
! Notes
|-
+
|-
| Y || Int
+
|rowspan="1"| 0x3E
|-
+
|rowspan="1"| Play
| Z || Int
+
|rowspan="1"| Client
|-
+
| Camera ID
| Destroy Stage || Byte || 0 - 9
+
| VarInt
|}
+
| ID of the entity to set the client's camera to
 +
|}
  
==== Map Chunk Bulk ====
+
The notchian also loads certain shaders for given entities:
  
See also: [[SMP Map Format]]
+
* 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
  
To reduce the number of bytes this packet is used to send chunks together for better compression results.
+
==== Held Item Change (clientbound) ====
 +
 
 +
Sent to change the player's slot selection.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x26 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Chunk column count || Short || The number of chunk in this packet
+
! Field Name
|-
+
! Field Type
| Data length || Int || The size of the data field
+
! Notes
|-
+
|-
| Sky light sent || Bool || Whether or not the chunk data contains a light nibble array. This is true in the main world, false in the end + nether
+
|rowspan="1"| 0x3F
|-
+
|rowspan="1"| Play
| Data || Byte Array || Compressed chunk data
+
|rowspan="1"| Client
|-
+
| Slot
| Meta information || Meta || See below
+
| Byte
|}
+
| The slot which the player has selected (0–8)
 +
|}
 +
 
 +
==== Update View Position ====
 +
 
 +
{{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.}}
 +
 
 +
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.
  
'''Meta'''
 
 
{| class="wikitable"
 
{| class="wikitable"
! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
|Chunk X || Int || The X Coordinate of the chunk
+
! Bound To
|-
+
! Field Name
|Chunk Z || Int || The Z Coordinate of the chunk
+
! Field Type
|-
+
! Notes
|Primary bitmap || Unsigned Short || A bitmap which specifies which sections are not empty in this chunk
+
|-
|-
+
|rowspan="2"| 0x40
|Add bitmap || Unsigned Short || A bitmap which specifies which sections need add information because of very high block ids. not yet used
+
|rowspan="2"| Play
|}
+
|rowspan="2"| 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 <code>view-distance</code> in server.properties cannot be changed at runtime.
  
==== Explosion ====
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x41
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| View Distance
 +
| VarInt
 +
| Render distance (2-32)
 +
|}
  
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
+
==== Display Scoreboard ====
  
Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x
+
This is sent to the client when it should display a scoreboard.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="9" | 0x27 || rowspan=9 | Play || rowspan=9 | Client
+
! Bound To
| X || Float ||
+
! Field Name
|-
+
! Field Type
| Y || Float ||
+
! Notes
|-
+
|-
| Z || Float ||
+
|rowspan="2"| 0x42
|-
+
|rowspan="2"| Play
| Radius || Float || Currently unused in the client
+
|rowspan="2"| Client
|-
+
| Position
| Record count || Int || This is the count, not the size. The size is 3 times this value.
+
| Byte
|-
+
| The position of the scoreboard. 0: list, 1: sidebar, 2: below name, 3 - 18: team specific sidebar, indexed as 3 + team color.
| Records || (Byte, Byte, Byte) × count || Each record is 3 signed bytes long, each bytes are the XYZ (respectively) offsets of affected blocks.
+
|-
|-
+
| Score Name
| Player Motion X || Float || X velocity of the player being pushed by the explosion
+
| String (16)
|-
+
| The unique name for the scoreboard to be displayed.
| 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
 
|}
 
  
==== Effect ====
+
==== Entity Metadata ====
 +
 
 +
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"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x43
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Metadata
 +
| [[Entities#Entity Metadata Format|Entity Metadata]]
 +
|
 +
|}
  
Sent when a client is to play a sound or particle effect.
+
==== Attach Entity ====
  
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 effects 1013 and 1018 (mob.wither.spawn and mob.enderdragon.end, respectively), and is ignored for any other value by the client.
+
This packet is sent when an entity has been {{Minecraft Wiki|Lead|leashed}} to another entity.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x28 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Effect ID || Int || The ID of the effect, see below.
+
! Field Name
|-
+
! Field Type
| X || Int || The X location of the effect
+
! Notes
|-
+
|-
| Y || Byte || The Y location of the effect
+
|rowspan="2"| 0x44
|-
+
|rowspan="2"| Play
| Z || Int || The Z location of the effect
+
|rowspan="2"| Client
|-
+
| Attached Entity ID
| Data || Int || Extra data for certain effects, see below.
+
| Int
|-
+
| Attached entity's EID
| Disable relative volume || Bool || See above
+
|-
|}
+
| Holding Entity ID
 +
| Int
 +
| ID of the entity holding the lead. Set to -1 to detach.
 +
|}
 +
 
 +
==== Entity Velocity ====
  
===== Effects =====
+
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"
! ID !! Name
+
! Packet ID
|-
+
! State
| colspan=2 | '''Sound'''
+
! Bound To
|-
+
! Field Name
| 1000|| <code>random.click</code>
+
! Field Type
|-
+
! Notes
| 1001|| <code>random.click</code>
+
|-
|-
+
|rowspan="4"| 0x45
| 1002|| <code>random.bow</code>
+
|rowspan="4"| Play
|-
+
|rowspan="4"| Client
| 1003|| <code>random.door_open</code> or <code>random.door_close</code> (50/50 chance)
+
| Entity ID
|-
+
| VarInt
| 1004|| <code>random.fizz</code>
+
|  
|-
+
|-
| 1005|| Play a music disc. '''Data''' [http://www.minecraftwiki.net/wiki/Music_Discs Record ID]
+
| Velocity X
|-
+
| Short
| ''(1006 not assigned)'' ||
+
| Velocity on the X axis
|-
+
|-
| 1007|| <code>mob.ghast.charge</code>
+
| Velocity Y
|-
+
| Short
| 1008|| <code>mob.ghast.fireball</code>
+
| Velocity on the Y axis
|-
+
|-
| 1009|| <code>mob.ghast.fireball</code>, but with a lower volume.
+
| Velocity Z
|-
+
| Short
| 1010|| <code>mob.zombie.wood</code>
+
| Velocity on the Z axis
|-
+
|}
| 1011|| <code>mob.zombie.metal</code>
 
|-
 
| 1012|| <code>mob.zombie.woodbreak</code>
 
|-
 
| 1013|| <code>mob.wither.spawn</code>
 
|-
 
| 1014|| <code>mob.wither.shoot</code>
 
|-
 
| 1015|| <code>mob.bat.takeoff</code>
 
|-
 
| 1016|| <code>mob.zombie.infect</code>
 
|-
 
| 1017|| <code>mob.zombie.unfect</code>
 
|-
 
| 1018|| <code>mob.enderdragon.end</code>
 
|-
 
| 1020|| <code>random.anvil_break</code>
 
|-
 
| 1021|| <code>random.anvil_use</code>
 
|-
 
| 1022|| <code>random.anvil_land</code>
 
|-
 
| colspan=2 | '''Particle'''
 
|-
 
| 2000|| Spawns 10 smoke particles, e.g. from a fire. '''Data''' direction, see below
 
|-
 
| 2001|| Block break. '''Data''' [http://www.minecraftwiki.net/wiki/Data_values Block ID]
 
|-
 
| 2002|| Splash potion. Particle effect + glass break sound. '''Data''' [http://www.lb-stuff.com/Minecraft/PotionDataValues1.9pre3.txt Potion ID]
 
|-
 
| 2003|| Eye of ender entity break animation - particles and sound
 
|-
 
| 2004|| Mob spawn particle effect: smoke + flames
 
|-
 
| 2005|| Spawn "happy villager" effect (green crosses), used for bonemealing vegetation.
 
|-
 
| 2005|| Spawn fall particles (when player hits ground). '''Data''' fall damage taken for particle speed
 
|}
 
  
Smoke directions:
+
==== Entity Equipment ====
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Direction
+
! Packet ID
|-
+
! State
| 0 || South - East
+
! Bound To
|-
+
! Field Name
| 1 || South
+
! Field Type
|-
+
! Notes
| 2 || South - West
+
|-
|-
+
|rowspan="3"| 0x46
| 3 || East
+
|rowspan="3"| Play
|-
+
|rowspan="3"| Client
| 4 || (Up or middle ?)
+
| Entity ID
|-
+
| VarInt
| 5 || West
+
| Entity's EID
|-
+
|-
| 6 || North - East
+
| Slot
|-
+
| VarInt Enum
| 7 || North
+
| Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet)
|-
+
|-
| 8 || North - West
+
| Item
|}
+
| [[Slot Data|Slot]]
 +
|  
 +
|}
 +
 
 +
==== Set Experience ====
  
==== Sound Effect ====
+
Sent by the server when the client should change experience levels.
  
Used to play a sound effect on the client.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x47
 +
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Experience bar
 +
| Float
 +
| Between 0 and 1
 +
|-
 +
| Level
 +
| VarInt
 +
|
 +
|-
 +
| Total Experience
 +
| VarInt
 +
| See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion
 +
|}
  
All known sound effect names can be seen [https://github.com/SirCmpwn/Craft.Net/blob/master/source/Craft.Net.Common/SoundEffect.cs here].
+
==== Update Health ====
  
Custom sounds may be added by resource packs
+
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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x29 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Sound name || String ||
+
! Field Name
|-
+
! Field Type
| Effect position X || Int || Effect X multiplied by 8
+
! Notes
|-
+
|-
| Effect position Y || Int || Effect Y multiplied by 8
+
|rowspan="3"| 0x48
|-
+
|rowspan="3"| Play
| Effect position Z || Int || Effect Z multiplied by 8
+
|rowspan="3"| Client
|-
+
| Health
| Volume || Float || 1 is 100%, can be more
+
| Float
|-
+
| 0 or less = dead, 20 = full HP
| Pitch || Unsigned Byte || 63 is 100%, can be more
+
|-
|}
+
| Food
 +
| VarInt
 +
| 0–20
 +
|-  
 +
| Food Saturation
 +
| Float
 +
| Seems to vary from 0.0 to 5.0 in integer increments
 +
|}
  
==== Particle ====
+
==== Scoreboard Objective ====
  
Displays the named particle
+
This is sent to the client when it should create a new {{Minecraft Wiki|scoreboard}} objective or remove one.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="9" | 0x2A || rowspan=9 | Play || rowspan=9 | Client
+
! Bound To
| Particle name || String || The name of the particle to create. A list can be found [https://gist.github.com/thinkofdeath/5110835 here]
+
! Field Name
|-
+
! Field Type
| X || Float || X position of the particle
+
! Notes
|-
+
|-
| Y || Float || Y position of the particle
+
|rowspan="4"| 0x49
|-
+
|rowspan="4"| Play
| Z || Float || Z position of the particle
+
|rowspan="4"| Client
|-
+
| Objective Name
| Offset X || Float || This is added to the X position after being multiplied by random.nextGaussian()
+
| String (16)
|-
+
| An unique name for the objective
| Offset Y || Float || This is added to the Y position after being multiplied by random.nextGaussian()
+
|-
|-
+
| Mode
| Offset Z || Float || This is added to the Z position after being multiplied by random.nextGaussian()
+
| Byte
|-
+
| 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.  
| Particle data || Float || The data of each particle
+
|-
|-
+
| Objective Value
| Number of particles || Int || The number of particles to create
+
| 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 ====
  
==== Change Game State ====
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x4A
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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
 +
|}
  
It appears when a bed can't be used as a spawn point and when the rain state changes.
+
==== Teams ====
  
The class has an array of strings linked to reason codes 0, 1, 2, and 3 but only the codes for 1 and 2 are null.
+
Creates and updates teams.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x2B || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Reason || Unsigned Byte ||
+
!colspan="2"| Field Name
|-
+
! Field Type
| Value || Float || Depends on reason
+
! Notes
|}
+
|-
 +
|rowspan="23"| 0x4B
 +
|rowspan="23"| Play
 +
|rowspan="23"| Client
 +
|colspan="2"| Team Name
 +
| String (16)
 +
| A unique name for the team. (Shared with scoreboard).
 +
|-
 +
|colspan="2"| Mode
 +
| Byte
 +
| Determines the layout of the remaining packet
 +
|-
 +
|rowspan="9"| 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)
 +
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
 +
|-
 +
| Collision Rule
 +
| String Enum (32)
 +
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 +
|-
 +
| 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''
 +
|  
 +
|-
 +
|rowspan="7"| 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)
 +
| <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
 +
|-
 +
| Collision Rule
 +
| String Enum (32)
 +
| <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
 +
|-
 +
| 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
 +
|-
 +
|rowspan="2"| 3: add players to team
 +
| Entity Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Entities
 +
| Array of String (40)
 +
| Identifiers for the entities added.  For players, this is their username; for other entities, it is their UUID.
 +
|-
 +
|rowspan="2"| 4: remove players from team
 +
| Entity Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Entities
 +
| Array of String (40)
 +
| Identifiers for the entities removed.  For players, this is their username; for other entities, it is their UUID.
 +
|}
  
'''Reason codes'''
+
Team Color: The color of a team defines how the names of the team members are visualized; any formatting code can be used. The following table lists all the possible values.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Code !! Effect !! Notes
+
! ID
|-
+
! Formatting
| 0 || Invalid Bed || "tile.bed.notValid"
+
|-
|-
+
| 0-15
| 1 || End raining ||  
+
| Color formatting, same values as [[Chat]] colors.
|-
+
|-
| 2 || Begin raining ||  
+
| 16
|-
+
| Obfuscated
| 3 || Change game mode || "gameMode.changed" 0 - Survival, 1 - Creative, 2 - Adventure
+
|-
|-
+
| 17
| 4 || Enter credits ||
+
| Bold
|-
+
|-
| 5 || Demo messages || 0 - Show welcome to demo screen, 101 - Tell movement controls, 102 - Tell jump control, 103 - Tell inventory control
+
| 18
|-
+
| Strikethrough
| 6 || Arrow hitting player || Appears to be played when an arrow strikes another player in Multiplayer
+
|-
|-
+
| 19
| 7 || Fade value || The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
+
| Underlined
|-
+
|-
| 8 || Fade time || Time in ticks for the sky to fade
+
| 20
|}
+
| Italic
 +
|-
 +
| 21
 +
| Reset
 +
|}
 +
 
 +
==== Update Score ====
  
==== Spawn Global Entity ====
+
This is sent to the client when it should update a scoreboard item.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x4C
 +
|rowspan="4"| Play
 +
|rowspan="4"| 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.
 +
|}
 +
 
 +
==== Spawn Position ====
  
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.
+
Sent by the server after login to specify the coordinates of the spawn point (the point at which players spawn at, and which the compass points to). It can be sent at any time to update the point compasses point at.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="5" | 0x2C || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Entity ID || VarInt || The entity ID of the thunderbolt
+
! Field Name
|-
+
! Field Type
| Type || Byte || The global entity type, currently always 1 for thunderbolt.
+
! Notes
|-
+
|-
| X || Int || Thunderbolt X a [[Data_Types#Fixed-point_numbers|fixed-point number]]
+
|rowspan="1"| 0x4D
|-
+
|rowspan="1"| Play
| Y || Int || Thunderbolt Y a [[Data_Types#Fixed-point_numbers|fixed-point number]]
+
|rowspan="1"| Client
|-
+
| Location
| Z || Int || Thunderbolt Z a [[Data_Types#Fixed-point_numbers|fixed-point number]]
+
| Position
|}
+
| Spawn location
 +
|}
  
==== Open Window ====
+
==== 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 <code>20</code> every second.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x4E
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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
 +
|}
  
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.
+
==== Title ====
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x2D || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Window id || Unsigned Byte || A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
+
!colspan="2"| Field Name
|-
+
! Field Type
| Inventory Type || Unsigned Byte || The window type to use for display. Check below
+
! Notes
|-
+
|-
| Window title || String || The title of the window.
+
|rowspan="10"| 0x4F
|-
+
|rowspan="10"| Play
| Number of Slots || Unsigned Byte || Number of slots in the window (excluding the number of slots in the player inventory).
+
|rowspan="10"| Client
|-
+
|colspan="2"| Action
| Use provided window title || Bool || If false, the client will look up a string like "window.minecart". If true, the client uses what the server provides.
+
| VarInt Enum
|-
+
|  
| Entity ID || Int || EntityHorse's entityId. Only sent when window type is equal to 11 (AnimalChest).
+
|-
|}
+
! Action
 +
! Field Name
 +
!
 +
  !
 +
|-
 +
| 0: set title
 +
| Title Text
 +
| [[Chat]]
 +
|
 +
|-
 +
| 1: set subtitle
 +
| Subtitle Text
 +
| [[Chat]]
 +
  |
 +
|-  
 +
| 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
 +
| 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
 +
|-
 +
| 4: hide
 +
| ''no fields''
 +
| ''no fields''
 +
|  
 +
|-
 +
| 5: reset
 +
| ''no fields''
 +
| ''no fields''
 +
|
 +
|}
  
See [[Inventory#Windows|inventory windows]] for further information.
+
“Hide” makes the title disappear, but if you run times again the same title will appear. “Reset” erases the text.
  
==== Close Window ====
+
The title is visible on screen for Fade In + Stay + Fade Out ticks.
  
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.
+
==== Entity Sound Effect ====
 +
 
 +
Plays a sound effect from an entity.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x50
 +
|rowspan="5"| Play
 +
|rowspan="5"| Client
 +
| Sound ID
 +
| VarInt
 +
| ID of hardcoded sound event ([https://pokechu22.github.io/Burger/1.14.4.html#sounds events] as of 1.14.4)
 +
|-
 +
| Sound Category
 +
| VarInt Enum
 +
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 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|Named Sound Effect]].
  
Note, notchian clients send a close window message with window id 0 to close their inventory even though there is never an Open Window message for inventory.
+
{{Warning|Numeric sound effect IDs are liable to change between versions}}
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x2E || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Window ID || Unsigned Byte || This is the id of the window that was closed. 0 for inventory.
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x51
 +
|rowspan="7"| Play
 +
|rowspan="7"| Client
 +
| Sound ID
 +
| VarInt
 +
| ID of hardcoded sound event ([https://pokechu22.github.io/Burger/1.14.4.html#sounds events] as of 1.14.4)
 +
|-
 +
| Sound Category
 +
| VarInt Enum
 +
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
 +
|-
 +
| Effect Position X
 +
| Int
 +
| Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Effect Position Y
 +
| Int
 +
| Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Effect Position Z
 +
| Int
 +
| Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 +
|-
 +
| Volume
 +
| Float
 +
| 1.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
 +
|}
  
==== Set Slot ====
+
==== Stop Sound ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x52
 +
|rowspan="3"| Play
 +
|rowspan="3"| 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|Named Sound Effect]].  If not present, then all sounds are cleared.
 +
|}
  
Sent by the server when an item in a slot (in a window) is added/removed.
+
Categories:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Name !! Value
|-
+
|-
| rowspan="3" | 0x2F || rowspan=3 | Play || rowspan=3 | Client
+
| master || 0
| 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).
+
| music || 1
|-
+
|-
| Slot || Short || The slot that should be updated
+
| record || 2
|-
+
|-
| Slot data || [[Slot_Data|Slot]] ||
+
| 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.
  
==== Window Items ====
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x53
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Header
 +
| [[Chat]]
 +
| To remove the header, send a empty translatable component: {"translate":""}
 +
|-
 +
| Footer
 +
| [[Chat]]
 +
| To remove the footer, send a empty translatable component: {"translate":""}
 +
|}
  
[[File:Inventory-slots.png|thumb|The inventory slots]]
+
==== NBT Query Response ====
  
Sent by the server when an item in a slot (in a window) is added/removed. This includes the main inventory, equipped armour and crafting slots.  
+
Sent in response to [[#Query Block NBT|Query Block NBT]] or [[#Query Entity NBT|Query Entity NBT]].
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x30 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Window ID || Unsigned Byte || The id of window which items are being sent for. 0 for player inventory.
+
! Field Name
|-
+
! Field Type
| Count || Short || The number of slots (see below)
+
! Notes
|-
+
|-
| Slot data || Array of [[Slot_Data|Slot]]s ||
+
|rowspan="2"| 0x54
|}
+
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Transaction ID
 +
| VarInt
 +
| Can be compared to the one sent in the original query packet.
 +
|-
 +
| NBT
 +
| [[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 ====
  
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
+
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.
  
==== Window Property ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x31 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Window ID || Unsigned Byte || The id of the window.
+
! Field Name
|-
+
! Field Type
| Property || Short || Which property should be updated.
+
! Notes
|-
+
|-
| Value || Short || The new value for the property.
+
|rowspan="3"| 0x55
|}
+
|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.
 +
|}
  
'''Furnace'''
+
==== Entity Teleport ====
  
Properties:
+
This packet is sent by the server when an entity moves more than 8 blocks.
  
* 0: Progress arrow
+
{| class="wikitable"
* 1: Fire icon (fuel)
+
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x56
 +
|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
 +
|
 +
|}
  
Values:
+
==== Advancements ====
  
* 0-200 for progress arrow
+
{| class="wikitable"
* 0-200 for fuel indicator
+
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="9"| 0x57
 +
|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
 +
|}
  
Ranges are presumably in in-game ticks
+
Advancement structure:
  
'''Enchantment Table'''
+
{| 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
 +
|}
  
Properties: 0, 1 or 2 depending on the "enchantment slot" being given.
+
Advancement display:
  
Values: The enchantment's level.
+
{| 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
 +
|
 +
|}
  
'''Beacon'''
+
Advancement progress:
  
* 0: Power level
+
{| class="wikitable"
* 1: Potion effect one
+
!colspan="2"| Field Name
* 2: Potion effect two
+
!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>]
 +
|}
  
'''Anvil'''
+
==== Entity Properties ====
  
* 0: Maximum cost
+
Sets {{Minecraft Wiki|Attribute|attributes}} on the given entity.
  
'''Brewing Stand'''
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="6"| 0x58
 +
|rowspan="6"| Play
 +
|rowspan="6"| Client
 +
|colspan="2"| Entity ID
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
|colspan="2"| Number Of Properties
 +
|colspan="2"| Int
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="4"| Property
 +
| Key
 +
|rowspan="4"| Array
 +
| String (64)
 +
| 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.
 +
|}
  
* 0: Brew time
+
Known Key values (see also {{Minecraft Wiki|Attribute#Modifiers}}):
  
==== Confirm Transaction ====
+
{| class="wikitable"
 +
|-
 +
! Key
 +
! Default
 +
! Min
 +
! Max
 +
! Label
 +
|-
 +
| generic.maxHealth
 +
| 20.0
 +
| 0.0
 +
| 1024.0
 +
| Max Health
 +
|-
 +
| generic.followRange
 +
| 32.0
 +
| 0.0
 +
| 2048.0
 +
| Follow Range
 +
|-
 +
| generic.knockbackResistance
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Knockback Resistance
 +
|-
 +
| generic.movementSpeed
 +
| 0.699999988079071
 +
| 0.0
 +
| 1024.0
 +
| Movement Speed
 +
|-
 +
| generic.attackDamage
 +
| 2.0
 +
| 0.0
 +
| 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
 +
|-
 +
| 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)
 +
|}
  
A packet from the server indicating whether a request from the client was accepted, or whether there was a conflict (due to lag). This packet is also sent from the client to the server in response to a server transaction rejection packet.
+
''Modifier Data'' structure:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
|-
|-
+
! Field Name
| rowspan="3" | 0x32 || rowspan=3 | Play || rowspan=3 | Client
+
! Field Type
| Window ID || Unsigned Byte || The id of the window that the action occurred in.
+
! Notes
|-
+
|-
| Action number || Short || Every action that is to be accepted has a unique number. This field corresponds to that number.
+
| UUID
|-
+
| UUID
| Accepted || Bool || Whether the action was accepted.
+
|  
|}
+
|-
 +
| Amount
 +
| Double
 +
| May be positive or negative
 +
|-
 +
| Operation
 +
| Byte
 +
| See below
 +
|}
 +
 
 +
The operation controls how the base value of the modifier is changed.
  
==== Update Sign ====
+
* 0: Add/subtract amount
 +
* 1: Add/subtract amount percent of the current value
 +
* 2: Multiply by amount percent
  
This message is sent from the server to the client whenever a sign is discovered or created. This message is NOT sent when a sign is destroyed or unloaded.
+
All of the 0's are applied first, and then the 1's, and then the 2's.
 +
 
 +
==== Entity Effect ====
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="7" | 0x33 || rowspan=7 | Play || rowspan=7 | Client
+
! Bound To
| X || Int || Block X Coordinate
+
! Field Name
|-
+
! Field Type
| Y || Short || Block Y Coordinate
+
! Notes
|-
+
|-
| Z || Int || Block Z Coordinate
+
|rowspan="5"| 0x59
|-
+
|rowspan="5"| Play
| Line 1 || String || First line of text in the sign
+
|rowspan="5"| Client
|-
+
| Entity ID
| Line 2 || String || Second line of text in the sign
+
| VarInt
|-
+
|  
| Line 3 || String || Third line of text in the sign
+
|-
|-
+
| Effect ID
| Line 4 || String || Fourth line of text in the sign
+
| Byte
|}
+
| See {{Minecraft Wiki|Status effect#List of effects|this table}}
 +
|-
 +
| Amplifier
 +
| Byte
 +
| Notchian client displays effect level as Amplifier + 1
 +
|-
 +
| Duration
 +
| VarInt
 +
| Seconds
 +
|-
 +
| Flags
 +
| Byte
 +
| Bit field, see below.
 +
|}
  
==== Maps ====
+
Within flags:
  
If the first byte of the array is 0, the next two bytes are X start and Y start and the rest of the bytes are the colors in that column.
+
* 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.
 +
* 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.
  
If the first byte of the array is 1, the rest of the bytes are in groups of three: (data, x, y). The lower half of the data is the type (always 0 under vanilla) and the upper half is the direction.
+
==== Declare Recipes ====
  
If the first byte of the array is 2, the second byte is the map scale.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x5A
 +
|rowspan="4"| Play
 +
|rowspan="4"| Client
 +
|colspan="2"| Num Recipes
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="3"| Recipe
 +
| Recipe ID
 +
|rowspan="3"| Array
 +
| Identifier
 +
|
 +
|-
 +
| Type
 +
| String
 +
| The recipe type, see below
 +
|-
 +
| Data
 +
| Optional, varies
 +
| Additional data for the recipe.  For some types, there will be no data.
 +
|}
 +
 
 +
Recipe types:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Type
|-
+
! Description
| rowspan="3" | 0x34 || rowspan=3 | Play || rowspan=3 | Client
+
! Data
| Item Damage || VarInt || The damage value of the map being modified
+
|-
|-
+
| <code>crafting_shapeless</code>
| Length || Short || Length of following byte array
+
| Shapeless crafting recipe.  All items in the ingredient list must be present, but in any order/slot.
|-
+
| As follows:
| Data || Byte Array || Array data
+
  {| 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 width * height.  Indexed by x + (y * width).
 +
    |-
 +
    | Result
 +
    | [[Slot]]
 +
    |
 +
    |}
 +
|-
 +
| <code>crafting_special_armordye</code>
 +
| Recipe for dying leather armor
 +
| None
 +
|-
 +
| <code>crafting_special_bookcloning</code>
 +
| Recipe for copying contents of written books
 +
| None
 +
|-
 +
| <code>crafting_special_mapcloning</code>
 +
| Recipe for copying maps
 +
| None
 +
|-
 +
| <code>crafting_special_mapextending</code>
 +
| Recipe for adding paper to maps
 +
| None
 +
|-
 +
| <code>crafting_special_firework_rocket</code>
 +
| Recipe for making firework rockets
 +
| None
 +
|-
 +
| <code>crafting_special_firework_star</code>
 +
| Recipe for making firework stars
 +
| None
 +
|-
 +
| <code>crafting_special_firework_star_fade</code>
 +
| Recipe for making firework stars fade between multiple colors
 +
| None
 +
|-
 +
| <code>crafting_special_repairitem</code>
 +
| Recipe for repairing items via crafting
 +
| None
 +
|-
 +
| <code>crafting_special_tippedarrow</code>
 +
| Recipe for crafting tipped arrows
 +
| None
 +
|-
 +
| <code>crafting_special_bannerduplicate</code>
 +
| Recipe for copying banner patterns
 +
| None
 +
|-
 +
| <code>crafting_special_banneraddpattern</code>
 +
| Recipe for adding patterns to banners
 +
| None
 +
|-
 +
| <code>crafting_special_shielddecoration</code>
 +
| Recipe for applying a banner's pattern to a shield
 +
| None
 +
|-
 +
| <code>crafting_special_shulkerboxcoloring</code>
 +
| Recipe for recoloring a shulker box
 +
| None
 +
|-
 +
| <code>smelting</code>
 +
| Smelting recipe
 +
| 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
 +
    |
 +
    |}
 +
|}
  
==== Update Block Entity ====
+
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
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x5B
 +
|rowspan="4"| Play
 +
|rowspan="4"| Client
 +
| Block Tags
 +
| (See below)
 +
| IDs are block IDs
 +
|-
 +
| Item Tags
 +
| (See below)
 +
| IDs are item IDs
 +
|-
 +
| Fluid Tags
 +
| (See below)
 +
| IDs are fluid IDs
 +
|-
 +
| Entity Tags
 +
| (See below)
 +
| IDs are entity IDs
 +
|}
  
Essentially a block update on a block entity.
+
Tags look like:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| rowspan="6" | 0x35 || rowspan=6 | Play || rowspan=6 | Client
+
! Notes
| X || Int ||
+
|-
|-
+
|colspan="2"| Length
| Y || Short ||
+
|colspan="2"| VarInt
|-
+
| Number of elements in the following array
| Z || Int ||
+
|-
|-
+
|rowspan="3"| Tags
| Action || Unsigned Byte || The type of update to perform
+
| Tag name
|-
+
|rowspan="3"| Array
| Data length || Short || Varies
+
| Identifier
|-
+
|
| NBT Data || Byte Array || Present if data length > 0. Compressed with [[wikipedia:Gzip|gzip]]. Varies, but based on the NBT chunk storage format as can be found in the Minecraft Wiki (http://www.minecraftwiki.net/Chunk_Format)
+
|-
|}
+
| Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Entries
 +
| Array of VarInt
 +
| Numeric ID of the block/item.
 +
|}
 +
 
 +
==== Acknowledge Player Digging ====
  
'''Actions'''
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="4"| 0x5C
 +
|rowspan="4"| Play
 +
|rowspan="4"| 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.  (How does this work?)
 +
|}
  
* '''1''': Set mob displayed inside a mob spawner
+
=== Serverbound ===
* '''2''': Set command block text (command and last execution status)
 
* '''3''': Set rotation and skin of mob head
 
* '''4''': Set type of flower in flower pot
 
  
==== Sign Editor Open ====
+
==== Teleport Confirm ====
  
Sent on placement of sign.
+
Sent by client as confirmation of [[#Player Position And Look (clientbound)|Player Position And Look]].
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x36 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| X || Int || X in block coordinates
+
! Field Name
|-
+
! Field Type
| Y || Int || Y in block coordinates
+
! Notes
|-
+
|-
| Z || Int || Z in block coordinates
+
| 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.
  
==== Statistics ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To  
+
! Packet ID
! colspan="2" | Field Name
+
! State
! Field Type !! Notes
+
! Bound To
|-
+
! Field Name
| rowspan="3" | 0x37 || rowspan=3 | Play || rowspan=3 | Client
+
! Field Type
| colspan="2" | Count || VarInt || Number of entries
+
! Notes
|-
+
|-
| rowspan=2 | Entry
+
|rowspan="2"| 0x01
| Statistic's name || String || https://gist.github.com/thinkofdeath/a1842c21a0cf2e1fb5e0
+
|rowspan="2"| Play
|-
+
|rowspan="2"| Server
| Value || VarInt || The amount to set it to
+
| 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.
 +
|}
  
==== Player List Item ====
+
==== Set Difficulty ====
  
Sent by the notchian server to update the user list (<tab> in the client).
+
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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x38 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Player name || String || Supports chat colouring, limited to 16 characters.
+
! Field Name
|-
+
! Field Type
| Online || Bool || The client will remove the user from the list if false.
+
! Notes
|-
+
|-
| Ping || Short || Ping, presumably in ms.
+
|rowspan="1"| 0x02
|}
+
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| New difficulty
 +
| Byte
 +
| 0: peaceful, 1: easy, 2: normal, 3: hard
 +
|}
  
==== Player Abilities ====
+
==== Chat Message (serverbound) ====
  
The latter 2 floats are used to indicate the walking and flying speeds respectively, while the first byte is used to determine the value of 4 booleans.
+
Used to send a chat message to the server.  The message may not be longer than 256 characters or else the server will kick the client.
+
 
The flags are whether damage is disabled (god mode, 8, bit 3), whether the player can fly (4, bit 2), whether the player is flying (2, bit 1), and whether the player is in creative mode (1, bit 0).
+
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.
 
To get the values of these booleans, simply AND (&) the byte with 1,2,4 and 8 respectively, to get the 0 or 1 bitwise value. To set them OR (|) them with their repspective masks.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x39 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Flags || Byte ||
+
! Field Name
|-
+
! Field Type
| Flying speed || Float|| previous integer value divided by 250
+
! Notes
|-
+
|-
| Walking speed || Float || previous integer value divided by 250
+
|rowspan="1"| 0x03
|}
+
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Message
 +
| String (256)
 +
| The client sends the raw input, not a [[Chat]] component
 +
|}
  
==== Tab-Complete ====
+
==== Client Status ====
  
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.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x04
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Action ID
 +
| VarInt Enum
 +
| See below
 +
|}
 +
 
 +
''Action ID'' values:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
|-
|-
+
! Action ID
| rowspan=2| 0x3A || rowspan=2 | Play || rowspan=2 | Client
+
! Action
| Count || VarInt || Number of following strings
+
! Notes
|-
+
|-
| Match || String || One eligible command, note that each command is sent separately instead of in a single string, hence the need for Count
+
| 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
 +
|}
  
==== Scoreboard Objective ====
+
==== Client Settings ====
  
This is sent to the client when it should create a new scoreboard or remove one.
+
Sent when the player connects, or when settings are changed.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x3B || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Objective name || String || An unique name for the objective
+
! Field Name
|-
+
! Field Type
| Objective value || String || The text to be displayed for the score.
+
! Notes
|-
+
|-
| Create/Remove || Byte || 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
+
|rowspan="6"| 0x05
|}
+
|rowspan="6"| Play
 +
|rowspan="6"| Server
 +
| Locale
 +
| String (16)
 +
| e.g. en_GB
 +
|-
 +
| View Distance
 +
| Byte
 +
| Client-side render distance, in chunks
 +
|-
 +
| Chat Mode
 +
| VarInt Enum
 +
| 0: enabled, 1: commands only, 2: hidden.  See [[Chat#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:
 +
 
 +
* 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
  
==== Update Score ====
+
The most significant bit (bit 7, 0x80) appears to be unused.
 +
 
 +
==== Tab-Complete (serverbound) ====
  
This is sent to the client when it should update a scoreboard item.  
+
Sent when the client needs to tab-complete a <code>minecraft:ask_server</code> suggestion type.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="4" | 0x3C || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Item Name || String || An unique name to be displayed in the list.
+
! Field Name
|-
+
! Field Type
| Update/Remove || Byte || 0 to create/update an item. 1 to remove an item.
+
! Notes
|-
+
|-
| Score Name || String || The unique name for the scoreboard to be updated. Only sent when Update/Remove does not equal 1.
+
|rowspan="5"| 0x06
|-
+
|rowspan="5"| Play
| Value || Int || The score to be displayed next to the entry. Only sent when Update/Remove does not equal 1.
+
|rowspan="5"| Server
|}
+
| Transaction Id
{{Warning|The final String and Int are only sent if the Update/Remove Byte does not equal 1}}
+
| VarInt
 +
| The id received in the tab completion request packet, must match or the client will ignore this packet.  Client generates this and increments it each time it sends another tab completion that doesn't get a response.
 +
|-
 +
| Text
 +
| 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)
 +
|}
  
==== Display Scoreboard ====
+
==== Confirm Transaction (serverbound) ====
  
This is sent to the client when it should display a scoreboard.
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x3D || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Position || Byte || The position of the scoreboard. 0 = list, 1 = sidebar, 2 = belowName.
+
! Field Name
|-
+
! Field Type
| Score Name || String || The unique name for the scoreboard to be displayed.
+
! Notes
|}
+
|-
 +
|rowspan="3"| 0x07
 +
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Window ID
 +
| Byte
 +
| The ID of the window that the action occurred in
 +
|-
 +
| Action Number
 +
| Short
 +
| Every action that is to be accepted has a unique number. This number is an incrementing integer (starting at 1) with separate counts for each window ID.
 +
|-
 +
| Accepted
 +
| Boolean
 +
| Whether the action was accepted
 +
|}
 +
 
 +
==== Click Window Button ====
  
==== Teams ====
+
Used when clicking on window buttons.  Until 1.14, this was only used by enchantment tables.
  
Creates and updates teams.
+
{| 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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Window type
|-
+
! ID
| rowspan="8" | 0x3E || rowspan=8 | Play || rowspan=8 | Client
+
! Meaning
| Team Name || String || A unique name for the team. (Shared with scoreboard).
+
|-
|-
+
|rowspan="3"| Enchantment Table
| Mode || Byte || If 0 then the team is created.  
+
| 0 || Topmost enchantment
If 1 then the team is removed.  
+
|-
 +
| 1 || Middle enchantment
 +
|-
 +
| 2 || Bottom enchantment
 +
|-
 +
|rowspan="4"| Lectern
 +
| 1 || Unknown - maybe previous page?  (which does give a redstone output)
 +
|-
 +
| 2 || Unknown - maybe next page?
 +
|-
 +
| 3 || Take Book
 +
|-
 +
| 100? || Unknown - actual value is 100 + some parameter, so there may be multiple
 +
|-
 +
| 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.
 +
|}
  
If 2 the team team information is updated.
 
  
If 3 then new players are added to the team.
+
==== Click Window ====
  
If 4 then players are removed from the team.
+
This packet is sent by the player when it clicks on a slot in a window.
|-
 
| Team Display Name || String || Only if Mode = 0 or 2.
 
|-
 
| Team Prefix || String || Only if Mode = 0 or 2. Displayed before the players' name that are part of this team.
 
|-
 
| Team Suffix || String || Only if Mode = 0 or 2. Displayed after the players' name that are part of this team.
 
|-
 
| Friendly fire || Byte || Only if Mode = 0 or 2; 0 for off, 1 for on, 3 for seeing friendly invisibles
 
|-
 
| Player count || Short || Only if Mode = 0 or 3 or 4. Number of players in the array
 
|-
 
| Players || Array of strings || Only if Mode = 0 or 3 or 4. Players to be added/remove from the team.
 
|}
 
  
==== Plugin Message ====
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="6"| 0x09
 +
|rowspan="6"| Play
 +
|rowspan="6"| 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
 +
|-
 +
| Action Number
 +
| Short
 +
| 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)]].
 +
|-
 +
| Mode
 +
| VarInt Enum
 +
| Inventory operation mode, see below
 +
|-
 +
| Clicked item
 +
| [[Slot Data|Slot]]
 +
| The clicked slot. Has to be empty (item ID = -1) for drop mode.
 +
|}
  
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>.
+
See [[Inventory]] for further information about how slots are indexed.
  
More documentation on this: http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/
+
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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Mode
|-
+
! Button
| rowspan="3" | 0x3F || rowspan=3 | Play || rowspan=3 | Client
+
! Slot
| Channel || String || Name of the "channel" used to send the data.
+
! Trigger
|-
+
|-
| Length || Short || Length of the following byte array
+
!rowspan="2"| 0
|-
+
| 0
| Data || Byte Array || Any data.
+
| Normal
|}
+
| Left mouse click
 +
|-
 +
| 1
 +
| Normal
 +
| Right mouse click
 +
|-
 +
!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
 +
|-
 +
!rowspan="1"| 3
 +
| 2
 +
| Normal
 +
| Middle click, only defined for creative players in non-player inventories.
 +
|-
 +
!rowspan="4"| 4
 +
| 0
 +
| Normal*
 +
| Drop key (Q) (* Clicked item is different, see above)
 +
|-
 +
| 1
 +
| Normal*
 +
| Ctrl + Drop key (Ctrl-Q) ''(drops full stack)''
 +
|-
 +
| 0
 +
| -999
 +
| Left click outside inventory holding nothing ''(no-op)''
 +
|-
 +
| 1
 +
| -999
 +
| Right click outside inventory holding nothing ''(no-op)''
 +
|-
 +
!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
 +
|}
  
==== Disconnect ====
+
Starting from version 1.5, “painting mode” is available for use in inventory windows. It is done by picking up stack of something (more than 1 item), then holding mouse button (left, right or middle) and dragging held stack over empty (or same type in case of right button) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):
  
Sent by the server before it disconnects a client. The server assumes that the sender has already closed the connection by the time the packet arrives.
+
# 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.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x40 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Reason || String || Displayed to the client when the connection terminates. Must be valid JSON.
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
| 0x0A
 +
| 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.
  
=== Serverbound ===
+
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/]
  
==== Keep Alive ====
+
Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.
  
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
 +
|-
 +
|rowspan="2"| 0x0B
 +
|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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Keep Alive ID || Int ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x0C
 +
|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
 +
|}
  
==== Chat Message ====
+
When editing a draft, the [[NBT]] section of the Slot contains this:
  
The default server will check the message to see if it begins with a '/'. If it doesn't, the username of the sender is prepended and sent to all other clients (including the original sender). If it does, the server assumes it to be a command and attempts to process it. A message longer than 100 characters will cause the server to kick the client. This change was initially done by allowing the client to not slice the message up to 119 (the previous limit), without changes to the server. For this reason, the vanilla server kept the code to cut messages at 119, but this isn't a protocol limitation and can be ignored.
+
<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>
  
For more information, see [[Chat]].
+
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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x01 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Message || String ||  
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x0D
 +
|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.
 +
|}
  
 
==== Use Entity ====
 
==== Use Entity ====
Line 1,619: Line 5,972:
 
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.
 
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 packet instead.
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x02 || rowspan=2 | Play || rowspan=2 | Server
+
! Bound To
| Target || Int ||
+
! Field Name
|-
+
! Field Type
| Mouse || Byte || 0 = Right-click, 1 = Left-click
+
! Notes
|}
+
|-
 +
|rowspan="6"| 0x0E
 +
|rowspan="6"| Play
 +
|rowspan="6"| Server
 +
| Target
 +
| VarInt
 +
|
 +
|-
 +
| 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
 +
|}
  
==== Player ====
+
==== 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
 +
|
 +
|}
  
This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).
+
==== Lock Difficulty ====
  
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.
+
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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x03 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| On Ground || Bool || True if the client is on the ground, False otherwise
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x10
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Locked
 +
| Boolean
 +
|
 +
|}
  
 
==== Player Position ====
 
==== Player Position ====
  
Updates the players XYZ position on the server.  
+
Updates the player's XYZ position on the server.
If <code>HeadY - FeetY</code> is less than <code>0.1</code> or greater than <code>1.65</code>, the stance is illegal and the client will be kicked with the message “Illegal Stance”.
+
 
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 units will result in the client being kicked for "You moved too quickly :( (Hacking?)"
+
Checking for moving too fast is achieved like this:
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"
+
 
 +
* 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 Look (serverbound) ====
 +
 
 +
A combination of [[#Player Look|Player Look]] and [[#Player Position|Player Position]].
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5| 0x04 || rowspan=5 | Play || rowspan=5 | Server
+
! Bound To
| X || Double || Absolute position
+
! Field Name
|-
+
! Field Type
| FeetY || Double || Absolute feet position, normally HeadY - 1.62. Used to modify the players bounding box when going up stairs, crouching, etc…
+
! Notes
|-
+
|-
| HeadY || Double || Absolute head position
+
|rowspan="6"| 0x12
|-
+
|rowspan="6"| Play
| Z || Double || Absolute position
+
|rowspan="6"| Server
|-
+
| X
| On Ground || Bool || True if the client is on the ground, False otherwise
+
| 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 Look ====
 
==== Player Look ====
 
 
[[File:Minecraft-trig-yaw.png|thumb|The unit circle for yaw]]
 
[[File:Minecraft-trig-yaw.png|thumb|The unit circle for yaw]]
 
 
[[File:Yaw.png|thumb|The unit circle of yaw, redrawn]]
 
[[File:Yaw.png|thumb|The unit circle of yaw, redrawn]]
  
Line 1,677: Line 6,144:
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
  
The yaw of player (in degrees), standing at point (x0,z0) and looking towards point (x,z) one can be calculated with:
+
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:
  l = x-x0
 
  w = z-z0
 
  c = sqrt( l*l + w*w )
 
  alpha1 = -arcsin(l/c)/PI*180
 
  alpha2 =  arccos(w/c)/PI*180
 
  if alpha2 > 90 then
 
    yaw = 180 - alpha1
 
  else
 
    yaw = alpha1
 
  
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
+
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:
 
You can get a unit vector from a given yaw/pitch via:
  x = -cos(pitch) * sin(yaw)
+
 
  y = -sin(pitch)
+
x = -cos(pitch) * sin(yaw)
  z =  cos(pitch) * cos(yaw)
+
y = -sin(pitch)
 +
z =  cos(pitch) * cos(yaw)
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3| 0x05 || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Yaw || Float || Absolute rotation on the X Axis, in degrees
+
! Field Name
|-
+
! Field Type
| Pitch || Float || Absolute rotation on the Y Axis, in degrees
+
! Notes
|-
+
|-
| On Ground || Bool || True if the client is on the ground, False otherwise
+
|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 ====
  
==== Player Position And Look ====
+
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.
  
A combination of Player Look and Player position.  
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=7| 0x06 || rowspan=7 | Play || rowspan=7 | Server
+
! Bound To
| X || Double || Absolute position
+
! Field Name
|-
+
! Field Type
| FeetY || Double || Absolute feet position. Is normally HeadY - 1.62. Used to modify the players bounding box when going up stairs, crouching, etc…
+
! Notes
|-
+
|-
| HeadY || Double || Absolute head position
+
|rowspan="1"| 0x14
|-
+
|rowspan="1"| Play
| Z || Double || Absolute position
+
|rowspan="1"| Server
|-
+
| On Ground
| Yaw || Float || Absolute rotation on the X Axis, in degrees
+
| Boolean
|-
+
| True if the client is on the ground, false otherwise
| Pitch || Float || Absolute rotation on the Y Axis, in degrees
+
|}
|-
 
| On Ground || Bool || True if the client is on the ground, False otherwise
 
|}
 
  
==== Player Digging ====
+
==== Vehicle Move (serverbound) ====
  
Sent when the player mines a block. A Notchian server only accepts digging packets with coordinates within a 6-unit radius of the player's position.
+
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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="5" | 0x07 || rowspan=5 | Play || rowspan=5 | Server
+
! Bound To
| Status || Byte || The action the player is taking against the block (see below)
+
! Field Name
|-
+
! Field Type
| X || Int || Block position
+
! Notes
|-
+
|-
| Y || Unsigned Byte || Block position
+
|rowspan="5"| 0x15
|-
+
|rowspan="5"| Play
| Z || Int || Block position
+
|rowspan="5"| Server
|-
+
| X
| Face || Byte || The face being hit (see below)
+
| 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 ====
  
Status can (currently) be one of six values:
+
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"
! Meaning !! Value
+
! Packet ID
|-
+
! State
| Started digging || <code>0</code>
+
! Bound To
|-
+
! Field Name
| Cancelled digging || <code>1</code>
+
! Field Type
|-
+
! Notes
| Finished digging || <code>2</code>
+
|-
|-
+
|rowspan="2"| 0x16
| Drop item stack || <code>3</code>
+
|rowspan="2"| Play
|-
+
|rowspan="2"| Server
| Drop item || <code>4</code>
+
| Left paddle turning
|-
+
| Boolean
| Shoot arrow / finish eating || <code>5</code>
+
|
|}
+
|-
 +
| Right paddle turning
 +
| Boolean
 +
|
 +
|}
  
Notchian clients send a 0 (started digging) when they start digging and a 2 (finished digging) once they think they are finished. If digging is aborted, the client simply send a 1 (Cancel digging).
+
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.
  
Status code 4 (drop item) is a special case.  In-game, when you use the Drop Item command (keypress 'q'), a dig packet with a status of 4, and all other values set to 0, is sent from client to server. Status code 3 is similar, but drops the entire stack.
+
==== Pick Item ====
  
Status code 5 (shoot arrow / finish eating) is also a special case. The x, y and z fields are all set to 0 like above, with the exception of the face field, which is set to 255.
+
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.
  
The face can be one of six values, representing the face being hit:
 
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
! Packet ID
| Value || 0 || 1 || 2 || 3 || 4 || 5
+
! State
|-
+
! Bound To
| Offset || -Y || +Y || -Z || +Z || -X || +X
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x17
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Slot to use
 +
| VarInt
 +
| See [[Inventory]]
 +
|}
 +
 
 +
The server will first search the player's hotbar for an empty slot, starting from the current slot and looping around to the slot before it.  If there are no empty slots, it will start a second search from the current slot and find the first slot that does not contain an enchanted item.  If there still are no slots that meet that criteria, then the server will use the currently selected slot.
 +
 
 +
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 ====
  
In 1.7.3, when a player opens a door with left click the server receives Packet 0xE+start digging and opens the door.
+
This packet is sent when a player clicks a recipe in the crafting book that is craftable (white border).
  
==== Player Block Placement ====
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
! Packet ID
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! State
|-
+
! Bound To
| rowspan="8" | 0x08 || rowspan=8 | Play || rowspan=8 | Server
+
! Field Name
| X || Int || Block position
+
! Field Type
|-
+
! Notes
| Y || Unsigned Byte || Block position
+
|-
|-
+
|rowspan="3"| 0x18
| Z || Int || Block position
+
|rowspan="3"| Play
|-
+
|rowspan="3"| Server
| Direction || Byte || The offset to use for block/item placement (see below)
+
| Window ID
|-
+
| Byte
| Held item || [[Slot_Data|Slot]] ||
+
|
|-
+
|-
| Cursor position X || Byte || The position of the crosshair on the block
+
| Recipe
|-
+
| Identifier
| Cursor position Y || Byte ||
+
| A recipe ID
|-
+
|-
| Cursor position Z || Byte ||
+
| Make all
|}
+
| Boolean
In normal operation (ie placing a block), this packet is sent once, with the values set normally.
+
| Affects the amount of items processed; true if shift is down when clicked
 +
|}
  
This packet has a special case where X, Y, Z, and Direction 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, shooting bows, using buckets, etc.
+
==== Player Abilities (serverbound) ====
  
In a Notchian Beta client, the block or item ID corresponds to whatever the client is currently holding, and the client sends one of these packets any time a right-click is issued on a surface, so no assumptions can be made about the safety of the ID.  However, with the implementation of server-side inventory, a Notchian server seems to ignore the item ID, instead operating on server-side inventory information and holding selection. The client has been observed (1.2.5 and 1.3.2) to send both real item IDs and -1 in a single session.
+
The latter 2 fields are used to indicate the walking and flying speeds respectively, while the first field is used to determine the value of 4 booleans.
  
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.
+
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.
  
==== Held Item Change ====
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x19
 +
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Flags
 +
| Byte
 +
| Bit mask. 0x08: damage disabled (god mode), 0x04: can fly, 0x02: is flying, 0x01: is Creative
 +
|-
 +
| Flying Speed
 +
| Float
 +
|
 +
|-
 +
| Walking Speed
 +
| Float
 +
|
 +
|}
  
Sent when the player changes the slot selection
+
==== 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"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x09 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Slot || Short || The slot which the player has selected (0-8)
+
! 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:
  
==== Animation ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Value
|-
+
! Meaning
| rowspan=2 | 0x0A || rowspan=2 | Play || rowspan=2 | Server
+
! Notes
| Entity ID || Int || Player ID
+
|-
|-
+
| 0
| Animation || Byte || Animation ID
+
| 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:
Animation can be one of the following values:
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Animation
+
|-
|-
+
! Value
| 0 || No animation
+
! Offset
|-
+
! Face
| 1 || Swing arm
+
|-
|-
+
| 0
| 2 || Damage animation
+
| -Y
|-
+
| Bottom
| 3 || Leave bed
+
|-
|-
+
| 1
| 5 || Eat food
+
| +Y
|-
+
| Top
| 6 || Critical effect
+
|-
|-
+
| 2
| 7 || Magic critical effect
+
| -Z
|-
+
| North
| 102 || (unknown)
+
|-
|-
+
| 3
| 104 || Crouch
+
| +Z
|-
+
| South
| 105 || Uncrouch
+
|-
|}
+
| 4
 +
| -X
 +
| West
 +
|-
 +
| 5
 +
| +X
 +
| East
 +
|}
  
 
==== Entity Action ====
 
==== Entity Action ====
  
Sent at least when crouching, leaving a bed, or sprinting.
+
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.
To send action animation to client use 0x28.
 
The client will send this with Action ID = 3 when "Leave Bed" is clicked.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x0B || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Entity ID || Int || Player ID
+
! Field Name
|-
+
! Field Type
| Action ID || Byte || The ID of the action, see below.
+
! Notes
|-
+
|-
| Jump Boost || Int || Horse jump boost. Ranged from 0 -> 100.
+
|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:
 
Action ID can be one of the following values:
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Action
+
! ID
|-
+
! Action
| 1 || Crouch
+
|-
|-
+
| 0
| 2 || Uncrouch
+
| Start sneaking
|-
+
|-
| 3 || Leave bed
+
| 1
|-
+
| Stop sneaking
| 4 || Start sprinting
+
|-
|-
+
| 2
| 5 || Stop sprinting
+
| Leave bed
|-
+
|-
| 6 || Horse jump
+
| 3
|-
+
| Start sprinting
| 5 || Horse interaction ?
+
|-
|}
+
| 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 ====
 
==== 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.
 +
 +
==== Recipe Book Data ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="4" | 0x0C || rowspan=4 | Play || rowspan=4 | Server
+
! Bound To
| Sideways || Float || Positive to the left of the player
+
!colspan="2"| Field Name
|-
+
! Field Type
| Forward || Float || Positive forward
+
! Notes
|-
+
|-
| Jump || Bool ||
+
|rowspan="11"| 0x1D
|-
+
|rowspan="11"| Play
| Unmount || Bool || True when leaving the vehicle
+
|rowspan="11"| Server
|}
+
|colspan="2"| Type
 +
| VarInt
 +
| Determines the format of the rest of the packet
 +
|-
 +
! Type
 +
! Field Name
 +
!
 +
!
 +
|-
 +
| 0: Displayed Recipe
 +
| Recipe ID
 +
| Identifier
 +
| A recipe ID
 +
|-
 +
|rowspan="4"| 1: Recipe Book States
 +
| Crafting Recipe Book Open
 +
| Boolean
 +
| Whether the player has the crafting recipe book currently opened/active.
 +
|-
 +
| Crafting Recipe Filter Active
 +
| Boolean
 +
| Whether the player has the crafting recipe book filter option currently active.
 +
|-
 +
| Smelting Recipe Book Open
 +
| Boolean
 +
| Whether the player has the smelting recipe book currently opened/active.
 +
|-
 +
| Smelting Recipe Filter Active
 +
| Boolean
 +
| Whether the player has the smelting recipe book filter option currently active.
 +
|-
 +
| Blasting Recipe Book Open
 +
| Boolean
 +
| May be swapped with smoking recipe book.  Also, the notchian client appears to use the same value for both of those books currently.
 +
|-
 +
| Blasting Recipe Filter Active
 +
| Boolean
 +
| May be swapped with smoking recipe book.  Also, the notchian client appears to use the same value for both of those books currently.
 +
|-
 +
| Smoking Recipe Book Open
 +
| Boolean
 +
|
 +
|-
 +
| Smoking Recipe Filter Active
 +
| Boolean
 +
|
 +
|}
 +
 
 +
The Recipe Book Status type is sent when one of the states changes.
 +
 
 +
==== Name Item ====
  
==== Close Window ====
+
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.
  
This packet is sent by the client when closing a window.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x1E
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Item name
 +
| String (32767)
 +
| The new name of the item
 +
|}
  
Note, notchian clients send a close window message with window id 0 to close their inventory even though there is never an Open Window message for inventory.
+
==== Resource Pack Status ====
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x0D || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Window id || byte || This is the id of the window that was closed. 0 for inventory.
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x1F
 +
|rowspan="1"| Play
 +
|rowspan="1"| 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"| 0x20
 +
|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
 +
|}
  
==== Click Window ====
+
==== Select Trade ====
  
This packet is sent by the player when it clicks on a slot in a window.
+
When a player selects a specific trade offered by a villager NPC.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x0E || rowspan=6 | Play || rowspan=6 | Server
+
! Bound To
| Window ID || Byte || The id of the window which was clicked. 0 for player inventory.
+
! Field Name
|-
+
! Field Type
| Slot || Short || The clicked slot. See below.
+
! Notes
|-
+
|-
| Button || Byte || The button used in the click. See below.
+
|rowspan="1"| 0x21
|-
+
|rowspan="1"| Play
| Action number || Short || A unique number for the action, used for transaction handling (See the Transaction packet).
+
|rowspan="1"| Server
|-
+
| Selected slot
| Mode || Byte || Inventory operation mode. See below.
+
| VarInt
|-
+
| The selected slot int the players current (trading) inventory. (Was a full Integer for the plugin message)
| Clicked item || [[Slot_Data|Slot]] ||
+
|}
|}
 
  
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
+
==== Set Beacon Effect ====
 +
 
 +
Changes the effect of the current beacon.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x22
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Primary Effect
 +
| VarInt
 +
| A [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]. (Was a full Integer for the plugin message)
 +
|-
 +
| Secondary Effect
 +
| VarInt
 +
| A [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]. (Was a full Integer for the plugin message)
 +
|}
  
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.
+
==== Held Item Change (serverbound) ====
  
The Action number is actually a counter, starting at 1.  This number is used by the server as a transaction ID to send back a [[#0x6A|Transaction packet]].
+
Sent when the player changes the slot selection
  
The distinct type of click performed by the client is determined by the combination of the "Mode" and "Button" fields.
 
 
{| class="wikitable"
 
{| class="wikitable"
! Mode !! Button !! Slot !! Trigger
+
! Packet ID
|-
+
! State
! rowspan="2" | 0
+
! Bound To
| 0 || Normal || Left mouse click
+
! Field Name
|-
+
! Field Type
| 1 || Normal || Right mouse click
+
! Notes
|-
+
|-
! rowspan="2" | 1
+
|rowspan="1"| 0x23
| 0 || Normal || Shift + left mouse click
+
|rowspan="1"| Play
|-
+
|rowspan="1"| Server
| 1 || Normal || Shift + right mouse click ''(Identical behavior)''
+
| Slot
|-
+
| Short
! rowspan="5" | 2
+
| The slot which the player has selected (0–8)
| 0 || Normal || Number key 1
+
|}
|-
 
| 1 || Normal || Number key 2
 
|-
 
| 2 || Normal || Number key 3
 
|-
 
| ...
 
| ...
 
| ...
 
|-
 
| 8 || Normal || Number key 9
 
|-
 
! rowspan="1" | 3
 
| 2 || Normal || Middle click
 
|-
 
! rowspan="4" | 4
 
| 0 || Normal || Drop key (Q)
 
|-
 
| 1 || Normal || Ctrl + Drop key (Ctrl-Q)
 
|-
 
| 0 || -999 || Left click outside inventory holding nothing ''(No-op)''
 
|-
 
| 1 || -999 || Right click outside inventory holding nothing ''(No-op)''
 
|-
 
! rowspan="6" | 5
 
| 0 || -999 || Starting left mouse drag ''(Or middle mouse)''
 
|-
 
| 4 || -999 || Starting right mouse drag
 
|-
 
| 1 || Normal || Add slot for left-mouse drag
 
|-
 
| 5 || Normal || Add slot for right-mouse drag
 
|-
 
| 2 || -999 || Ending left mouse drag
 
|-
 
| 6 || -999 || Ending right mouse drag
 
|-
 
! 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 items), then holding mouse button (left, right or middle) and dragging holded 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):
+
==== Update Command Block ====
  
# packet with mode 5, slot -999 , button (0 for left | 4 for right);
+
{| class="wikitable"
# packet for every slot painted on, mode is still 5, button (1 | 5);
+
! Packet ID
# packet with mode 5, slot -999, button (2 | 6);
+
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x24
 +
|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
 +
|}
  
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.
+
==== Update Command Block Minecart ====
  
==== Confirm Transaction ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x0F || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Window ID || Byte || The id of the window that the action occurred in.
+
! Field Name
|-
+
! Field Type
| Action number || Short || Every action that is to be accepted has a unique number. This field corresponds to that number.
+
! Notes
|-
+
|-
| Accepted || Bool || Whether the action was accepted.
+
|rowspan="3"| 0x25
|}
+
|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 ====
 
==== Creative Inventory Action ====
  
While the user is in the standard inventory (i.e., not a crafting bench) on a creative-mode server then the server will send this packet:
+
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.
  
* If an item is dropped into the quick bar
+
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).
* If an item is picked up from the quick bar (item id is -1)
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x10 || rowspan=2 | Play || rowspan=2 | Server
+
! Bound To
| Slot || Short || Inventory slot
+
! Field Name
|-
+
! Field Type
| Clicked item || [[Slot_Data|Slot]] ||
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x26
 +
|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.
  
==== Enchant Item ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x11 || rowspan=2 | Play || rowspan=2 | Server
+
! Bound To
| Window ID || Byte || The ID sent by [[#0x64|Open Window]]
+
! Field Name
|-
+
! Field Type
| Enchantment || Byte || The position of the enchantment on the enchantment table window, starting with 0 as the topmost one.
+
! Notes
|}
+
|-
 +
|rowspan="4"| 0x27
 +
|rowspan="4"| Play
 +
|rowspan="4"| Server
 +
| Location
 +
| Position
 +
| Block entity location
 +
|-
 +
| Attachment type
 +
| Identifier
 +
|  
 +
|-  
 +
| Target pool
 +
| Identifier
 +
|  
 +
|-
 +
| Final state
 +
| String
 +
| "Turns into" on the GUI, <code>final_state</code> in NBT
 +
|}
  
==== Update Sign ====
+
==== Update Structure Block ====
  
This message is sent from the client to the server when the "Done" button is pushed after placing a sign.  
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="17"| 0x28
 +
|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
 +
|}
  
{| class="wikitable"
+
Possible actions:
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
 
|-
 
| rowspan="7" | 0x12 || rowspan=7 | Play || rowspan=7 | Server
 
| X || Int || Block X Coordinate
 
|-
 
| Y || Short || Block Y Coordinate
 
|-
 
| Z || Int || Block Z Coordinate
 
|-
 
| Line 1 || String || First line of text in the sign
 
|-
 
| Line 2 || String || Second line of text in the sign
 
|-
 
| Line 3 || String || Third line of text in the sign
 
|-
 
| Line 4 || String || Fourth line of text in the sign
 
|}
 
  
==== Player Abilities ====
+
* 0 - Update data
 +
* 1 - Save the structure
 +
* 2 - Load the structure
 +
* 3 - Detect size
  
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 Notchian client uses update data to indicate no special action should be taken (i.e. the done button).
 
The flags are whether damage is disabled (god mode, 8, bit 3), whether the player can fly (4, bit 2), whether the player is flying (2, bit 1), and whether the player is in creative mode (1, bit 0).
 
 
To get the values of these booleans, simply AND (&) the byte with 1,2,4 and 8 respectively, to get the 0 or 1 bitwise value. To set them OR (|) them with their repspective masks.
 
The vanilla client sends this packet when the player starts/stops flying with the second parameter changed accordingly. All other parameters are ignored by the vanilla server.
 
  
{| class="wikitable"
+
==== Update Sign ====
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
 
|-
 
| rowspan="3" | 0x13 || rowspan=3 | Play || rowspan=3 | Server
 
| Flags || Byte ||
 
|-
 
| Flying speed || Float|| previous integer value divided by 250
 
|-
 
| Walking speed || Float || previous integer value divided by 250
 
|}
 
  
==== Tab-Complete ====
+
{{anchor|Update Sign (serverbound)}}This message is sent from the client to the server when the “Done” button is pushed after placing a sign.
  
Sent when the user presses [tab] while writing text. The payload contains all text behind the cursor.
+
The server only accepts this packet after [[#Open Sign Editor|Open Sign Editor]], otherwise this packet is silently ignored.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x14 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Text || String ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="5"| 0x29
 +
  |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
 +
|}
  
==== Client Settings ====
+
==== Animation (serverbound) ====
  
Sent when the player connects, or when settings are changed.
+
Sent when the player's arm swings.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x15 || rowspan=6 | Play || rowspan=6 | Server
+
! Bound To
| Locale || String || en_GB
+
! Field Name
|-
+
! Field Type
| View distance || Byte || Client-side render distance(chunks)
+
! Notes
|-
+
|-
| Chat flags || Byte || Chat settings. See notes below.
+
| 0x2A
|-
+
| Play
| Chat colours || Bool || "Colours" multiplayer setting
+
| Server
|-
+
| Hand
| Difficulty || Byte || Client-side difficulty from options.txt
+
| VarInt Enum
|-
+
| Hand used for the animation. 0: main hand, 1: off hand.
| Show Cape || Bool || Show Cape multiplayer setting
+
|}
|}
 
  
Chat flags has several values packed into one byte.
+
==== Spectate ====
  
'''Chat Enabled:''' Bits 0-1. 00: Enabled.  01: Commands only10: Hidden.
+
Teleports the player to the given entityThe player must be in spectator mode.
  
==== Client Status ====
+
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"| 0x2B
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Target Player
 +
| UUID
 +
| UUID of the player to teleport to (can also be an entity UUID)
 +
|}
  
Sent when the client is ready to complete login and when the client is ready to respawn after death.
+
==== Player Block Placement ====
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
|-
|-
+
! Packet ID
| rowspan=1 | 0x16 || rowspan=1 | Play || rowspan=1 | Server
+
! State
| Action ID || Byte || See below
+
! Bound To
|}
+
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="7"| 0x2C
 +
|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.
 +
|}
  
Action ID values:
+
Upon placing a block, this packet is sent once.
{| class="wikitable"
+
 
|-
+
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.
! Action ID !! Name
 
|-
 
| 0 || Perform respawn
 
|-
 
| 1 || Request stats
 
|-
 
| 2 || Open inventory achievement
 
|}
 
  
==== Plugin Message ====
+
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).
  
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>.
+
==== Use Item ====
  
More documentation on this: http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/
+
Sent when pressing the Use Item key (default: right click) with an item in hand.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x17 || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Channel || String || Name of the "channel" used to send the data.
+
! Field Name
|-
+
! Field Type
| Length || Short || Length of the following byte array
+
! Notes
|-
+
|-
| Data || Byte Array || Any data.
+
| 0x2D
|}
+
| Play
 +
| Server
 +
| Hand
 +
| VarInt Enum
 +
| Hand used for the animation. 0: main hand, 1: off hand.
 +
|}
  
 
== Status ==
 
== Status ==
The status ping works as follows.
+
{{Main|Server List Ping}}
    C->S : Handshake State=1
 
    C->S : Request
 
    S->C : Response
 
    C->S : Ping
 
    S->C : Ping
 
  
 
=== Clientbound ===
 
=== Clientbound ===
  
 
==== Response ====
 
==== Response ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00  || rowspan=1 | Status || rowspan=1 | Client
+
! Bound To
| JSON Response || String || https://gist.github.com/thinkofdeath/6927216
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x00
 +
  |rowspan="1"| Status
 +
|rowspan="1"| Client
 +
| JSON Response
 +
| String (32767)
 +
| See [[Server List Ping#Response]]
 +
|}
  
 +
==== Pong ====
  
==== Ping ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x01  || rowspan=1 | Status || rowspan=1 | Client
+
! Bound To
| Time || Long || Should be the same as sent by the client
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x01
 +
  |rowspan="1"| Status
 +
|rowspan="1"| Client
 +
| Payload
 +
| Long
 +
| Should be the same as sent by the client
 +
|}
  
 
=== Serverbound ===
 
=== Serverbound ===
  
 
==== Request ====
 
==== Request ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00 || Status || Server || || ||
+
! Bound To
|}
+
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x00
 +
| Status
 +
| Server
 +
|colspan="3"| ''no fields''
 +
|}
  
 +
==== Ping ====
  
==== Ping ====
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x01  || rowspan=1 | Status || rowspan=1 | Server
+
! Bound To
| Time || Long ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x01
 +
  |rowspan="1"| Status
 +
|rowspan="1"| Server
 +
| Payload
 +
| Long
 +
| May be any number. Notchian clients use a system-dependent time value which is counted in milliseconds.
 +
|}
  
 
== Login ==
 
== Login ==
  
 
The login process is as follows:
 
The login process is as follows:
    C->S : Handshake State=2
 
    C->S : Login Start
 
    S->C : Encryption Key Request
 
    (Client Auth)
 
    C->S : Encryption Key Response
 
    (Server Auth, Both enable encryption)
 
    S->C : Login Success
 
  
For unauthenticated and* localhost connections there is no encryption.
+
# C→S: [[#Handshake|Handshake]] with Next State set to 2 (login)
In that case Login Start is directly followed by Login Success.
+
# 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]].
  
<nowiki>*</nowiki> It could be that only one of the two conditions is enough for an unencrypted connection.
+
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.
 
See [[Protocol Encryption]] for details.
Line 2,239: Line 7,180:
 
=== Clientbound ===
 
=== Clientbound ===
  
==== Disconnect ====
+
==== Disconnect (login) ====
 +
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00 || rowspan=1 | Login || rowspan=1 | Client
+
! Bound To
| JSON Data || String ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x00
 +
|rowspan="1"| Login
 +
|rowspan="1"| Client
 +
| Reason
 +
| [[Chat]]
 +
|  
 +
|}
  
 
==== Encryption Request ====
 
==== Encryption Request ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x01  || rowspan=5 | Login || rowspan=5 | Client
+
! Bound To
| Server ID || String || appears to be empty as of 1.7.x
+
! Field Name
|-
+
! Field Type
| Length || Short || length of public key
+
! Notes
|-
+
|-
| Public Key || Byte array ||  
+
|rowspan="5"| 0x01
|-
+
  |rowspan="5"| Login
| Length || Short || length of verify token
+
|rowspan="5"| Client
|-
+
| Server ID
| Verify Token || Byte array ||
+
| String (20)
|-
+
| Appears to be empty
|}
+
|-
 +
| Public Key Length
 +
| VarInt
 +
| Length of Public Key
 +
|-
 +
| Public Key
 +
| Byte Array
 +
|  
 +
|-
 +
| 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.
 
See [[Protocol Encryption]] for details.
  
 
==== Login Success ====
 
==== Login Success ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x02 || rowspan=2 | Login || rowspan=2 | Client
+
! Bound To
| UUID || String ||
+
! Field Name
|-
+
! Field Type
| Username || String ||
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x02
 +
|rowspan="2"| Login
 +
|rowspan="2"| Client
 +
| 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]].
 +
 
 +
==== Set Compression ====
 +
 
 +
Enables compression.  If compression is enabled, all following packets are encoded in the [[#With compression|compressed packet format]].  Negative values will disable compression, meaning the packet format should remain in the [[#Without compression|uncompressed packet format]].  However, this packet is entirely optional, and if not sent, compression will also not be enabled (the notchian server does not send the packet when compression is disabled).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x03
 +
|rowspan="1"| Login
 +
|rowspan="1"| 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 | Login Plugin Response]].
 +
 
 +
Unlike plugin messages in "play" mode, these messages follow a lock-step request/response scheme, where the client is expected to respond to a request indicating whether it understood. The notchian client always responds that it hasn't understood, and sends an empty payload.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x04
 +
|rowspan="3"| Login
 +
|rowspan="3"| 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 ===
 
=== Serverbound ===
  
 
==== Login Start  ====
 
==== Login Start  ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00 || rowspan=1 | Login || rowspan=1 | Server
+
! Bound To
| Name || String ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x00
 +
|rowspan="1"| Login
 +
|rowspan="1"| Server
 +
| Name
 +
| String (16)
 +
| Player's Username
 +
|}
  
 
==== Encryption Response ====
 
==== Encryption Response ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x01  || rowspan=4 | Login || rowspan=4 | Server
+
! Bound To
| Length || Short || length of shared secret
+
! Field Name
|-
+
! Field Type
| Shared Secret || Byte array ||  
+
! Notes
|-
+
|-
| Length || Short || length of verify token
+
|rowspan="4"| 0x01
|-
+
  |rowspan="4"| Login
| Verify Token || Byte array ||
+
|rowspan="4"| Server
|-
+
| Shared Secret Length
|}
+
| VarInt
 +
| Length of Shared Secret
 +
|-
 +
| Shared Secret
 +
| Byte Array
 +
|  
 +
|-
 +
| Verify Token Length
 +
| VarInt
 +
| Length of Verify Token
 +
|-
 +
| Verify Token
 +
| Byte Array
 +
|  
 +
|}
  
 
See [[Protocol Encryption]] for details.
 
See [[Protocol Encryption]] for details.
  
== See Also ==
+
==== Login Plugin Response ====
* [[Data Types]]
+
 
* [[Protocol History]]
+
{| class="wikitable"
* [[Units of Measurement]]
+
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x02
 +
|rowspan="3"| Login
 +
|rowspan="3"| Server
 +
| Message ID
 +
| VarInt
 +
| Should match ID from server.
 +
|-
 +
| Successful
 +
| Boolean
 +
| <code>true</code> if the client understands the request, <code>false</code> otherwise. When <code>false</code>, 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.
 +
|}
  
 
[[Category:Protocol Details]]
 
[[Category:Protocol Details]]
 
[[Category:Minecraft Modern]]
 
[[Category:Minecraft Modern]]

Revision as of 05:38, 23 September 2019

Heads up!

This article is about the protocol for the latest stable release of Minecraft computer edition (1.14.4, protocol 498). For the computer edition pre-releases, see Pre-release protocol. For 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 chat.freenode.net (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

Without compression

Field Name Field Type Notes
Length VarInt Length of packet data + length of the packet ID
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 slighty 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 498 in Minecraft 1.14.4)
Server Address String (255) Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
Server Port 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.

Play

Clientbound

Spawn Object

Sent by the server when a vehicle or other object is created.

Packet ID State Bound To Field Name Field Type Notes
0x00 Play Client Entity ID VarInt EID of the object
Object UUID UUID
Type VarInt The type of object (same as in Spawn Mob)
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 Global Entity

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.

Packet ID State Bound To Field Name Field Type Notes
0x02 Play Client Entity ID VarInt 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

Sent by the server when a mob entity is spawned.

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

Spawn Painting

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

Packet ID State Bound To Field Name Field Type Notes
0x04 Play Client Entity ID VarInt
Entity UUID UUID
Motive VarInt Panting'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
0x05 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
Metadata Entity Metadata

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

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.

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

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.sneak_Time 3 Time
minecraft.walk_one_cm 4 Distance
minecraft.crouch_one_cm 5 Distance
minecraft.sprint_one_cm 6 Distance
minecraft.swim_one_cm 7 Distance
minecraft.fall_one_cm 8 Distance
minecraft.climb_one_cm 9 Distance
minecraft.fly_one_cm 10 Distance
minecraft.dive_one_cm 11 Distance
minecraft.minecart_one_cm 12 Distance
minecraft.boat_one_cm 13 Distance
minecraft.pig_one_cm 14 Distance
minecraft.horse_one_cm 15 Distance
minecraft.aviate_one_cm 16 Distance
minecraft.jump 17 None
minecraft.drop 18 None
minecraft.damage_dealt 19 Damage
minecraft.damage_taken 20 Damage
minecraft.deaths 21 None
minecraft.mob_kills 22 None
minecraft.animals_bred 23 None
minecraft.player_kills 24 None
minecraft.fish_caught 25 None
minecraft.talked_to_villager 26 None
minecraft.traded_with_villager 27 None
minecraft.eat_cake_slice 28 None
minecraft.fill_cauldron 29 None
minecraft.use_cauldron 30 None
minecraft.clean_armor 31 None
minecraft.clean_banner 32 None
minecraft.interact_with_brewingstand 33 None
minecraft.interact_with_beacon 34 None
minecraft.inspect_dropper 35 None
minecraft.inspect_hopper 36 None
minecraft.inspect_dispenser 37 None
minecraft.play_noteblock 38 None
minecraft.tune_noteblock 39 None
minecraft.pot_flower 40 None
minecraft.trigger_trapped_chest 41 None
minecraft.open_enderchest 42 None
minecraft.enchant_item 43 None
minecraft.play_record 44 None
minecraft.interact_with_furnace 45 None
minecraft.interact_with_crafting_table 46 None
minecraft.open_chest 47 None
minecraft.sleep_in_bed 48 None
minecraft.open_shulker_box 49 None

Units:

  • None: just a normal number (formatted with 0 decimal places)
  • Damage: value is 10 times the normal amount
  • Distance: a distance in centimeters (hundredths of blocks)
  • Time: a time span in ticks

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

Update Block Entity

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

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

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. Unfortunately, block IDs are not directly included in the output from Data Generators, but can manually be calculated.

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

Warning.png 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 packet, so prefer that packet for displaying information in that slot. See MC-119145 for more information.

Packet ID State Bound To Field Name Field Type Notes
0x0E Play Client JSON Data Chat Limited to 32767 bytes
Position Byte 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).

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
0x0F Play Client Chunk X Int Chunk X coordinate
Chunk Z Int Chunk Z coordinate
Record Count VarInt Number of elements in the following array, i.e. the number of blocks affected
Record Horizontal Position Array Unsigned Byte The 4 most significant bits (0xF0) encode the X coordinate, relative to the chunk. The 4 least significant bits (0x0F) encode the Z coordinate, relative to the chunk.
Y Coordinate Unsigned Byte Y coordinate of the block
Block ID VarInt The new block state ID for the block as given in the global palette. See that section for more information.

To decode the position into a world position:

worldX = (horizPos >> 4 & 15) + (chunkX * 16);
worldY = vertPos;
worldZ = (horizPos & 15) + (chunkZ * 16);

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
0x10 Play Client
ID VarInt Transaction ID
Start VarInt Start of the text to replace
Length VarInt Length of the text to replace
Count VarInt Number of elements in the following array
Matches Match Array String (32767) One eligible value to insert, note that each command is sent separately instead of in a single string, hence the need for Count. Note that for instance this doesn't include a leading / on commands.
Has tooltip Boolean True if the following is present
Tooltip Optional 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
0x11 Play Client Count VarInt Number of elements in the following array
Nodes Array of Node An array of nodes
Root index VarInt Index of the root node in the previous array

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

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 serverbound confirm transaction packet.

Packet ID State Bound To Field Name Field Type Notes
0x12 Play Client Window ID Byte The ID of the window that the action occurred in
Action Number Short Every action that is to be accepted has a unique number. This number is an incrementing integer (starting at 0) with separate counts for each window ID.
Accepted Boolean Whether the action was accepted

Close Window (clientbound)

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.

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.

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

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:sharpness Sharpness
12 minecraft:smite Smite
13 minecraft:bane_of_arthropods Bane of Arthropods
14 minecraft:knockback Knockback
15 minecraft:fire_aspect Fire Aspect
16 minecraft:looting Looting
17 minecraft:sweeping Sweeping Edge
18 minecraft:efficiency Efficiency
19 minecraft:silk_touch Silk Touch
20 minecraft:unbreaking Unbreaking
21 minecraft:fortune Fortune
22 minecraft:power Power
23 minecraft:punch Punch
24 minecraft:flame Flame
25 minecraft:infinity Infinity
26 minecraft:luck_of_the_sea Luck of the Sea
27 minecraft:lure Lure
28 minecraft:loyalty Loyalty
29 minecraft:impaling Impaling
30 minecraft:riptide Riptide
31 minecraft:channeling Channeling
32 minecraft:mending Mending
33 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: http://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.14.4 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 below

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
Radius Float Currently unused in the client
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

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 whether 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 Invalid Bed Would be used to switch between messages, but the only used message is 0 for invalid bed
1 End raining
2 Begin raining
3 Change gamemode 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
4 Exit end 0: Immediately send Client Status of respawn without showing end credits; 1: Show end credits and respawn at the end (or when esc is pressed). 1 is sent if the player has not yet received the "The end?" advancement, while if they do have it 0 is used.
5 Demo message 0: Show welcome to demo screen, 101: Tell movement controls, 102: Tell jump control, 103: Tell inventory control
6 Arrow hitting player Appears to be played when an arrow strikes another player in Multiplayer
7 Fade value The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
8 Fade time Time in ticks for the sky to fade
9 Play pufferfish sting sound
10 Play elder guardian mob appearance (effect and sound)

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

Keep Alive (clientbound)

The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same packet. If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.

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

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

Chunk Data

Main article: Chunk Format
See also: #Unload Chunk

The server only sends skylight information for chunk pillars in the 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 later).

Packet ID State Bound To Field Name Field Type Notes
0x21 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)
Full chunk Boolean See Chunk Format
Primary Bit Mask VarInt Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
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.
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.

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.

Packet ID State Bound To Field Name Field Type Notes
0x22 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
Particle
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. Potion ID
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 Potion ID
3000 End gateway spawn
3001 Enderdragon growl

Smoke directions:

ID Direction
0 South-East
1 South
2 South-West
3 East
4 (Up or middle ?)
5 West
6 North-East
7 North
8 North-West

Play record: This is actually a special case within this packet. You can start/stop a record at a specific location. Use a valid 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
0x23 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 Float X position of the particle
Y Float Y position of the particle
Z Float 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
0x24 Play Client Chunk X VarInt Chunk coordinate (block coordinate divided by 16, rounded down)
Chunk Z VarInt Chunk coordinate (block coordinate divided by 16, rounded down)
Sky Light Mask VarInt Mask containing 18 bits, with the lowest bit corresponding to chunk section -1 (in the void, y=-16 to y=-1) and the highest bit for chunk section 16 (above the world, y=256 to y=271)
Block Light Mask VarInt Mask containing 18 bits, with the same order as sky light
Empty Sky Light Mask VarInt Mask containing 18 bits, which indicates sections that have 0 for all their sky light values. If a section is set in both this mask and the main sky light mask, it is ignored for this mask and it is included in the sky light arrays (the notchian server does not create such masks). If it is only set in this mask, it is not included in the sky light arrays.
Empty Block Light Mask VarInt Mask containing 18 bits, which indicates sections that have 0 for all their block light values. If a section is set in both this mask and the main block light mask, it is ignored for this mask and it is included in the block light arrays (the notchian server does not create such masks). If it is only set in this mask, it is not included in the block light arrays.
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 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.

Individual block or sky light arrays are is given for each block with increasing x coordinates, within rows of increasing z coordinates, within layers of increasing y coordinates. Even-indexed items (those with an even x coordinate, starting at 0) are packed into the low bits, odd-indexed into the high bits.

Join Game

See Protocol Encryption for information on logging in.

Packet ID State Bound To Field Name Field Type Notes
0x25 Play Client Entity ID Int The player's Entity ID (EID)
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.
Max Players Unsigned Byte Was once used by the client to draw the player list, but now is ignored
Level Type String Enum (16) default, flat, largeBiomes, amplified, customized, buffet, default_1_1
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.

Map Data

Updates a rectangular area on a map item.

Packet ID State Bound To Field Name Field Type Notes
0x26 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)
Tracking Position Boolean Specifies whether player and item frame icons are shown
Locked Boolean True if the map has been locked in a cartography table
Icon Count VarInt Number of elements in the following array
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
0x27 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 villager is buying
Output item Slot The item the villager is selling
Has second item Boolean Whether there is a second item
Input item 2 Optional Slot The second item the villager is buying; only present if they have a second item.
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
Maximum number of trade uses Integer Number of times this trade can be used
XP Integer
Special Price Integer
Price Multiplier Float
Demand Integer
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.
The merchant UI, for reference

Entity Relative Move

This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks Entity Teleport 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
0x28 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 Look And Relative Move

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
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
Yaw Angle New angle, not a delta
Pitch Angle New angle, not a delta
On Ground Boolean

Entity Look

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

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

Entity

This packet may be used to initialize an entity.

For player entities, either this packet or any move/look packet is sent every game tick. So the meaning of this packet is basically that the entity did not move/look since the last such packet.

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

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 regisry; see Inventory for the different values.
Window Title Chat The title of the window

Open Sign Editor

Sent when the client has placed a sign and is allowed to send Update Sign. 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

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
0x30 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
0x31 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

Combat Event

Packet ID State Bound To Field Name Field Type Notes
0x32 Play Client Event VarInt Enum Determines the layout of the remaining packet
Event Field Name
0: enter combat no fields no fields
1: end combat Duration VarInt
Entity ID Int
2: entity dead Player ID VarInt
Entity ID Int
Message Chat

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
0x33 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
0x34 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
0x35 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

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
0x36 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.
Array size 1 VarInt Number of elements in the following array
Recipe IDs Array of Identifier
Array size 2 Optional VarInt Number of elements in the following array, only present if mode is 0 (init)
Recipe IDs Optional Array of Identifier, only present if mode is 0 (init)

Action:

  • 0 (init) = All the recipes in the list 2 will added to the recipe book. All the recipes in list 1 will be tagged as displayed, recipes that aren't tagged will be shown in the notification. VERIFY LIST ORDER?
  • 1 (add) = All the recipes in the list are added and their icon will be shown in the notification.
  • 2 (remove) = Remove all the recipes in the list. This allows them to re-displayed when they are readded.

Destroy Entities

Sent by the server when a list of entities is to be destroyed on the client.

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

Remove Entity Effect

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

Resource Pack Send

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

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
0x3A Play Client Dimension Int Enum -1: The Nether, 0: The Overworld, 1: The End
Gamemode Unsigned Byte 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
Level Type String (16) Same as Join Game

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

Select Advancement Tab

Sent by the server to indicate that the client should switch advancement tab. Sent either when the client switches tab in the GUI or when an advancement in another tab is made.

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

World Border

Packet ID State Bound To Field Name Field Type Notes
0x3D Play Client Action VarInt Enum Determines the format of the rest of the packet
Action Field Name
0: set size Diameter Double Length of a single side of the world border, in meters
1: lerp size 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.
2: set center X Double
Z Double
3: initialize 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 Time VarInt In seconds as set by /worldborder warning time
Warning Blocks VarInt In meters
4: set warning time Warning Time VarInt In seconds as set by /worldborder warning time
5: set warning blocks Warning Blocks VarInt In meters

The Notchian client determines how solid to display the warning by comparing to whichever is higher, the warning distance or whichever is lower, the distance from the current diameter to the target diameter or the place the border will be after warningTime seconds. In pseudocode:

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

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
0x3E Play Client Camera ID VarInt ID of the entity to set the client's camera to

The notchian 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
0x3F 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
0x40 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
0x41 Play Client View Distance VarInt Render distance (2-32)

Display Scoreboard

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

Packet ID State Bound To Field Name Field Type Notes
0x42 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
0x43 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
0x44 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
0x45 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
0x46 Play Client Entity ID VarInt Entity's EID
Slot VarInt Enum Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet)
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
0x47 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
0x48 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
0x49 Play Client Objective Name String (16) An 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
0x4A 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
0x4B 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 players to team Entity Count VarInt Number of elements in the following array
Entities Array of String (40) Identifiers for the entities added. For players, this is their username; for other entities, it is their UUID.
4: remove players from team Entity Count VarInt Number of elements in the following array
Entities Array of String (40) Identifiers for the entities removed. For players, this is their username; for other entities, it is their UUID.

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

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
0x4D Play Client Location Position Spawn location

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

Title

Packet ID State Bound To Field Name Field Type Notes
0x4F Play Client Action VarInt Enum
Action Field Name
0: set title Title Text Chat
1: set subtitle Subtitle Text Chat
2: set action bar Action bar text Chat Displays a message above the hotbar (the same as position 2 in Chat Message (clientbound), except that it correctly renders formatted chat. See MC-119145 for more information.)
3: set times and display 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
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.

The title is visible on screen for Fade In + Stay + Fade Out ticks.

Entity Sound Effect

Plays a sound effect from an entity.

Packet ID State Bound To Field Name Field Type Notes
0x50 Play Client Sound ID VarInt ID of hardcoded sound event (events as of 1.14.4)
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
0x51 Play Client Sound ID VarInt ID of hardcoded sound event (events as of 1.14.4)
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
0x52 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
0x53 Play Client Header Chat To remove the header, send a empty translatable component: {"translate":""}
Footer Chat To remove the footer, send a empty translatable component: {"translate":""}

NBT Query Response

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

Packet ID State Bound To Field Name Field Type Notes
0x54 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
0x55 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
0x56 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
0x57 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
0x58 Play Client Entity ID VarInt
Number Of Properties Int Number of elements in the following array
Property Key Array String (64) 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.maxHealth 20.0 0.0 1024.0 Max Health
generic.followRange 32.0 0.0 2048.0 Follow Range
generic.knockbackResistance 0.0 0.0 1.0 Knockback Resistance
generic.movementSpeed 0.699999988079071 0.0 1024.0 Movement Speed
generic.attackDamage 2.0 0.0 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
generic.reachDistance 5.0 0.0 1024.0 Player Reach Distance (Forge only)
forge.swimSpeed 1.0 0.0 1024.0 Swimming Speed (Forge only)

Modifier Data structure:

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

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

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

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

Entity Effect

Packet ID State Bound To Field Name Field Type Notes
0x59 Play Client Entity ID VarInt
Effect ID Byte See this table
Amplifier Byte Notchian client displays effect level as Amplifier + 1
Duration VarInt Seconds
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.

Declare Recipes

Packet ID State Bound To Field Name Field Type Notes
0x5A Play Client Num Recipes VarInt Number of elements in the following array
Recipe Recipe ID Array Identifier
Type String The recipe type, see below
Data Optional, varies Additional data for the recipe. For some types, there will be no data.

Recipe types:

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 None
crafting_special_mapcloning Recipe for copying maps None
crafting_special_mapextending Recipe for adding paper to maps None
crafting_special_firework_rocket Recipe for making firework rockets None
crafting_special_firework_star Recipe for making firework stars None
crafting_special_firework_star_fade Recipe for making firework stars fade between multiple colors None
crafting_special_repairitem Recipe for repairing items via crafting None
crafting_special_tippedarrow Recipe for crafting tipped arrows None
crafting_special_bannerduplicate Recipe for copying banner patterns None
crafting_special_banneraddpattern Recipe for adding patterns to banners None
crafting_special_shielddecoration Recipe for applying a banner's pattern to a shield None
crafting_special_shulkerboxcoloring Recipe for recoloring a shulker box None
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

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
0x5B Play Client Block Tags (See below) IDs are block IDs
Item Tags (See below) IDs are item IDs
Fluid Tags (See below) IDs are fluid IDs
Entity Tags (See below) IDs are entity IDs

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 block/item.

Acknowledge Player Digging

Packet ID State Bound To Field Name Field Type Notes
0x5C 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. (How does this work?)

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

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 received in the tab completion request packet, must match or the client will ignore this packet. Client generates this and increments it each time it sends another tab completion that doesn't get a response.
Text String (32500) All text behind the cursor without the / (e.g. to the left of the cursor in left-to-right languages like English)

Confirm Transaction (serverbound)

If a transaction sent by the client was not accepted, the server will reply with a 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.

Packet ID State Bound To Field Name Field Type Notes
0x07 Play Server Window ID Byte The ID of the window that the action occurred in
Action Number Short Every action that is to be accepted has a unique number. This number is an incrementing integer (starting at 1) with separate counts for each window ID.
Accepted Boolean Whether the action was accepted

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 Unknown - maybe previous page? (which does give a redstone output)
2 Unknown - maybe next page?
3 Take Book
100? Unknown - actual value is 100 + some parameter, so there may be multiple
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 player when it clicks on a slot in a window.

Packet ID State Bound To Field Name Field Type Notes
0x09 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
Action Number Short 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).
Mode VarInt Enum Inventory operation mode, see below
Clicked item Slot The clicked slot. Has to be empty (item ID = -1) for drop mode.

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
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 different, see above)
1 Normal* Ctrl + Drop key (Ctrl-Q) (drops full stack)
0 -999 Left click outside inventory holding nothing (no-op)
1 -999 Right click outside inventory holding nothing (no-op)
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.

The server will send back a Confirm Transaction packet. If the click was not accepted, the client must send a matching serverbound confirm transaction packet before sending more Click Window packets, otherwise the server will reject them silently. The Notchian server also sends a Window Items packet for the open window and 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 packet for the inventory.

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

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

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

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
0x0E Play Server Target VarInt
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

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 Look (serverbound)

A combination of Player Look 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 Look

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

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 set to true.

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 latter 2 fields are used to indicate the walking and flying speeds respectively, while the first field is used to determine the value of 4 booleans.

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.

Packet ID State Bound To Field Name Field Type Notes
0x19 Play Server Flags Byte Bit mask. 0x08: damage disabled (god mode), 0x04: can fly, 0x02: is flying, 0x01: is Creative
Flying Speed Float
Walking Speed Float

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.

Recipe Book Data

Packet ID State Bound To Field Name Field Type Notes
0x1D Play Server Type VarInt Determines the format of the rest of the packet
Type Field Name
0: Displayed Recipe Recipe ID Identifier A recipe ID
1: Recipe Book States Crafting Recipe Book Open Boolean Whether the player has the crafting recipe book currently opened/active.
Crafting Recipe Filter Active Boolean Whether the player has the crafting recipe book filter option currently active.
Smelting Recipe Book Open Boolean Whether the player has the smelting recipe book currently opened/active.
Smelting Recipe Filter Active Boolean Whether the player has the smelting recipe book filter option currently active.
Blasting Recipe Book Open Boolean May be swapped with smoking recipe book. Also, the notchian client appears to use the same value for both of those books currently.
Blasting Recipe Filter Active Boolean May be swapped with smoking recipe book. Also, the notchian client appears to use the same value for both of those books currently.
Smoking Recipe Book Open Boolean
Smoking Recipe Filter Active Boolean

The Recipe Book Status type is sent when one of the states changes.

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
0x1E 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
0x1F 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
0x20 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
0x21 Play Server Selected slot VarInt The selected slot int 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
0x22 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
0x23 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
0x24 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
0x25 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
0x26 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
0x27 Play Server Location Position Block entity location
Attachment type Identifier
Target pool Identifier
Final state String "Turns into" on the GUI, final_state in NBT

Update Structure Block

Packet ID State Bound To Field Name Field Type Notes
0x28 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
0x29 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
0x2A 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
0x2B 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
0x2C 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
0x2D Play Server Hand VarInt Enum Hand used for the animation. 0: main hand, 1: off hand.

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

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

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

Set Compression

Enables compression. If compression is enabled, all following packets are encoded in the compressed packet format. Negative values will disable compression, meaning the packet format should remain in the uncompressed packet format. However, this packet is entirely optional, and if not sent, compression will also not be enabled (the notchian server does not send the packet when compression is disabled).

Packet ID State Bound To Field Name Field Type Notes
0x03 Login Client Threshold VarInt Maximum size of a packet before it is compressed

Login Plugin Request

Used to implement a custom handshaking flow together with Login Plugin Response.

Unlike plugin messages in "play" mode, these messages follow a lock-step request/response scheme, where the client is expected to respond to a request indicating whether it understood. The notchian client always responds that it hasn't understood, and sends an empty payload.

Packet ID State Bound To Field Name Field Type Notes
0x04 Login Client Message ID VarInt Generated by the server - should be unique to the connection.
Channel Identifier Name of the plugin channel used to send the data
Data Byte Array 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
Verify Token Length VarInt Length of Verify Token
Verify Token Byte Array

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.