Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to: navigation, search
(Plugin channels and inventories have been merged)
(Merge 1.14 clientbound packets)
Line 245: Line 245:
 
!colspan="4"| Handshaking serverbound
 
!colspan="4"| Handshaking serverbound
 
{{PacketList|0x00|Handshake}}
 
{{PacketList|0x00|Handshake}}
|-
 
!colspan="4"| Play clientbound
 
{{PacketList|0x00|Spawn Object}}
 
{{PacketList|0x01|Spawn Experience Orb|pre=unchanged}}
 
{{PacketList|0x02|Spawn Global Entity|pre=unchanged}}
 
{{PacketList|0x03|Spawn Mob|pre=unchanged}}
 
{{PacketList|0x04|Spawn Painting|pre=unchanged}}
 
{{PacketList|0x05|Spawn Player|pre=unchanged}}
 
{{PacketList|0x06|Animation (clientbound)|pre=unchanged}}
 
{{PacketList|0x07|Statistics|pre=unchanged}}
 
{{PacketList|0x08|Block Break Animation|pre=unchanged}}
 
{{PacketList|0x09|Update Block Entity}}
 
{{PacketList|0x0A|Block Action|pre=unchanged}}
 
{{PacketList|0x0B|Block Change|pre=unchanged}}
 
{{PacketList|0x0C|Boss Bar|pre=unchanged}}
 
{{PacketList|0x0D|Server Difficulty}}
 
{{PacketList|0x0E|Chat Message (clientbound)|pre=unchanged}}
 
{{PacketList|0x0F|Multi Block Change|pre=unchanged}}
 
{{PacketList|0x10|Tab-Complete (clientbound)|pre=unchanged}}
 
{{PacketList|0x11|Declare Commands|pre=unchanged}}
 
{{PacketList|0x12|Confirm Transaction (clientbound)|pre=unchanged}}
 
{{PacketList|0x13|Close Window (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x15|0x14}}|Window Items|pre=unchanged}}
 
{{PacketList|{{change|0x16|0x15}}|Window Property|pre=unchanged}}
 
{{PacketList|{{change|0x17|0x16}}|Set Slot|pre=unchanged}}
 
{{PacketList|{{change|0x18|0x17}}|Set Cooldown|pre=unchanged}}
 
{{PacketList|{{change|0x19|0x18}}|Plugin Message (clientbound)}}
 
{{PacketList|{{change|0x1A|0x19}}|Named Sound Effect|pre=unchanged}}
 
{{PacketList|{{change|0x1B|0x1A}}|Disconnect (play)|pre=unchanged}}
 
{{PacketList|{{change|0x1C|0x1B}}|Entity Status|pre=unchanged}}
 
{{PacketList|{{change|0x1E|0x1C}}|Explosion|pre=unchanged}}
 
{{PacketList|{{change|0x1F|0x1D}}|Unload Chunk|pre=unchanged}}
 
{{PacketList|{{change|0x20|0x1E}}|Change Game State|pre=unchanged}}
 
{{PacketList|0x1F|Open Horse Window|rel=added}}
 
{{PacketList|{{change|0x21|0x20}}|Keep Alive (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x22|0x21}}|Chunk Data}}
 
{{PacketList|{{change|0x23|0x22}}|Effect|pre=unchanged}}
 
{{PacketList|{{change|0x24|0x23}}|Particle|pre=unchanged}}
 
{{PacketList|0x24|Update Light|rel=added}}
 
{{PacketList|0x25|Join Game}}
 
{{PacketList|0x26|Map Data}}
 
{{PacketList|0x27|Trade List|rel=added}}
 
{{PacketList|0x28|Entity Relative Move|pre=unchanged}}
 
{{PacketList|0x29|Entity Look And Relative Move|pre=unchanged}}
 
{{PacketList|0x2A|Entity Look|pre=unchanged}}
 
{{PacketList|{{change|0x27|0x2B}}|Entity|pre=unchanged}}
 
{{PacketList|{{change|0x2B|0x2C}}|Vehicle Move (clientbound)|pre=unchanged}}
 
{{PacketList|0x2D|Open Book|rel=added}}
 
{{PacketList|{{change|0x14|0x2E}}|Open Window}}
 
{{PacketList|{{change|0x2C|0x2F}}|Open Sign Editor|pre=unchanged}}
 
{{PacketList|{{change|0x2D|0x30}}|Craft Recipe Response|pre=unchanged}}
 
{{PacketList|{{change|0x2E|0x31}}|Player Abilities (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x2F|0x32}}|Combat Event|pre=unchanged}}
 
{{PacketList|{{change|0x33}}|Use Bed|pre=removed}}
 
{{PacketList|{{change|0x30|0x33}}|Player Info|pre=unchanged}}
 
{{PacketList|{{change|0x31|0x34}}|Face Player|pre=unchanged}}
 
{{PacketList|{{change|0x32|0x35}}|Player Position And Look (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x34|0x36}}|Unlock Recipes|pre=unchanged}}
 
{{PacketList|{{change|0x35|0x37}}|Destroy Entities|pre=unchanged}}
 
{{PacketList|{{change|0x36|0x38}}|Remove Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x37|0x39}}|Resource Pack Send|pre=unchanged}}
 
{{PacketList|{{change|0x38|0x3A}}|Respawn}}
 
