Difference between revisions of "Protocol"

From wiki.vg
Jump to: navigation, search
(Clientbound: Play clientbound: new packets)
(Chunk Data: Document my findings/headaches)
 
(44 intermediate revisions by 14 users not shown)
Line 5: Line 5:
 
   |ICON =  
 
   |ICON =  
 
   |HEADING = Heads up!
 
   |HEADING = Heads up!
   |CONTENT = This article is about the protocol for the latest '''stable''' release of Minecraft '''computer edition''' ([[Protocol version numbers|1.13.1, protocol 401]]). For the computer edition pre-releases, see [[Pre-release protocol]]. For Pocket Edition, see [[Pocket Edition Protocol Documentation]].
+
   |CONTENT = This article is about the protocol for the latest '''stable''' release of Minecraft '''computer edition''' ([[Protocol version numbers|1.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 '''[https://minecraft.net/ Minecraft] protocol'''.
 
This page presents a dissection of the current '''[https://minecraft.net/ Minecraft] protocol'''.
  
If you're having trouble, check out the [[Protocol FAQ|FAQ]] or ask for help in the IRC channel [irc://irc.freenode.net/mcdevs #mcdevs on chat.freenode.net] ([http://wiki.vg/MCDevs More Information]).
+
If you're having trouble, check out the [[Protocol FAQ|FAQ]] or ask for help in the IRC channel [ircs://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.
Line 47: Line 47:
 
  |-
 
  |-
 
  | Global palette
 
  | Global palette
  | A table/dictionary/palette mapping nonnegative integers to block states. Block state IDs are created in a linear fashion based off of order of assignment.  One block state ID allocated for each unique block state for a block; if a block has multiple properties then the number of allocated states is the product of the number of values for each property.  A current list of properties and state ID ranges is found on [http://pokechu22.github.io/Burger/1.13.1.html burger].
+
  | A table/dictionary/palette mapping nonnegative integers to block states. Block state IDs are created in a linear fashion based off of order of assignment.  One block state ID allocated for each unique block state for a block; if a block has multiple properties then the number of allocated states is the product of the number of values for each property.  A current list of properties and state ID ranges is found on [https://pokechu22.github.io/Burger/1.14.4.html burger].
  
 
Alternatively, the vanilla server now includes an option to export the current block state ID mapping, by running <code>java -cp minecraft_server.jar net.minecraft.data.Main --reports</code>.  See [[Data Generators]] for more information.
 
Alternatively, the vanilla server now includes an option to export the current block state ID mapping, by running <code>java -cp minecraft_server.jar net.minecraft.data.Main --reports</code>.  See [[Data Generators]] for more information.
Line 111: Line 111:
 
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
 
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
  
If compressed, the uncompressed length of (Packet ID + Data) must be equal to or over the threshold set in the packet [[#Set Compression 2|Set Compression]], otherwise the receiving party will disconnect.
+
If compressed, the uncompressed length of (Packet ID + Data) must be equal to or over the threshold set in the packet [[#Set Compression|Set Compression]], otherwise the receiving party will disconnect.
  
 
Compression can be disabled by sending the packet [[#Set Compression|Set Compression]] with a negative Threshold, or not sending the Set Compression packet at all.
 
Compression can be disabled by sending the packet [[#Set Compression|Set Compression]] with a negative Threshold, or not sending the Set Compression packet at all.
Line 140: Line 140:
 
  | Protocol Version
 
  | Protocol Version
 
  | VarInt
 
  | VarInt
  | See [[protocol version numbers]] (currently 401 in Minecraft 1.13.1)
+
  | See [[protocol version numbers]] (currently 498 in Minecraft 1.14.4)
 
  |-
 
  |-
 
  | Server Address
 
  | Server Address
 
  | String (255)
 
  | String (255)
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information.
+
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
 
  |-  
 
  |-  
 
  | Server Port
 
  | Server Port
Line 207: Line 207:
 
  |-
 
  |-
 
  | Type
 
  | Type
  | Byte
+
  | VarInt
  | The type of object (see [[Entities#Objects]])
+
  | The type of object (same as in [[#Spawn Mob|Spawn Mob]])
 
  |-
 
  |-
 
  | X
 
  | X
Line 408: Line 408:
 
  |  
 
  |  
 
  |-
 
  |-
  | Title
+
  | Motive
  | String (13)
+
  | VarInt
  | Name of the painting. Max length 13
+
  | Panting's ID, see below
 
  |-
 
  |-
 
  | Location
 
  | Location
Line 427: Line 427:
 
{| class="wikitable"
 
{| class="wikitable"
 
  ! Name
 
  ! Name
 +
! ID
 
  ! x
 
  ! x
 
  ! y
 
  ! y
Line 432: Line 433:
 
  ! height
 
  ! height
 
  |-
 
  |-
  | <code>Kebab</code>
+
  | <code>minecraft:kebab</code>
 +
| 0
 
  | 0
 
  | 0
 
  | 0
 
  | 0
Line 438: Line 440:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Aztec</code>
+
  | <code>minecraft:aztec</code>
 +
| 1
 
  | 16
 
  | 16
 
  | 0
 
  | 0
Line 444: Line 447:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Alban</code>
+
  | <code>minecraft:alban</code>
 +
| 2
 
  | 32
 
  | 32
 
  | 0
 
  | 0
Line 450: Line 454:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Aztec2</code>
+
  | <code>minecraft:aztec2</code>
 +
| 3
 
  | 48
 
  | 48
 
  | 0
 
  | 0
Line 456: Line 461:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Bomb</code>
+
  | <code>minecraft:bomb</code>
 +
| 4
 
  | 64
 
  | 64
 
  | 0
 
  | 0
Line 462: Line 468:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Plant</code>
+
  | <code>minecraft:plant</code>
 +
| 5
 
  | 80
 
  | 80
 
  | 0
 
  | 0
Line 468: Line 475:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Wasteland</code>
+
  | <code>minecraft:wasteland</code>
 +
| 6
 
  | 96
 
  | 96
 
  | 0
 
  | 0
Line 474: Line 482:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Pool</code>
+
  | <code>minecraft:pool</code>
 +
| 7
 
  | 0
 
  | 0
 
  | 32
 
  | 32
Line 480: Line 489:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Courbet</code>
+
  | <code>minecraft:courbet</code>
 +
| 8
 
  | 32
 
  | 32
 
  | 32
 
  | 32
Line 486: Line 496:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Sea</code>
+
  | <code>minecraft:sea</code>
 +
| 9
 
  | 64
 
  | 64
 
  | 32
 
  | 32
Line 492: Line 503:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Sunset</code>
+
  | <code>minecraft:sunset</code>
 +
| 10
 
  | 96
 
  | 96
 
  | 32
 
  | 32
Line 498: Line 510:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Creebet</code>
+
  | <code>minecraft:creebet</code>
 +
| 11
 
  | 128
 
  | 128
 
  | 32
 
  | 32
Line 504: Line 517:
 
  | 16
 
  | 16
 
  |-
 
  |-
  | <code>Wanderer</code>
+
  | <code>minecraft:wanderer</code>
 +
| 12
 
  | 0
 
  | 0
 
  | 64
 
  | 64
Line 510: Line 524:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Graham</code>
+
  | <code>minecraft:graham</code>
 +
| 13
 
  | 16
 
  | 16
 
  | 64
 
  | 64
Line 516: Line 531:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Match</code>
+
  | <code>minecraft:match</code>
 +
| 14
 
  | 0
 
  | 0
 
  | 128
 
  | 128
Line 522: Line 538:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Bust</code>
+
  | <code>minecraft:bust</code>
 +
| 15
 
  | 32
 
  | 32
 
  | 128
 
  | 128
Line 528: Line 545:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Stage</code>
+
  | <code>minecraft:stage</code>
 +
| 16
 
  | 64
 
  | 64
 
  | 128
 
  | 128
Line 534: Line 552:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Void</code>
+
  | <code>minecraft:void</code>
 +
| 17
 
  | 96
 
  | 96
 
  | 128
 
  | 128
Line 540: Line 559:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>SkullAndRoses</code>
+
  | <code>skull_and_roses</code>
 +
| 18
 
  | 128
 
  | 128
 
  | 128
 
  | 128
Line 546: Line 566:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Wither</code>
+
  | <code>minecraft:wither</code>
 +
| 19
 
  | 160
 
  | 160
 
  | 128
 
  | 128
Line 552: Line 573:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Fighters</code>
+
  | <code>minecraft:fighters</code>
 +
| 20
 
  | 0
 
  | 0
 
  | 96
 
  | 96
Line 558: Line 580:
 
  | 32
 
  | 32
 
  |-
 
  |-
  | <code>Pointer</code>
+
  | <code>minecraft:pointer</code>
 +
| 21
 
  | 0
 
  | 0
 
  | 192
 
  | 192
Line 564: Line 587:
 
  | 64
 
  | 64
 
  |-
 
  |-
  | <code>Pigscene</code>
+
  | <code>minecraft:pigscene</code>
 +
| 22
 
  | 64
 
  | 64
 
  | 192
 
  | 192
Line 570: Line 594:
 
  | 64
 
  | 64
 
  |-
 
  |-
  | <code>BurningSkull</code>
+
  | <code>minecraft:burning_skull</code>
 +
| 23
 
  | 128
 
  | 128
 
  | 192
 
  | 192
Line 576: Line 601:
 
  | 64
 
  | 64
 
  |-
 
  |-
  | <code>Skeleton</code>
+
  | <code>minecraft:skeleton</code>
 +
| 24
 
  | 192
 
  | 192
 
  | 64
 
  | 64
Line 582: Line 608:
 
  | 48
 
  | 48
 
  |-
 
  |-
  | <code>DonkeyKong</code>
+
  | <code>minecraft:donkey_kong</code>
 +
| 25
 
  | 192
 
  | 192
 
  | 112
 
  | 112
Line 595: Line 622:
 
This packet is sent by the server when a player comes into visible range, ''not'' when a player joins.
 
This packet is sent by the server when a player comes into visible range, ''not'' when a player joins.
  
This packet must be sent after the [[#Player List Item|Player List Item]] packet that adds the player data for the client to use when spawning a player. If the Player List Item for the player spawned by this packet is not present when this packet arrives, Notchian clients will not spawn the player entity. The Player List Item packet includes skin/cape data.
+
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.
 
Servers can, however, safely spawn player entities for players not in visible range. The client appears to handle it correctly.
Line 714: Line 741:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x07
+
  |rowspan="4"| 0x07
  |rowspan="3"| Play
+
  |rowspan="4"| Play
  |rowspan="3"| Client
+
  |rowspan="4"| Client
 
  |colspan="2"| Count
 
  |colspan="2"| Count
 
  |colspan="2"| VarInt
 
  |colspan="2"| VarInt
Line 722: Line 749:
 
  |-
 
  |-
 
  |rowspan="2"| Statistic
 
  |rowspan="2"| Statistic
  | Name
+
  | Category ID
 
  |rowspan="2"| Array
 
  |rowspan="2"| Array
  | String (32767)
+
  | VarInt
  | [https://gist.github.com/Alvin-LB/8d0d13db00b3c00fd0e822a562025eff https://gist.github.com/Alvin-LB/8d0d13db00b3c00fd0e822a562025eff]
+
  | See below
 
  |-
 
  |-
  | Value
+
  | Statistic ID
 
  | VarInt
 
  | VarInt
 +
| See below
 +
|-
 +
|colspan="2"| Value
 +
|colspan="2"| VarInt
 
  | The amount to set it to
 
  | The amount to set it to
 
  |}
 
  |}
  
==== Block Break Animation ====
+
Categories (these are namespaced, but with <code>:</code> replaced with <code>.</code>):
 
 
0–9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
 
 
 
Block break animations can still be applied on air; the animation will remain visible although there is no block being broken.  However, if this is applied to a transparent block, odd graphical effects may happen, including water losing its transparency. (An effect similar to this can be seen in normal gameplay when breaking ice blocks)
 
 
 
If you need to display several break animations at the same time you have to give each of them a unique Entity ID. The entity ID does not need to correspond to an actual entity on the client. It is valid to use a randomly generated number.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Name
  ! State
+
! ID
  ! Bound To
+
  ! Registry
  ! Field Name
+
  |-
  ! Field Type
+
| <code>minecraft.mined</code>
  ! Notes
+
| 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
 
  |-
 
  |-
  |rowspan="3"| 0x08
+
  | <code>minecraft.killed</code>
|rowspan="3"| Play
+
  | 6
|rowspan="3"| Client
+
  | Entities
| Entity ID
 
  | VarInt
 
  | Entity ID of the entity breaking the block
 
 
  |-
 
  |-
  | Location
+
  | <code>minecraft.killed_by</code>
  | Position
+
  | 7
  | Block Position
+
  | Entities
 
  |-
 
  |-
  | Destroy Stage
+
  | <code>minecraft.custom</code>
  | Byte
+
  | 8
  | 0–9 to set it, any other value to remove it
+
  | Custom
 
  |}
 
  |}
  
==== Update Block Entity ====
+
Blocks, Items, and Entities use block (not block state), item, and entity ids.
  
Sets tile entity associated with the block at the given location.
+
Custom has the following (unit only matters for clients):
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Name
! State
+
  ! ID
! Bound To
+
  ! Unit
! Field Name
 
  ! Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x09
+
  | <code>minecraft.leave_game</code>
|rowspan="3"| Play
+
  | 0
|rowspan="3"| Client
+
  | None
| Location
 
  | Position
 
  |  
 
 
  |-
 
  |-
  | Action
+
  | <code>minecraft.play_one_minute</code>
  | Unsigned Byte
+
  | 1
  | The type of update to perform, see below
+
  | Time
 
  |-
 
  |-
  | NBT Data
+
  | <code>minecraft.time_since_death</code>
| [[NBT|NBT Tag]]
+
  | 2
| 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)
+
| Time
  |}
 
 
 
''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''': Set type of flower in flower pot
 
* '''6''': Set base color and patterns on a banner
 
* '''7''': Set the data for a Structure tile entity
 
* '''8''': Set the destination for a end gateway
 
* '''9''': Set the text on a sign
 
* '''10''': Declare a shulker box, no data appears to be sent and the client seems to do fine without this packet. Perhaps it is a leftover from earlier versions?
 
* '''11''': Set the color of a bed
 
 
 
==== Block Action ====
 
 
 
This packet is used for a number of actions and animations performed by blocks, usually non-persistent.
 
 
 
See [[Block Actions]] for a list of values.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x0A
+
  | <code>minecraft.sneak_Time</code>
|rowspan="4"| Play
+
  | 3
|rowspan="4"| Client
+
  | Time
| Location
 
  | Position
 
  | Block coordinates
 
 
  |-
 
  |-
  | Action ID (Byte 1)
+
  | <code>minecraft.walk_one_cm</code>
  | Unsigned Byte
+
  | 4
  | Varies depending on block — see [[Block Actions]]
+
  | Distance
 +
|-
 +
| <code>minecraft.crouch_one_cm</code>
 +
| 5
 +
| Distance
 
  |-
 
  |-
  | Action Param (Byte 2)
+
  | <code>minecraft.sprint_one_cm</code>
  | Unsigned Byte
+
  | 6
  | Varies depending on block — see [[Block Actions]]
+
  | Distance
 
  |-
 
  |-
  | Block Type
+
  | <code>minecraft.swim_one_cm</code>
| VarInt
+
  | 7
| The block type ID for the block, not including metadata/damage value.  This must match the block at the given coordinates.
+
  | Distance
  |}
 
 
 
==== Block Change ====
 
 
 
Fired whenever a block is changed within the render distance.
 
 
 
{{Warning2|Changing a block in a chunk that is not loaded is not a stable action. The Notchian client currently uses a ''shared'' empty chunk which is modified for all block changes in unloaded chunks; while in 1.9 this chunk never renders in older versions the changed block will appear in all copies of the empty chunk.  Servers should avoid sending block changes in unloaded chunks and clients should ignore such packets.}}
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x0B
+
  | <code>minecraft.fall_one_cm</code>
|rowspan="2"| Play
+
  | 8
|rowspan="2"| Client
+
  | Distance
| Location
 
  | Position
 
  | Block Coordinates
 
 
  |-
 
  |-
  | Block ID
+
  | <code>minecraft.climb_one_cm</code>
| VarInt
+
  | 9
| The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}} (When reading data: <code>type = id &gt;&gt; 4</code>, <code>meta = id & 15</code>, when writing data: <code>id = type &lt;&lt; 4 &#124; (meta &amp; 15)</code>)
+
  | Distance
  |}
 
 
 
==== Boss Bar ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
  ! State
 
! Bound To
 
!colspan="2"| Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="14"| 0x0C
+
  | <code>minecraft.fly_one_cm</code>
|rowspan="14"| Play
+
  | 10
|rowspan="14"| Client
+
  | Distance
|colspan="2"| UUID
 
  | UUID
 
  | Unique ID for this bar
 
 
  |-
 
  |-
  |colspan="2"| Action
+
  | <code>minecraft.dive_one_cm</code>
  | VarInt Enum
+
  | 11
  | Determines the layout of the remaining packet
+
  | Distance
 
  |-
 
  |-
  ! Action
+
  | <code>minecraft.minecart_one_cm</code>
  ! Field Name
+
  | 12
  !
+
  | Distance
!
 
 
  |-
 
  |-
  |rowspan="5"| 0: add
+
  | <code>minecraft.boat_one_cm</code>
| Title
+
  | 13
  | [[Chat]]
+
  | Distance
  |  
 
 
  |-
 
  |-
  | Health
+
  | <code>minecraft.pig_one_cm</code>
  | Float
+
  | 14
  | 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.
+
  | Distance
 
  |-
 
  |-
  | Color
+
  | <code>minecraft.horse_one_cm</code>
  | VarInt Enum
+
  | 15
  | Color ID (see below)
+
  | Distance
 
  |-
 
  |-
  | Division
+
  | <code>minecraft.aviate_one_cm</code>
  | VarInt Enum
+
  | 16
  | Type of division (see below)
+
  | Distance
 
  |-
 
  |-
  | Flags
+
  | <code>minecraft.jump</code>
  | Unsigned Byte
+
  | 17
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music)
+
  | None
 
  |-
 
  |-
  | 1: remove
+
  | <code>minecraft.drop</code>
  | ''no fields''
+
  | 18
  | ''no fields''
+
  | None
| Removes this boss bar
 
 
  |-
 
  |-
  | 2: update health
+
  | <code>minecraft.damage_dealt</code>
  | Health
+
  | 19
  | Float
+
  | Damage
| as above
 
 
  |-
 
  |-
  | 3: update title
+
  | <code>minecraft.damage_taken</code>
  | Title
+
  | 20
| [[Chat]]
+
  | Damage
  |  
 
 
  |-
 
  |-
  |rowspan="2"| 4: update style
+
  | <code>minecraft.deaths</code>
  | Color
+
| 21
  | VarInt Enum
+
| None
  | Color ID (see below)
+
|-
 +
  | <code>minecraft.mob_kills</code>
 +
  | 22
 +
  | None
 
  |-
 
  |-
  | Dividers
+
  | <code>minecraft.animals_bred</code>
  | VarInt Enum
+
  | 23
  | as above
+
  | None
 
  |-
 
  |-
  | 5: update flags
+
  | <code>minecraft.player_kills</code>
  | Flags
+
  | 24
  | Unsigned Byte
+
  | None
| as above
 
 
  |-
 
  |-
  |}
+
  | <code>minecraft.fish_caught</code>
 
+
| 25
{| class="wikitable"
+
  | None
  ! ID
 
! Color
 
 
  |-
 
  |-
  | 0
+
  | <code>minecraft.talked_to_villager</code>
  | Pink
+
  | 26
 +
| None
 
  |-
 
  |-
  | 1
+
  | <code>minecraft.traded_with_villager</code>
  | Blue
+
  | 27
 +
| None
 
  |-
 
  |-
  | 2
+
  | <code>minecraft.eat_cake_slice</code>
  | Red
+
  | 28
 +
| None
 
  |-
 
  |-
  | 3
+
  | <code>minecraft.fill_cauldron</code>
  | Green
+
  | 29
 +
| None
 
  |-
 
  |-
  | 4
+
  | <code>minecraft.use_cauldron</code>
  | Yellow
+
  | 30
 +
| None
 
  |-
 
  |-
  | 5
+
  | <code>minecraft.clean_armor</code>
  | Purple
+
  | 31
 +
| None
 
  |-
 
  |-
  | 6
+
  | <code>minecraft.clean_banner</code>
  | White
+
  | 32
  |}
+
  | None
 
+
|-
{| class="wikitable"
+
| <code>minecraft.interact_with_brewingstand</code>
  ! ID
+
  | 33
  ! Type of division
+
  | None
 +
|-
 +
| <code>minecraft.interact_with_beacon</code>
 +
| 34
 +
| None
 
  |-
 
  |-
  | 0
+
  | <code>minecraft.inspect_dropper</code>
  | No division
+
  | 35
 +
| None
 
  |-
 
  |-
  | 1
+
  | <code>minecraft.inspect_hopper</code>
  | 6 notches
+
  | 36
 +
| None
 
  |-
 
  |-
  | 2
+
  | <code>minecraft.inspect_dispenser</code>
  | 10 notches
+
  | 37
 +
| None
 
  |-
 
  |-
  | 3
+
  | <code>minecraft.play_noteblock</code>
  | 12 notches
+
  | 38
 +
| None
 
  |-
 
  |-
  | 4
+
  | <code>minecraft.tune_noteblock</code>
  | 20 notches
+
  | 39
  |}
+
  | None
 
 
==== 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="1"| 0x0D
+
  | <code>minecraft.pot_flower</code>
  |rowspan="1"| Play
+
| 40
  |rowspan="1"| Client
+
| None
  | Difficulty
+
|-
  | Unsigned Byte
+
| <code>minecraft.trigger_trapped_chest</code>
  | 0: peaceful, 1: easy, 2: normal, 3: hard
+
| 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
 
  |}
 
  |}
  
==== Chat Message (clientbound) ====  
+
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.
  
Identifying the difference between Chat/System Message is important as it helps respect the user's chat visibility optionsSee [[Chat#Processing chat|processing chat]] for more info about these positions.
+
Block break animations can still be applied on air; the animation will remain visible although there is no block being brokenHowever, if this is applied to a transparent block, odd graphical effects may happen, including water losing its transparency. (An effect similar to this can be seen in normal gameplay when breaking ice blocks)
  
{{warning2|Game info accepts json formatting but does not display it, although the deprecated §-based formatting works. This is not an issue when using the [[#Title|Title]] packet, so prefer that packet for displaying information in that slot. See [https://bugs.mojang.com/browse/MC-119145 MC-119145] for more information.}}
+
If you need to display several break animations at the same time you have to give each of them a unique Entity ID. The entity ID does not need to correspond to an actual entity on the client. It is valid to use a randomly generated number.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,024: Line 1,040:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x0E
+
  |rowspan="3"| 0x08
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | JSON Data
+
  | Entity ID
  | [[Chat]]
+
  | VarInt
  | Limited to 32767 bytes
+
  | Entity ID of the entity breaking the block
 
  |-
 
  |-
 +
| Location
 
  | Position
 
  | Position
 +
| Block Position
 +
|-
 +
| Destroy Stage
 
  | Byte
 
  | Byte
  | 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
+
  | 0–9 to set it, any other value to remove it
 
  |}
 
  |}
  
==== Multi Block Change ====
+
==== Update Block Entity ====
  
Fired whenever 2 or more blocks are changed within the same chunk on the same tick.
+
Sets the block entity associated with the block at the given location.
 
 
{{Warning|Changing blocks in chunks not loaded by the client is unsafe (see note on [[#Block Change|Block Change]]).}}
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,046: Line 1,064:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="6"| 0x0F
+
  |rowspan="3"| 0x09
  |rowspan="6"| Play
+
  |rowspan="3"| Play
  |rowspan="6"| Client
+
  |rowspan="3"| Client
  |colspan="2"| Chunk X
+
  | Location
  |colspan="2"| Int
+
  | Position
  | Chunk X coordinate
+
  |  
 
  |-
 
  |-
  |colspan="2"| Chunk Z
+
  | Action
|colspan="2"| Int
 
| Chunk Z coordinate
 
|-
 
|colspan="2"| Record Count
 
|colspan="2"| VarInt
 
| Number of elements in the following array, i.e. the number of blocks affected
 
|-
 
|rowspan="3"| Record
 
| Horizontal Position
 
|rowspan="3"| Array
 
 
  | Unsigned Byte
 
  | Unsigned Byte
  | The 4 most significant bits (<code>0xF0</code>) encode the X coordinate, relative to the chunk. The 4 least significant bits (<code>0x0F</code>) encode the Z coordinate, relative to the chunk.
+
  | The type of update to perform, see below
 
  |-
 
  |-
  | Y Coordinate
+
  | NBT Data
  | Unsigned Byte
+
  | [[NBT|NBT Tag]]
| Y coordinate of the block
+
  | Data to set. May be a TAG_END (0), in which case the block entity at the given location is removed (though this is not required since the client will remove the block entity automatically on chunk unload or block removal)
  |-
 
  | Block ID
 
| VarInt
 
| The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}} (When reading data: <code>type = id &gt;&gt; 4</code>, <code>meta = id & 15</code>, when writing data: <code>id = type &lt;&lt; 4 &#124; (meta &amp; 15)</code>)
 
 
  |}
 
  |}
  
To decode the position into a world position:
+
''Action'' field:
  
<syntaxhighlight lang="java">
+
* '''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.)
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
+
* '''2''': Set command block text (command and last execution status)
worldY = vertPos;
+
* '''3''': Set the level, primary, and secondary powers of a beacon
worldZ = (horizPos & 15) + (chunkZ * 16);
+
* '''4''': Set rotation and skin of mob head
</syntaxhighlight>
+
* '''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.
  
==== Tab-Complete (clientbound) ====
+
See [[Block Actions]] for a list of values.
  
The server responds with a list of auto-completions of the last word sent to it. In the case of regular chat, this is a player username. Command names and parameters are also supported. The client sorts these alphabetically before listing them.
+
{{Warning2|This packet uses a block ID, not a block state. Unfortunately, block IDs are not directly included in the output from [[Data Generators]], but can manually be calculated.}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,100: Line 1,116:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x10
+
  |rowspan="4"| 0x0A
  |rowspan="2"| Play
+
  |rowspan="4"| Play
  |rowspan="2"| Client
+
  |rowspan="4"| Client
  | Count
+
  | 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
 
  | VarInt
  | Number of elements in the following array
+
  | The block type ID for the block. This must match the block at the given coordinates.
  |-
 
| Matches
 
| Array of String (32767)
 
| One eligible command, note that each command is sent separately instead of in a single string, hence the need for Count
 
 
  |}
 
  |}
  
==== Declare Commands ====
+
==== Block Change ====
  
Lists all of the commands on the server, and how they are parsed.
+
Fired whenever a block is changed within the render distance.
  
This is a directed graph, with one root nodeEach redirect or child node must refer only to nodes that have already been declared.
+
{{Warning2|Changing a block in a chunk that is not loaded is not a stable action.  The Notchian client currently uses a ''shared'' empty chunk which is modified for all block changes in unloaded chunks; while in 1.9 this chunk never renders in older versions the changed block will appear in all copies of the empty chunkServers should avoid sending block changes in unloaded chunks and clients should ignore such packets.}}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,126: Line 1,150:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x11
+
  |rowspan="2"| 0x0B
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Client
+
  |rowspan="2"| Client
  | Count
+
  | Location
  | VarInt
+
  | Position
  | Number of elements in the following array
+
  | Block Coordinates
 
  |-
 
  |-
  | Nodes
+
  | Block ID
| Array of [[Command Data|Node]]
 
| An array of nodes
 
|-
 
| Root index
 
 
  | VarInt
 
  | VarInt
  | Index of the <code>root</code> node in the previous array
+
  | The new block state ID for the block as given in the {{Minecraft Wiki|Data values#Block IDs|global palette}}. See that section for more information.
 
  |}
 
  |}
  
For more information on this packet, see the [[Command Data]] article.
+
==== Boss Bar ====  
 
 
==== Confirm Transaction (clientbound) ====
 
 
 
A packet from the server indicating whether a request from the client was accepted, or whether there was a conflict (due to lag).  If the packet was not accepted, the client must respond with a [[#Confirm Transaction (serverbound)|serverbound confirm transaction]] packet.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,152: Line 1,168:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x12
+
  |rowspan="14"| 0x0C
  |rowspan="3"| Play
+
  |rowspan="14"| Play
  |rowspan="3"| Client
+
  |rowspan="14"| Client
  | Window ID
+
  |colspan="2"| UUID
  | Byte
+
| UUID
  | The ID of the window that the action occurred in
+
| Unique ID for this bar
 +
  |-
 +
  |colspan="2"| Action
 +
| VarInt Enum
 +
| Determines the layout of the remaining packet
 
  |-
 
  |-
  | Action Number
+
  ! Action
  | Short
+
  ! Field Name
  | 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
+
  |rowspan="5"| 0: add
  | Boolean
+
  | Title
  | Whether the action was accepted
+
  | [[Chat]]
  |}
+
  |  
 
+
|-
==== Close Window (clientbound) ====
+
| Health
 
+
| Float
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.
+
| 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.
 
+
|-
{| class="wikitable"
+
  | Color
  ! Packet ID
+
  | VarInt Enum
  ! State
+
  | Color ID (see below)
  ! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  | 0x13
+
  | Division
  | Play
+
  | VarInt Enum
  | Client
+
  | Type of division (see below)
| Window ID
 
| Unsigned Byte
 
| This is the ID of the window that was closed. 0 for inventory.
 
|}
 
 
 
==== Open Window ====
 
 
 
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| 0x14
+
  | Flags
|rowspan="5"| Play
 
|rowspan="5"| Client
 
| Window ID
 
 
  | Unsigned Byte
 
  | Unsigned Byte
  | A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
+
  | Bit mask. 0x1: should darken sky, 0x2: is dragon bar (used to play end music), 0x04: create fog (previously was also controlled by 0x02)
 
  |-
 
  |-
  | Window Type
+
  | 1: remove
  | String (32)
+
  | ''no fields''
  | The window type to use for display. See [[Inventory]] for a list.
+
  | ''no fields''
  |-
+
| Removes this boss bar
  | Window Title
+
|-
 +
| 2: update health
 +
| Health
 +
| Float
 +
| as above
 +
  |-
 +
  | 3: update title
 +
| Title
 
  | [[Chat]]
 
  | [[Chat]]
  | The title of the window
+
  |  
 +
|-
 +
|rowspan="2"| 4: update style
 +
| Color
 +
| VarInt Enum
 +
| Color ID (see below)
 +
|-
 +
| Dividers
 +
| VarInt Enum
 +
| as above
 
  |-
 
  |-
  | Number Of Slots
+
  | 5: update flags
 +
| Flags
 
  | Unsigned Byte
 
  | Unsigned Byte
  | Number of slots in the window (excluding the number of slots in the player inventory). Always 0 for non-storage windows (e.g. Workbench, Anvil).
+
  | as above
 
  |-
 
  |-
| Entity ID
 
| Optional Int
 
| EntityHorse's EID. Only sent when Window Type is “EntityHorse”
 
 
  |}
 
  |}
 
See [[Inventory]] for further information.
 
 
==== Window Items ====
 
[[File:Inventory-slots.png|thumb|The inventory slots]]
 
 
Sent by the server when items in multiple slots (in a window) are added/removed. This includes the main inventory, equipped armour and crafting slots.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Color
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="3"| 0x15
+
  | 0
  |rowspan="3"| Play
+
  | Pink
|rowspan="3"| Client
 
| Window ID
 
| Unsigned Byte
 
| The ID of window which items are being sent for. 0 for player inventory.
 
 
  |-
 
  |-
  | Count
+
  | 1
  | Short
+
  | Blue
  | Number of elements in the following array
+
  |-
 +
| 2
 +
| Red
 +
|-
 +
| 3
 +
| Green
 +
|-
 +
| 4
 +
| Yellow
 +
|-
 +
| 5
 +
| Purple
 
  |-
 
  |-
  | Slot Data
+
  | 6
| Array of [[Slot Data|Slot]]
+
  | White
  |  
 
 
  |}
 
  |}
  
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
+
{| class="wikitable"
 +
! ID
 +
! Type of division
 +
|-
 +
| 0
 +
| No division
 +
|-
 +
| 1
 +
| 6 notches
 +
|-
 +
| 2
 +
| 10 notches
 +
|-
 +
| 3
 +
| 12 notches
 +
|-
 +
| 4
 +
| 20 notches
 +
|}
  
==== Window Property ====
+
==== Server Difficulty ====
  
This packet is used to inform the client that part of a GUI window should be updated.
+
Changes the difficulty setting in the client's option menu
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,273: Line 1,298:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x16
+
  |rowspan="2"| 0x0D
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Client
+
  |rowspan="2"| Client
  | Window ID
+
  | Difficulty
 
  | Unsigned Byte
 
  | Unsigned Byte
  |  
+
  | 0: peaceful, 1: easy, 2: normal, 3: hard
 
  |-
 
  |-
  | Property
+
  | Difficulty locked?
  | Short
+
  | Boolean
  | 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.
+
==== 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"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  ! Window type
+
  |rowspan="2"| 0x0E
  ! Property
+
  |rowspan="2"| Play
  ! Value
+
  |rowspan="2"| Client
 +
| JSON Data
 +
| [[Chat]]
 +
| Limited to 32767 bytes
 
  |-
 
  |-
  |rowspan="4"| Furnace
+
  | Position
  | 0: Fire icon (fuel left)
+
| Byte
  | counting from fuel burn time down to 0 (in-game ticks)
+
  | 0: chat (chat box), 1: system message (chat box), 2: game info (above hotbar).
  |-
+
  |}
  | 1: Maximum fuel burn time
+
 
  | fuel burn time or 0 (in-game ticks)
+
==== Multi Block Change ====
  |-
+
 
  | 2: Progress arrow
+
Fired whenever 2 or more blocks are changed within the same chunk on the same tick.
  | counting from 0 to maximum progress (in-game ticks)
+
 
 +
{{Warning|Changing blocks in chunks not loaded by the client is unsafe (see note on [[#Block Change|Block Change]]).}}
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
  ! State
 +
  ! Bound To
 +
  !colspan="2"| Field Name
 +
  !colspan="2"| Field Type
 +
  ! Notes
 
  |-
 
  |-
  | 3: Maximum progress
+
  |rowspan="6"| 0x0F
  | always 200 on the notchian server
+
|rowspan="6"| Play
 +
|rowspan="6"| Client
 +
|colspan="2"| Chunk X
 +
|colspan="2"| Int
 +
  | Chunk X coordinate
 
  |-
 
  |-
  |rowspan="10"| Enchantment Table
+
  |colspan="2"| Chunk Z
  | 0: Level requirement for top enchantment slot
+
  |colspan="2"| Int
|rowspan="3"| The enchantment's xp level requirement
+
| Chunk Z coordinate
 
  |-
 
  |-
  | 1: Level requirement for middle enchantment slot
+
  |colspan="2"| Record Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array, i.e. the number of blocks affected
 
  |-
 
  |-
  | 2: Level requirement for bottom enchantment slot
+
  |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.
 
  |-
 
  |-
  | 3: The enchantment seed
+
  | Y Coordinate
  | 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>).
+
  | Unsigned Byte
 +
| Y coordinate of the block
 
  |-
 
  |-
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
+
  | Block ID
  |rowspan="3"| The enchantment id (set to -1 to hide it)
+
| 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.
| 5: Enchantment ID shown on mouse hover over middle enchantment slot
+
  |}
|-
+
 
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
+
To decode the position into a world position:
  |-
+
 
  | 7: Enchantment level shown on mouse hover over the top slot
+
<syntaxhighlight lang="java">
  |rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
+
worldX = (horizPos >> 4 & 15) + (chunkX * 16);
 +
worldY = vertPos;
 +
worldZ = (horizPos & 15) + (chunkZ * 16);
 +
</syntaxhighlight>
 +
 
 +
==== Tab-Complete (clientbound) ====
 +
 
 +
The server responds with a list of auto-completions of the last word sent to it. In the case of regular chat, this is a player username. Command names and parameters are also supported. The client sorts these alphabetically before listing them.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
  ! State
 +
  ! Bound To
 +
  !colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  | 8: Enchantment level shown on mouse hover over the middle slot
+
  |rowspan="8"| 0x10
 +
|rowspan="8"| Play
 +
|rowspan="8"| Client
 
  |-
 
  |-
  | 9: Enchantment level shown on mouse hover over the bottom slot
+
  |colspan="2"| ID
 +
|colspan="2"| VarInt
 +
| Transaction ID
 
  |-
 
  |-
  |rowspan="3"| Beacon
+
  |colspan="2"| Start
  | 0: Power level
+
  |colspan="2"| VarInt
  | 0-4, controls what effect buttons are enabled
+
  | Start of the text to replace
 
  |-
 
  |-
  | 1: First potion effect
+
  |colspan="2"| Length
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the first effect, or -1 if no effect
+
  |colspan="2"| VarInt
 +
| Length of the text to replace
 
  |-
 
  |-
  | 2: Second potion effect
+
  |colspan="2"| Count
  | {{Minecraft Wiki|Data values#Status effects|Potion effect ID}} for the second effect, or -1 if no effect
+
  |colspan="2"| VarInt
 +
| Number of elements in the following array
 
  |-
 
  |-
  | Anvil
+
  |rowspan="3"| Matches
  | 0: Repair cost
+
| Match
  | The repair's cost in xp levels
+
  |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.
 
  |-
 
  |-
  |rowspan="2"| Brewing Stand
+
  | Has tooltip
  | 0: Brew time
+
  | Boolean
  | 0 – 400, with 400 making the arrow empty, and 0 making the arrow full
+
  | True if the following is present
 
  |-
 
  |-
  | 1: Fuel time
+
  | Tooltip
  | 0 - 20, with 0 making the arrow empty, and 20 making the arrow full
+
  | Optional [[Chat]]
 +
| Tooltip to display; only present if previous boolean is true
 
  |}
 
  |}
  
==== Set Slot ====
+
==== Declare Commands ====
  
Sent by the server when an item in a slot (in a window) is added/removed.
+
Lists all of the commands on the server, and how they are parsed.
 +
 
 +
This is a directed graph, with one root node.  Each redirect or child node must refer only to nodes that have already been declared.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,369: Line 1,449:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x17
+
  |rowspan="3"| 0x11
 
  |rowspan="3"| Play
 
  |rowspan="3"| Play
 
  |rowspan="3"| Client
 
  |rowspan="3"| Client
  | Window ID
+
  | Count
  | Byte
+
  | VarInt
  | 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).
+
  | Number of elements in the following array
 
  |-
 
  |-
  | Slot
+
  | Nodes
  | Short
+
  | Array of [[Command Data|Node]]
  | The slot that should be updated
+
  | An array of nodes
 
  |-
 
  |-
  | Slot Data
+
  | Root index
  | [[Slot Data|Slot]]
+
  | VarInt
  |  
+
  | Index of the <code>root</code> node in the previous array
 
  |}
 
  |}
  
To set the cursor (the item currently dragged with the mouse), use -1 as Window ID and as Slot.
+
For more information on this packet, see the [[Command Data]] article.
  
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.
+
==== Confirm Transaction (clientbound) ====
  
==== Set Cooldown ====
+
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.
 
 
Applies a cooldown period to all items with the given type.  Used by the Notchian server with enderpearls.  This packet should be sent when the cooldown starts and also when the cooldown ends (to compensate for lag), although the client will end the cooldown automatically. Can be applied to any item, note that interactions still get sent to the server with the item but the client does not play the animation nor attempt to predict results (i.e block placing).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,401: Line 1,479:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x18
+
  |rowspan="3"| 0x12
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | Item ID
+
  | Window ID
  | VarInt
+
  | Byte
  | Numeric ID of the item to apply a cooldown to.
+
  | 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.
 
  |-
 
  |-
  | Cooldown Ticks
+
  | Accepted
  | VarInt
+
  | Boolean
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
+
  | Whether the action was accepted
  |}
+
  |}
  
==== Plugin Message (clientbound) ====
+
==== Close Window (clientbound) ====
  
{{Main|Plugin channels}}
+
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.
 
 
Mods and plugins can use this to send their data. Minecraft itself uses a number of [[plugin channel]]s. These internal channels are prefixed with <code>MC|</code>.
 
 
 
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,429: Line 1,507:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x19
+
  | 0x13
  |rowspan="2"| Play
+
  | Play
  |rowspan="2"| Client
+
  | Client
  | Channel
+
  | Window ID
| String (20)
+
  | Unsigned Byte
| Name of the [[plugin channel]] used to send the data
+
  | This is the ID of the window that was closed. 0 for inventory.
|-
 
| Data
 
  | Byte Array
 
  | Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].  The length of this array must be inferred from the packet length.
 
 
  |}
 
  |}
  
==== Named Sound Effect ====
+
==== Window Items ====
{{See also|#Sound Effect}}
+
[[File:Inventory-slots.png|thumb|The inventory slots]]
  
Used to play a sound effect on the client. Custom sounds may be added by resource packs.
+
Sent by the server when items in multiple slots (in a window) are added/removed. This includes the main inventory, equipped armour and crafting slots.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,454: Line 1,528:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x1A
+
  |rowspan="3"| 0x14
  |rowspan="7"| Play
+
  |rowspan="3"| Play
  |rowspan="7"| Client
+
  |rowspan="3"| Client
  | Sound Name
+
  | Window ID
  | String (256)
+
  | Unsigned Byte
  | All sound effect names as of 1.12.2 can be seen [http://pokechu22.github.io/Burger/1.12.2.html#sounds here].
+
  | The ID of window which items are being sent for. 0 for player inventory.
 
  |-
 
  |-
  | Sound Category
+
  | Count
  | VarInt Enum
+
  | Short
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
  | Number of elements in the following array
 
  |-
 
  |-
  | Effect Position X
+
  | Slot Data
| Int
+
  | Array of [[Slot Data|Slot]]
| 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
 
 
  |}
 
  |}
  
==== Disconnect (play) ====
+
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 +
 
 +
==== Window Property ====
  
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.
+
This packet is used to inform the client that part of a GUI window should be updated.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,498: Line 1,558:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  | 0x1B
+
  |rowspan="3"| 0x15
  | Play
+
  |rowspan="3"| Play
  | Client
+
  |rowspan="3"| Client
  | Reason
+
  | Window ID
  | [[Chat]]
+
| Unsigned Byte
  | Displayed to the client when the connection terminates.
+
|
 +
|-
 +
| Property
 +
  | Short
 +
  | The property to be updated, see below
 +
|-
 +
| Value
 +
| Short
 +
| The new value for the property, see below
 
  |}
 
  |}
  
==== Entity Status ====
+
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.
 
 
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
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x1C
+
! Window type
  |rowspan="2"| Play
+
! Property
  |rowspan="2"| Client
+
! Value
  | Entity ID
+
  |-
  | Int
+
  |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)
 
  |-
 
  |-
  | Entity Status
+
  | 2: Progress arrow
  | Byte Enum
+
  | counting from 0 to maximum progress (in-game ticks)
| See below
 
|}
 
 
 
See [[Entity statuses]] for a list of which statuses are valid for each type of entity.
 
 
 
==== NBT Query Response ====
 
 
 
Sent in response to [[#Query Block NBT|Query Block NBT]] or [[#Query Entity NBT|Query Entity NBT]].
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x1D
+
  | 3: Maximum progress
|rowspan="2"| Play
+
  | always 200 on the notchian server
|rowspan="2"| Client
 
| Transaction ID
 
| VarInt
 
  | Can be compared to the one sent in the original query packet.
 
 
  |-
 
  |-
  | NBT
+
  |rowspan="10"| Enchantment Table
| [[NBT|NBT Tag]]
+
  | 0: Level requirement for top enchantment slot
  | The NBT of the block or entity.  May be a TAG_END (0) in which case no NBT is present.
+
  |rowspan="3"| The enchantment's xp level requirement
  |}
 
 
 
==== Explosion ====
 
 
 
Sent when an explosion occurs (creepers, TNT, and ghast fireballs).
 
 
 
Each block in Records is set to air. Coordinates for each axis in record is int(X) + record.x
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="9"| 0x1E
+
  | 1: Level requirement for middle enchantment slot
|rowspan="9"| Play
 
|rowspan="9"| Client
 
| X
 
| Float
 
|
 
 
  |-
 
  |-
  | Y
+
  | 2: Level requirement for bottom enchantment slot
| Float
 
|
 
 
  |-
 
  |-
  | Z
+
  | 3: The enchantment seed
  | Float
+
  | 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>).
  |
 
 
  |-
 
  |-
  | Radius
+
  | 4: Enchantment ID shown on mouse hover over top enchantment slot
  | Float
+
  |rowspan="3"| The enchantment id (set to -1 to hide it), see below for values
| Currently unused in the client
 
 
  |-
 
  |-
  | Record Count
+
  | 5: Enchantment ID shown on mouse hover over middle enchantment slot
| Int
 
| Number of elements in the following array
 
 
  |-
 
  |-
  | Records
+
  | 6: Enchantment ID shown on mouse hover over bottom enchantment slot
| 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
+
  | 7: Enchantment level shown on mouse hover over the top slot
  | Float
+
  |rowspan="3"| The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant
| X velocity of the player being pushed by the explosion
 
 
  |-
 
  |-
  | Player Motion Y
+
  | 8: Enchantment level shown on mouse hover over the middle slot
| Float
 
| Y velocity of the player being pushed by the explosion
 
 
  |-
 
  |-
  | Player Motion Z
+
  | 9: Enchantment level shown on mouse hover over the bottom slot
  | Float
+
|-
  | Z velocity of the player being pushed by the explosion
+
|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
 
  |}
 
  |}
  
==== Unload Chunk ====
+
For an enchanting table, the following numerical IDs are used:
 
 
Tells the client to unload a chunk column.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! Numerical ID
  ! State
+
  ! Enchantment ID
  ! Bound To
+
  ! Enchantment Name
  ! Field Name
+
|-
  ! Field Type
+
| 0
  ! Notes
+
| minecraft:protection
 +
| Protection
 +
|-
 +
  | 1
 +
  | minecraft:fire_protection
 +
  | Fire Protection
 
  |-
 
  |-
  |rowspan="2"| 0x1F
+
  | 2
|rowspan="2"| Play
+
  | minecraft:feather_falling
|rowspan="2"| Client
+
  | Feather Falling
| Chunk X
 
  | Int
 
  | Block coordinate divided by 16, rounded down
 
 
  |-
 
  |-
  | Chunk Z
+
  | 3
  | Int
+
  | minecraft:blast_protection
  | Block coordinate divided by 16, rounded down
+
  | Blast Protection
|}
 
 
 
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"| 0x20
+
  | 4
|rowspan="2"| Play
+
  | minecraft:projectile_protection
|rowspan="2"| Client
+
  | Projectile Protection
| Reason
 
  | Unsigned Byte
 
  | See below
 
 
  |-
 
  |-
  | Value
+
  | 5
  | Float
+
  | minecraft:respiration
| Depends on Reason
+
  | Respiration
  |}
 
 
 
''Reason codes'':
 
 
 
{| class="wikitable"
 
! Reason
 
! Effect
 
! Value
 
 
  |-
 
  |-
  | 0
+
  | 6
  | Invalid Bed
+
  | minecraft:aqua_affinity
  | Would be used to switch between messages, but the only used message is 0 for invalid bed
+
  | Aqua Affinity
 
  |-
 
  |-
  | 1
+
  | 7
  | End raining
+
  | minecraft:thorns
  |  
+
  | Thorns
 
  |-
 
  |-
  | 2
+
  | 8
  | Begin raining
+
  | minecraft:depth_strider
  |  
+
  | Depth Strider
 
  |-
 
  |-
  | 3
+
  | 9
  | Change gamemode
+
  | minecraft:frost_walker
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
+
  | Frost Walker
 
  |-
 
  |-
  | 4
+
  | 10
  | Exit end
+
  | minecraft:binding_curse
  | 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.
+
  | Curse of Binding
 
  |-
 
  |-
  | 5
+
  | 11
  | Demo message
+
  | minecraft:sharpness
  | 0: Show welcome to demo screen, 101: Tell movement controls, 102: Tell jump control, 103: Tell inventory control
+
| Sharpness
  |-  
+
  |-
  | 6
+
| 12
  | Arrow hitting player
+
| minecraft:smite
  | Appears to be played when an arrow strikes another player in Multiplayer
+
| Smite
 +
|-
 +
| 13
 +
| minecraft:bane_of_arthropods
 +
| Bane of Arthropods
 +
|-
 +
| 14
 +
| minecraft:knockback
 +
| Knockback
 +
  |-
 +
  | 15
 +
  | minecraft:fire_aspect
 +
  | Fire Aspect
 
  |-
 
  |-
  | 7
+
  | 16
  | Fade value
+
  | minecraft:looting
  | The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
+
  | Looting
 
  |-
 
  |-
  | 8
+
  | 17
  | Fade time
+
  | minecraft:sweeping
  | Time in ticks for the sky to fade
+
  | Sweeping Edge
 
  |-
 
  |-
  | 10
+
  | 18
  | Play elder guardian mob appearance (effect and sound)
+
  | minecraft:efficiency
  |  
+
  | Efficiency
|}
 
 
 
==== Keep Alive (clientbound) ====
 
 
 
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same packet. If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.
 
 
 
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x21
+
  | 19
  |rowspan="1"| Play
+
| minecraft:silk_touch
  |rowspan="1"| Client
+
| Silk Touch
  | Keep Alive ID
+
|-
  | Long
+
| 20
  |  
+
| minecraft:unbreaking
  |}
+
| Unbreaking
 
+
|-
==== Chunk Data ====
+
| 21
{{Main|Chunk Format}}
+
| minecraft:fortune
{{See also|#Unload Chunk}}
+
| 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 ====
  
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimenison the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.  This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with [[#Update Block Entity|Update Block Entity]] later).
+
Sent by the server when an item in a slot (in a window) is added/removed.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,744: Line 1,798:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x22
+
  |rowspan="3"| 0x16
  |rowspan="8"| Play
+
  |rowspan="3"| Play
  |rowspan="8"| Client
+
  |rowspan="3"| Client
  | Chunk X
+
  | Window ID
  | Int
+
  | Byte
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  | The window which is being updated. 0 for player inventory. Note that all known window types include the player inventory. This packet will only be sent for the currently opened window while the player is performing actions, even if it affects the player inventory. After the window is closed, a number of these packets are sent to update the player's inventory window (0).
 
  |-
 
  |-
  | Chunk Z
+
  | Slot
  | Int
+
  | Short
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  | The slot that should be updated
 
  |-
 
  |-
  | Ground-Up Continuous
+
  | Slot Data
  | Boolean
+
| [[Slot Data|Slot]]
  | See [[Chunk Format#Ground-up continuous|Chunk Format]]
+
  |  
 +
  |}
 +
 
 +
To set the cursor (the item currently dragged with the mouse), use -1 as Window ID and as Slot.
 +
 
 +
This packet can only be used to edit the hotbar of the player's inventory if window ID is set to 0 (slots 36 through 44).  If the window ID is set to -2, then any slot in the inventory can be used but no add item animation will be played.
 +
 
 +
==== Set Cooldown ====
 +
 
 +
Applies a cooldown period to all items with the given type.  Used by the Notchian server with enderpearls.  This packet should be sent when the cooldown starts and also when the cooldown ends (to compensate for lag), although the client will end the cooldown automatically. Can be applied to any item, note that interactions still get sent to the server with the item but the client does not play the animation nor attempt to predict results (i.e block placing).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | Primary Bit Mask
+
  |rowspan="2"| 0x17
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Item ID
 
  | VarInt
 
  | 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).
+
  | Numeric ID of the item to apply a cooldown to.
|-
 
| Size
 
| VarInt
 
| Size of Data in bytes
 
 
  |-
 
  |-
  | Data
+
  | Cooldown Ticks
| Byte array
 
| See [[Chunk Format#Data structure|data structure]] in Chunk Format
 
|-
 
| Number of block entities
 
 
  | VarInt
 
  | VarInt
  | Number of elements in the following array
+
  | Number of ticks to apply a cooldown for, or 0 to clear the cooldown.
|-
 
| Block entities
 
| Array of [[NBT|NBT Tag]]
 
| All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 
 
  |}
 
  |}
  
==== Effect ====
+
==== Plugin Message (clientbound) ====
 +
 
 +
{{Main|Plugin channels}}
  
Sent when a client is to play a sound or particle effect.
+
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.
  
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.
+
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,794: Line 1,858:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x23
+
  |rowspan="2"| 0x18
  |rowspan="4"| Play
+
  |rowspan="2"| Play
  |rowspan="4"| Client
+
  |rowspan="2"| Client
  | Effect ID
+
  | Channel
  | Int
+
  | Identifier
  | The ID of the effect, see below
+
  | Name of the [[plugin channel]] used to send the data
|-
 
| Location
 
| Position
 
| The location of the effect
 
 
  |-
 
  |-
 
  | Data
 
  | Data
  | Int
+
  | Byte Array
  | Extra data for certain effects, see below
+
  | 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.
|-
 
| Disable Relative Volume
 
  | Boolean
 
| See above
 
 
  |}
 
  |}
  
Effect IDs:
+
==== Named Sound Effect ====
 +
{{See also|#Sound Effect}}
 +
 
 +
Used to play a sound effect on the client. Custom sounds may be added by resource packs.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Name
+
  ! State
  ! Data
+
! Bound To
 +
! Field Name
 +
  ! Field Type
 +
! Notes
 
  |-
 
  |-
  !colspan="3"| Sound
+
  |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].
 
  |-
 
  |-
  | 1000
+
  | Sound Category
  | Dispenser dispenses
+
  | VarInt Enum
  |  
+
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
 
  |-
 
  |-
  | 1001
+
  | Effect Position X
  | Dispenser fails to dispense
+
  | Int
  |  
+
  | Effect X multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 
  |-
 
  |-
  | 1002
+
  | Effect Position Y
  | Dispenser shoots
+
  | Int
  |  
+
  | Effect Y multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 
  |-
 
  |-
  | 1003
+
  | Effect Position Z
  | Ender eye launched
+
  | Int
  |  
+
  | Effect Z multiplied by 8 ([[Data types#Fixed-point numbers|fixed-point number]] with only 3 bits dedicated to the fractional part)
 
  |-
 
  |-
  | 1004
+
  | Volume
  | Firework shot
+
  | Float
  |  
+
  | 1 is 100%, can be more
 
  |-
 
  |-
  | 1005
+
  | Pitch
  | Iron door opened
+
  | 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.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1006
+
  | 0x1A
  | Wooden door opened
+
  | Play
  |  
+
  | Client
  |-
+
| Reason
  | 1007
+
| [[Chat]]
  | Wooden trapdoor opened
+
| Displayed to the client when the connection terminates.
 +
|}
 +
 
 +
==== Entity Status ====
 +
 
 +
Entity statuses generally trigger an animation for an entity.  The available statuses vary by the entity's type (and are available to subclasses of that type as well).
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
  |-
 +
  |rowspan="2"| 0x1B
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
  | Int
 
  |  
 
  |  
 
  |-
 
  |-
  | 1008
+
  | Entity Status
  | Fence gate opened
+
  | 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
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="9"| 0x1C
 +
|rowspan="9"| Play
 +
|rowspan="9"| Client
 +
| X
 +
| Float
 
  |  
 
  |  
 
  |-
 
  |-
  | 1009
+
  | Y
  | Fire extinguished
+
  | Float
 
  |  
 
  |  
 
  |-
 
  |-
  | 1010
+
  | Z
  | Play record
+
  | Float
| Special case, see below for more info
 
|-
 
| 1011
 
| Iron door closed
 
 
  |  
 
  |  
 
  |-
 
  |-
  | 1012
+
  | Radius
  | Wooden door closed
+
  | Float
  |  
+
  | Currently unused in the client
 
  |-
 
  |-
  | 1013
+
  | Record Count
  | Wooden trapdoor closed
+
  | Int
  |  
+
  | Number of elements in the following array
 
  |-
 
  |-
  | 1014
+
  | Records
  | Fence gate closed
+
  | Array of (Byte, Byte, Byte)
  |  
+
  | Each record is 3 signed bytes long, each bytes are the XYZ (respectively) offsets of affected blocks.
 
  |-
 
  |-
  | 1015
+
  | Player Motion X
  | Ghast warns
+
  | Float
  |  
+
  | X velocity of the player being pushed by the explosion
 
  |-
 
  |-
  | 1016
+
  | Player Motion Y
  | Ghast shoots
+
  | Float
  |  
+
  | Y velocity of the player being pushed by the explosion
 
  |-
 
  |-
  | 1017
+
  | Player Motion Z
  | Enderdragon shoots
+
  | Float
  |  
+
  | Z velocity of the player being pushed by the explosion
  |-
+
  |}
| 1018
+
 
  | Blaze shoots
+
==== Unload Chunk ====
  |
+
 
  |-
+
Tells the client to unload a chunk column.
  | 1019
+
 
  | Zombie attacks wood door
+
{| class="wikitable"
  |
+
  ! Packet ID
 +
  ! State
 +
  ! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | 1020
+
  |rowspan="2"| 0x1D
  | Zombie attacks iron door
+
|rowspan="2"| Play
  |  
+
|rowspan="2"| Client
 +
| Chunk X
 +
  | Int
 +
  | Block coordinate divided by 16, rounded down
 
  |-
 
  |-
  | 1021
+
  | Chunk Z
  | Zombie breaks wood door
+
  | Int
  |
+
  | Block coordinate divided by 16, rounded down
 +
|}
 +
 
 +
It is legal to send this packet even if the given chunk is not currently loaded.
 +
 
 +
==== Change Game State ====
 +
 
 +
Used for a wide variety of game state things, from whether to bed use to gamemode to demo messages.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1022
+
  |rowspan="2"| 0x1E
  | Wither breaks block
+
|rowspan="2"| Play
  |
+
|rowspan="2"| Client
 +
| Reason
 +
  | Unsigned Byte
 +
  | See below
 
  |-
 
  |-
  | 1023
+
  | Value
  | Wither spawned
+
  | Float
  |  
+
  | Depends on Reason
 +
|}
 +
 
 +
''Reason codes'':
 +
 
 +
{| class="wikitable"
 +
! Reason
 +
! Effect
 +
! Value
 
  |-
 
  |-
  | 1024
+
  | 0
  | Wither shoots
+
  | Invalid Bed
  |
+
  | Would be used to switch between messages, but the only used message is 0 for invalid bed
 
  |-
 
  |-
  | 1025
+
  | 1
  | Bat takes off
+
  | End raining
|
 
|-
 
| 1026
 
| Zombie infects
 
|
 
|-
 
| 1027
 
| Zombie villager converted
 
|
 
|-
 
| 1028
 
| Ender dragon death
 
|
 
|-
 
| 1029
 
| Anvil destroyed
 
 
  |  
 
  |  
 
  |-
 
  |-
  | 1030
+
  | 2
  | Anvil used
+
  | Begin raining
 
  |  
 
  |  
 
  |-
 
  |-
  | 1031
+
  | 3
  | Anvil landed
+
  | Change gamemode
  |
+
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
 
  |-
 
  |-
  | 1032
+
  | 4
  | Portal travel
+
  | 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
 
  |-
 
  |-
  | 1033
+
  | 7
  | Chorus flower grown
+
  | Fade value
  |
+
  | The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
 
  |-
 
  |-
  | 1034
+
  | 8
  | Chorus flower died
+
  | Fade time
  |  
+
  | Time in ticks for the sky to fade
 
  |-
 
  |-
  | 1035
+
  | 9
| Brewing stand brewed
+
  | Play pufferfish sting sound
  |
 
 
  |-
 
  |-
  | 1036
+
  | 10
  | Iron trapdoor opened
+
  | Play elder guardian mob appearance (effect and sound)
 
  |  
 
  |  
 +
|}
 +
 +
==== Open Horse Window ====
 +
 +
This packet is used exclusively for opening the horse GUI.  [[#Open Window|Open Window]] is used for all other GUIs.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | 1037
+
  |rowspan="3"| 0x1F
  | Iron trapdoor closed
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Window ID?
 +
  | Byte
 
  |
 
  |
 
  |-
 
  |-
  !colspan="3"| Particle
+
  | Number of slots?
 +
| VarInt
 +
|
 
  |-
 
  |-
  | 2000
+
  | Entity ID?
| Spawns 10 smoke particles, e.g. from a fire
+
  | Integer
| Direction, see below
 
|-
 
| 2001
 
| Block break + block break sound
 
| Block state, determined by <code>meta << 12 | block id</code> (this differs from normal global palette use)
 
|-
 
| 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
 
 
  |
 
  |
 
  |}
 
  |}
  
Smoke directions:
+
==== Keep Alive (clientbound) ====
 +
 
 +
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same packet. If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.
 +
 
 +
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! ID
+
  ! Packet ID
  ! Direction
+
  ! State
  |-
+
  ! Bound To
  | 0
+
! Field Name
  | South-East
+
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | 1
+
  |rowspan="1"| 0x20
| South
+
  |rowspan="1"| Play
  |-
+
  |rowspan="1"| Client
| 2
+
  | Keep Alive ID
  | South-West
+
  | Long
|-
+
  |  
| 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 {{Minecraft Wiki|Music Discs|Record ID}} to start a record (or overwrite a currently playing one), any other value will stop the record.
+
==== Chunk Data ====
 +
{{Main|Chunk Format}}
 +
{{See also|#Unload Chunk}}
  
==== Particle ====
+
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).
 
 
Displays the named particle
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,066: Line 2,180:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="11"| 0x24
+
  |rowspan="9"| 0x21
  |rowspan="11"| Play
+
  |rowspan="9"| Play
  |rowspan="11"| Client
+
  |rowspan="9"| Client
  | Particle ID
+
  | Chunk X
 
  | Int
 
  | Int
  | See below
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | Long Distance
+
  | Chunk Z
  | Boolean
+
  | Int
  | If true, particle distance increases from 256 to 65536
+
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | X
+
  | Full chunk
  | Float
+
  | Boolean
  | X position of the particle
+
  | See [[Chunk Format#Full chunk|Chunk Format]]
 
  |-
 
  |-
  | Y
+
  | Primary Bit Mask
  | Float
+
  | VarInt
  | Y position of the particle
+
  | 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).
 
  |-
 
  |-
  | Z
+
  | Heightmaps
  | Float
+
  | [[NBT]]
  | Z position of the particle
+
  | 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
 
  |-
 
  |-
  | Offset X
+
  | Data
  | Float
+
  | Byte array
  | This is added to the X position after being multiplied by random.nextGaussian()
+
  | See [[Chunk Format#Data structure|data structure]] in Chunk Format
 
  |-
 
  |-
  | Offset Y
+
  | Number of block entities
  | Float
+
  | VarInt
  | This is added to the Y position after being multiplied by random.nextGaussian()
+
  | Number of elements in the following array
 
  |-
 
  |-
  | Offset Z
+
  | Block entities
  | Float
+
  | Array of [[NBT|NBT Tag]]
  | This is added to the Z position after being multiplied by random.nextGaussian()
+
  | All block entities in the chunkUse the x, y, and z tags in the NBT to determine their positions.
  |-
 
| Particle Data
 
| Float
 
| The data of each particle
 
|-
 
| Particle Count
 
| Int
 
| The number of particles to create
 
|-
 
| Data
 
| Array of VarInt
 
| Length depends on particle. "iconcrack" has length of 2, "blockcrack", "blockdust", and "fallingdust" have lengths of 1, the rest have 0.
 
 
  |}
 
  |}
  
Particle IDs:
+
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 ====
  
{| class="wikitable"
+
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
 
  |-
 
  |-
  ! Particle Name
+
  |rowspan="4"| 0x22
  ! Particle ID
+
  |rowspan="4"| Play
 +
|rowspan="4"| Client
 +
| Effect ID
 +
| Int
 +
| The ID of the effect, see below
 
  |-
 
  |-
  | explode
+
  | Location
  | 0
+
  | Position
 +
| The location of the effect
 
  |-
 
  |-
  | largeexplode
+
  | Data
  | 1
+
  | Int
 +
| Extra data for certain effects, see below
 
  |-
 
  |-
  | hugeexplosion
+
  | Disable Relative Volume
  | 2
+
  | Boolean
 +
| See above
 +
|}
 +
 
 +
Effect IDs:
 +
 
 +
{| class="wikitable"
 +
! ID
 +
! Name
 +
! Data
 
  |-
 
  |-
  | fireworksSpark
+
  !colspan="3"| Sound
| 3
 
 
  |-
 
  |-
  | bubble
+
  | 1000
  | 4
+
| Dispenser dispenses
 +
  |  
 
  |-
 
  |-
  | splash
+
  | 1001
  | 5
+
| Dispenser fails to dispense
 +
  |  
 
  |-
 
  |-
  | wake
+
  | 1002
  | 6
+
| Dispenser shoots
 +
  |  
 
  |-
 
  |-
  | suspended
+
  | 1003
  | 7
+
| Ender eye launched
 +
  |  
 
  |-
 
  |-
  | depthsuspend
+
  | 1004
  | 8
+
| Firework shot
 +
  |  
 
  |-
 
  |-
  | crit
+
  | 1005
  | 9
+
| Iron door opened
 +
  |  
 
  |-
 
  |-
  | magicCrit
+
  | 1006
  | 10
+
| Wooden door opened
 +
  |  
 
  |-
 
  |-
  | smoke
+
  | 1007
  | 11
+
| Wooden trapdoor opened
 +
  |  
 
  |-
 
  |-
  | largesmoke
+
  | 1008
  | 12
+
| Fence gate opened
 +
  |  
 
  |-
 
  |-
  | spell
+
  | 1009
  | 13
+
| Fire extinguished
 +
  |  
 
  |-
 
  |-
  | instantSpell
+
  | 1010
  | 14
+
  | Play record
 +
| Special case, see below for more info
 
  |-
 
  |-
  | mobSpell
+
  | 1011
  | 15
+
| Iron door closed
 +
  |  
 
  |-
 
  |-
  | mobSpellAmbient
+
  | 1012
  | 16
+
| Wooden door closed
 +
  |  
 
  |-
 
  |-
  | witchMagic
+
  | 1013
  | 17
+
| Wooden trapdoor closed
 +
  |  
 
  |-
 
  |-
  | dripWater
+
  | 1014
  | 18
+
| Fence gate closed
 +
  |  
 
  |-
 
  |-
  | dripLava
+
  | 1015
  | 19
+
| Ghast warns
 +
  |  
 
  |-
 
  |-
  | angryVillager
+
  | 1016
  | 20
+
| Ghast shoots
 +
  |  
 
  |-
 
  |-
  | happyVillager
+
  | 1017
  | 21
+
| Enderdragon shoots
 +
  |  
 
  |-
 
  |-
  | townaura
+
  | 1018
  | 22
+
| Blaze shoots
 +
  |  
 
  |-
 
  |-
  | note
+
  | 1019
  | 23
+
| Zombie attacks wood door
 +
  |  
 
  |-
 
  |-
  | portal
+
  | 1020
  | 24
+
| Zombie attacks iron door
 +
  |  
 
  |-
 
  |-
  | enchantmenttable
+
  | 1021
  | 25
+
| Zombie breaks wood door
 +
  |
 
  |-
 
  |-
  | flame
+
  | 1022
  | 26
+
| Wither breaks block
 +
  |
 
  |-
 
  |-
  | lava
+
  | 1023
  | 27
+
| Wither spawned
 +
  |  
 
  |-
 
  |-
  | footstep
+
  | 1024
  | 28
+
| Wither shoots
 +
  |
 
  |-
 
  |-
  | cloud
+
  | 1025
  | 29
+
| Bat takes off
 +
  |
 
  |-
 
  |-
  | reddust
+
  | 1026
  | 30
+
| Zombie infects
 +
  |
 
  |-
 
  |-
  | snowballpoof
+
  | 1027
  | 31
+
| Zombie villager converted
 +
  |
 
  |-
 
  |-
  | snowshovel
+
  | 1028
  | 32
+
| Ender dragon death
 +
  |
 
  |-
 
  |-
  | slime
+
  | 1029
  | 33
+
| Anvil destroyed
 +
  |  
 
  |-
 
  |-
  | heart
+
  | 1030
  | 34
+
| Anvil used
 +
  |  
 
  |-
 
  |-
  | barrier
+
  | 1031
  | 35
+
| Anvil landed
 +
  |
 
  |-
 
  |-
  | iconcrack_(id)_(data)
+
  | 1032
  | 36
+
| Portal travel
 +
  |  
 
  |-
 
  |-
  | blockcrack_(id+(data<<12))
+
  | 1033
  | 37
+
| Chorus flower grown
 +
  |
 
  |-
 
  |-
  | blockdust_(id)
+
  | 1034
  | 38
+
| Chorus flower died
 +
  |  
 
  |-
 
  |-
  | droplet
+
  | 1035
  | 39
+
| Brewing stand brewed
 +
  |
 
  |-
 
  |-
  | take
+
  | 1036
  | 40
+
| Iron trapdoor opened
 +
  |  
 
  |-
 
  |-
  | mobappearance
+
  | 1037
  | 41
+
| Iron trapdoor closed
 +
  |
 
  |-
 
  |-
  | dragonbreath
+
  !colspan="3"| Particle
| 42
 
 
  |-
 
  |-
  | endrod
+
  | 2000
  | 43
+
  | Spawns 10 smoke particles, e.g. from a fire
 +
| Direction, see below
 
  |-
 
  |-
  | damageindicator
+
  | 2001
  | 44
+
  | Block break + block break sound
 +
| Block state, as an index into the global palette
 
  |-
 
  |-
  | sweepattack
+
  | 2002
  | 45
+
  | Splash potion. Particle effect + glass break sound.
 +
| [http://minecraft.gamepedia.com/Data_values#Potions Potion ID]
 
  |-
 
  |-
  | fallingdust
+
  | 2003
  | 46
+
  | 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]
 
  |-
 
  |-
  | totem
+
  | 3000
  | 47
+
| End gateway spawn
 +
  |  
 
  |-
 
  |-
  | spit
+
  | 3001
  | 48
+
| Enderdragon growl
 +
  |
 
  |}
 
  |}
  
==== Join Game ====
+
Smoke directions:
 
 
See [[Protocol Encryption]] for information on logging in.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Packet ID
+
  ! ID
  ! State
+
  ! Direction
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="7"| 0x25
+
  | 0
|rowspan="7"| Play
+
  | South-East
|rowspan="7"| Client
 
| Entity ID
 
| Int
 
  | The player's Entity ID (EID)
 
 
  |-
 
  |-
  | Gamemode
+
  | 1
  | Unsigned Byte
+
  | South
  | 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. Bit 3 (0x8) is the hardcore flag.
+
|-
 +
  | 2
 +
| South-West
 +
|-
 +
| 3
 +
| East
 
  |-
 
  |-
  | Dimension
+
  | 4
  | Int Enum
+
  | (Up or middle ?)
| -1: Nether, 0: Overworld, 1: End; also, note that this is not a VarInt but instead a regular int.
 
 
  |-
 
  |-
  | Difficulty
+
  | 5
  | Unsigned Byte
+
  | West
| 0: peaceful, 1: easy, 2: normal, 3: hard
 
 
  |-
 
  |-
  | Max Players
+
  | 6
  | Unsigned Byte
+
  | North-East
| Was once used by the client to draw the player list, but now is ignored
 
 
  |-
 
  |-
  | Level Type
+
  | 7
  | String Enum (16)
+
  | North
| default, flat, largeBiomes, amplified, default_1_1
 
 
  |-
 
  |-
  | Reduced Debug Info
+
  | 8
  | Boolean
+
  | North-West
| 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 ====
+
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.
  
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
+
==== Particle ====
 +
 
 +
Displays the named particle
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,321: Line 2,504:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
  !colspan="2"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="13"| 0x26
+
  |rowspan="11"| 0x23
  |rowspan="13"| Play
+
  |rowspan="11"| Play
  |rowspan="13"| Client
+
  |rowspan="11"| Client
  |colspan="2"| Item Damage
+
  | Particle ID
  |colspan="2"| VarInt
+
  | Int
  | The damage value (map ID) of the map being modified
+
  | The particle ID listed in [[#Particle|the particle data type]].
 
  |-
 
  |-
  |colspan="2"| Scale
+
  | Long Distance
  |colspan="2"| Byte
+
  | Boolean
  | From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
+
  | If true, particle distance increases from 256 to 65536
|-
 
|colspan="2"| Tracking Position
 
|colspan="2"| Boolean
 
| Specifies whether the icons are shown
 
|-
 
|colspan="2"| Icon Count
 
|colspan="2"| VarInt
 
| Number of elements in the following array
 
 
  |-
 
  |-
  |rowspan="3"| Icon
+
  | X
| Direction And Type
+
  | Float
|rowspan="3"| Array
+
  | X position of the particle
  | Byte
 
  | 0xF0 = Type, 0x0F = Direction
 
 
  |-
 
  |-
  | X
+
  | Y
  | Byte
+
  | Float
  |  
+
  | Y position of the particle
 
  |-
 
  |-
 
  | Z
 
  | Z
  | Byte
+
  | Float
  |  
+
  | Z position of the particle
|-
 
|colspan="2"| Columns
 
|colspan="2"| Byte
 
| Number of columns updated
 
 
  |-
 
  |-
  |colspan="2"| Rows
+
  | Offset X
  |colspan="2"| Optional Byte
+
  | Float
  | Only if Columns is more than 0; number of rows updated
+
  | This is added to the X position after being multiplied by random.nextGaussian()
 
  |-
 
  |-
  |colspan="2"| X
+
  | Offset Y
  |colspan="2"| Optional Byte
+
  | Float
  | Only if Columns is more than 0; x offset of the westernmost column
+
  | This is added to the Y position after being multiplied by random.nextGaussian()
 
  |-
 
  |-
  |colspan="2"| Z
+
  | Offset Z
  |colspan="2"| Optional Byte
+
  | Float
  | Only if Columns is more than 0; z offset of the northernmost row
+
  | This is added to the Z position after being multiplied by random.nextGaussian()
 
  |-
 
  |-
  |colspan="2"| Length
+
  | Particle Data
  |colspan="2"| Optional VarInt
+
  | Float
  | Only if Columns is more than 0; length of the following array
+
  | The data of each particle
 
  |-
 
  |-
  |colspan="2"| Data
+
  | Particle Count
  |colspan="2"| Optional Array of Unsigned Byte
+
| Int
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
+
| The number of particles to create
 +
|-
 +
| Data
 +
  | Varies
 +
  | The variable data listed in [[#Particle|the particle data type]].
 
  |}
 
  |}
  
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
+
==== Update Light ====
  
Types are based off of rows and columns in <code>map_icons.png</code>:
+
Updates light levels for a chunk.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
  ! Icon type
+
  |rowspan="10"| 0x24
  ! Result
+
  |rowspan="10"| Play
 +
|rowspan="10"| Client
 +
|colspan="2"| Chunk X
 +
|colspan="2"| VarInt
 +
| Chunk coordinate (block coordinate divided by 16, rounded down)
 
  |-
 
  |-
  | 0
+
  |colspan="2"| Chunk Z
  | White arrow (players)
+
|colspan="2"| VarInt
 +
  | Chunk coordinate (block coordinate divided by 16, rounded down)  
 
  |-
 
  |-
  | 1
+
  |colspan="2"| Sky Light Mask
  | Green arrow (item frames)
+
|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)
 
  |-
 
  |-
  | 2
+
  |colspan="2"| Block Light Mask
  | Red arrow
+
|colspan="2"| VarInt
 +
  | Mask containing 18 bits, with the same order as sky light
 
  |-
 
  |-
  | 3
+
  |colspan="2"| Empty Sky Light Mask
  | Blue arrow
+
  |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.
 
  |-
 
  |-
  | 4
+
  |colspan="2"| Empty Block Light Mask
  | White cross
+
  |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.
 
  |-
 
  |-
  | 5
+
  |rowspan="2"| Sky Light arrays
  | Red pointer
+
| Length
 +
|rowspan="2"| Array
 +
| VarInt
 +
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | 6
+
  | Sky Light array
  | White circle (off-map players)
+
  | 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.
 
  |-
 
  |-
  | 7
+
  |rowspan="2"| Block Light arrays
  | Small white circle (far-off-map players)
+
| Length
 +
|rowspan="2"| Array
 +
| VarInt
 +
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | 8
+
  | Block Light array
  | Mansion
+
  | 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.
| 9
+
  |}
| Temple
 
|-
 
  | 10-15
 
| Unused (blue square)
 
  |}
 
  
==== Entity ====
+
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.
  
This packet may be used to initialize an entity.
+
==== Join Game ====
  
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.
+
See [[Protocol Encryption]] for information on logging in.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,440: Line 2,630:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x27
+
  |rowspan="7"| 0x25
  |rowspan="1"| Play
+
  |rowspan="7"| Play
  |rowspan="1"| Client
+
  |rowspan="7"| Client
 
  | Entity ID
 
  | 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
 
  | 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.
 
  |}
 
  |}
  
==== Entity Relative Move ====
+
==== Map Data ====
 
 
This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks [[#Entity Teleport|Entity Teleport]] should be sent instead.
 
  
This packet allows at most 8 blocks movement in any direction, because short range is from -32768 to 32767. And <code>32768 / (128 * 32)</code> = 8.
+
Updates a rectangular area on a {{Minecraft Wiki|map}} item.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,458: Line 2,670:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x28
+
  |rowspan="17"| 0x26
  |rowspan="5"| Play
+
  |rowspan="17"| Play
  |rowspan="5"| Client
+
  |rowspan="17"| Client
  | Entity ID
+
  |colspan="2"| Map ID
  | VarInt
+
|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
 
  |-
 
  |-
  | Delta X
+
  | X
  | Short
+
  | Byte
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
  | Map coordinates: -128 for furthest left, +127 for furthest right
 
  |-
 
  |-
  | Delta Y
+
  | Z
  | Short
+
  | Byte
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
+
  | Map coordinates: -128 for highest, +127 for lowest
 
  |-
 
  |-
  | Delta Z
+
  | Direction
  | Short
+
  | Byte
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
+
  | 0-15
 
  |-
 
  |-
  | On Ground
+
  | Has Display Name
 
  | Boolean
 
  | Boolean
  |  
+
  |
  |}
+
  |-
 
+
| Display Name
==== Entity Look And Relative Move ====
+
  | Optional [[Chat]]
 
+
  | Only present if previous Boolean is true
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>)
+
  |-
 
+
  |colspan="2"| Columns
{| class="wikitable"
+
  |colspan="2"| Unsigned Byte
  ! Packet ID
+
  | Number of columns updated
  ! State
 
  ! Bound To
 
  ! Field Name
 
  ! Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="7"| 0x29
+
  |colspan="2"| Rows
  |rowspan="7"| Play
+
  |colspan="2"| Optional Byte
|rowspan="7"| Client
+
  | Only if Columns is more than 0; number of rows updated
| Entity ID
 
| VarInt
 
  |  
 
 
  |-
 
  |-
  | Delta X
+
  |colspan="2"| X
  | Short
+
  |colspan="2"| Optional Byte
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
+
  | Only if Columns is more than 0; x offset of the westernmost column
 
  |-
 
  |-
  | Delta Y
+
  |colspan="2"| Z
  | Short
+
  |colspan="2"| Optional Byte
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
+
  | Only if Columns is more than 0; z offset of the northernmost row
 
  |-
 
  |-
  | Delta Z
+
  |colspan="2"| Length
  | Short
+
  |colspan="2"| Optional VarInt
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
+
  | Only if Columns is more than 0; length of the following array
 
  |-
 
  |-
  | Yaw
+
  |colspan="2"| Data
| Angle
+
  |colspan="2"| Optional Array of Unsigned Byte
  | New angle, not a delta
+
  | Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
|-
 
  | Pitch
 
| Angle
 
| New angle, not a delta
 
|-
 
| On Ground
 
| Boolean
 
|  
 
 
  |}
 
  |}
  
==== Entity Look ====
+
For icons, a direction of 0 is a vertical icon and increments by 22.5&deg; (360/16).
  
This packet is sent by the server when an entity rotates.
+
Types are based off of rows and columns in <code>map_icons.png</code>:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x2A
+
  ! Icon type
  |rowspan="4"| Play
+
  ! Result
|rowspan="4"| Client
 
| Entity ID
 
| VarInt
 
|
 
 
  |-
 
  |-
  | Yaw
+
  | 0
  | Angle
+
  | White arrow (players)
| New angle, not a delta
 
 
  |-
 
  |-
  | Pitch
+
  | 1
  | Angle
+
  | Green arrow (item frames)
| New angle, not a delta
 
 
  |-
 
  |-
  | On Ground
+
  | 2
  | Boolean
+
  | Red arrow
|
 
|}
 
 
 
==== Vehicle Move (clientbound) ====
 
 
 
Note that all fields use absolute positioning and do not allow for relative positioning.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="5"| 0x2B
+
  | 3
|rowspan="5"| Play
+
  | Blue arrow
|rowspan="5"| Client
 
| X
 
| Double
 
  | Absolute position (X coordinate)
 
 
  |-
 
  |-
  | Y
+
  | 4
  | Double
+
  | White cross
  | Absolute position (Y coordinate)
+
  |-
 +
| 5
 +
| Red pointer
 +
|-
 +
| 6
 +
| White circle (off-map players)
 +
|-
 +
| 7
 +
| Small white circle (far-off-map players)
 +
|-
 +
| 8
 +
| Mansion
 
  |-
 
  |-
  | Z
+
  | 9
  | Double
+
  | Temple
| Absolute position (Z coordinate)
 
 
  |-
 
  |-
  | Yaw
+
  | 10
  | Float
+
  | White Banner
| Absolute rotation on the vertical axis, in degrees
 
 
  |-
 
  |-
  | Pitch
+
  | 11
  | Float
+
  | Orange Banner
| Absolute rotation on the horizontal axis, in degrees
 
|}
 
 
 
==== Open Sign Editor ====
 
 
 
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].  There must already be a sign at the given location (which the client does not do automatically) - send a [[#Block Change|Block Change]] first.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x2C
+
  | 12
  |rowspan="1"| Play
+
| Magenta Banner
  |rowspan="1"| Client
+
  |-
  | Location
+
| 13
  | Position
+
  | Light Blue Banner
  |  
+
|-
  |}
+
  | 14
 
+
  | Yellow Banner
==== Craft Recipe Response ====
+
  |-
 
+
  | 15
Response to the serverbound packet ([[#Craft Recipe Request|Craft Recipe Request]]), with the same recipe ID. Appears to be used to notify the UI.
+
| Lime Banner
 
+
|-
{| class="wikitable"
+
| 16
  ! Packet ID
+
| Pink Banner
  ! State
+
  |-
  ! Bound To
+
| 17
  ! Field Name
+
| Gray Banner
  ! Field Type
+
  |-
  ! Notes
+
  | 18
 +
  | Light Gray Banner
 +
  |-
 +
  | 19
 +
  | Cyan Banner
 +
|-
 +
| 20
 +
| Purple Banner
 +
|-
 +
| 21
 +
| Blue Banner
 +
|-
 +
| 22
 +
| Brown Banner
 +
|-
 +
| 23
 +
| Green Banner
 +
|-
 +
| 24
 +
| Red Banner
 
  |-
 
  |-
  |rowspan="2"| 0x2D
+
  | 25
|rowspan="2"| Play
+
  | Black Banner
|rowspan="2"| Client
 
| Window ID
 
| Byte
 
  |
 
 
  |-
 
  |-
  | Recipe
+
  | 26
  | VarInt
+
  | Treasure marker
| A recipe ID
 
 
  |}
 
  |}
  
==== Player Abilities (clientbound) ====
+
==== Trade List ====
  
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.
+
The list of trades a villager NPC is offering.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,650: Line 2,847:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
  ! Field Type
+
  !colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x2E
+
  |rowspan="18"| 0x27
  |rowspan="3"| Play
+
  |rowspan="18"| Play
  |rowspan="3"| Client
+
  |rowspan="18"| Client
  | Flags
+
  |-
  | Byte
+
  | colspan="2" | Window ID
  | Bit field, see below
+
| colspan="2" | VarInt
 +
  | The ID of the window that is open; this is an int rather than a byte.
 
  |-
 
  |-
  | Flying Speed
+
  | colspan="2" | Size
  | Float
+
  | colspan="2" | Byte
  |  
+
  | The number of trades in the following array
 
  |-
 
  |-
  | Field of View Modifier
+
  | rowspan="11" | Trades
  | Float
+
| Input item 1
  | Modifies the field of view, like a speed potion. A Notchian server will use the same value as the movement speed (send in the [[Protocol#Entity_Properties|Entity Properties]] packet).
+
  | rowspan="11" | Array
  |}
+
  | [[Slot]]
 
+
  | The first item the villager is buying
About the flags:
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Field
+
  | Output item
  ! Bit
+
  | [[Slot]]
 +
| The item the villager is selling
 
  |-
 
  |-
  | Invulnerable
+
  | Has second item
  | 0x01
+
  | Boolean
 +
| Whether there is a second item
 
  |-
 
  |-
  | Flying
+
  | Input item 2
  | 0x02
+
  | Optional [[Slot]]
 +
| The second item the villager is buying; only present if they have a second item.
 
  |-
 
  |-
  | Allow Flying
+
  | Trade disabled
  | 0x04
+
  | Boolean
 +
| True if the trade is disabled; false if the trade is enabled.
 
  |-
 
  |-
  | Creative Mode (Instant Break)
+
  | Number of trade uses
  | 0x08
+
  | Integer
  |}
+
  | Number of times the trade has been used so far
 
 
==== Combat Event ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="8"| 0x2F
+
  | Maximum number of trade uses
|rowspan="8"| Play
+
  | Integer
|rowspan="8"| Client
+
  | Number of times this trade can be used
|colspan="2"| Event
 
  | VarInt Enum
 
  | Determines the layout of the remaining packet
 
 
  |-
 
  |-
  ! Event
+
  | XP
  ! Field Name
+
  | Integer
  !
+
  |
  !
+
  |-
 +
| Special Price
 +
| Integer
 +
|
 
  |-
 
  |-
  | 0: enter combat
+
  | Price Multiplier
  | ''no fields''
+
  | Float
| ''no fields''
+
  |
  |  
 
 
  |-
 
  |-
  |rowspan="2"| 1: end combat
+
  | Demand
| Duration
+
  | Integer
  | VarInt
+
  |
  |  
 
 
  |-
 
  |-
  | Entity ID
+
  |colspan="2"| Villager level
  | Int
+
  |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
 
  |-
 
  |-
  |rowspan="3"| 2: entity dead
+
  |colspan="2"| Experience
  | Player ID
+
  |colspan="2"| VarInt
| VarInt
+
  | Total experience for this villager (always 0 for the wandering trader)
  |  
 
 
  |-
 
  |-
  | Entity ID
+
  |colspan="2"| Is regular villager
  | Int
+
  |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.
 
  |-
 
  |-
  | Message
+
  |colspan="2"| Can restock
  | [[Chat]]
+
  |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.
 
  |}
 
  |}
  
==== Player List Item ====
+
[[File:1.14-merchant-slots.png|thumb|The merchant UI, for reference]]
 +
{{-}}
  
Sent by the server to update the user list (<tab> in the client).
+
==== Entity Relative Move ====
 +
 
 +
This packet is sent by the server when an entity moves less then 8 blocks; if an entity moves more than 8 blocks [[#Entity Teleport|Entity Teleport]] should be sent instead.
 +
 
 +
This packet allows at most 8 blocks movement in any direction, because short range is from -32768 to 32767. And <code>32768 / (128 * 32)</code> = 8.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,748: Line 2,940:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="4"| Field Name
+
  ! Field Name
  !colspan="3"| Field Type
+
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="19"| 0x30
+
  |rowspan="5"| 0x28
  |rowspan="19"| Play
+
  |rowspan="5"| Play
  |rowspan="19"| Client
+
  |rowspan="5"| Client
  |colspan="4"| Action
+
  | Entity ID
  |colspan="3"| VarInt
+
  | 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
+
  | Delta X
  !colspan="2"| Field Name
+
  | Short
  !colspan="2"|  
+
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
!
 
 
  |-
 
  |-
  |rowspan="10"| 0: add player
+
  | Delta Y
  |colspan="2"| Name
+
  | Short
  |colspan="2"| String (16)
+
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
|
 
 
  |-
 
  |-
  |colspan="2"| Number Of Properties
+
  | Delta Z
  |colspan="2"| VarInt
+
  | Short
  | Number of elements in the following array
+
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
 
  |-
 
  |-
  |rowspan="4"| Property
+
  | On Ground
| Name
 
|rowspan="4"| Array
 
| String (32767)
 
|
 
|-
 
| Value
 
| String (32767)
 
|
 
|-
 
| Is Signed
 
 
  | Boolean
 
  | 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
 
  |-
 
  |-
  | Signature
+
  |rowspan="7"| 0x29
| Optional String (32767)
+
  |rowspan="7"| Play
  | Only if Is Signed is true
+
  |rowspan="7"| Client
|-
+
  | Entity ID
  |colspan="2"| Gamemode
+
| VarInt
  |colspan="2"| VarInt
 
 
  |  
 
  |  
 
  |-
 
  |-
  |colspan="2"| Ping
+
  | Delta X
  |colspan="2"| VarInt
+
  | Short
  | Measured in milliseconds
+
  | Change in X position as <code>(currentX * 32 - prevX * 32) * 128</code>
 
  |-
 
  |-
  |colspan="2"| Has Display Name
+
  | Delta Y
  |colspan="2"| Boolean
+
  | Short
  |  
+
  | Change in Y position as <code>(currentY * 32 - prevY * 32) * 128</code>
 
  |-
 
  |-
  |colspan="2"| Display Name
+
  | Delta Z
  |colspan="2"| Optional [[Chat]]
+
  | Short
  | Only if Has Display Name is true
+
  | Change in Z position as <code>(currentZ * 32 - prevZ * 32) * 128</code>
 
  |-
 
  |-
  | 1: update gamemode
+
  | Yaw
  |colspan="2"| Gamemode
+
  | Angle
|colspan="2"| VarInt
+
  | New angle, not a delta
|
 
|-
 
| 2: update latency
 
|colspan="2"| Ping
 
|colspan="2"| VarInt
 
  | Measured in milliseconds
 
 
  |-
 
  |-
  |rowspan="2"| 3: update display name
+
  | Pitch
|colspan="2"| Has Display Name
+
  | Angle
  |colspan="2"| Boolean
+
  | New angle, not a delta
  |  
 
 
  |-
 
  |-
  |colspan="2"| Display Name
+
  | On Ground
|colspan="2"| Optional [[Chat]]
+
  | Boolean
  | Only send if Has Display Name is true
 
|-
 
| 4: remove player
 
|colspan="2"| ''no fields''
 
|colspan="2"| ''no fields''
 
 
  |  
 
  |  
 
  |}
 
  |}
  
The Property field looks as in the response of [[Mojang API#UUID -> Profile + Skin/Cape]], except of course using the protocol format instead of JSON. That is, each player will usually have one property with Name “textures” and Value being a base64-encoded JSON string as documented at [[Mojang API#UUID -> Profile + Skin/Cape]]. An empty properties array is also acceptable, and will cause clients to display the player with one of the two default skins depending on UUID.
+
==== Entity Look ====
  
Ping values correspond with icons in the following way:
+
This packet is sent by the server when an entity rotates.
* A ping that negative (i.e. not known to the server yet) will result in the no connection icon.
 
* A ping under 150 milliseconds will result in 5 bars
 
* A ping under 300 milliseconds will result in 4 bars
 
* A ping under 600 milliseconds will result in 3 bars
 
* A ping under 1000 milliseconds (1 second) will result in 2 bars
 
* A ping greater than or equal to 1 second will result in 1 bar.
 
 
 
==== Face Player ====
 
 
 
Used to rotate the client player to face the given location or entity (for <code>/teleport [<targets>] <x> <y> <z> facing</code>).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,864: Line 3,024:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x31
+
  |rowspan="4"| 0x2A
  |rowspan="8"| Play
+
  |rowspan="4"| Play
  |rowspan="8"| Client
+
  |rowspan="4"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 
  |-
 
  |-
  | Feet/eyes
+
  | Yaw
  | VarInt enum
+
  | Angle
  | Values are feet=0, eyes=1.  If set to eyes, aims using the head position; otherwise aims using the feet position.
+
  | New angle, not a delta
 
  |-
 
  |-
  | Target x
+
  | Pitch
  | Double
+
  | Angle
  | x coordinate of the point to face towards
+
  | New angle, not a delta
 
  |-
 
  |-
  | Target y
+
  | On Ground
| Double
 
| y coordinate of the point to face towards
 
|-
 
| Target z
 
| Double
 
| z coordinate of the point to face towards
 
|-
 
| Is entity
 
 
  | Boolean
 
  | Boolean
  | If true, additional information about an entity is provided.
+
  |  
|-
 
| Entity ID
 
| Optional VarInt
 
| Only if is entity is true &mdash; the entity to face towards
 
|-
 
| Entity feet/eyes
 
| Optional VarInt enum
 
| Whether to look at the entity's eyes or feet.  Same values and meanings as before, just for the entity's head/feet.
 
 
  |}
 
  |}
  
If the entity given by entity ID cannot be found, this packet should be treated as if is entity was false.
+
==== Entity ====
  
==== Player Position And Look (clientbound) ====
+
This packet may be used to initialize an entity.
  
Updates the player's position on the server. This packet will also close the “Downloading Terrain” screen when joining/respawning.
+
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.
  
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?)”.
+
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x2B
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|}
  
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”.
+
==== Vehicle Move (clientbound) ====
  
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.
+
Note that all fields use absolute positioning and do not allow for relative positioning.
 
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,919: Line 3,078:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x32
+
  |rowspan="5"| 0x2C
  |rowspan="7"| Play
+
  |rowspan="5"| Play
  |rowspan="7"| Client
+
  |rowspan="5"| Client
 
  | X
 
  | X
 
  | Double
 
  | Double
  | Absolute or relative position, depending on Flags
+
  | Absolute position (X coordinate)
 
  |-
 
  |-
 
  | Y
 
  | Y
 
  | Double
 
  | Double
  | Absolute or relative position, depending on Flags
+
  | Absolute position (Y coordinate)
 
  |-
 
  |-
 
  | Z
 
  | Z
 
  | Double
 
  | Double
  | Absolute or relative position, depending on Flags
+
  | Absolute position (Z coordinate)
 
  |-
 
  |-
 
  | Yaw
 
  | Yaw
 
  | Float
 
  | Float
  | Absolute or relative rotation on the X axis, in degrees
+
  | Absolute rotation on the vertical axis, in degrees
 
  |-
 
  |-
 
  | Pitch
 
  | Pitch
 
  | Float
 
  | Float
  | Absolute or relative rotation on the Y axis, in degrees
+
  | Absolute rotation on the horizontal 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:
+
==== Open Book ====
  
<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
+
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
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
! Field
+
  |rowspan="1"| 0x2D
! Bit
+
  |rowspan="1"| Play
|-
+
  |rowspan="1"| Client
| X
+
  | Hand
| 0x01
+
  | VarInt enum
|-
+
  | 0: Main hand, 1: Off hand
| Y
 
| 0x02
 
  |-
 
| Z
 
  | 0x04
 
|-
 
  | Y_ROT
 
| 0x08
 
  |-
 
  | X_ROT
 
  | 0x10
 
 
  |}
 
  |}
  
==== Use Bed ====  
+
==== Open Window ====
 
 
This packet tells that a player goes to bed.
 
 
 
The client with the matching Entity ID will go into bed mode.
 
 
 
This Packet is sent to all nearby players including the one sent to bed.
 
  
Any packets sent with a location not currently occupied by a bed will be ignored by clients.
+
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.  For horses, use [[#Open Horse Window|Open Horse Window]].
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 2,994: Line 3,134:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x33
+
  |rowspan="3"| 0x2E
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | Entity ID
+
  | Window ID
 +
| VarInt
 +
| A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
 +
|-
 +
| Window Type
 
  | VarInt
 
  | VarInt
  | Sleeping player's EID
+
  | The window type to use for display. Contained in the <code>minecraft:menu</code> regisry; see [[Inventory]] for the different values.
 +
|-
 +
| Window Title
 +
| [[Chat]]
 +
| The title of the window
 +
|}
 +
 
 +
==== Open Sign Editor ====
 +
 
 +
Sent when the client has placed a sign and is allowed to send [[#Update Sign|Update Sign]].  There must already be a sign at the given location (which the client does not do automatically) - send a [[#Block Change|Block Change]] first.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
 +
|rowspan="1"| 0x2F
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 
  | Location
 
  | Location
 
  | Position
 
  | Position
  | Block location of the head part of the bed
+
  |  
 
  |}
 
  |}
  
==== Unlock Recipes ====
+
==== Craft Recipe Response ====
 +
 
 +
Response to the serverbound packet ([[#Craft Recipe Request|Craft Recipe Request]]), with the same recipe ID.  Appears to be used to notify the UI.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,016: Line 3,182:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="8"| 0x34
+
  |rowspan="2"| 0x30
  |rowspan="8"| Play
+
  |rowspan="2"| Play
  |rowspan="8"| Client
+
  |rowspan="2"| Client
 +
| Window ID
 +
| Byte
 +
|
 
  |-
 
  |-
| Action
+
  | Recipe
| VarInt
+
  | Identifier
| 0: init, 1: add, 2: remove
+
  | A recipe ID
|-
+
  |}
| Crafting Book Open
+
 
| Boolean
+
==== Player Abilities (clientbound) ====
| If true, then the crafting book will be open when the player opens its inventory.
 
|-
 
| Filtering Craftable
 
| Boolean
 
| If true, then the filtering option is active when the players opens its inventory.
 
|-
 
| Array size 1
 
| VarInt
 
| Number of elements in the following array
 
|-
 
  | Recipe IDs
 
  | Array of VarInt
 
|
 
|-
 
| Array size 2
 
| Optional VarInt
 
| Number of elements in the following array, only present if mode is 0 (init)
 
|-
 
| Recipe IDs
 
| Optional Array of VarInt, 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.
 
  
Recipe ID:
+
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.
These are hardcoded values in the client and server, all the recipe json files will be loaded in a specific order (alphabetical, like sounds) and internal ids will be assigned in that order. There are also inbuilt recipes like fireworks, banners, etc., these are the first recipes to have their id assigned. Due the fact that the recipes are loaded in a specific order will the ids very likely change when recipes get added. [https://twitter.com/dinnerbone/status/856505341479145472 Custom recipes are scheduled for Minecraft 1.13], so most likely will things change a bit in that version.
 
 
 
==== Destroy Entities ====
 
 
 
Sent by the server when a list of entities is to be destroyed on the client.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,068: Line 3,206:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x35
+
  |rowspan="3"| 0x31
  |rowspan="2"| Play
+
  |rowspan="3"| Play
  |rowspan="2"| Client
+
  |rowspan="3"| Client
  | Count
+
  | Flags
  | VarInt
+
  | Byte
  | Number of elements in the following array
+
  | Bit field, see below
 +
|-
 +
| Flying Speed
 +
| Float
 +
| 0.05 by default
 
  |-
 
  |-
  | Entity IDs
+
  | Field of View Modifier
  | Array of VarInt
+
  | Float
  | The list of entities of destroy
+
  | 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.
 
  |}
 
  |}
  
==== Remove Entity Effect ====
+
About the flags:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x36
+
  ! Field
|rowspan="2"| Play
+
  ! Bit
  |rowspan="2"| Client
+
  |-
  | Entity ID
+
  | Invulnerable
  | VarInt
+
  | 0x01
  |  
 
 
  |-
 
  |-
  | Effect ID
+
  | Flying
  | Byte
+
  | 0x02
| See {{Minecraft Wiki|Status effect#List of effects|this table}}
 
|}
 
 
 
==== Resource Pack Send ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x37
+
  | Allow Flying
|rowspan="2"| Play
+
  | 0x04
|rowspan="2"| Client
 
| URL
 
| String (32767)
 
  | The URL to the resource pack.
 
 
  |-
 
  |-
  | Hash
+
  | Creative Mode (Instant Break)
| String (40)
+
  | 0x08
  | 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 ====
+
==== Combat Event ====
 
 
To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,132: Line 3,248:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x38
+
  |rowspan="8"| 0x32
  |rowspan="4"| Play
+
  |rowspan="8"| Play
  |rowspan="4"| Client
+
  |rowspan="8"| Client
  | Dimension
+
  |colspan="2"| Event
  | Int Enum
+
  | VarInt Enum
  | -1: The Nether, 0: The Overworld, 1: The End
+
| 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
 +
|
 
  |-
 
  |-
  | Difficulty
+
  |rowspan="3"| 2: entity dead
  | Unsigned Byte
+
  | Player ID
  | 0: Peaceful, 1: Easy, 2: Normal, 3: Hard
+
| VarInt
 +
  |  
 
  |-
 
  |-
  | Gamemode
+
  | Entity ID
  | Unsigned Byte
+
  | Int
  | 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
+
  |  
 
  |-
 
  |-
  | Level Type
+
  | Message
  | String (16)
+
  | [[Chat]]
| 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).
+
==== Player Info ====
  
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.}}
+
Sent by the server to update the user list (<tab> in the client).
  
==== Entity Head Look ====
+
{| class="wikitable"
 
 
Changes the direction an entity's head is facing.
 
 
 
{| class="wikitable"
 
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="4"| Field Name
  ! Field Type
+
  !colspan="3"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x39
+
  |rowspan="19"| 0x33
  |rowspan="2"| Play
+
  |rowspan="19"| Play
  |rowspan="2"| Client
+
  |rowspan="19"| Client
  | Entity ID
+
  |colspan="4"| Action
  | VarInt
+
  |colspan="3"| VarInt
 +
| Determines the rest of the Player format after the UUID
 +
|-
 +
|colspan="4"| Number Of Players
 +
|colspan="3"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="17"| Player
 +
|colspan="3"| UUID
 +
|rowspan="17"| Array
 +
|colspan="2"| UUID
 
  |  
 
  |  
 
  |-
 
  |-
  | Head Yaw
+
  ! Action
  | Angle
+
  !colspan="2"| Field Name
| New angle, not a delta
+
  !colspan="2"|
|}
+
  !  
 
 
==== Select Advancement Tab ====
 
 
 
Sent by the server to indicate that the client should switch advancement tab. Sent either when the client switches tab in the GUI or when an advancement in another tab is made.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
  ! Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="2"| 0x3A
+
  |rowspan="10"| 0: add player
  |rowspan="2"| Play
+
|colspan="2"| Name
  |rowspan="2"| Client
+
|colspan="2"| String (16)
  | Has id
+
|
  | Boolean
+
|-
  | Indicates if the next field is present
+
  |colspan="2"| Number Of Properties
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
  |rowspan="4"| Property
 +
  | Name
 +
  |rowspan="4"| Array
 +
| String (32767)
 +
  |  
 
  |-
 
  |-
  | Optional Identifier
+
  | Value
 
  | String (32767)
 
  | String (32767)
  | See below
+
  |  
  |}
+
  |-
 
+
| Is Signed
The Identifier can be one of the following:
+
| Boolean
 
+
  |
{| class="wikitable"
 
  ! Optional Identifier
 
 
  |-
 
  |-
  | minecraft:story/root
+
  | Signature
 +
| Optional String (32767)
 +
| Only if Is Signed is true
 
  |-
 
  |-
  | minecraft:nether/root
+
  |colspan="2"| Gamemode
 +
|colspan="2"| VarInt
 +
|
 
  |-
 
  |-
  | minecraft:end/root
+
  |colspan="2"| Ping
 +
|colspan="2"| VarInt
 +
| Measured in milliseconds
 
  |-
 
  |-
  | minecraft:adventure/root
+
  |colspan="2"| Has Display Name
 +
|colspan="2"| Boolean
 +
|
 
  |-
 
  |-
  | minecraft:husbandry/root
+
  |colspan="2"| Display Name
  |}
+
|colspan="2"| Optional [[Chat]]
 
+
| Only if Has Display Name is true
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
+
|-
 
+
| 1: update gamemode
==== World Border ====  
+
|colspan="2"| Gamemode
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
| 2: update latency
 +
|colspan="2"| Ping
 +
|colspan="2"| VarInt
 +
| Measured in milliseconds
 +
|-
 +
|rowspan="2"| 3: update display name
 +
|colspan="2"| Has Display Name
 +
|colspan="2"| Boolean
 +
|
 +
|-
 +
|colspan="2"| Display Name
 +
|colspan="2"| Optional [[Chat]]
 +
| Only send if Has Display Name is true
 +
|-
 +
| 4: remove player
 +
|colspan="2"| ''no fields''
 +
|colspan="2"| ''no fields''
 +
|
 +
  |}
 +
 
 +
The Property field looks as in the response of [[Mojang API#UUID -> Profile + Skin/Cape]], except of course using the protocol format instead of JSON. That is, each player will usually have one property with Name “textures” and Value being a base64-encoded JSON string as documented at [[Mojang API#UUID -> Profile + Skin/Cape]]. An empty properties array is also acceptable, and will cause clients to display the player with one of the two default skins depending on UUID.
 +
 
 +
Ping values correspond with icons in the following way:
 +
* A ping that negative (i.e. not known to the server yet) will result in the no connection icon.
 +
* A ping under 150 milliseconds will result in 5 bars
 +
* A ping under 300 milliseconds will result in 4 bars
 +
* A ping under 600 milliseconds will result in 3 bars
 +
* A ping under 1000 milliseconds (1 second) will result in 2 bars
 +
* A ping greater than or equal to 1 second will result in 1 bar.
 +
 
 +
==== Face Player ====
 +
 
 +
Used to rotate the client player to face the given location or entity (for <code>/teleport [<targets>] <x> <y> <z> facing</code>).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,232: Line 3,412:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="18"| 0x3B
+
  |rowspan="8"| 0x34
  |rowspan="18"| Play
+
  |rowspan="8"| Play
  |rowspan="18"| Client
+
  |rowspan="8"| Client
|colspan="2"| Action
 
| VarInt Enum
 
| Determines the format of the rest of the packet
 
 
  |-
 
  |-
  ! Action
+
  | Feet/eyes
  ! Field Name
+
  | VarInt enum
  !
+
  | Values are feet=0, eyes=1. If set to eyes, aims using the head position; otherwise aims using the feet position.
  !
 
 
  |-
 
  |-
  | 0: set size
+
  | Target x
| Diameter
 
 
  | Double
 
  | Double
  | Length of a single side of the world border, in meters
+
  | x coordinate of the point to face towards
 
  |-
 
  |-
  |rowspan="3"| 1: lerp size
+
  | Target y
| Old Diameter
 
 
  | Double
 
  | Double
  | Current length of a single side of the world border, in meters
+
  | y coordinate of the point to face towards
 
  |-
 
  |-
  | New Diameter
+
  | Target z
 
  | Double
 
  | Double
  | Target length of a single side of the world border, in meters
+
  | z coordinate of the point to face towards
 
  |-
 
  |-
  | Speed
+
  | Is entity
  | VarLong
+
  | Boolean
  | 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.
+
  | If true, additional information about an entity is provided.
 
  |-
 
  |-
  |rowspan="2"| 2: set center
+
  | Entity ID
| X
+
  | Optional VarInt
  | Double
+
  | Only if is entity is true &mdash; the entity to face towards
  |  
 
 
  |-
 
  |-
  | Z
+
  | Entity feet/eyes
  | Double
+
  | 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.
  |-
+
  |}
|rowspan="8"| 3: initialize
+
 
  | X
+
If the entity given by entity ID cannot be found, this packet should be treated as if is entity was false.
  | Double
+
 
  |
+
==== Player Position And Look (clientbound) ====
 +
 
 +
Updates the player's position on the server. This packet will also close the “Downloading Terrain” screen when joining/respawning.
 +
 
 +
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 meters, the client will be kicked for “You moved too quickly :( (Hacking?)”.
 +
 
 +
Also if the fixed-point number of X or Z is set greater than <code>3.2E7D</code> the client will be kicked for “Illegal position”.
 +
 
 +
Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0, -1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.
 +
 
 +
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  | Z
+
  |rowspan="7"| 0x35
 +
|rowspan="7"| Play
 +
|rowspan="7"| Client
 +
| X
 
  | Double
 
  | Double
  |  
+
  | Absolute or relative position, depending on Flags
 
  |-
 
  |-
  | Old Diameter
+
  | Y
 
  | Double
 
  | Double
  | Current length of a single side of the world border, in meters
+
  | Absolute or relative position, depending on Flags
 
  |-
 
  |-
  | New Diameter
+
  | Z
 
  | Double
 
  | Double
  | Target length of a single side of the world border, in meters
+
  | Absolute or relative position, depending on Flags
 
  |-
 
  |-
  | Speed
+
  | Yaw
  | VarLong
+
  | Float
  | 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.
+
  | Absolute or relative rotation on the X axis, in degrees
 
  |-
 
  |-
  | Portal Teleport Boundary
+
  | Pitch
  | VarInt
+
  | Float
  | Resulting coordinates from a portal teleport are limited to ±value. Usually 29999984.
+
  | Absolute or relative rotation on the Y axis, in degrees
 
  |-
 
  |-
  | Warning Time
+
  | Flags
  | VarInt
+
  | Byte
  | In seconds as set by <code>/worldborder warning time</code>
+
  | Bit field, see below
 
  |-
 
  |-
  | Warning Blocks
+
  | Teleport ID
 
  | VarInt
 
  | VarInt
  | In meters
+
  | Client should confirm this packet with [[#Teleport Confirm|Teleport Confirm]] containing the same Teleport ID
|-
 
|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:
+
About the Flags field:
  
<syntaxhighlight lang="java">
+
<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
distance = max(min(resizeSpeed * 1000 * warningTime, abs(targetDiameter - currentDiameter)), warningDistance);
 
if (playerDistance < distance) {
 
    warning = 1.0 - playerDistance / distance;
 
} else {
 
    warning = 0.0;
 
}
 
</syntaxhighlight>
 
 
 
==== Camera ====
 
 
 
Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.
 
 
 
The player's camera will move with the entity and look where it is looking. The entity is often another player, but can be any type of entity.  The player is unable to move this entity (move packets will act as if they are coming from the other entity).
 
 
 
If the given entity is not loaded by the player, this packet is ignored.  To return control to the player, send this packet with their entity ID.
 
 
 
The Notchian server resets this (sends it back to the default entity) whenever the spectated entity is killed or the player sneaks, but only if they were spectating an entity. It also sends this packet whenever the player switches out of spectator mode (even if they weren't spectating an entity).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x3C
+
  ! Field
  |rowspan="1"| Play
+
  ! Bit
  |rowspan="1"| Client
+
  |-
  | Camera ID
+
  | X
  | VarInt
+
  | 0x01
  | ID of the entity to set the client's camera to
+
  |-
  |}
+
  | Y
 
+
| 0x02
The notchian also loads certain shaders for given entities:
+
  |-
 
+
  | Z
* Creeper &rarr; <code>shaders/post/creeper.json</code>
+
  | 0x04
* Spider (and cave spider) &rarr; <code>shaders/post/spider.json</code>
+
  |-
* Enderman &rarr; <code>shaders/post/invert.json</code>
+
  | Y_ROT
* Anything else &rarr; the current shader is unloaded
+
  | 0x08
 
 
==== Held Item Change (clientbound) ====
 
 
 
Sent to change the player's slot selection.
 
 
 
{| class="wikitable"
 
  ! Packet ID
 
  ! State
 
  ! Bound To
 
  ! Field Name
 
  ! Field Type
 
  ! Notes
 
 
  |-
 
  |-
  |rowspan="1"| 0x3D
+
  | X_ROT
|rowspan="1"| Play
+
  | 0x10
|rowspan="1"| Client
 
| Slot
 
| Byte
 
  | The slot which the player has selected (0–8)
 
 
  |}
 
  |}
  
==== Display Scoreboard ====
+
==== Unlock Recipes ====
 
 
This is sent to the client when it should display a scoreboard.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,395: Line 3,538:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x3E
+
  |rowspan="10"| 0x36
  |rowspan="2"| Play
+
  |rowspan="10"| Play
  |rowspan="2"| Client
+
  |rowspan="10"| 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
+
  | Action
  | String (16)
+
  | VarInt
  | The unique name for the scoreboard to be displayed.
+
| 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.
  
==== Entity Metadata ====
+
==== Destroy Entities ====
  
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.
+
Sent by the server when a list of entities is to be destroyed on the client.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,419: Line 3,595:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x3F
+
  |rowspan="2"| 0x37
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
 
  |rowspan="2"| Client
 
  |rowspan="2"| Client
  | Entity ID
+
  | Count
 
  | VarInt
 
  | VarInt
  |  
+
  | Number of elements in the following array
 
  |-
 
  |-
  | Metadata
+
  | Entity IDs
  | [[Entities#Entity Metadata Format|Entity Metadata]]
+
  | Array of VarInt
  |  
+
  | The list of entities of destroy
 
  |}
 
  |}
  
==== Attach Entity ====
+
==== Remove Entity Effect ====
 
 
This packet is sent when an entity has been {{Minecraft Wiki|Lead|leashed}} to another entity.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,443: Line 3,617:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x40
+
  |rowspan="2"| 0x38
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
 
  |rowspan="2"| Client
 
  |rowspan="2"| Client
  | Attached Entity ID
+
  | Entity ID
  | Int
+
  | VarInt
  | Attached entity's EID
+
  |  
 
  |-
 
  |-
  | Holding Entity ID
+
  | Effect ID
  | Int
+
  | Byte
  | ID of the entity holding the lead. Set to -1 to detach.
+
  | See {{Minecraft Wiki|Status effect#List of effects|this table}}
 
  |}
 
  |}
  
==== Entity Velocity ====
+
==== Resource Pack Send ====  
 
 
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"
Line 3,467: Line 3,639:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="4"| 0x41
+
  |rowspan="2"| 0x39
  |rowspan="4"| Play
+
  |rowspan="2"| Play
  |rowspan="4"| Client
+
  |rowspan="2"| Client
  | Entity ID
+
  | URL
  | VarInt
+
  | String (32767)
  |  
+
  | The URL to the resource pack.
 
  |-
 
  |-
  | Velocity X
+
  | Hash
  | Short
+
  | String (40)
  | Velocity on the X axis
+
  | 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
|-
 
| Velocity Y
 
| Short
 
| Velocity on the Y axis
 
|-
 
| Velocity Z
 
| Short
 
| Velocity on the Z axis
 
 
  |}
 
  |}
  
==== Entity Equipment ====
+
==== 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"
 
{| class="wikitable"
Line 3,497: Line 3,663:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x42
+
  |rowspan="3"| 0x3A
 
  |rowspan="3"| Play
 
  |rowspan="3"| Play
 
  |rowspan="3"| Client
 
  |rowspan="3"| Client
  | Entity ID
+
  | Dimension
  | VarInt
+
  | Int Enum
  | Entity's EID
+
  | -1: The Nether, 0: The Overworld, 1: The End
 
  |-
 
  |-
  | Slot
+
  | Gamemode
  | VarInt Enum
+
  | Unsigned Byte
  | Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet)
+
  | 0: survival, 1: creative, 2: adventure, 3: spectator. The hardcore flag is not included
 
  |-
 
  |-
  | Item
+
  | Level Type
  | [[Slot Data|Slot]]
+
  | String (16)
|
+
| Same as [[#Join Game|Join Game]]
 
  |}
 
  |}
  
==== Set Experience ====
+
{{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.
  
Sent by the server when the client should change experience levels.
+
While sending the Entity Look packet changes the vertical rotation of the head, sending this packet appears to be necessary to rotate the head horizontally.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,525: Line 3,697:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x43
+
  |rowspan="2"| 0x3B
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Client
+
  |rowspan="2"| Client
  | Experience bar
+
  | Entity ID
| Float
 
| Between 0 and 1
 
|-
 
| Level
 
 
  | VarInt
 
  | VarInt
 
  |  
 
  |  
 
  |-
 
  |-
  | Total Experience
+
  | Head Yaw
  | VarInt
+
  | Angle
  | See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion
+
  | New angle, not a delta
 
  |}
 
  |}
  
==== Update Health ====
+
==== Select Advancement Tab ====
  
Sent by the server to update/set the health of the player it is sent to.
+
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.
 
 
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"
Line 3,555: Line 3,721:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x44
+
  |rowspan="2"| 0x3C
  |rowspan="3"| Play
+
  |rowspan="2"| Play
  |rowspan="3"| Client
+
  |rowspan="2"| Client
  | Health
+
  | Has id
  | Float
+
  | Boolean
  | 0 or less = dead, 20 = full HP
+
  | Indicates if the next field is present
 
  |-
 
  |-
  | Food
+
  | Optional Identifier
  | VarInt
+
  | String (32767)
  | 0–20
+
  | See below
|-
 
| Food Saturation
 
| Float
 
| Seems to vary from 0.0 to 5.0 in integer increments
 
 
  |}
 
  |}
  
==== Scoreboard Objective ====
+
The Identifier can be one of the following:
 
 
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
+
  ! Optional Identifier
  ! State
+
  |-
  ! Bound To
+
  | minecraft:story/root
! Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="4"| 0x45
+
  | minecraft:nether/root
|rowspan="4"| Play
 
|rowspan="4"| Client
 
| Objective Name
 
| String (16)
 
| An unique name for the objective
 
 
  |-
 
  |-
  | Mode
+
  | minecraft:end/root
| Byte
 
| 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.
 
 
  |-
 
  |-
  | Objective Value
+
  | minecraft:adventure/root
| Optional String (32)
 
| Only if mode is 0 or 2. The text to be displayed for the score
 
 
  |-
 
  |-
  | Type
+
  | minecraft:husbandry/root
| Optional String (16)
 
| Only if mode is 0 or 2. “integer” or “hearts”
 
 
  |}
 
  |}
  
==== Set Passengers ====
+
If no or an invalid identifier is sent, the client will switch to the first tab in the GUI.
 +
 
 +
==== World Border ====  
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,609: Line 3,757:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  ! Field Name
+
  !colspan="2"| Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x46
+
  |rowspan="18"| 0x3D
  |rowspan="3"| Play
+
  |rowspan="18"| Play
  |rowspan="3"| Client
+
  |rowspan="18"| Client
  | Entity ID
+
  |colspan="2"| Action
  | VarInt
+
  | VarInt Enum
  | Vehicle's EID
+
  | Determines the format of the rest of the packet
 
  |-
 
  |-
  | Passenger Count
+
  ! Action
  | VarInt
+
  ! Field Name
  | Number of elements in the following array
+
  !
 +
!
 
  |-
 
  |-
  | Passengers
+
  | 0: set size
  | Array of VarInt
+
  | Diameter
  | EIDs of entity's passengers
+
  | Double
  |}
+
  | Length of a single side of the world border, in meters
 
 
==== Teams ====
 
 
 
Creates and updates teams.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
! Field Type
 
! Notes
 
 
  |-
 
  |-
  |rowspan="23"| 0x47
+
  |rowspan="3"| 1: lerp size
  |rowspan="23"| Play
+
  | Old Diameter
|rowspan="23"| Client
+
  | Double
|colspan="2"| Team Name
+
  | Current length of a single side of the world border, in meters
  | String (16)
 
  | A unique name for the team. (Shared with scoreboard).
 
 
  |-
 
  |-
  |colspan="2"| Mode
+
  | New Diameter
  | Byte
+
  | Double
  | Determines the layout of the remaining packet
+
  | Target length of a single side of the world border, in meters
 
  |-
 
  |-
  |rowspan="9"| 0: create team
+
| Speed
  | Team Display Name
+
| VarLong
  | String (32)
+
| 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
 
  |  
 
  |  
 
  |-
 
  |-
  | Team Prefix
+
  | Z
  | String (16)
+
  | Double
  | Displayed before the names of players that are part of this team
+
  |  
 
  |-
 
  |-
  | Team Suffix
+
  |rowspan="8"| 3: initialize
  | String (16)
+
| X
  | Displayed after the names of players that are part of this team
+
  | Double
 +
  |  
 
  |-
 
  |-
  | Friendly Flags
+
  | Z
  | Byte
+
  | Double
  | Bit mask. 0x01: Allow friendly fire, 0x02: can see invisible players on same team
+
  |  
 
  |-
 
  |-
  | Name Tag Visibility
+
  | Old Diameter
  | String Enum (32)
+
  | Double
  | <code>always</code>, <code>hideForOtherTeams</code>, <code>hideForOwnTeam</code>, <code>never</code>
+
  | Current length of a single side of the world border, in meters
 
  |-
 
  |-
  | Collision Rule
+
  | New Diameter
  | String Enum (32)
+
  | Double
  | <code>always</code>, <code>pushOtherTeams</code>, <code>pushOwnTeam</code>, <code>never</code>
+
  | Target length of a single side of the world border, in meters
 
  |-
 
  |-
  | Color
+
  | Speed
  | Byte
+
  | VarLong
  | For colors, the same [[Chat]] colors (0-15).  -1 indicates RESET/no color.
+
  | 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.
 
  |-
 
  |-
  | Entity Count
+
  | Portal Teleport Boundary
 
  | VarInt
 
  | VarInt
  | Number of elements in the following array
+
  | Resulting coordinates from a portal teleport are limited to ±value. Usually 29999984.
 
  |-
 
  |-
  | Entities
+
  | Warning Time
  | Array of String (40)
+
  | VarInt
  | Identifiers for the entities in this team.  For players, this is their username; for other entities, it is their UUID.
+
  | In seconds as set by <code>/worldborder warning time</code>
 
  |-
 
  |-
  | 1: remove team
+
  | Warning Blocks
  | ''no fields''
+
  | VarInt
| ''no fields''
+
  | In meters
  |  
 
 
  |-
 
  |-
  |rowspan="7"| 2: update team info
+
  |rowspan="1"| 4: set warning time
| Team Display Name
+
  | Warning Time
| String (32)
 
|
 
|-
 
| Team Prefix
 
| String (16)
 
| Displayed before the names of entities that are part of this team
 
|-
 
| Team Suffix
 
| String (16)
 
| Displayed after the names of entities that are part of this team
 
|-
 
| 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>
 
|-
 
| Color
 
| Byte
 
| For colors, the same [[Chat]] colors (0-15).  -1 indicates RESET/no color.
 
|-
 
|rowspan="2"| 3: add players to team
 
  | Entity Count
 
 
  | VarInt
 
  | VarInt
  | Number of elements in the following array
+
  | In seconds as set by <code>/worldborder warning time</code>
 
  |-
 
  |-
| Entities
+
  |rowspan="1"| 5: set warning blocks
| Array of String (40)
+
  | Warning Blocks
| 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
 
  | VarInt
  | Number of elements in the following array
+
  | In meters
|-
 
| Entities
 
| Array of String (40)
 
| Identifiers for the entities removed.  For players, this is their username; for other entities, it is their UUID.
 
 
  |}
 
  |}
  
==== Update Score ====
+
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>
 +
 
 +
==== Camera ====
  
This is sent to the client when it should update a scoreboard item.  
+
Sets the entity that the player renders from. This is normally used when the player left-clicks an entity while in spectator mode.
  
{| class="wikitable"
+
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 entityThe player is unable to move this entity (move packets will act as if they are coming from the other entity).
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="4"| 0x48
 
|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 ====
+
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.
  
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.
+
The Notchian server resets this (sends it back to the default entity) whenever the spectated entity is killed or the player sneaks, but only if they were spectating an entity. It also sends this packet whenever the player switches out of spectator mode (even if they weren't spectating an entity).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,786: Line 3,873:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="1"| 0x49
+
  |rowspan="1"| 0x3E
 
  |rowspan="1"| Play
 
  |rowspan="1"| Play
 
  |rowspan="1"| Client
 
  |rowspan="1"| Client
  | Location
+
  | Camera ID
  | Position
+
  | VarInt
  | Spawn location
+
  | ID of the entity to set the client's camera to
 +
|}
 +
 
 +
The notchian also loads certain shaders for given entities:
 +
 
 +
* Creeper &rarr; <code>shaders/post/creeper.json</code>
 +
* Spider (and cave spider) &rarr; <code>shaders/post/spider.json</code>
 +
* Enderman &rarr; <code>shaders/post/invert.json</code>
 +
* Anything else &rarr; the current shader is unloaded
 +
 
 +
==== Held Item Change (clientbound) ====
 +
 
 +
Sent to change the player's slot selection.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x3F
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Slot
 +
| Byte
 +
| The slot which the player has selected (0–8)
 
  |}
 
  |}
  
==== Time Update ====
+
==== Update View Position ====
  
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.
+
{{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.}}
  
The time of day is based on the timestamp modulo 24000. 0 is sunrise, 6000 is noon, 12000 is sunset, and 18000 is midnight.
+
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.
  
The default SMP server increments the time by <code>20</code> every second.
+
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"
 
{| class="wikitable"
Line 3,810: Line 3,924:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="2"| 0x4A
+
  |rowspan="2"| 0x40
 
  |rowspan="2"| Play
 
  |rowspan="2"| Play
 
  |rowspan="2"| Client
 
  |rowspan="2"| Client
  | World Age
+
  | Chunk X
  | Long
+
  | VarInt
  | In ticks; not changed by server commands
+
  | Chunk X coordinate of the player's position
 
  |-
 
  |-
  | Time of day
+
  | Chunk Z
  | Long
+
  | VarInt
  | The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time
+
  | Chunk Z coordinate of the player's position
 
  |}
 
  |}
  
==== Title ====
+
==== 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"
 
{| class="wikitable"
Line 3,828: Line 3,944:
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
  !colspan="2"| Field Name
+
  ! Field Name
 
  ! Field Type
 
  ! Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="10"| 0x4B
+
  |rowspan="1"| 0x41
  |rowspan="10"| Play
+
  |rowspan="1"| Play
  |rowspan="10"| Client
+
  |rowspan="1"| Client
  |colspan="2"| Action
+
  | View Distance
  | VarInt Enum
+
| VarInt
  |  
+
| Render distance (2-32)
 +
|}
 +
 
 +
==== Display Scoreboard ====
 +
 
 +
This is sent to the client when it should display a scoreboard.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x42
 +
|rowspan="2"| Play
 +
|rowspan="2"| 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.
 
  |-
 
  |-
  ! Action
+
| Score Name
 +
| String (16)
 +
| The unique name for the scoreboard to be displayed.
 +
|}
 +
 
 +
==== 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 Name
  !  
+
  ! Field Type
  !  
+
  ! Notes
 
  |-
 
  |-
  | 0: set title
+
  |rowspan="2"| 0x43
  | Title Text
+
|rowspan="2"| Play
  | [[Chat]]
+
|rowspan="2"| Client
 +
  | Entity ID
 +
  | VarInt
 
  |  
 
  |  
 
  |-
 
  |-
  | 1: set subtitle
+
  | Metadata
| Subtitle Text
+
  | [[Entities#Entity Metadata Format|Entity Metadata]]
  | [[Chat]]
 
 
  |  
 
  |  
  |-
+
  |}
  | 2: set action bar
+
 
  | Action bar text
+
==== Attach Entity ====
  | [[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.)
+
This packet is sent when an entity has been {{Minecraft Wiki|Lead|leashed}} to another entity.
 +
 
 +
{| class="wikitable"
 +
  ! Packet ID
 +
! State
 +
! Bound To
 +
  ! Field Name
 +
  ! Field Type
 +
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 3: set times and display
+
  |rowspan="2"| 0x44
  | Fade In
+
  |rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Attached Entity ID
 
  | Int
 
  | Int
  | Ticks to spend fading in
+
  | Attached entity's EID
 
  |-
 
  |-
  | Stay
+
  | Holding Entity ID
 
  | Int
 
  | Int
  | Ticks to keep the title displayed
+
  | ID of the entity holding the lead. Set to -1 to detach.
|-
 
| 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.
+
==== Entity Velocity ====
  
The title is visible on screen for Fade In + Stay + Fade Out ticks.
+
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).
 
 
==== Stop Sound ====
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 3,897: Line 4,040:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="3"| 0x4C
+
  |rowspan="4"| 0x45
  |rowspan="3"| Play
+
  |rowspan="4"| Play
  |rowspan="3"| Client
+
  |rowspan="4"| Client
  | Flags
+
  | Entity ID
  | Byte
+
  | VarInt
  | Controls which fields are present.
+
  |  
 +
|-
 +
| Velocity X
 +
| Short
 +
| Velocity on the X axis
 
  |-
 
  |-
  | Source
+
  | Velocity Y
  | Optional VarInt enum
+
  | Short
  | Only if flags is 3 or 1 (bit mask 0x1).  See below.  If not present, then sounds from all sources are cleared.
+
  | Velocity on the Y axis
 
  |-
 
  |-
  | Sound
+
  | Velocity Z
  | Optional Identifier
+
  | Short
  | 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.
+
  | Velocity on the Z axis
 
  |}
 
  |}
  
Categories:
+
==== Entity Equipment ====
  
 
{| class="wikitable"
 
{| class="wikitable"
  ! Name !! Value
+
  ! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | master || 0
+
  |rowspan="3"| 0x46
 +
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Entity ID
 +
| VarInt
 +
| Entity's EID
 
  |-
 
  |-
  | music || 1
+
  | Slot
 +
| VarInt Enum
 +
| Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet)
 
  |-
 
  |-
  | record || 2
+
  | Item
  |-
+
| [[Slot Data|Slot]]
  | weather || 3
+
  |  
 +
  |}
 +
 
 +
==== Set Experience ====
 +
 
 +
Sent by the server when the client should change experience levels.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 
  |-
 
  |-
  | block || 4
+
  |rowspan="3"| 0x47
 +
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Experience bar
 +
| Float
 +
| Between 0 and 1
 
  |-
 
  |-
  | hostile || 5
+
  | Level
 +
| VarInt
 +
|  
 
  |-
 
  |-
  | neutral || 6
+
  | Total Experience
|-
+
  | VarInt
  | player || 7
+
  | See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion
  |-
 
| ambient || 8
 
|-
 
| voice || 9
 
 
  |}
 
  |}
  
==== Sound Effect ====
+
==== Update Health ====
  
This packet is used to play a number of hardcoded sound events. For custom sounds, use [[#Named Sound Effect|Named Sound Effect]].
+
Sent by the server to update/set the health of the player it is sent to.
  
{{Warning|Numeric sound effect IDs are liable to change between versions}}
+
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"
Line 3,953: Line 4,128:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="7"| 0x4D
+
  |rowspan="3"| 0x48
  |rowspan="7"| Play
+
  |rowspan="3"| Play
  |rowspan="7"| Client
+
  |rowspan="3"| Client
  | Sound ID
+
  | Health
  | VarInt
+
  | Float
  | ID of hardcoded sound event ([http://pokechu22.github.io/Burger/1.12.2.html#sounds events] as of 1.12.2)
+
  | 0 or less = dead, 20 = full HP
 
  |-
 
  |-
  | Sound Category
+