{{PacketList|{{change|0x39|0x3B}}|Entity Head Look|pre=unchanged}}
 
{{PacketList|{{change|0x3A|0x3C}}|Select Advancement Tab|pre=unchanged}}
 
{{PacketList|{{change|0x3B|0x3D}}|World Border|pre=unchanged}}
 
{{PacketList|{{change|0x3C|0x3E}}|Camera|pre=unchanged}}
 
{{PacketList|{{change|0x3D|0x3F}}|Held Item Change (clientbound)|pre=unchanged}}
 
{{PacketList|0x40|Update View Position|rel=added}}
 
{{PacketList|0x41|Update View Distance|rel=added}}
 
{{PacketList|{{change|0x3E|0x42}}|Display Scoreboard|pre=unchanged}}
 
{{PacketList|{{change|0x3F|0x43}}|Entity Metadata|pre=unchanged}}
 
{{PacketList|{{change|0x40|0x44}}|Attach Entity|pre=unchanged}}
 
{{PacketList|{{change|0x41|0x45}}|Entity Velocity|pre=unchanged}}
 
{{PacketList|{{change|0x42|0x46}}|Entity Equipment|pre=unchanged}}
 
{{PacketList|{{change|0x43|0x47}}|Set Experience|pre=unchanged}}
 
{{PacketList|{{change|0x44|0x48}}|Update Health|pre=unchanged}}
 
{{PacketList|{{change|0x45|0x49}}|Scoreboard Objective|pre=unchanged}}
 
{{PacketList|{{change|0x46|0x4A}}|Set Passengers|pre=unchanged}}
 
{{PacketList|{{change|0x47|0x4B}}|Teams|pre=unchanged}}
 
{{PacketList|{{change|0x48|0x4C}}|Update Score|pre=unchanged}}
 
{{PacketList|{{change|0x49|0x4D}}|Spawn Position|pre=unchanged}}
 
{{PacketList|{{change|0x4A|0x4E}}|Time Update|pre=unchanged}}
 
{{PacketList|{{change|0x4B|0x4F}}|Title|pre=unchanged}}
 
{{PacketList|0x50|Entity Sound Effect|rel=added}}
 
{{PacketList|{{change|0x4D|0x51}}|Sound Effect|pre=unchanged}}
 
{{PacketList|{{change|0x4C|0x52}}|Stop Sound|pre=unchanged}}
 
{{PacketList|{{change|0x4E|0x53}}|Player List Header And Footer|pre=unchanged}}
 
{{PacketList|{{change|0x1D|0x54}}|NBT Query Response|pre=unchanged}}
 
{{PacketList|{{change|0x4F|0x55}}|Collect Item|pre=unchanged}}
 
{{PacketList|{{change|0x50|0x56}}|Entity Teleport|pre=unchanged}}
 
{{PacketList|{{change|0x51|0x57}}|Advancements|pre=unchanged}}
 
{{PacketList|{{change|0x52|0x58}}|Entity Properties|pre=unchanged}}
 
{{PacketList|{{change|0x53|0x59}}|Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x54|0x5A}}|Declare Recipes}}
 
{{PacketList|{{change|0x55|0x5B}}|Tags}}
 
{{PacketList|0x5C|Acknowledge Player Digging|rel=added}}
 
 
  |-
 
  |-
 
!colspan="4"| Play serverbound
 
!colspan="4"| Play serverbound
Line 1,344: Line 1,248:
 
=== Clientbound ===
 
=== Clientbound ===
  
==== Spawn Object ====
+
Merged
 +
 
 +
=== Serverbound ===
  
Sent by the server when a vehicle or other object is created.
+
==== Set Difficulty ====
 +
 
 +
Must have at least op level 2 to use.  Appears to only be used on singleplayer; the difficulty buttons are still disabled in multiplayer.
  
{| class="wikitable"
+
{| class="wikitable" {{added}}
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
Line 1,356: Line 1,264:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
|rowspan="12"| 0x00
+
  |rowspan="1"| 0x02
|rowspan="12"| Play
+
  |rowspan="1"| Play
|rowspan="12"| Client
+
  |rowspan="1"| Server
| Entity ID
+
  | New difficulty
| VarInt
+
  | Byte
| EID of the object
+
  | 0: peaceful, 1: easy, 2: normal, 3: hard  
|-
+
  |}
| Object UUID
+
 
| UUID
+
==== Click Window Button ====
|
 
|-
 
| Type
 
| {{change|Byte|VarInt}}
 
| The type of object. {{change|(see [[Entities#Objects]])|Uses the same entity type IDs 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
 
|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
 
|}
 
 
 
==== 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''': {{change|Declare a shulker box, no data appears to be sent and the client seems to do fine without this packet. Perhaps it is a leftover from earlier versions?}}
 
* '''11''': Declare a bed
 
* '''12''': {{Change||Set data of a jigsaw block}}
 
* '''13''': {{Change||Set items in a campfire}}
 
 
 
==== 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
 
|- {{Added}}
 
| Difficulty locked?
 
| Boolean
 
|
 
|}
 
 
 
==== Open Horse Window ====
 
 
 
{{Change||This packet is used exclusively for opening the horse GUI.  [[#Open Window|Open Window]] is used for all other GUIs, and now has ID 0x59.}}
 
 
 
{| class="wikitable" {{added}}
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="3"| 0x1F
 
|rowspan="3"| Play
 
|rowspan="3"| Client
 
| Window ID?
 
| Byte
 
|
 
|-
 
| Number of slots?
 
| VarInt
 
|
 
|-
 
| Entity ID?
 
| Integer
 
|
 
|}
 
 
 
==== Chunk Data ====
 
{{Main|Chunk Format}}
 
{{See also|#Unload Chunk}}
 
 
 
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimenison the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.  This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with [[#Update Block Entity|Update Block Entity]] later).
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="9"| {{Change|0x22|0x21}}
 
|rowspan="9"| Play
 
|rowspan="9"| 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#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).
 
|- {{Added}}
 
| 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).
 
|-
 
| 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]]
 
| All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 
|}
 
 
 
===== Data structure =====
 
 
 
The data section of the packet contains most of the useful data for the chunk.
 
 
 
{| class="wikitable"
 
|-
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
| Data
 
| Array of [[#Chunk Section structure|Chunk Section]]
 
| The number of elements in the array is equal to the number of bits set in Primary Bit Mask. Sections are sent bottom-to-top, i.e. the first section, if sent, extends from Y=0 to Y=15.
 
|-
 
| Biomes
 
| Optional Int Array
 
| Only sent if full chunk is true; 256 entries if present
 
|}
 
 
 
===== Chunk Section structure =====
 
 
 
A Chunk Section is defined in terms of other [[data types]]. A Chunk Section consists of the following fields:
 
 
 
{| class="wikitable"
 
|-
 
! Field Name
 
! Field Type
 
! Notes
 
|- {{added}}
 
| Block count
 
| Short
 
| Number of non-air blocks present in the chunk section, for lighting purposes.  "Non-air" is defined as any block other than air, cave air, and void air (in particular, note that fluids such as water are still counted).
 
|-
 
| Bits Per Block
 
| Unsigned Byte
 
| Determines how many bits are used to encode a block. Note that not all numbers are valid here.
 
|-
 
| Palette
 
| Varies
 
| See below for the format.
 
|-
 
| Data Array Length
 
| VarInt
 
| Number of longs in the following array
 
|-
 
| Data Array
 
| Array of Long
 
| Compacted list of 4096 indices pointing to state IDs in the Palette
 
|- {{removed}}
 
| Block Light
 
| Byte Array
 
| Half byte per block
 
|- {{removed}}
 
| Sky Light
 
| Optional Byte Array
 
| Only if in the Overworld; half byte per block
 
|}
 
 
 
Data Array{{change|, Block Light, and Sky Light are|is}} given for each block with increasing x coordinates, within rows of increasing z coordinates, within layers of increasing y coordinates.  {{change|For the half-byte light arrays, even-indexed items (those with an even x coordinate, starting at 0) are packed into the ''low bits'', odd-indexed into the ''high bits''.}}
 
 
 
==== Update Light ====
 
 
 
Updates light levels for a chunk.
 
 
 
{| class="wikitable" {{added}}
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
|-
 
|rowspan="10"| 0x24
 
|rowspan="10"| Play
 
|rowspan="10"| Client
 
|colspan="2"| Chunk X
 
|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.
 
 
 
==== Join Game ====
 
 
 
See [[Protocol Encryption]] for information on logging in.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="8"| 0x25
 
|rowspan="8"| Play
 
|rowspan="8"| 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.
 
|- {{removed}}
 
| Difficulty
 
| Unsigned Byte
 
| 0: peaceful, 1: easy, 2: normal, 3: hard
 
|-
 
| Max Players
 
| Unsigned Byte
 
| Was once used by the client to draw the player list, but now is ignored
 
|-
 
| Level Type
 
| String Enum (16)
 
| default, flat, largeBiomes, amplified, default_1_1
 
|- {{added}}
 
| 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.
 
|}
 
 
 
==== Map Data ====
 
 
 
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! 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
 
|- {{Added}}
 
|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="5"| 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"| 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}}
 
|}
 
 
 
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
 
|}
 
 
 
==== Trade List ====
 
 
 
{{change||Replaces the [[#minecraft:trader_list|minecraft:trader_list]] plugin channel.}}
 
 
 
The list of trades a villager NPC is offering.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!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
 
|- {{Added}}
 
| XP
 
| Integer
 
|
 
|- {{Added}}
 
| Special Price
 
| Integer
 
|
 
|- {{Added}}
 
| Price Multiplier
 
| Float
 
|
 
|- {{Added}}
 
| Demand
 
| Integer
 
|
 
|- {{Added}}
 
|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
 
|- {{Added}}
 
|colspan="2"| Experience
 
|colspan="2"| VarInt
 
| Total experience for this villager (always 0 for the wandering trader)
 
|- {{Added}}
 
|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.
 
|- {{Added}}
 
|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]]
 
{{-}}
 
 
 
==== Open Book ====
 
 
 
{{change||Replaces the [[#minecraft:book_open|minecraft:book_open]] plugin channel.}}
 
 
 
Sent when a player right clicks with a signed book. This tells the client to open the book GUI.
 
 
 
{| class="wikitable" {{Added}}
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="1"| 0x2D
 
|rowspan="1"| Play
 
|rowspan="1"| 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.  {{change||For horses, use [[#Open Horse Window|Open Horse Window]]}}
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="5"| {{change|0x14|0x2E}}
 
|rowspan="5"| Play
 
|rowspan="5"| Client
 
| Window ID
 
| {{change|Unsigned Byte|VarInt}}
 
| A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
 
|-
 
| Window Type
 
| {{change|String (32)|VarInt}}
 
| The window type to use for display. {{change|See [[Inventory]] for a list|contained in the <code>minecraft:menu</code> regisry}}.
 
|-
 
| Window Title
 
| [[Chat]]
 
| The title of the window
 
|- {{removed}}
 
| Number Of Slots
 
| Unsigned Byte
 
| Number of slots in the window (excluding the number of slots in the player inventory). Always 0 for non-storage windows (e.g. Workbench, Anvil).
 
|- {{removed}}
 
| Entity ID
 
| Optional Int
 
| EntityHorse's EID. Only sent when Window Type is “EntityHorse”
 
|}
 
 
 
==== Use Bed ====
 
 
 
{{change|This packet tells that a player goes to bed.}}
 
 
 
{{change|The client with the matching Entity ID will go into bed mode.}}
 
 
 
{{change|This Packet is sent to all nearby players including the one sent to bed.}}
 
 
 
{{change|Any packets sent with a location not currently occupied by a bed will be ignored by clients.}}
 
 
 
{| class="wikitable" {{removed}}
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="2"| 0x33
 
|rowspan="2"| Play
 
|rowspan="2"| Client
 
| Entity ID
 
| VarInt
 
| Sleeping player's EID
 
|-
 
| Location
 
| Position
 
| Block location of the head part of the bed
 
|}
 
 
 
==== Respawn ====
 
 
 
To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="4"| 0x3A
 
|rowspan="4"| Play
 
|rowspan="4"| Client
 
| Dimension
 
| Int Enum
 
| -1: The Nether, 0: The Overworld, 1: The End
 
|- {{removed}}
 
| Difficulty
 
| Unsigned Byte
 
| 0: Peaceful, 1: Easy, 2: Normal, 3: Hard
 
|-
 
| 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.}}
 
 
 
==== 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.
 
 
 
{| class="wikitable" {{added}}
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="2"| 0x40
 
|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.
 
 
 
{| class="wikitable" {{added}}
 
! 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)
 
|}
 
 
 
==== Entity Sound Effect ====
 
 
 
Plays a sound effect from an entity.
 
 
 
{| class="wikitable" {{added}}
 
! 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
 
|}
 
 
 
==== Declare Recipes ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
|-
 
|rowspan="5"| {{Change|0x54|0x5A}}
 
|rowspan="5"| Play
 
|rowspan="5"| Client
 
|colspan="2"| Num Recipes
 
|colspan="2"| VarInt
 
| Number of elements in the following array
 
|-
 
|rowspan="4"| Recipe
 
|{{removed}}| Recipe ID
 
|rowspan="4"| Array
 
|{{removed}}| Identifier
 
|{{removed}}|
 
|-
 
| Type
 
| {{Change|String|Identifier}}
 
| The recipe serializer, see below
 
|- {{Added}}
 
| Recipe ID
 
| Identifier
 
|
 
|-
 
| Data
 
| Optional, varies
 
| Additional data for the recipe.  For some types, there will be no data.
 
|}
 
 
 
Recipe serializers:
 
 
 
{| class="wikitable"
 
! Serializer
 
! Description
 
! Data
 
|-
 
| <code>{{change||minecraft:}}crafting_shapeless</code>
 
| Shapeless crafting recipe.  All items in the ingredient list must be present, but in any order/slot.
 
| As follows:
 
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Group
 
    | 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>{{change||minecraft:}}crafting_shaped</code>
 
| Shaped crafting recipe.  All items must be present in the same pattern (which may be flipped horizontally or translated)
 
| As follows:
 
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | 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>{{change||minecraft:}}crafting_special_armordye</code>
 
| Recipe for dying leather armor
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_bookcloning</code>
 
| Recipe for copying contents of written books
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_mapcloning</code>
 
| Recipe for copying maps
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_mapextending</code>
 
| Recipe for adding paper to maps
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_firework_rocket</code>
 
| Recipe for making firework rockets
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_firework_star</code>
 
| Recipe for making firework stars
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_firework_star_fade</code>
 
| Recipe for making firework stars fade between multiple colors
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_repairitem</code>
 
| Recipe for repairing items via crafting
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_tippedarrow</code>
 
| Recipe for crafting tipped arrows
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_bannerduplicate</code>
 
| Recipe for copying banner patterns
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_banneraddpattern</code>
 
| Recipe for adding patterns to banners
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_shielddecoration</code>
 
| Recipe for applying a banner's pattern to a shield
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_shulkerboxcoloring</code>
 
| Recipe for recoloring a shulker box
 
| None
 
|- {{Added}}
 
| <code>minecraft:crafting_special_suspiciousstew</code>
 
| Recipe for crafting suspicious stew with various affects.
 
| None
 
|-
 
| <code>{{change||minecraft:}}smelting</code>
 
| Smelting recipe
 
|rowspan="4"| All of these have the same format, 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
 
    |
 
    |}
 
|- {{Added}}
 
| <code>minecraft:blasting</code>
 
| Recipes in a blast furnace.
 
|- {{Added}}
 
| <code>minecraft:smoking</code>
 
| Recipes in a smoker.
 
|- {{Added}}
 
| <code>minecraft:campfire_cooking</code>
 
| Recipes in a campfire.
 
|- {{Added}}
 
| <code>{{change||minecraft:stonecutting}}</code>
 
| {{change||Stonecutting recipe.}}
 
| As follows:
 
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Group
 
    | String
 
    | Used to group similar recipes together in the recipe book.  Tag is present in recipe JSON.
 
    |-
 
    | Ingredient
 
    | Ingredient
 
    | The ingredient
 
    |-
 
    | Result
 
    | [[Slot]]
 
    |
 
    |}
 
|-
 
|}
 
 
 
Ingredient is defined as:
 
 
 
{| class="wikitable"
 
! Name
 
! Type
 
! Description
 
|-
 
| Count
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Items
 
| Array of [[Slot]]
 
| Any item in this array may be used for the recipe.  The count of each item should be 1.
 
|}
 
 
 
==== Tags ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="4"| {{change|0x55|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
 
|- {{added}}
 
| Entity Tags
 
| (See below)
 
| IDs are entity type IDs
 
|}
 
 
 
==== Acknowledge Player Digging ====
 
 
 
{| class="wikitable" {{added}}
 
! 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?)
 
|}
 
 
 
=== Serverbound ===
 
 
 
==== Set Difficulty ====
 
 
 
Must have at least op level 2 to use.  Appears to only be used on singleplayer; the difficulty buttons are still disabled in multiplayer.
 
 
 
{| class="wikitable" {{added}}
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
  |rowspan="1"| 0x02
 
  |rowspan="1"| Play
 
  |rowspan="1"| Server
 
  | New difficulty
 
  | Byte
 
  | 0: peaceful, 1: easy, 2: normal, 3: hard  
 
  |}
 
 
 
==== Click Window Button ====
 
  
 
{{Change|Was named Enchant Item}}
 
{{Change|Was named Enchant Item}}
Line 2,750: Line 1,506:
 
=== Serverbound ===
 
=== Serverbound ===
  
==== Handshake ====
+
<!-- ==== Handshake ====
  
 
This causes the server to switch into the target state.
 
This causes the server to switch into the target state.
Line 2,767: Line 1,523:
 
  | Protocol Version
 
  | Protocol Version
 
  | VarInt
 
  | VarInt
  | See [[protocol version numbers]] (currently {{change|404|498}})
+
  | See [[protocol version numbers]] (currently {{change|498|550}})
 
  |-
 
  |-
 
  | Server Address
 
  | Server Address
 
  | String
 
  | String
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information.
+
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
 
  |-  
 
  |-  
 
  | Server Port
 
  | Server Port
Line 2,780: Line 1,536:
 
  | VarInt Enum
 
  | VarInt Enum
 
  | 1 for [[#Status|status]], 2 for [[#Login|login]]
 
  | 1 for [[#Status|status]], 2 for [[#Login|login]]
  |}
+
  |}-->
  
 
== Status ==
 
== Status ==

Revision as of 19:52, 22 August 2019

This page documents the changes from the last stable Minecraft release (currently 1.13.2, protocol 404) to the current pre-release (currently 1.14.4, protocol 498). Note that this page contains bleeding-edge information that may not be completely or correctly documented.

One who wishes to commandeer the merging of this into Protocol when an update is made must be sure to respect any changes that may have occurred to the respective packets there.

Contents

Data types

Position

64-bit value split in to three parts

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

Encoded as followed:

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

And decoded as:

val = read_unsigned_long();
x = val >> 38;
y = (val >> 26) & 0xFFF val & 0xFFF;
z = val << 38 >> 38 (val << 26 >> 38);

Note: The details of bit shifting are rather language dependent; the above may work in Java but probably won't in other languages without some tweaking. In particular, you will usually receive positive numbers even if the actual coordinates are negative. This can be fixed by adding something like the following:

if x >= 2^25 { x -= 2^26 }
if y >= 2^11 { y -= 2^12 }
if z >= 2^25 { z -= 2^26 }

Particle

Particle Name Particle ID Data
minecraft:falling_lava 10 None
minecraft:landing_lava 11 None
minecraft:dripping_water 10 12 None
minecraft:falling_water 13 None
minecraft:dust 11 14 None
minecraft:effect 12 15 None
minecraft:elder_guardian 13 16 None
minecraft:enchanted_hit 14 17 None
minecraft:enchant 15 18 None
minecraft:end_rod 16 19 None
minecraft:entity_effect 17 20 None
minecraft:explosion_emitter 18 21 None
minecraft:explosion 19 22 None
minecraft:falling_dust 20 23 None
minecraft:firework 21 24 None
minecraft:fishing 22 25 None
minecraft:flame 23 26 None
minecraft:flash 27 None
minecraft:happy_villager 24 28 None
minecraft:composter 29 None
minecraft:heart 25 30 None
minecraft:instant_effect 26 31 None
minecraft:item 27 32 None
minecraft:item_slime 28 33 None
minecraft:item_snowball 29 34 None
minecraft:large_smoke 30 35 None
minecraft:lava 31 36 None
minecraft:mycelium 32 37 None
minecraft:note 33 38 None
minecraft:poof 34 39 None
minecraft:portal 35 40 None
minecraft:rain 36 41 None
minecraft:smoke 37 42 None
minecraft:sneeze 43 None
minecraft:spit 38 44 None
minecraft:squid_ink 39 45 None
minecraft:sweep_attack 40 46 None
minecraft:totem_of_undying 41 47 None
minecraft:underwater 42 48 None
minecraft:splash 43 49 None
minecraft:witch 44 50 None
minecraft:bubble_pop 45 51 None
minecraft:current_down 46 52 None
minecraft:bubble_column_up 47 53 None
minecraft:nautilus 48 54 None
minecraft:dolphin 49 55 None
minecraft:campfire_cosy_smoke 56 None
minecraft:campfire_signal_smoke 57 None

Packets

ID Packet name Documentation
Handshaking serverbound
0x00 Handshake Current Pre
Play serverbound
0x00 Teleport Confirm Current (unchanged)
0x01 Query Block NBT Current (unchanged)
0x02 Set Difficulty Current Pre
0x02 0x03 Chat Message (serverbound) Current (unchanged)
0x03 0x04 Client Status Current (unchanged)
0x04 0x05 Client Settings Current (unchanged)
0x05 0x06 Tab-Complete (serverbound) Current (unchanged)
0x06 0x07 Confirm Transaction (serverbound) Current (unchanged)
0x07 0x08 Click Window Button Current Pre
0x08 0x09 Click Window Current (unchanged)
0x09 0x0A Close Window (serverbound) Current (unchanged)
0x0A 0x0B Plugin Message (serverbound) Current (unchanged)
0x0B 0x0C Edit Book Current (unchanged)
0x0C 0x0D Query Entity NBT Current (unchanged)
0x0D 0x0E Use Entity Current (unchanged)
0x0E 0x0F Keep Alive (serverbound) Current (unchanged)
0x10 Lock Difficulty Current Pre
0x10 0x11 Player Position Current (unchanged)
0x11 0x12 Player Position And Look (serverbound) Current (unchanged)
0x12 0x13 Player Look Current (unchanged)
0x0F 0x14 Player Current (unchanged)
0x13 0x15 Vehicle Move (serverbound) Current (unchanged)
0x14 0x16 Steer Boat Current (unchanged)
0x15 0x17 Pick Item Current (unchanged)
0x16 0x18 Craft Recipe Request Current (unchanged)
0x17 0x19 Player Abilities (serverbound) Current (unchanged)
0x18 0x1A Player Digging Current (unchanged)
0x19 0x1B Entity Action Current (unchanged)
0x1A 0x1C Steer Vehicle Current (unchanged)
0x1B 0x1D Recipe Book Data Current Pre
0x1C 0x1E Name Item Current (unchanged)
0x1D 0x1F Resource Pack Status Current (unchanged)
0x1E 0x20 Advancement Tab Current (unchanged)
0x1F 0x21 Select Trade Current (unchanged)
0x20 0x22 Set Beacon Effect Current (unchanged)
0x21 0x23 Held Item Change (serverbound) Current (unchanged)
0x22 0x24 Update Command Block Current (unchanged)
0x23 0x25 Update Command Block Minecart Current (unchanged)
0x24 0x26 Creative Inventory Action Current (unchanged)
0x27 Update Jigsaw Block Pre
0x25 0x28 Update Structure Block Current (unchanged)
0x26 0x29 Update Sign Current (unchanged)
0x27 0x2A Animation (serverbound) Current (unchanged)
0x28 0x2B Spectate Current (unchanged)
0x29 0x2C Player Block Placement Current Pre
0x2A 0x2D Use Item Current (unchanged)

New/modified data types

No changes so far.

Entity Metadata

Warning.png Entity metadata shifted in 19w08a; not all entities are copied here. All subclasses of entity had shift of 1; all subclasses of living had a second shift (2 total). All entities listed in the article have been updated, but there are ones not listed here.

Entity Metadata Format

Note that entity metadata is a totally distinct concept from block metadata. It is not required to send all metadata fields, or even any metadata fields, so long as the terminating entry is correctly sent.

Entity Metadata is an array of entries, each of which looks like the following:

Name Type Meaning
Index Unsigned Byte Unique index key determining the meaning of the following value, see the table below. If this is 0xff then the it is the end of the Entity Metadata array and no more is read.
Type Optional VarInt Enum Only if Index is not 0xff; the type of the index, see the table below
Value Optional value of Type Only if Index is not 0xff: the value of the metadata field
Value of Type field Type of Value field Notes
0 Byte
1 VarInt
2 Float
3 String
4 Chat
5 OptChat (Boolean + Optional Chat) Chat is present if the Boolean is set to true
6 Slot
7 Boolean
8 Rotation 3 floats: rotation on x, rotation on y, rotation on z
9 Position
10 OptPosition (Boolean + Optional Position) Position is present if the Boolean is set to true
11 Direction (VarInt) (Down = 0, Up = 1, North = 2, South = 3, West = 4, East = 5)
12 OptUUID (Boolean + Optional UUID) UUID is present if the Boolean is set to true
13 OptBlockID (VarInt) 0 for absent otherwise, id << 4 | data
14 NBT
15 Particle
16 Villager Data 3 VarInts: villager type, villager profession, level
17 OptVarInt 0 for absent; 1 + actual value otherwise. Used for entity IDs.
18 Pose A VarInt enum: 0: STANDING, 1: FALL_FLYING, 2: SLEEPING, 3: SWIMMING, 4: SPIN_ATTACK, 5: SNEAKING, 6: DYING

Villager type (minecraft:villager_type registry):

Name ID
minecraft:desert 0
minecraft:jungle 1
minecraft:plains 2
minecraft:savanna 3
minecraft:snow 4
minecraft:swamp 5
minecraft:taiga 6

Villager professions (minecraft:villager_profession registry):

Name ID
minecraft:none 0
minecraft:armorer 1
minecraft:butcher 2
minecraft:cartographer 3
minecraft:cleric 4
minecraft:farmer 5
minecraft:fisherman 6
minecraft:fletcher 7
minecraft:leatherworker 8
minecraft:librarian 9
minecraft:mason 10
minecraft:nitwit 11
minecraft:shepherd 12
minecraft:toolsmith 13
minecraft:weaponsmith 14

Mobs

Entity IDs have shifted with the addition of some new mobs.

Entity

The base class.

Index Type Meaning Default
0 Byte Bit mask Meaning 0
0x01 On Fire
0x02 Crouched
0x04 Unused (previously riding)
0x08 Sprinting
0x10 Swimming
0x20 Invisible
0x40 Glowing effect
0x80 Flying with elytra
1 VarInt Air 300
2 OptChat Custom name empty
3 Boolean Is custom name visible false
4 Boolean Is silent false
5 Boolean No gravity false
6 Pose Pose STANDING

Itemed Throwable

Extends Throwable.

Used for all things that previously extended throwable other than potions, which already had an item.

Index Type Meaning Default
7 Slot Item empty (which behaves as if it were a specific item, depending on the subclass)

Egg

Extends Itemed Throwable.

No additional metadata.

An empty item behaves as if the item were a minecraft:egg.

Ender Pearl

Extends Itemed Throwable.

No additional metadata.

An empty item behaves as if the item were a minecraft:ender_pearl.

Experience Bottle

Extends Itemed Throwable.

No additional metadata.

minecraft:experience_bottle

Snowball

Extends Itemed Throwable.

No additional metadata.

minecraft:snowball

Eye of Ender

Extends Entity.

Index Type Meaning Default
7 Slot Item empty (which behaves as if it were a minecraft:ender_eye)

Arrow

Extends Entity.

Abstract base class for TippedArrow (which is used for regular arrows as well as tipped ones) and Spectral Arrow.

Index Type Meaning Default
6 7 Byte Bit mask Meaning 0
0x01 Is critical
0x02 Is noclip (used by loyalty tridents when returning)
7 8 OptUUID Shooter UUID Empty
9 Byte Piercing level 0

TippedArrow

Extends Arrow.

Used for both tipped and regular arrows. If not tipped, then color is set to -1 and no tipped arrow particles are used.

Index Type Meaning Default
8 10 VarInt Color (-1 for no particles) -1

Trident

Extends Arrow.

Index Type Meaning Default
8 10 VarInt Loyalty level (enchantment) 0

Itemed Fireball

Extends Entity.

Used for regular and small fireballs. Not used for dragon fireballs and wither skulls. Interestingly, regular fireballs do not come from an item.

Index Type Meaning Default
7 Slot Item empty (which behaves as if it were a minecraft:fire_charge)

Fireball

Extends Abstract Fireball Itemed Fireball. This is the large fireball shot by ghasts.

No additional metadata.

Small Fireball

Extends Abstract Fireball Itemed Fireball. This is the fireball shot by blazes and dispensers with fire charges.

No additional metadata.

Fireworks

Extends Entity.

Index Type Meaning Default
6 7 Slot Firework info empty
7 8 VarInt OptVarInt Entity ID of entity which used firework (for elytra boosting) 0
9 Boolean Shot at angle (from a crossbow) false

Living

Extends Entity.

Index Type Meaning Default
6 7 Byte Hand states, used to trigger blocking/eating/drinking animation. 0
Bit mask Meaning
0x01 Is hand active
0x02 Active hand (0 = main hand, 1 = offhand)
0x04 In riptide spin attack
7 8 Float Health 1.0
8 9 VarInt Potion effect color (or 0 if there is no effect) 0
9 10 Boolean Is potion effect ambient: reduces the number of particles generated by potions to 1/5 the normal amount false
10 11 VarInt Number of arrows in entity 0
12 OptBlockPos Unknown (Bed location?) Absent

Panda

Extends Animal.

Index Type Meaning Default
15 Integer Breed timer? Set to 32 when something happens, and then counts down to 0 again. At 29 and 14 (before counting down), will play the entity.panda.cant_breed sound event. 0
16 Integer Sneeze timer. Counts up from 0; when it hits 1 the entity.panda.pre_sneeze event plays and when it hits 21 the entity.panda.sneeze event plays (and it is set back to 0 and the sneeze flag is cleared). 0
17 Integer Eat timer. If nonzero, counts upwards. 0
18 Byte Main Gene 0
19 Byte Hidden Gene 0
20 Byte Bit mask Meaning 0
0x01 Unused
0x02 Is sneezing
0x04 Is eating
0x08 Unknown
0x10 Unknown

Fox

Extends Animal.

Index Type Meaning Default
15 VarInt Type (0: red, 1: snow) 0 (red)
16 Byte Bit mask Meaning 0
0x01 Sitting
0x02 Unused
0x04 Crouching
0x08 Unknown
0x10 Unknown
0x20 Sleeping
0x40 Unknown
0x80 Unknown
17 OptUUID First UUID (in UUIDs NBT)? Absent
18 OptUUID Second UUID (in UUIDs NBT)? Absent

Mooshroom

Extends Cow.

No additional metadata.

Index Type Meaning Default
15 String Variant ("red" or "brown") red

Raid Participent

Extends Monster.

Index Type Meaning Default
14 boolean Is celebrating false

"Is celebrating" appears to control the pose for vindicators and does not appear to be used by other types.

Abstract Illager

Extends Monster Raid Participent.

Index Type Meaning Default
12 Byte Bit mask Meaning 0
0x01 Has target (aggressive state)

Replaced with pose (presumably?)

Spellcaster Illager

Extends Abstract Illlager.

Index Type Meaning Default
13 15 Byte Spell (0: none, 1: summon vex, 2: attack, 3: wololo, 4: disappear, 5: blindness) 0

EvocationIllager Evoker

Extends Spellcaster Illager.

IllusionIllager Illusioner

Extends Spellcaster Illager.

Pillager

Extends Abstract Illlager.

Index Type Meaning Default
15 Boolean Using crossbow false

VindicationIllager Vindicator

Extends Abstract Illager.

Ravager

Extends Raid Participent

No additional metadata.

Status Description
4 Starts the attack animation.
39 Starts the stun animation.

Witch

Extends Monster Raid Participent.

Index Type Meaning Default
12 15 Boolean Is drinking potion false

AbstractSkeleton

Extends Monster.

Index Type Meaning Default
12 14 Boolean Is swinging arms false

Replaced with pose (presumably?)

Zombie

Extends Monster.

Index Type Meaning Default
12 14 Boolean Is baby false
13 15 VarInt Unused (previously type) 0
14 Boolean Are hands held up false
15 16 Boolean Is becoming a drowned false

Replaced with pose (presumably?)

Zombie Villager

Extends Zombie.

Index Type Meaning Default
16 17 Boolean Is converting false
17 18 VarInt Villager Data Profession Villager Data 0 Plains/None/1


Ocelot

Extends TameableAnimal Ageable.

Index Type Meaning Default
15 VarInt Type (0 = untamed, 1 = tuxedo, 2 = tabby, 3 = siamese). Used to render regardless as to whether it is tamed or not. 0
15 Boolean Is trusting false
Status Description
40 Spawn smoke particles (trust gaining failed)
41 Spawn heart particles (trust gaining succeeded)

Cat

Extends TameableAnimal.

Index Type Meaning Default
17 VarInt Type (0 = tabby, 1 = black, 2 = red, 3 = siamese, 4 = british_shorthair, 5 = calico, 6 = persian, 7 = ragdoll, 8 = white, 9 = all_black) 1
18 Boolean Unknown false
19 Boolean Unknown false
20 VarInt Collar color (values are those used with dyes) 14 (Red)

Horse

Extends AbstractHorse.

Index Type Meaning Default
15 17 VarInt Variant (Color & Style) 0
16 VarInt Armor (0: none, 1: iron, 2: gold, 3: diamond) 0 (none)
17 Slot Armor Item (Forge only) Empty

Replaced with Entity Equipment packet. (Uses chestplate slot)

Trader Llama

Extends Llama.

No additional metadata.

Abstract Merchant

Extends Ageable.

Index Type Meaning Default
15 VarInt Head shake timer (starts at 40, decrements each tick) 0

Villager

Extends Ageable Abstract Merchant.

Index Type Meaning Default
13 16 VarInt Villager Data Villager Data 0 Plains/None/1

Wandering Trader

Extends Abstract Merchant.

No additional metadata.

Block Actions

No changes so far.

Inventories

Merged

Plugin Channels

Merged

Play

Clientbound

Merged

Serverbound

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

Click Window Button

Was named Enchant Item

Used more generally than just for enchanting in 1.14, although the code internally supported general use in earlier versions.

Packet ID State Bound To Field Name Field Type Notes
0x07 Play Server Window ID Byte The ID of the enchantment table window sent by Open Window
Enchantment Button ID Byte The position of the enchantment on the enchantment table window, starting with 0 as the topmost one 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.

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
0x0F Play Server Locked Boolean

Recipe Book Data

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

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

Player Block Placement

Packet ID State Bound To Field Name Field Type Notes
0x29 0x2C Play Server Location Position Block position
Face VarInt Enum The face on which the block is placed (as documented at Player Digging)
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 pixel in the default resource pack. For example, let's say a slab is being placed against the south face of a full block. The Cursor Position X will be higher if the player was pointing near the right (east) edge of the face, lower if pointing near the left. The Cursor Position Y will be used to determine whether it will appear as a bottom slab (values 0.0–0.5) or as a top slab (values 0.5-1.0). The Cursor Position Z should be 1.0 since the player was looking at the southernmost part of the block.

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

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

Status

Clientbound

No changes so far.

Serverbound

No changes so far.

Login

Clientbound

No changes so far.

Serverbound

No changes so far.