Difference between revisions of "Protocol"

From wiki.vg
Jump to: navigation, search
m (discovery regarding enchant tooltips)
(Undo revision 6638 by Kangarko (talk))
Line 1: Line 1:
This page presents a dissection of the current stable [http://minecraft.net/game/ Minecraft] protocol. The current pre-release protocol is documented [[Pre-release_protocol|elsewhere]]. The protocol for Pocket Minecraft is substantially different, and is documented at [[Pocket Minecraft Protocol]].
+
{{Box|
 +
BORDER = #9999FF|
 +
BACKGROUND = #99CCFF|
 +
WIDTH = 100%|
 +
ICON = |
 +
HEADING = Heads up! |
 +
CONTENT =
 +
This article is about the protocol for the latest '''stable''' release of Minecraft computer edition. For the current pre-release protocol, see [[Pre-release 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 irc.freenode.net]).
+
This page presents a dissection of the current '''[https://minecraft.net/ Minecraft] protocol'''. The protocol for Pocket Minecraft is substantially different, and is documented at [[Pocket 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 irc.freenode.net]).
  
 
'''Note:''' While you may use the contents of this page without restriction to create servers, clients, bots, etc… you still need to provide attribution to #mcdevs if you copy any of the contents of this page for publication elsewhere.
 
'''Note:''' While you may use the contents of this page without restriction to create servers, clients, bots, etc… you still need to provide attribution to #mcdevs if you copy any of the contents of this page for publication elsewhere.
  
{{Warning|As of 1.7 strings are now UTF-8 (prefixed with a VarInt giving the string's length in bytes) instead of UTF-16.}}
+
The changes between versions may be viewed at [[Protocol History]].
  
{{Warning|As of 1.7.6 all UUIDs used in the protocol now contain '-'. The session server still returns them without}}
+
== Definitions ==
  
The changes between versions may be viewed at [[Protocol History]]
+
The Minecraft server accepts connections from TCP clients and communicates with them using ''packets''. A packet is a sequence of bytes sent over the TCP connection. The meaning of a packet depends both on its packet ID and the current state of the connection. The initial state of each connection is [[#Handshaking|Handshaking]], and state is switched using the packets [[#Handshake|Handshake]] ([[#Handshaking|Handshaking]], 0x00, serverbound) and [[#Login Success|Login Success]] ([[#Login|Login]], 0x02, clientbound).
 
 
== Definitions ==
 
  
 
=== Data types ===
 
=== Data types ===
  
<!-- Transcluded contents of data types page in here - go to that page if you want to edit it -->
+
<!-- Transcluded contents of Data Types article in here - go to that page if you want to edit it -->
  
 
{{:Data Types}}
 
{{:Data Types}}
Line 22: Line 30:
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! Term
+
! Term
! Definition
+
! Definition
|-
+
|-
| Player
+
| Player
| When used in the singular, Player always refers to the client connected to the server
+
| When used in the singular, Player always refers to the client connected to the server.
|-
+
|-
| Entity
+
| Entity
| Entity refers to any item, player, mob, minecart or boat in the world. This definition is subject to change as Notch extends the protocol
+
| Entity refers to any item, player, mob, minecart or boat etc. See {{Minecraft Wiki|Entity|the Minecraft Wiki article}} for a full list.
|-
+
|-
| EID
+
| EID
| An EID - or Entity ID - is a unique 4-byte integer used to identify a specific entity
+
| An EID or Entity ID is a 4-byte sequence used to identify a specific entity. An entity's EID is unique on the entire server.
|-
+
|-
| XYZ
+
| XYZ
| In this document, the axis names are the same as those used by Notch. Y points upwards, X points South, and Z points West.
+
| In this document, the axis names are the same as those shown in the debug screen (F3). Y points upwards, X points East, and Z points South.
|-
+
|-
!colspan="2"|See also: [[Units of Measurement]]
+
!colspan="2"| See also: [[Units of Measurement]]
|}
+
|}
 +
 
 +
== Packet format ==
 +
 
 +
=== Without compression ===
 +
 
 +
{| class="wikitable"
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| Length
 +
| VarInt
 +
| Length of packet data + length of the packet ID
 +
|-
 +
| Packet ID
 +
| VarInt
 +
|
 +
|-
 +
| Data
 +
| Byte Array
 +
| Depends on the connection state and packet ID, see the sections below
 +
|}
  
== Packets ==
+
=== With compression ===
  
=== Protocol Version ===
+
Once a [[#Set Compression|Set Compression]] packet is sent, [[wikipedia:Zlib|zlib]] compression is enabled for all following packets. The format of a packet changes slighty to include the size of the uncompressed packet.
1.7.2 - 4
 
  
1.7.6 - 5
+
{| class=wikitable
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| Packet Length
 +
| VarInt
 +
| Length of Data + length of Data Length
 +
|-
 +
| Data Length
 +
| VarInt
 +
| Length of uncompressed Data or 0
 +
|-
 +
| Data
 +
| Byte Array
 +
| zlib compressed packet, including packet ID (see the sections below)
 +
|}
  
== Packet format ==
+
The length given by the Packet Length field is the number of bytes that remain in that packet, including the Data Length field.
 +
 
 +
If Data Length is set to zero, then the packet is uncompressed; otherwise it is the size of the uncompressed packet.
 +
 
 +
If compressed, the length of Data must be equal to or over the threshold set in the Set Compression packet, otherwise the client/server will disconnect.
  
{| class="wikitable"
+
Compression can be disabled by sending a threshold of -1.
! Field Name !! Field Type !! Notes
 
|-
 
| Length || VarInt || Length of packet data + length of the packet ID
 
|-
 
| Packet ID || VarInt ||
 
|-
 
| Data || ||
 
|}
 
  
 
== Handshaking ==
 
== Handshaking ==
Line 65: Line 106:
  
 
==== Handshake ====
 
==== Handshake ====
 +
 
This causes the server to switch into the target state.
 
This causes the server to switch into the target state.
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x00 || rowspan=4 | Handshake || rowspan=4 | Server
+
! Bound To
| Protocol Version || VarInt || (4 as of 1.7.2)
+
! Field Name
|-
+
! Field Type
| Server Address (hostname or IP) || String || localhost
+
! Notes
|-  
+
|-
| Server Port || Unsigned Short|| 25565
+
|rowspan="4"| 0x00
|-
+
|rowspan="4"| Handshake
| Next state || VarInt || 1 for status, 2 for login
+
|rowspan="4"| Server
|}
+
| Protocol Version
 +
| VarInt
 +
| See [[protocol version numbers]] (currently 47)
 +
|-
 +
| Server Address
 +
| String
 +
| hostname or IP, e.g. localhost or 127.0.0.1<!-- does this support IPv6? -->
 +
|-  
 +
| Server Port
 +
| Unsigned Short
 +
| default is 25565
 +
|-
 +
| Next State
 +
| VarInt
 +
| 1 for [[#Status|status]], 2 for [[#Login|login]]
 +
|}
  
 
== Play ==
 
== Play ==
Line 88: Line 146:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Keep Alive ID || Int ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x00
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Keep Alive ID
 +
| VarInt
 +
|  
 +
|}
  
 
==== Join Game ====
 
==== Join Game ====
 +
 
See [[Protocol Encryption]] for information on logging in.
 
See [[Protocol Encryption]] for information on logging in.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x01 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || Int || The player's Entity ID
+
! Field Name
|-
+
! Field Type
| Gamemode || Unsigned Byte || 0: survival, 1: creative, 2: adventure. Bit 3 (0x8) is the hardcore flag
+
! Notes
|-
+
|-
| Dimension || Byte || -1: nether, 0: overworld, 1: end
+
|rowspan="7"| 0x01
|-
+
|rowspan="7"| Play
| Difficulty || Unsigned Byte || 0 thru 3 for Peaceful, Easy, Normal, Hard
+
|rowspan="7"| Client
|-
+
| Entity ID
| Max Players || Unsigned Byte || Used by the client to draw the player list
+
| Int
|-
+
| The player's Entity ID (EID)
| Level Type || String || default, flat, largeBiomes, amplified, default_1_1
+
|-
|}
+
| Gamemode
 +
| Unsigned Byte
 +
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator. Bit 3 (0x8) is the hardcore flag.
 +
|-
 +
| Dimension
 +
| Byte
 +
| -1: Nether, 0: Overworld, 1: End
 +
|-
 +
| Difficulty
 +
| Unsigned Byte
 +
| 0: peaceful, 1: easy, 2: normal, 3: hard
 +
|-
 +
| Max Players
 +
| Unsigned Byte
 +
| Used by the client to draw the player list
 +
|-
 +
| Level Type
 +
| String
 +
| default, flat, largeBiomes, amplified, default_1_1
 +
|-
 +
| Reduced Debug Info
 +
| Boolean
 +
|
 +
|}
 +
 
 
{{Warning|If the Dimension isn't valid then the client will crash}}
 
{{Warning|If the Dimension isn't valid then the client will crash}}
  
==== Chat Message ====
+
==== Chat Message ====  
 +
 
 +
Identifying the difference between Chat/System Message is important as it helps respect the user's chat visibility options. While Position 2 accepts json formatting it will not display, old style formatting works
 +
 
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x02 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| JSON Data || String || [[Chat]], Limited to 32767 bytes
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x02
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| JSON Data
 +
| [[Chat]]
 +
| Limited to 32767 bytes
 +
|-
 +
| Position
 +
| Byte
 +
| 0: chat (chat box), 1: system message (chat box), 2: above action bar
 +
|}
 +
 
 
{{Warning|Malformed JSON will disconnect the client}}
 
{{Warning|Malformed JSON will disconnect the client}}
  
Line 133: Line 242:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x03 || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Age of the world || Long || In ticks; not changed by server commands
+
! Field Name
|-
+
! Field Type
| Time of day || Long || The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x03
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| World Age
 +
| Long
 +
| In ticks; not changed by server commands
 +
|-
 +
| Time of day
 +
| Long
 +
| The world (or region) time, in ticks. If negative the sun will stop moving at the Math.abs of the time
 +
|}
  
 
==== Entity Equipment ====
 
==== Entity Equipment ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x04 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| EntityID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Slot || Short || Equipment slot: 0=held, 1-4=armor slot (1 - boots, 2 - leggings, 3 - chestplate, 4 - helmet)
+
! Notes
|-
+
|-
| Item || [[Slot_Data|Slot]] || Item in slot format
+
|rowspan="3"| 0x04
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Entity ID
 +
| VarInt
 +
| Entity's EID
 +
|-
 +
| Slot
 +
| Short
 +
| Equipment slot. 0: held, 1–4: armor slot (1: boots, 2: leggings, 3: chestplate, 4: helmet)
 +
|-
 +
| Item
 +
| [[Slot Data|Slot]]
 +
| Item in slot format
 +
|}
  
 
==== Spawn Position ====
 
==== Spawn Position ====
Line 158: Line 292:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x05 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| X || Int || Spawn X in block coordinates
+
! Field Name
|-
+
! Field Type
| Y || Int || Spawn Y in block coordinates
+
! Notes
|-
+
|-
| Z || Int || Spawn Z in block coordinates
+
|rowspan="1"| 0x05
|}
+
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Location
 +
| Position
 +
| Spawn location
 +
|}
  
 
==== Update Health ====
 
==== Update Health ====
Line 172: Line 311:
 
Sent by the server to update/set the health of the player it is sent to.
 
Sent by the server to update/set the health of the player it is sent to.
  
Food saturation acts as a food "overcharge". Food values will not decrease while the saturation is over zero. Players logging in automatically get a saturation of 5.0. Eating food increases the saturation as well as the food bar.
+
Food {{Minecraft Wiki|Food#Hunger vs. Saturation|saturation}} acts as a food “overcharge”. Food values will not decrease while the saturation is over zero. Players logging in automatically get a saturation of 5.0. Eating food increases the saturation as well as the food bar.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x06 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Health || Float || 0 or less = dead, 20 = full HP
+
! Field Name
|-
+
! Field Type
| Food || Short || 0 - 20
+
! Notes
|-  
+
|-
| Food Saturation || Float || Seems to vary from 0.0 to 5.0 in integer increments
+
|rowspan="3"| 0x06
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Health
 +
| Float
 +
| 0 or less = dead, 20 = full HP
 +
|-
 +
| Food
 +
| VarInt
 +
| 0–20
 +
|-  
 +
| Food Saturation
 +
| Float
 +
| Seems to vary from 0.0 to 5.0 in integer increments
 +
|}
  
 
==== Respawn ====
 
==== 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.
+
To change the player's dimension (overworld/nether/end), send them a respawn packet with the appropriate dimension, followed by prechunks/chunks for the new dimension, and finally a position and look packet. You do not need to unload chunks, the client will do it automatically.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x07 || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Dimension || Int || -1: The Nether, 0: The Overworld, 1: The End
+
! Field Name
|-
+
! Field Type
| Difficulty || Unsigned Byte || 0 thru 3 for Peaceful, Easy, Normal, Hard.
+
! Notes
|-
+
|-
| Gamemode || Unsigned Byte || 0: survival, 1: creative, 2: adventure. The hardcore flag is not included
+
|rowspan="4"| 0x07
|-
+
|rowspan="4"| Play
| Level Type || String || Same as [[Protocol#Join_Game|Join Game]]
+
|rowspan="4"| Client
|}
+
| Dimension
 +
| Int
 +
| -1: The Nether, 0: The Overworld, 1: The End
 +
|-
 +
| Difficulty
 +
| Unsigned Byte
 +
| 0: Peaceful, 1: Easy, 2: Normal, 3: Hard
 +
|-
 +
| Gamemode
 +
| Unsigned Byte
 +
| 0: survival, 1: creative, 2: adventure. The hardcore flag is not included
 +
|-
 +
| Level Type
 +
| String
 +
| Same as [[#Join Game|Join Game]]
 +
|}
 +
 
 
{{Warning|If the Dimension isn't valid then the client will crash}}
 
{{Warning|If the Dimension isn't valid then the client will crash}}
  
 
{{Warning|Avoid changing player's dimension to same dimension they were already in, weird bugs can occur i.e. such player will be unable to attack other players in new world (fixes after their death and respawn)}}
 
{{Warning|Avoid changing player's dimension to same dimension they were already in, weird bugs can occur i.e. such player will be unable to attack other players in new world (fixes after their death and respawn)}}
  
==== Player Position And Look ====
+
==== Player Position And Look ====  
 +
 
 +
Updates the players position on the server.
 +
 
 +
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 units will result in the client being kicked for “You moved too quickly :( (Hacking?)”
  
Updates the players position on the server.
+
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”
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 units will result in the client being kicked for "You moved too quickly :( (Hacking?)"
 
Also if the fixed-point number of X or Z is set greater than <code>3.2E7D</code> the client will be kicked for "Illegal position"
 
  
Yaw is measured in degrees, and does not follow classical trigonometry rules. The unit circle of yaw on the XZ-plane starts at (0, 1) and turns counterclockwise, with 90 at (-1, 0), 180 at (0,-1) and 270 at (1, 0). Additionally, yaw is not clamped to between 0 and 360 degrees; any number is valid, including negative numbers and numbers greater than 360.
+
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.
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
  
The yaw of player (in degrees), standing at point (x0,z0) and looking towards point (x,z) one can be calculated with:
+
The yaw of player (in degrees), standing at point (x0, z0) and looking towards point (x, z) one can be calculated with:
  l = x-x0
+
 
  w = z-z0
+
l = x-x0
  c = sqrt( l*l + w*w )
+
w = z-z0
  alpha1 = -arcsin(l/c)/PI*180
+
c = sqrt( l*l + w*w )
  alpha2 =  arccos(w/c)/PI*180
+
alpha1 = -arcsin(l/c)/PI*180
  if alpha2 > 90 then
+
alpha2 =  arccos(w/c)/PI*180
    yaw = 180 - alpha1
+
if alpha2 > 90 then
  else
+
    yaw = 180 - alpha1
    yaw = alpha1
+
else
 +
    yaw = alpha1
  
 
You can get a unit vector from a given yaw/pitch via:
 
You can get a unit vector from a given yaw/pitch via:
  x = -cos(pitch) * sin(yaw)
+
 
  y = -sin(pitch)
+
x = -cos(pitch) * sin(yaw)
  z =  cos(pitch) * cos(yaw)
+
y = -sin(pitch)
 +
z =  cos(pitch) * cos(yaw)
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6| 0x08 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| X || Double || Absolute position
+
! Field Name
|-
+
! Field Type
| Y || Double || Absolute position (eyes pos)
+
! Notes
|-
+
|-
| Z || Double || Absolute position
+
|rowspan="6"| 0x08
|-
+
|rowspan="6"| Play
| Yaw || Float || Absolute rotation on the X Axis, in degrees
+
|rowspan="6"| Client
|-
+
| X
| Pitch || Float || Absolute rotation on the Y Axis, in degrees
+
| Double
|-
+
| Absolute or relative position, depending on Flags
| On Ground || Bool || True if the client is on the ground, False otherwise
+
|-
|}
+
| Y
 +
| Double
 +
| Absolute or relative position, depending on Flags
 +
|-
 +
| Z
 +
| Double
 +
| Absolute or relative position, depending on Flags
 +
|-
 +
| Yaw
 +
| Float
 +
| Absolute or relative rotation on the X Axis, in degrees
 +
|-
 +
| Pitch
 +
| Float
 +
| Absolute or relative rotation on the Y Axis, in degrees
 +
|-
 +
| Flags
 +
| Byte
 +
| Bit field, see below
 +
|}
 +
 
 +
About the Flags field:
 +
 
 +
<Dinnerbone> It's a bitfield, X/Y/Z/Y_ROT/X_ROT. If X is set, the x value is relative and not absolute.
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Field
 +
! Bit
 +
|-
 +
| X
 +
| 0x01
 +
|-
 +
| Y
 +
| 0x02
 +
|-
 +
| Z
 +
| 0x04
 +
|-
 +
| Y_ROT
 +
| 0x08
 +
|-
 +
| X_ROT
 +
| 0x10
 +
|}
  
 
==== Held Item Change ====
 
==== Held Item Change ====
  
Sent to change the player's slot selection
+
Sent to change the player's slot selection.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x09 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Slot || Byte || The slot which the player has selected (0-8)
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x09
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Slot
 +
| Byte
 +
| The slot which the player has selected (0–8)
 +
|}
  
==== Use Bed ====
+
==== Use Bed ====  
  
 
This packet tells that a player goes to bed.
 
This packet tells that a player goes to bed.
  
The client with the matching Entity ID will go into bed mode.
+
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.
 
This Packet is sent to all nearby players including the one sent to bed.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x0A || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Player ID
+
! Field Name
|-
+
! Field Type
| X || Int || Bed headboard X as block coordinate
+
! Notes
|-
+
|-
| Y || Unsigned Byte || Bed headboard Y as block coordinate
+
|rowspan="2"| 0x0A
|-
+
|rowspan="2"| Play
| Z || Int || Bed headboard Z as block coordinate
+
|rowspan="2"| Client
|}
+
| Entity ID
 +
| VarInt
 +
| Sleeping player's EID
 +
|-
 +
| Location
 +
| Position
 +
| Block location of the head part of the bed
 +
|}
  
 
==== Animation ====
 
==== Animation ====
Line 285: Line 517:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x0B || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || VarInt || Player ID
+
! Field Name
|-
+
! Field Type
| Animation || Unsigned Byte || Animation ID
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x0B
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
| Player ID
 +
|-
 +
| Animation
 +
| Unsigned Byte
 +
| Animation ID (see below)
 +
|}
  
 
Animation can be one of the following values:
 
Animation can be one of the following values:
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Animation
+
! ID
|-
+
! Animation
| 0 || Swing arm
+
|-
|-
+
| 0
| 1 || Damage animation
+
| Swing arm
|-
+
|-
| 2 || Leave bed
+
| 1
|-
+
| Take damage
| 3 || Eat food
+
|-
|-
+
| 2
| 4 || Critical effect
+
| Leave bed
|-
+
|-
| 5 || Magic critical effect
+
| 3
|-
+
| Eat food
| 102 || (unknown)
+
|-
|-
+
| 4
| 104 || Crouch
+
| Critical effect
|-
+
|-
| 105 || Uncrouch
+
| 5
|}
+
| Magic critical effect
 +
|}
  
 
==== Spawn Player ====
 
==== Spawn Player ====
  
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]] ([[#Play|Play]], 0x38, clientbound) packet that adds the player data for the client to use when spawning a player. The tab 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.
  
When in online-mode the uuids must be valid and have valid skin blobs, in offline-mode uuid v3 is used.
+
When in online-mode the UUIDs must be valid and have valid skin blobs, in offline-mode UUID v3 is used.
  
 
For NPCs UUID v2 should be used. Note:
 
For NPCs UUID v2 should be used. Note:
  <+Grum> i will never confirm this as a feature you know that :)
+
 
 +
<+Grum> i will never confirm this as a feature you know that :)
 +
 
 +
In an example UUID, <code>xxxxxxxx-xxxx-Yxxx-xxxx-xxxxxxxxxxxx</code>, the UUID version is specified by <code>Y</code>. So, for UUID v3, <code>Y</code> will always be <code>3</code>, and for UUID v2, <code>Y</code> will always be <code>2</code>.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! colspan=2 | Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=14 | 0x0C || rowspan=14 | Play || rowspan=14 | Client
+
! Bound To
| colspan=2 | Entity ID || VarInt || Player's Entity ID
+
! Field Name
|-
+
! Field Type
| colspan=2 | Player UUID || String || Player's UUID
+
! Notes
|-
+
|-
| colspan=2 | Player Name || String || Player's Name
+
|rowspan="9"| 0x0C
|-
+
|rowspan="9"| Play
| colspan=2 | Data count || VarInt ||
+
|rowspan="9"| Client
|-
+
| Entity ID
| rowspan=3 | Data
+
| VarInt
| Name || String || Name of the property as return by the session server's /hasJoined. E.g: textures
+
| Player's EID
|-
+
|-
| Value || String || Value of the property (base64) as return by the session server's /hasJoined
+
| Player UUID
|-
+
| UUID
| Signature || String || Signature of the property (base64) as return by the session server's /hasJoined.
+
|  
|-
+
|-
| colspan=2 | X || Int || Player X as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
| X
|-
+
| Int
| colspan=2 | Y || Int || Player X as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
| Player X as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
|-
+
|-
| colspan=2 | Z || Int || Player X as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
| Y
|-
+
| Int
| colspan=2 | Yaw || Byte || Player rotation as a packed byte
+
| Player Y as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
|-
+
|-
| colspan=2 | Pitch || Byte || Player rotation as a packet byte
+
| Z
|-
+
| Int
| colspan=2 | Current Item || Short || The item the player is currently holding. Note that this should be 0 for "no item", unlike -1 used in other packets. A negative value crashes clients.
+
| Player Z as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
|-
+
|-
| colspan=2 | Metadata || [[Entities#Entity_Metadata_Format|Metadata]] || The client will crash if no metadata is sent
+
| Yaw
|}
+
| Angle
{{Warning|The client will crash if no metadata is sent}}
+
|  
{{Warning|The client will disconnect if both UUID and Name are empty}}
+
|-
 +
| Pitch
 +
| Angle
 +
|  
 +
|-
 +
| Current Item
 +
| Short
 +
| The item the player is currently holding. Note that this should be 0 for “no item”, unlike -1 used in other packets.
 +
|-
 +
| Metadata
 +
| [[Entities#Entity Metadata Format|Metadata]]
 +
|  
 +
|}
 +
 
 +
{{Warning|A negative Current Item crashes clients}}
 +
 
 +
{{Warning|The client will crash if no Metadata is sent}}
  
 
==== Collect Item ====
 
==== Collect Item ====
  
Sent by the server when someone picks up an item lying on the ground - its sole purpose appears to be the animation of the item flying towards you. It doesn't destroy the entity in the client memory, and it doesn't add it to your inventory. The server only checks for items to be picked up after each Player Position and [Player Position & Look packet sent by the client.
+
Sent by the server when someone picks up an item lying on the ground its sole purpose appears to be the animation of the item flying towards you. It doesn't destroy the entity in the client memory, and it doesn't add it to your inventory. The server only checks for items to be picked up after each [[#Player Position|Player Position]] (and [[#Player Position And Look|Player Position And Look]]) packet sent by the client.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x0D || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Collected Entity ID || Int ||
+
! Field Name
|-  
+
! Field Type
| Collector Entity ID || Int ||
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x0D
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Collected Entity ID
 +
| VarInt
 +
|  
 +
|-  
 +
| Collector Entity ID
 +
| VarInt
 +
|  
 +
|}
  
 
==== Spawn Object ====
 
==== Spawn Object ====
Line 382: Line 658:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=8| 0x0E || rowspan=8 | Play || rowspan=8 | Client
+
! Bound To
| Entity ID || VarInt || Entity ID of the object
+
! Field Name
|-
+
! Field Type
| Type || Byte || The type of object (See [[Entities#Objects|Objects]])
+
! Notes
|-
+
|-
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
|rowspan="8"| 0x0E
|-
+
|rowspan="8"| Play
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
|rowspan="8"| Client
|-
+
| Entity ID  
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
| VarInt
|-
+
| EID of the object
| Pitch || Byte || The pitch in steps of 2p/256
+
|-
|-
+
| Type
| Yaw || Byte || The yaw in steps of 2p/256
+
| Byte
|-
+
| The type of object (See [[Entities#Objects|Objects]])
| Data || [[Object_Data|Object Data]] ||
+
|-
|}
+
| X
 +
| Int
 +
| X position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Y
 +
| Int
 +
| Y position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Z
 +
| Int
 +
| Z position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Pitch
 +
| Angle
 +
|  
 +
|-
 +
| Yaw
 +
| Angle
 +
|  
 +
|-
 +
| Data
 +
| [[Object Data]]
 +
|  
 +
|}
  
 
==== Spawn Mob ====
 
==== Spawn Mob ====
Line 407: Line 706:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=12 | 0x0F || rowspan=12 | Play || rowspan=12 | Client
+
! Bound To
| Entity ID || VarInt || Entity's ID
+
! Field Name
|-
+
! Field Type
| Type || Unsigned Byte || The type of mob. See [[Entities#Mobs|Mobs]]
+
! Notes
|-
+
|-
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
|rowspan="12"| 0x0F
|-
+
|rowspan="12"| Play
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
|rowspan="12"| Client
|-
+
| Entity ID
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
| VarInt
|-
+
|  
| Yaw || Byte || The yaw in steps of 2p/256
+
|-
|-
+
| Type
| Pitch || Byte || The pitch in steps of 2p/256
+
| Unsigned Byte
|-
+
| The type of mob. See [[Entities#Mobs|Mobs]]
| Head Pitch || Byte || The pitch in steps of 2p/256
+
|-
|-
+
| X
| Velocity X || Short ||
+
| Int
|-
+
| X position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]  
| Velocity Y || Short ||
+
|-
|-
+
| Y
| Velocity Z || Short ||
+
| Int
|-
+
| Y position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]  
| Metadata || [[Entities#Entity_Metadata_Format|Metadata]] ||
+
|-
|}
+
| Z
 +
| Int
 +
| Z position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]  
 +
|-
 +
| Yaw
 +
| Angle
 +
|  
 +
|-
 +
| Pitch
 +
| Angle
 +
|  
 +
|-
 +
| Head Pitch
 +
| Angle
 +
|  
 +
|-
 +
| Velocity X
 +
| Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]]
 +
|-
 +
| Velocity Y
 +
| Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]]
 +
|-
 +
| Velocity Z
 +
| Short
 +
| Same units as [[#Entity Velocity|Entity Velocity]]
 +
|-
 +
| Metadata
 +
| [[Entities#Entity Metadata Format|Metadata]]
 +
|  
 +
|}
  
 
==== Spawn Painting ====
 
==== Spawn Painting ====
Line 441: Line 771:
 
Calculating the center of an image: given a (width x height) grid of cells, with (0, 0) being the top left corner, the center is (max(0, width / 2 - 1), height / 2). E.g.
 
Calculating the center of an image: given a (width x height) grid of cells, with (0, 0) being the top left corner, the center is (max(0, width / 2 - 1), height / 2). E.g.
  
2x1 (1, 0)
+
2x1 (1, 0)
4x4 (1, 2)
+
4x4 (1, 2)
 
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x10 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || VarInt || Entity's ID
+
! Field Name
|-
+
! Field Type
| Title || String || Name of the painting. Max length 13
+
! Notes
|-
+
|-
| X || Int || Center X coordinate
+
|rowspan="4"| 0x10
|-
+
|rowspan="4"| Play
| Y || Int || Center Y coordinate
+
|rowspan="4"| Client
|-
+
| Entity ID
| Z || Int || Center Z coordinate
+
| VarInt
|-
+
|  
| Direction || Int || Direction the painting faces (0 -z, 1 -x, 2 +z, 3 +x)
+
|-
|}
+
| Title
 +
| String
 +
| Name of the painting. Max length 13
 +
|-
 +
| Location
 +
| Position
 +
| Center coordinates
 +
|-
 +
| Direction
 +
| Unsigned Byte
 +
| Direction the painting faces. 0: north (-z), 1: west (-x), 2: south (+z), 3: east (+x)
 +
|}
  
 
==== Spawn Experience Orb ====
 
==== Spawn Experience Orb ====
Line 467: Line 807:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x11 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Entity ID || VarInt || Entity's ID
+
! Field Name
|-
+
! Field Type
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
! Notes
|-
+
|-
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
|rowspan="5"| 0x11
|-
+
|rowspan="5"| Play
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]  
+
|rowspan="5"| Client
|-
+
| Entity ID
| Count || Short || The amount of experience this orb will reward once collected
+
| VarInt
|}
+
| Entity's ID
 +
|-
 +
| X
 +
| Int
 +
| X position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Y
 +
| Int
 +
| Y position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Z
 +
| Int
 +
| Z position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Count
 +
| Short
 +
| The amount of experience this orb will reward once collected
 +
|}
  
 
==== Entity Velocity ====
 
==== Entity Velocity ====
  
Velocity is believed to be in units of 1/8000 of a block per server tick (50ms);
+
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).
for example, -1343 would move (-1343 / 8000) = -0.167875 blocks per tick (or -3,3575 blocks per second).
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x12 || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Velocity X || Short || Velocity on the X axis
+
! Notes
|-
+
|-
| Velocity Y || Short || Velocity on the Y axis
+
|rowspan="4"| 0x12
|-
+
|rowspan="4"| Play
| Velocity Z || Short || Velocity on the Z axis
+
|rowspan="4"| Client
|}
+
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Velocity X
 +
| Short
 +
| Velocity on the X axis
 +
|-
 +
| Velocity Y
 +
| Short
 +
| Velocity on the Y axis
 +
|-
 +
| Velocity Z
 +
| Short
 +
| Velocity on the Z axis
 +
|}
  
 
==== Destroy Entities ====
 
==== Destroy Entities ====
  
Sent by the server when an list of Entities is to be destroyed on the client.
+
Sent by the server when a list of entities is to be destroyed on the client.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x13 || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Count || Byte || Length of following array
+
! Field Name
|-
+
! Field Type
| Entity IDs || Array of Int || The list of entities of destroy  
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x13
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Entity IDs
 +
| Array of VarInt
 +
| The list of entities of destroy
 +
|}
  
 
==== Entity ====
 
==== Entity ====
Line 516: Line 898:
 
Most entity-related packets are subclasses of this packet. When sent from the server to the client, it may initialize the entry.
 
Most entity-related packets are subclasses of this packet. When sent from the server to the client, it may initialize the entry.
  
For player entities, either this packet or any move/look packet is sent every game tick.
+
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.
So the meaning of this packet is basically that the entity did not move/look since the last such packet.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x14 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x14
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Entity ID
 +
| VarInt
 +
|  
 +
|}
  
 
==== Entity Relative Move ====
 
==== Entity Relative Move ====
  
This packet is sent by the server when an entity moves less then 4 blocks; if an entity moves more than 4 blocks Entity Teleport should be sent instead.
+
This packet is sent by the server when an entity moves less then 4 blocks; if an entity moves more than 4 blocks [[#Entity Teleport|Entity Teleport]] should be sent instead.
  
 
This packet allows at most four blocks movement in any direction, because byte range is from -128 to 127.
 
This packet allows at most four blocks movement in any direction, because byte range is from -128 to 127.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4| 0x15 || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| DX || Byte || Change in X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
! Notes
|-
+
|-
| DY || Byte || Change in Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="5"| 0x15
|-
+
|rowspan="5"| Play
| DZ || Byte || Change in Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="5"| Client
|}
+
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Delta X
 +
| Byte
 +
| Change in X position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Delta Y
 +
| Byte
 +
| Change in Y position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Delta Z
 +
| Byte
 +
| Change in Z position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| On Ground
 +
| Boolean
 +
|
 +
|}
  
 
==== Entity Look ====
 
==== Entity Look ====
  
This packet is sent by the server when an entity rotates.  Example: "Yaw" field 64 means a 90 degree turn.
+
This packet is sent by the server when an entity rotates.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x16 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Yaw || Byte || The X Axis rotation as a fraction of 360
+
! Notes
|-
+
|-
| Pitch || Byte || The Y Axis rotation as a fraction of 360
+
|rowspan="5"| 0x16
|}
+
|rowspan="5"| Play
 +
|rowspan="5"| Client
 +
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Yaw
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| Pitch
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| On Ground
 +
| Boolean
 +
|  
 +
|}
  
==== Entity Look and Relative Move ====
+
==== Entity Look And Relative Move ====
  
This packet is sent by the server when an entity rotates and moves.
+
This packet is sent by the server when an entity rotates and moves. Since a byte range is limited from -128 to 127, and movement is offset of fixed-point numbers, this packet allows at most four blocks movement in any direction. (-128/32 == -4)
Since a byte range is limited from -128 to 127, and movement is offset of fixed-point numbers,
 
this packet allows at most four blocks movement in any direction. (-128/32 == -4)
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x17 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| DX || Byte || Change in X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
! Notes
|-
+
|-
| DY || Byte || Change in Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="7"| 0x17
|-
+
|rowspan="7"| Play
| DZ || Byte || Change in Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="7"| Client
|-
+
| Entity ID
| Yaw || Byte || The X Axis rotation as a fraction of 360
+
| VarInt
|-
+
|  
| Pitch || Byte || The Y Axis rotation as a fraction of 360
+
|-
|}
+
| Delta X
 +
| Byte
 +
| Change in X position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Delta Y
 +
| Byte
 +
| Change in Y position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Delta Z
 +
| Byte
 +
| Change in Z position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Yaw
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| Pitch
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| On Ground
 +
| Boolean
 +
|  
 +
|}
  
 
==== Entity Teleport ====
 
==== Entity Teleport ====
Line 588: Line 1,035:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x18 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| X || Int || X position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
! Notes
|-
+
|-
| Y || Int || Y position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="7"| 0x18
|-
+
|rowspan="7"| Play
| Z || Int || Z position as a [[Data_Types#Fixed-point_numbers|Fixed-Point number]]
+
|rowspan="7"| Client
|-
+
| Entity ID
| Yaw || Byte || The X Axis rotation as a fraction of 360
+
| VarInt
|-
+
|  
| Pitch || Byte || The Y Axis rotation as a fraction of 360
+
|-
|}
+
| X
 +
| Int
 +
| X position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Y
 +
| Int
 +
| Y position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Z
 +
| Int
 +
| Z position as a [[Data Types#Fixed-point numbers|Fixed-Point number]]
 +
|-
 +
| Yaw
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| Pitch
 +
| Angle
 +
| New angle, not a delta
 +
|-
 +
| On Ground
 +
| Boolean
 +
|  
 +
|}
  
 
==== Entity Head Look ====
 
==== Entity Head Look ====
Line 609: Line 1,079:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x19 || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Head Yaw || Byte || Head yaw in steps of 2p/256
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x19
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Head Yaw
 +
| Angle
 +
| New angle, not a delta
 +
|}
  
 
==== Entity Status ====
 
==== Entity Status ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x1A || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Entity Status || Byte || See below
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x1A
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| Int
 +
|  
 +
|-
 +
| Entity Status
 +
| Byte
 +
| See below
 +
|}
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! Entity Status !! Meaning
+
! Entity Status
|-
+
! Meaning
| 0 || Something related to living entities?
+
|-
|-
+
| 1
| 1 || Something related to the player entity?
+
| Sent when resetting a mob spawn minecart's timer - appears to be unused by the client
|-
+
|-
| 2 || Living Entity hurt  
+
| 2
|-
+
| Living Entity hurt  
| 3 || Living Entity dead
+
|-
|-
+
| 3
| 4 || Iron Golem throwing up arms
+
| Living Entity dead
|-
+
|-
| 6 || Wolf/Ocelot/Horse taming - Spawn "heart" particles
+
| 4
|-
+
| Iron Golem throwing up arms
| 7 || Wolf/Ocelot/Horse tamed - Spawn "smoke" particles
+
|-
|-
+
| 6
| 8 || Wolf shaking water - Trigger the shaking animation
+
| Wolf/Ocelot/Horse taming Spawn “heart” particles
|-
+
|-
| 9 || (of self) Eating accepted by server
+
| 7
|-
+
| Wolf/Ocelot/Horse tamed Spawn “smoke” particles
| 10 || Sheep eating grass
+
|-
|-
+
| 8
| 11 || Iron Golem handing over a rose
+
| Wolf shaking water Trigger the shaking animation
|-
+
|-
| 12 || Villager mating - Spawn "heart" particles
+
| 9
|-
+
| (of self) Eating accepted by server
| 13 || Spawn particles indicating that a villager is angry and seeking revenge
+
|-
|-
+
| 10
| 14 || Spawn happy particles near a villager
+
| Sheep eating grass
|-
+
|-
| 15 || Witch animation - Spawn "magic" particles
+
| 10
|-
+
| Play TNT ignite sound
| 16 || Zombie converting into a villager by shaking violently
+
|-
|-
+
| 11
| 17 || Firework exploding
+
| Iron Golem handing over a rose
|-
+
|-
| 18 || Animal in love (ready to mate) - Spawn "heart" particles
+
| 12
|}
+
| Villager mating Spawn “heart” particles
 +
|-
 +
| 13
 +
| Spawn particles indicating that a villager is angry and seeking revenge
 +
|-
 +
| 14
 +
| Spawn happy particles near a villager
 +
|-
 +
| 15
 +
| Witch animation Spawn “magic” particles
 +
|-
 +
| 16
 +
| Play zombie converting into a villager sound
 +
|-
 +
| 17
 +
| Firework exploding
 +
|-
 +
| 18
 +
| Animal in love (ready to mate) — Spawn “heart” particles
 +
|-
 +
| 19
 +
| Reset squid rotation
 +
|-
 +
| 20
 +
| Spawn explosion particle — works for some living entities
 +
|-
 +
| 21
 +
| Play guardian sound — works for every entity
 +
|-
 +
| 22
 +
| Enables reduced debug for players
 +
|-
 +
| 23
 +
| Disables reduced debug for players
 +
|}
  
 
==== Attach Entity ====
 
==== Attach Entity ====
  
This packet is sent when a player has been attached to an entity (e.g. Minecart)
+
This packet is sent when a player has been attached to an entity (e.g. Minecart).
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x1B || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Vehicle ID || Int || Vechicle's Entity ID
+
! Notes
|-
+
|-
| Leash || Bool || If true leashes the entity to the vehicle
+
|rowspan="3"| 0x1B
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Entity ID
 +
| Int
 +
| Attached entity's EID. Set to -1 to detach.
 +
|-
 +
| Vehicle ID
 +
| Int
 +
| Vechicle's Entity ID
 +
|-
 +
| Leash
 +
| Boolean
 +
| If true leashes the entity to the vehicle
 +
|}
  
 
==== Entity Metadata ====
 
==== Entity Metadata ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x1C || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Metadata || [[Entities#Entity_Metadata_Format|Metadata]] ||  
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x1C
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Metadata
 +
| [[Entities#Entity Metadata Format|Metadata]]
 +
|  
 +
|}
  
 
==== Entity Effect ====
 
==== Entity Effect ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=4 | 0x1D || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Effect ID || Byte || See [[http://www.minecraftwiki.net/wiki/Potion_effect#Parameters]]
+
! Notes
|-
+
|-
| Amplifier || Byte ||
+
|rowspan="5"| 0x1D
|-
+
|rowspan="5"| Play
| Duration || Short ||
+
|rowspan="5"| Client
|}
+
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Effect ID
 +
| Byte
 +
| See {{Minecraft Wiki|Status effect#List of effects|this table}}
 +
|-
 +
| Amplifier
 +
| Byte
 +
| Notchian client displays effect level as Amplifier + 1
 +
|-
 +
| Duration
 +
| VarInt
 +
| Seconds
 +
|-
 +
| Hide Particles
 +
| Boolean
 +
|  
 +
|}
  
 
==== Remove Entity Effect ====
 
==== Remove Entity Effect ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x1E || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
! Field Name
|-
+
! Field Type
| Effect ID || Byte ||
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x1E
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
|  
 +
|-
 +
| Effect ID
 +
| Byte
 +
| See {{Minecraft Wiki|Status effect#List of effects|this table}}
 +
|}
  
 
==== Set Experience ====
 
==== Set Experience ====
Line 722: Line 1,306:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x1F || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Experience bar || Float || Between 0 and 1
+
! Field Name
|-
+
! Field Type
| Level || Short ||
+
! Notes
|-
+
|-
| Total Experience || Short ||
+
|rowspan="3"| 0x1F
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Experience bar
 +
| Float
 +
| Between 0 and 1
 +
|-
 +
| Level
 +
| VarInt
 +
|  
 +
|-
 +
| Total Experience
 +
| VarInt
 +
| See {{Minecraft Wiki|Experience#Leveling up}} on the Minecraft Wiki for Total Experience to Level conversion
 +
|}
  
 
==== Entity Properties ====
 
==== Entity Properties ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3 | 0x20 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Entity ID || Int || Entity's ID
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| Count || Int || Length of following array
+
! Notes
|-
+
|-
| Properties || Array of Property Data ||
+
|rowspan="6"| 0x20
|}
+
|rowspan="6"| Play
 +
|rowspan="6"| Client
 +
|colspan="2"| Entity ID
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
|colspan="2"| Number Of Properties
 +
|colspan="2"| Int
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="4"| Property
 +
| Key
 +
|rowspan="4"| Array
 +
| String
 +
| See below
 +
|-
 +
| Value
 +
| Double
 +
| See below
 +
|-
 +
| Number Of Modifiers
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Modifiers
 +
| Array of Modifier Data
 +
| See {{Minecraft Wiki|Attribute#Modifiers}}
 +
|}
 +
 
 +
Known Key values:
  
'''Property Data''' structure:
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! Field Name !! Field Type !! Notes
+
! Key
|-
+
! Default
| Key || String ||  
+
! Min
|-
+
! Max
| Value || Double ||  
+
! Label
|-
+
|-
| List Length || Short || Number of list elements that follow.
+
| generic.maxHealth
|-
+
| 20.0
| Modifiers || Array of Modifier Data || http://www.minecraftwiki.net/wiki/Attribute#Modifiers
+
| 0.0
|}
+
| Double.MaxValue
 +
| Max Health
 +
|-
 +
| generic.followRange
 +
| 32.0
 +
| 0.0
 +
| 2048.0
 +
| Follow Range
 +
|-
 +
| generic.knockbackResistance
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Knockback Resistance
 +
|-
 +
| generic.movementSpeed
 +
| 0.699999988079071
 +
| 0.0
 +
| Double.MaxValue
 +
| Movement Speed
 +
|-
 +
| generic.attackDamage
 +
| 2.0
 +
| 0.0
 +
| Double.MaxValue
 +
|
 +
|-
 +
| horse.jumpStrength
 +
| 0.7
 +
| 0.0
 +
| 2.0
 +
| Jump Strength
 +
|-
 +
| zombie.spawnReinforcements
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Spawn Reinforcements Chance
 +
|}
  
Known key values:
+
''Modifier Data'' structure:
{| class="wikitable"
 
|-
 
! Key !! Default !! Min !! Max !! Label
 
|-
 
| generic.maxHealth || 20.0 || 0.0 || Double.MaxValue || Max Health
 
|-
 
| generic.followRange || 32.0 || 0.0 || 2048.0 || Follow Range
 
|-
 
| generic.knockbackResistance || 0.0 || 0.0 || 1.0 || Knockback Resistance
 
|-
 
| generic.movementSpeed || 0.699999988079071 || 0.0 || Double.MaxValue || Movement Speed
 
|-
 
| generic.attackDamage || 2.0 || 0.0 || Double.MaxValue ||
 
|-
 
| horse.jumpStrength || 0.7 || 0.0 || 2.0 || Jump Strength
 
|-
 
| zombie.spawnReinforcements || 0.0 || 0.0 || 1.0 || Spawn Reinforcements Chance
 
|}
 
  
'''Modifier Data''' structure:
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! Field Name !! Field Type !! Notes
+
! Field Name
|-
+
! Field Type
| UUID || 128-bit integer ||
+
! Notes
|-
+
|-
| Amount || Double ||
+
| UUID
|-
+
| UUID
| Operation || Byte ||
+
|  
|}
+
|-
 +
| Amount
 +
| Double
 +
|  
 +
|-
 +
| Operation
 +
| Byte
 +
|  
 +
|}
  
 
==== Chunk Data ====
 
==== Chunk Data ====
  
Chunks are not unloaded by the client automatically. To unload chunks, send this packet with ground-up continuous=true and no 16^3 chunks (eg. primary bit mask=0). The server does not send skylight information for nether-chunks, it's up to the client to know if the player is currently in the nether. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.
+
Chunks are not unloaded by the client automatically. To unload chunks, send this packet with Ground-Up Continuous=true and no 16^3 chunks (eg. Primary Bit Mask=0). The server does not send skylight information for nether-chunks, it's up to the client to know if the player is currently in the nether. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.
  
 
See also: [[SMP Map Format]]
 
See also: [[SMP Map Format]]
 +
 +
Changes in 1.8:
 +
 +
* Data value section removed
 +
* Extended id section removed
 +
* Block id section is now a unsigned short (little endian) per a block
 +
* The block id is equal to <code>(id << 4) | data</code>
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=7 | 0x21 || rowspan=7 | Play || rowspan=7 | Client
+
! Bound To
| Chunk X || Int || Chunk X coordinate
+
! Field Name
|-
+
! Field Type
| Chunk Z || Int || Chunk Z coordinate
+
! Notes
|-
+
|-
| Ground-Up continuous || Boolean || This is True if the packet represents all sections in this vertical column, where the primary bit map specifies exactly which sections are included, and which are air
+
|rowspan="6"| 0x21
|-
+
|rowspan="6"| Play
| Primary bit map || Unsigned Short || Bitmask with 1 for every 16x16x16 section which data follows in the compressed data.
+
|rowspan="6"| Client
|-
+
| Chunk X
| Add bit map || Unsigned Short || Same as above, but this is used exclusively for the 'add' portion of the payload
+
| Int
|-
+
| Chunk X coordinate
| Compressed size || Int || Size of compressed chunk data
+
|-
|-
+
| Chunk Z
| Compressed data || Byte array || The chunk data is compressed using Zlib Deflate
+
| Int
|}
+
| Chunk Z coordinate
 +
|-
 +
| Ground-Up Continuous
 +
| Boolean
 +
| This is true if the packet represents all sections in this vertical column, where the Primary Bit Mask specifies exactly which sections are included, and which are air
 +
|-
 +
| Primary Bit Mask
 +
| Unsigned Short
 +
| Bitmask with 1 for every 16x16x16 section whose data follows in the compressed data
 +
|-  
 +
| Size
 +
| VarInt
 +
| Size of Data
 +
|-
 +
| Data
 +
| [[SMP Map Format#Data|Chunk]]
 +
|  
 +
|}
  
 
==== Multi Block Change ====
 
==== Multi Block Change ====
 +
Fired whenever 2 or more blocks are changed within the render distance.
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x22 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Chunk X || Int || Chunk X coordinate
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| Chunk Z || Int || Chunk Z Coordinate
+
! Notes
|-
+
|-
| Record count || Short || The number of blocks affected
+
|rowspan="6"| 0x22
|-
+
|rowspan="6"| Play
| Data size || Int || The total size of the data, in bytes. Should always be 4*record count
+
|rowspan="6"| Client
|-
+
|colspan="2"| Chunk X
| Records || Array of Records ||  
+
|colspan="2"| Int
|}
+
| Chunk X coordinate
 
+
|-
'''Record'''
+
|colspan="2"| Chunk Z
{| class="wikitable"
+
|colspan="2"| Int
|-
+
| Chunk Z coordinate
! Bit mask !! Width !! Meaning
+
|-
|-
+
|colspan="2"| Record Count
| 00 00 00 0F || 4 bits || Block metadata
+
|colspan="2"| VarInt
|-
+
| Number of elements in the following array, a.k.a. the number of blocks affected
| 00 00 FF F0 || 12 bits || Block ID
+
|-
|-
+
  |rowspan="3"| Record
| 00 FF 00 00 || 8 bits || Y co-ordinate
+
| Horizontal Position
|-
+
|rowspan="3"| Array
| 0F 00 00 00 || 4 bits || Z co-ordinate, relative to chunk
+
| 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.
| F0 00 00 00 || 4 bits || X co-ordinate, relative to chunk
+
|-
|}
+
| Y Coordinate
 +
| Unsigned Byte
 +
|  
 +
|-
 +
| Block ID
 +
| VarInt
 +
| The new block ID for the block. <code><nowiki>id &lt;&lt; 4 | data</nowiki></code>
 +
|}
  
 
==== Block Change ====
 
==== Block Change ====
 +
Fired whenever a block is changed within the render distance.
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x23 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| X || Int || Block X Coordinate
+
! Field Name
|-
+
! Field Type
| Y || Unsigned Byte || Block Y Coordinate
+
! Notes
|-
+
|-
| Z || Int || Block Z Coordinate
+
|rowspan="2"| 0x23
|-
+
|rowspan="2"| Play
| Block ID || VarInt || The new block ID for the block
+
|rowspan="2"| Client
|-
+
| Location
| Block Metadata || Unsigned Byte || The new metadata for the block
+
| Position
|}
+
| Block Coordinates
 +
|-
 +
| Block ID
 +
| VarInt
 +
| The new block ID for the block. <code><nowiki>id &lt;&lt; 4 | data</nowiki></code>
 +
|}
  
 
==== Block Action ====
 
==== Block Action ====
  
 
This packet is used for a number of things:
 
This packet is used for a number of things:
* <div class="li">Chests opening and closing
+
 
 +
* Chests opening and closing
 
* Pistons pushing and pulling
 
* Pistons pushing and pulling
 
* Note blocks playing
 
* Note blocks playing
 +
* Updating beacons
  
 
See Also: [[Block Actions]]  
 
See Also: [[Block Actions]]  
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=6 | 0x24 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| X || Int || Block X Coordinate
+
! Field Name
|-
+
! Field Type
| Y || Short || Block Y Coordinate
+
! Notes
|-
+
|-
| Z || Int || Block Z Coordinate
+
|rowspan="4"| 0x24
|-
+
|rowspan="4"| Play
| Byte 1 || Unsigned Byte || Varies depending on block - see [[Block_Actions]]
+
|rowspan="4"| Client
|-
+
| Location
| Byte 2 || Unsigned Byte || Varies depending on block - see [[Block_Actions]]
+
| Position
|-
+
| Block Coordinates
| Block Type || VarInt || The block type for the block
+
|-
|}
+
| Byte 1
 +
| Unsigned Byte
 +
| Varies depending on block see [[Block Actions]]
 +
|-
 +
| Byte 2
 +
| Unsigned Byte
 +
| Varies depending on block see [[Block Actions]]
 +
|-
 +
| Block Type
 +
| VarInt
 +
| The block type for the block
 +
|}
  
 
==== Block Break Animation ====
 
==== Block Break Animation ====
  
0-9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
+
0–9 are the displayable destroy stages and each other number means that there is no animation on this coordinate.
  
 
You can also set an animation to air! The animation will still be visible.
 
You can also set an animation to air! The animation will still be visible.
Line 897: Line 1,601:
 
If you need to display several break animations at the same time you have to give each of them a unique Entity ID.
 
If you need to display several break animations at the same time you have to give each of them a unique Entity ID.
  
Also if you set the coordinates to a special block like water, it won't show the actual break animation, but some other interesting effects. (Water will lose its transparency)
+
Also if you set the coordinates to a special block like water etc. it won't show the actual break animation but some other interesting effects. (Water will lose it's transparency)
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x25 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Entity ID || VarInt || Entity's ID
+
! Field Name
|-
+
! Field Type
| X || Int || rowspan=3 | Block Position
+
! Notes
|-
+
|-
| Y || Int
+
|rowspan="3"| 0x25
|-
+
|rowspan="3"| Play
| Z || Int
+
|rowspan="3"| Client
|-
+
| Entity ID
| Destroy Stage || Byte || 0 - 9
+
| VarInt
|}
+
| EID for the animation
 +
|-
 +
| Location
 +
| Position
 +
| Block Position
 +
|-
 +
| Destroy Stage
 +
| Byte
 +
| 0–9 to set it, any other value to remove it
 +
|}
  
 
==== Map Chunk Bulk ====
 
==== Map Chunk Bulk ====
  
See also: [[SMP Map Format]]
+
1.8 changes at [[#Chunk Data|Chunk Data]]
  
To reduce the number of bytes this packet is used to send chunks together for better compression results.
+
To reduce the number of bytes, this packet is used to send chunks together for better compression results.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5 | 0x26 || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Chunk column count || Short || The number of chunk in this packet
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| Data length || Int || The size of the data field
+
! Notes
|-
+
|-
| Sky light sent || Bool || Whether or not the chunk data contains a light nibble array. This is true in the main world, false in the end + nether
+
|rowspan="7"| 0x26
|-
+
|rowspan="7"| Play
| Data || Byte Array || Compressed chunk data
+
|rowspan="7"| Client
|-
+
|colspan="2"| Sky Light Sent
| Meta information || Meta || See below
+
|colspan="2"| Boolean
|}
+
| Whether or not Chunk Data contains light nibble arrays. This is true in the Overworld, false in the End + Nether
 
+
|-
'''Meta'''
+
|colspan="2"| Chunk Column Count
{| class="wikitable"
+
|colspan="2"| VarInt
! Field Name !! Field Type !! Notes
+
| Number of elements in each of the following arrays
|-
+
|-
|Chunk X || Int || The X Coordinate of the chunk
+
|rowspan="3"| Chunk Meta
|-
+
| Chunk X
|Chunk Z || Int || The Z Coordinate of the chunk
+
|rowspan="3"| Array
|-
+
| Int
|Primary bitmap || Unsigned Short || A bitmap which specifies which sections are not empty in this chunk
+
| The X coordinate of the chunk
|-
+
|-
|Add bitmap || Unsigned Short || A bitmap which specifies which sections need add information because of very high block ids. not yet used
+
| Chunk Z
|}
+
| Int
 +
| The Z coordinate of the chunk
 +
|-
 +
| Primary Bit Mask
 +
| Unsigned Short
 +
| A bit mask which specifies which sections are not empty in this chunk
 +
|-
 +
|colspan="2"| Chunk Data
 +
|colspan="2"| Array of [[SMP Map Format#Data|Chunk]]
 +
| Each chunk in this array corresponds to the data at the same position in Chunk Meta
 +
|}
  
 
==== Explosion ====
 
==== Explosion ====
Line 955: Line 1,678:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="9" | 0x27 || rowspan=9 | Play || rowspan=9 | Client
+
! Bound To
| X || Float ||
+
! Field Name
|-
+
! Field Type
| Y || Float ||
+
! Notes
|-
+
|-
| Z || Float ||
+
|rowspan="9"| 0x27
|-
+
|rowspan="9"| Play
| Radius || Float || Currently unused in the client
+
|rowspan="9"| Client
|-
+
| X
| Record count || Int || This is the count, not the size. The size is 3 times this value.
+
| Float
|-
+
|  
| Records || (Byte, Byte, Byte) × count || Each record is 3 signed bytes long, each bytes are the XYZ (respectively) offsets of affected blocks.
+
|-
|-
+
| Y
| Player Motion X || Float || X velocity of the player being pushed by the explosion
+
| Float
|-
+
|  
| Player Motion Y || Float || Y velocity of the player being pushed by the explosion
+
|-
|-
+
| Z
| Player Motion Z || Float || Z velocity of the player being pushed by the explosion
+
| Float
|}
+
|  
 +
|-
 +
| Radius
 +
| Float
 +
| Currently unused in the client
 +
|-
 +
| Record Count
 +
| Int
 +
| Number of elements in the following array
 +
|-
 +
| Records
 +
| Array of (Byte, Byte, Byte)
 +
| Each record is 3 signed bytes long, each bytes are the XYZ (respectively) offsets of affected blocks.
 +
|-
 +
| Player Motion X
 +
| Float
 +
| X velocity of the player being pushed by the explosion
 +
|-
 +
| Player Motion Y
 +
| Float
 +
| Y velocity of the player being pushed by the explosion
 +
|-
 +
| Player Motion Z
 +
| Float
 +
| Z velocity of the player being pushed by the explosion
 +
|}
  
 
==== Effect ====
 
==== Effect ====
Line 981: Line 1,729:
 
Sent when a client is to play a sound or particle effect.
 
Sent when a client is to play a sound or particle effect.
  
By default, the minecraft client adjusts the volume of sound effects based on distance. The final boolean field is used to disable this, and instead the effect is played from 2 blocks away in the correct direction. Currently this is only used for effects 1013 and 1018 (mob.wither.spawn and mob.enderdragon.end, respectively), and is ignored for any other value by the client.
+
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 1013 (mob.wither.spawn), and is ignored for any other value by the client.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x28 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Effect ID || Int || The ID of the effect, see below.
+
! Field Name
|-
+
! Field Type
| X || Int || The X location of the effect
+
! Notes
|-
+
|-
| Y || Byte || The Y location of the effect
+
|rowspan="4"| 0x28
|-
+
|rowspan="4"| Play
| Z || Int || The Z location of the effect
+
|rowspan="4"| Client
|-
+
| Effect ID
| Data || Int || Extra data for certain effects, see below.
+
| Int
|-
+
| The ID of the effect, see below
| Disable relative volume || Bool || See above
+
|-
|}
+
| Location
 +
| Position
 +
| The location of the effect
 +
|-
 +
| Data
 +
| Int
 +
| Extra data for certain effects, see below
 +
|-
 +
| Disable Relative Volume
 +
| Boolean
 +
| See above
 +
|}
  
===== Effects =====
+
Effect IDs:
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Name
+
! ID
|-
+
! Name
| colspan=2 | '''Sound'''
+
! Data
|-
+
|-
| 1000|| <code>random.click</code>
+
!colspan="3"| Sound
|-
+
|-
| 1001|| <code>random.click</code>
+
| 1000
|-
+
| <code>random.click</code>
| 1002|| <code>random.bow</code>
+
|
|-
+
|-
| 1003|| <code>random.door_open</code> or <code>random.door_close</code> (50/50 chance)
+
| 1001
|-
+
| <code>random.click</code>
| 1004|| <code>random.fizz</code>
+
|
|-
+
|-
| 1005|| Play a music disc. '''Data''' [http://www.minecraftwiki.net/wiki/Music_Discs Record ID]
+
| 1002
|-
+
| <code>random.bow</code>
| ''(1006 not assigned)'' ||
+
|
|-
+
|-
| 1007|| <code>mob.ghast.charge</code>
+
| 1003
|-
+
| <code>random.door_open</code> or <code>random.door_close</code> (50/50 chance)
| 1008|| <code>mob.ghast.fireball</code>
+
|
|-
+
|-
| 1009|| <code>mob.ghast.fireball</code>, but with a lower volume.
+
| 1004
|-
+
| <code>random.fizz</code>
| 1010|| <code>mob.zombie.wood</code>
+
|
|-
+
|-
| 1011|| <code>mob.zombie.metal</code>
+
| 1005
|-
+
| Play a music disc.
| 1012|| <code>mob.zombie.woodbreak</code>
+
| {{Minecraft Wiki|Music Discs|Record ID}}
|-
+
|-
| 1013|| <code>mob.wither.spawn</code>
+
| 1006
|-
+
| ''not assigned''
| 1014|| <code>mob.wither.shoot</code>
+
|  
|-
+
|-
| 1015|| <code>mob.bat.takeoff</code>
+
| 1007
|-
+
| <code>mob.ghast.charge</code>
| 1016|| <code>mob.zombie.infect</code>
+
|
|-
+
|-
| 1017|| <code>mob.zombie.unfect</code>
+
| 1008
|-
+
| <code>mob.ghast.fireball</code>
| 1018|| <code>mob.enderdragon.end</code>
+
|
|-
+
|-
| 1020|| <code>random.anvil_break</code>
+
| 1009
|-
+
| <code>mob.ghast.fireball</code>, but with a lower volume
| 1021|| <code>random.anvil_use</code>
+
|
|-
+
|-
| 1022|| <code>random.anvil_land</code>
+
| 1010
|-
+
| <code>mob.zombie.wood</code>
| colspan=2 | '''Particle'''
+
|
|-
+
|-
| 2000|| Spawns 10 smoke particles, e.g. from a fire. '''Data''' direction, see below
+
| 1011
|-
+
| <code>mob.zombie.metal</code>
| 2001|| Block break. '''Data''' [http://www.minecraftwiki.net/wiki/Data_values Block ID]
+
|
|-
+
|-
| 2002|| Splash potion. Particle effect + glass break sound. '''Data''' [http://www.lb-stuff.com/Minecraft/PotionDataValues1.9pre3.txt Potion ID]
+
| 1012
|-
+
| <code>mob.zombie.woodbreak</code>
| 2003|| Eye of ender entity break animation - particles and sound
+
|
|-
+
|-
| 2004|| Mob spawn particle effect: smoke + flames
+
| 1013
|-
+
| <code>mob.wither.spawn</code>
| 2005|| Spawn "happy villager" effect (green crosses), used for bonemealing vegetation.
+
|
|-
+
|-
| 2006|| Spawn fall particles (when player hits ground). '''Data''' fall damage taken for particle speed
+
| 1014
|}
+
| <code>mob.wither.shoot</code>
 +
|
 +
|-
 +
| 1015
 +
| <code>mob.bat.takeoff</code>
 +
|
 +
|-
 +
| 1016
 +
| <code>mob.zombie.infect</code>
 +
|
 +
|-
 +
| 1017
 +
| <code>mob.zombie.unfect</code>
 +
|
 +
|-
 +
| 1018
 +
| <code>mob.enderdragon.end</code>
 +
|
 +
|-
 +
| 1020
 +
| <code>random.anvil_break</code>
 +
|
 +
|-
 +
| 1021
 +
| <code>random.anvil_use</code>
 +
|
 +
|-
 +
| 1022
 +
| <code>random.anvil_land</code>
 +
|
 +
|-
 +
!colspan="3"| Particle
 +
|-
 +
| 2000
 +
| Spawns 10 smoke particles, e.g. from a fire
 +
| Direction, see below
 +
|-
 +
| 2001
 +
| Block break
 +
| {{Minecraft Wiki|Data values|Block ID}}
 +
|-
 +
| 2002
 +
| Splash potion. Particle effect + glass break sound.
 +
| [http://www.lb-stuff.com/Minecraft/PotionDataValues1.9pre3.txt Potion ID]
 +
|-
 +
| 2003
 +
| Eye of Ender entity break animation particles and sound
 +
|
 +
|-
 +
| 2004
 +
| Mob spawn particle effect: smoke + flames
 +
|
 +
|-
 +
| 2005
 +
| Spawn “happy villager” effect (green crosses), used for bonemealing vegetation
 +
|  
 +
|}
  
 
Smoke directions:
 
Smoke directions:
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Direction
+
! ID
|-
+
! Direction
| 0 || South - East
+
|-
|-
+
| 0
| 1 || South
+
| South-East
|-
+
|-
| 2 || South - West
+
| 1
|-
+
| South
| 3 || East
+
|-
|-
+
| 2
| 4 || (Up or middle ?)
+
| South-West
|-
+
|-
| 5 || West
+
| 3
|-
+
| East
| 6 || North - East
+
|-
|-
+
| 4
| 7 || North
+
| (Up or middle ?)
|-
+
|-
| 8 || North - West
+
| 5
|}
+
| West
 +
|-
 +
| 6
 +
| North-East
 +
|-
 +
| 7
 +
| North
 +
|-
 +
| 8
 +
| North-West
 +
|}
  
 
==== Sound Effect ====
 
==== Sound Effect ====
Line 1,096: Line 1,921:
 
Used to play a sound effect on the client.
 
Used to play a sound effect on the client.
  
All known sound effect names can be seen [https://github.com/SirCmpwn/Craft.Net/blob/master/source/Craft.Net.Common/SoundEffect.cs here].
+
Custom sounds may be added by resource packs.
 
 
Custom sounds may be added by resource packs
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x29 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Sound name || String ||
+
! Field Name
|-
+
! Field Type
| Effect position X || Int || Effect X multiplied by 8
+
! Notes
|-
+
|-
| Effect position Y || Int || Effect Y multiplied by 8
+
|rowspan="6"| 0x29
|-
+
|rowspan="6"| Play
| Effect position Z || Int || Effect Z multiplied by 8
+
|rowspan="6"| Client
|-
+
| Sound name
| Volume || Float || 1 is 100%, can be more
+
| String
|-
+
| All known sound effect names can be seen [https://github.com/SirCmpwn/Craft.Net/blob/master/source/Craft.Net.Common/SoundEffect.cs here]
| Pitch || Unsigned Byte || 63 is 100%, can be more
+
|-
|}
+
| Effect position X
 +
| Int
 +
| Effect X multiplied by 8
 +
|-
 +
| Effect position Y
 +
| Int
 +
| Effect Y multiplied by 8
 +
|-
 +
| Effect position Z
 +
| Int
 +
| Effect Z multiplied by 8
 +
|-
 +
| Volume
 +
| Float
 +
| 1 is 100%, can be more
 +
|-
 +
| Pitch
 +
| Unsigned Byte
 +
| 63 is 100%, can be more
 +
|}
  
 
==== Particle ====
 
==== Particle ====
Line 1,122: Line 1,964:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="9" | 0x2A || rowspan=9 | Play || rowspan=9 | Client
+
! Bound To
| Particle name || String || The name of the particle to create. A list can be found [https://gist.github.com/thinkofdeath/5110835 here]
+
! Field Name
|-
+
! Field Type
| X || Float || X position of the particle
+
! Notes
|-
+
|-
| Y || Float || Y position of the particle
+
|rowspan="11"| 0x2A
|-
+
|rowspan="11"| Play
| Z || Float || Z position of the particle
+
|rowspan="11"| Client
|-
+
| Particle ID
| Offset X || Float || This is added to the X position after being multiplied by random.nextGaussian()  
+
| Int
|-
+
| See below
| Offset Y || Float || This is added to the Y position after being multiplied by random.nextGaussian()  
+
|-
|-
+
| Long Distance
| Offset Z || Float || This is added to the Z position after being multiplied by random.nextGaussian()  
+
| Boolean
|-
+
| If true, particle distance increases from 256 to 65536
| Particle data || Float || The data of each particle
+
|-
|-
+
| X
| Number of particles || Int || The number of particles to create
+
| Float
|}
+
| X position of the particle
 +
|-
 +
| Y
 +
| Float
 +
| Y position of the particle
 +
|-
 +
| Z
 +
| Float
 +
| Z position of the particle
 +
|-
 +
| Offset X
 +
| Float
 +
| This is added to the X position after being multiplied by random.nextGaussian()
 +
|-
 +
| Offset Y
 +
| Float
 +
| This is added to the Y position after being multiplied by random.nextGaussian()
 +
|-
 +
| Offset Z
 +
| Float
 +
| This is added to the Z position after being multiplied by random.nextGaussian()
 +
|-
 +
| Particle Data
 +
| Float
 +
| The data of each particle
 +
|-
 +
| Particle Count
 +
| Int
 +
| The number of particles to create
 +
|-
 +
| Data
 +
| Array of VarInt
 +
| Length depends on particle. "iconcrack" has length of 2, "blockcrack", and "blockdust" have lengths of 1, the rest have 0.
 +
|}
 +
 
 +
Particle IDs:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Particle Name
 +
! Particle ID
 +
|-
 +
| explode
 +
| 0
 +
|-
 +
| largeexplosion
 +
| 1
 +
|-
 +
| hugeexplosion
 +
| 2
 +
|-
 +
| fireworksSpark
 +
| 3
 +
|-
 +
| bubble
 +
| 4
 +
|-
 +
| splash
 +
| 5
 +
|-
 +
| wake
 +
| 6
 +
|-
 +
| suspended
 +
| 7
 +
|-
 +
| depthsuspend
 +
| 8
 +
|-
 +
| crit
 +
| 9
 +
|-
 +
| magicCrit
 +
| 10
 +
|-
 +
| smoke
 +
| 11
 +
|-
 +
| largesmoke
 +
| 12
 +
|-
 +
| spell
 +
| 13
 +
|-
 +
| instantSpell
 +
| 14
 +
|-
 +
| mobSpell
 +
| 15
 +
|-
 +
| mobSpellAmbient
 +
| 16
 +
|-
 +
| witchMagic
 +
| 17
 +
|-
 +
| dripWater
 +
| 18
 +
|-
 +
| dripLava
 +
| 19
 +
|-
 +
| angryVillager
 +
| 20
 +
|-
 +
| happyVillager
 +
| 21
 +
|-
 +
| townaura
 +
| 22
 +
|-
 +
| note
 +
| 23
 +
|-
 +
| portal
 +
| 24
 +
|-
 +
| enchantmenttable
 +
| 25
 +
|-
 +
| flame
 +
| 26
 +
|-
 +
| lava
 +
| 27
 +
|-
 +
| footstep
 +
| 28
 +
|-
 +
| cloud
 +
| 29
 +
|-
 +
| reddust
 +
| 30
 +
|-
 +
| snowballpoof
 +
| 31
 +
|-
 +
| snowshovel
 +
| 32
 +
|-
 +
| slime
 +
| 33
 +
|-
 +
| heart
 +
| 34
 +
|-
 +
| barrier
 +
| 35
 +
|-
 +
| iconcrack_(id)_(data)
 +
| 36
 +
|-
 +
| blockcrack_(id+(data<<12))
 +
| 37
 +
|-
 +
| blockdust_(id)
 +
| 38
 +
|-
 +
| droplet
 +
| 39
 +
|-
 +
| take
 +
| 40
 +
|-
 +
| mobappearance
 +
| 41
 +
|}
  
 
==== Change Game State ====
 
==== Change Game State ====
  
It appears when a bed can't be used as a spawn point and when the rain state changes.
+
It appears when a bed can't be used as a spawn point and when the rain state changes.
 
 
The class has an array of strings linked to reason codes 0, 1, 2, and 3 but only the codes for 1 and 2 are null.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x2B || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Reason || Unsigned Byte ||
+
! Field Name
|-
+
! Field Type
| Value || Float || Depends on reason
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x2B
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Reason
 +
| Unsigned Byte
 +
| See below
 +
|-
 +
| Value
 +
| Float
 +
| Depends on reason
 +
|}
  
'''Reason codes'''
+
''Reason codes'':
  
 
{| class="wikitable"
 
{| class="wikitable"
! Code !! Effect !! Notes
+
! Code
|-
+
! Effect
| 0 || Invalid Bed || "tile.bed.notValid"
+
! Value
|-
+
|-
| 1 || End raining ||  
+
| 0
|-
+
| Invalid Bed
| 2 || Begin raining ||  
+
|  
|-
+
|-
| 3 || Change game mode || "gameMode.changed" 0 - Survival, 1 - Creative, 2 - Adventure  
+
| 1
|-
+
| End raining
| 4 || Enter credits ||
+
|  
|-
+
|-
| 5 || Demo messages || 0 - Show welcome to demo screen, 101 - Tell movement controls, 102 - Tell jump control, 103 - Tell inventory control
+
| 2
|-  
+
| Begin raining
| 6 || Arrow hitting player || Appears to be played when an arrow strikes another player in Multiplayer
+
|  
|-
+
|-
| 7 || Fade value || The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
+
| 3
|-
+
| Change game mode
| 8 || Fade time || Time in ticks for the sky to fade
+
| 0: Survival, 1: Creative, 2: Adventure, 3: Spectator
|}
+
|-
 +
| 4
 +
| Enter credits
 +
|  
 +
|-
 +
| 5
 +
| Demo message
 +
| 0: Show welcome to demo screen, 101: Tell movement controls, 102: Tell jump control, 103: Tell inventory control
 +
|-  
 +
| 6
 +
| Arrow hitting player
 +
| Appears to be played when an arrow strikes another player in Multiplayer
 +
|-
 +
| 7
 +
| Fade value
 +
| The current darkness value. 1 = Dark, 0 = Bright, Setting the value higher causes the game to change color and freeze
 +
|-
 +
| 8
 +
| Fade time
 +
| Time in ticks for the sky to fade
 +
|-
 +
| 10
 +
| Play mob appearance (effect and sound)
 +
|}
  
 
==== Spawn Global Entity ====
 
==== Spawn Global Entity ====
Line 1,188: Line 2,229:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="5" | 0x2C || rowspan=5 | Play || rowspan=5 | Client
+
! Bound To
| Entity ID || VarInt || The entity ID of the thunderbolt
+
! Field Name
|-
+
! Field Type
| Type || Byte || The global entity type, currently always 1 for thunderbolt.
+
! Notes
|-
+
|-
| X || Int || Thunderbolt X a [[Data_Types#Fixed-point_numbers|fixed-point number]]
+
|rowspan="5"| 0x2C
|-
+
|rowspan="5"| Play
| Y || Int || Thunderbolt Y a [[Data_Types#Fixed-point_numbers|fixed-point number]]
+
|rowspan="5"| Client
|-
+
| Entity ID
| Z || Int || Thunderbolt Z a [[Data_Types#Fixed-point_numbers|fixed-point number]]
+
| VarInt
|}
+
| The EID of the thunderbolt
 +
|-
 +
| Type
 +
| Byte
 +
| The global entity type, currently always 1 for thunderbolt
 +
|-
 +
| X
 +
| Int
 +
| Thunderbolt X, a [[Data Types#Fixed-point numbers|fixed-point number]]
 +
|-
 +
| Y
 +
| Int
 +
| Thunderbolt Y, a [[Data Types#Fixed-point numbers|fixed-point number]]
 +
|-
 +
| Z
 +
| Int
 +
| Thunderbolt Z, a [[Data Types#Fixed-point numbers|fixed-point number]]
 +
|}
  
 
==== Open Window ====
 
==== Open Window ====
Line 1,207: Line 2,265:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x2D || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| Window id || Unsigned Byte || A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
+
! Field Name
|-
+
! Field Type
| Inventory Type || Unsigned Byte || The window type to use for display. Check below
+
! Notes
|-
+
|-
| Window title || String || The title of the window.
+
|rowspan="5"| 0x2D
|-
+
|rowspan="5"| Play
| Number of Slots || Unsigned Byte || Number of slots in the window (excluding the number of slots in the player inventory).
+
|rowspan="5"| Client
|-
+
| Window ID
| Use provided window title || Bool || If false, the client will look up a string like "window.minecart". If true, the client uses what the server provides.
+
| Unsigned Byte
|-
+
| A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
| Entity ID || Int || EntityHorse's entityId. Only sent when window type is equal to 11 (AnimalChest).
+
|-
|}
+
| Window Type
 +
| String
 +
| The window type to use for display. See below
 +
|-
 +
| Window Title
 +
| [[Chat]]
 +
| The title of the window
 +
|-
 +
| Number Of Slots
 +
| Unsigned Byte
 +
| Number of slots in the window (excluding the number of slots in the player inventory)
 +
|-
 +
| Entity ID
 +
| Optional Int
 +
| EntityHorse's EID. Only sent when Window Type is “EntityHorse”
 +
|}
  
 
See [[Inventory#Windows|inventory windows]] for further information.
 
See [[Inventory#Windows|inventory windows]] for further information.
Line 1,229: Line 2,302:
 
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.
 
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.
  
Note, notchian clients send a close window message with window id 0 to close their inventory even though there is never an Open Window message for inventory.  
+
Note, notchian clients send a close window packet with Window ID 0 to close their inventory even though there is never an [[#Open Window|Open Window]] packet for inventory.  
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x2E || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Window ID || Unsigned Byte || This is the id of the window that was closed. 0 for inventory.
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
| 0x2E
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Window ID
 +
| Unsigned Byte
 +
| This is the ID of the window that was closed. 0 for inventory.
 +
|}
  
 
==== Set Slot ====
 
==== Set Slot ====
Line 1,243: Line 2,325:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x2F || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Window ID || Byte
+
! Field Name
| 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).
+
! Field Type
|-
+
! Notes
| Slot || Short || The slot that should be updated
+
|-
|-
+
|rowspan="3"| 0x2F
| Slot data || [[Slot_Data|Slot]] ||
+
|rowspan="3"| Play
|}
+
|rowspan="3"| Client
 +
| Window ID
 +
| Byte
 +
| The window which is being updated. 0 for player inventory. Note that all known window types include the player inventory. This packet will only be sent for the currently opened window while the player is performing actions, even if it affects the player inventory. After the window is closed, a number of these packets are sent to update the player's inventory window (0).
 +
|-
 +
| Slot
 +
| Short
 +
| The slot that should be updated
 +
|-
 +
| Slot Data
 +
| [[Slot Data|Slot]]
 +
|  
 +
|}
  
 
==== Window Items ====
 
==== Window Items ====
Line 1,258: Line 2,352:
 
[[File:Inventory-slots.png|thumb|The inventory slots]]
 
[[File:Inventory-slots.png|thumb|The inventory slots]]
  
Sent by the server when an item in a slot (in a window) is added/removed. This includes the main inventory, equipped armour and crafting slots.  
+
Sent 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 !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x30 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Window ID || Unsigned Byte || The id of window which items are being sent for. 0 for player inventory.
+
! Field Name
|-
+
! Field Type
| Count || Short || The number of slots (see below)
+
! Notes
|-
+
|-
| Slot data || Array of [[Slot_Data|Slot]]s ||
+
|rowspan="3"| 0x30
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Window ID
 +
| Unsigned Byte
 +
| The ID of window which items are being sent for. 0 for player inventory.
 +
|-
 +
| Count
 +
| Short
 +
| Number of elements in the following array
 +
|-
 +
| Slot Data
 +
| Array of [[Slot Data|Slot]]
 +
|  
 +
|}
  
 
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
  
 
==== Window Property ====
 
==== Window Property ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x31 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Window ID || Unsigned Byte || The id of the window.
+
! Field Name
|-
+
! Field Type
| Property || Short || Which property should be updated.
+
! Notes
|-
+
|-
| Value || Short || The new value for the property.
+
|rowspan="3"| 0x31
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Window ID
 +
| Unsigned Byte
 +
|  
 +
|-
 +
| Property
 +
| Short
 +
| The property to be updated, see below
 +
|-
 +
| Value
 +
| Short
 +
| The new value for the property, see below
 +
|}
  
 
'''Furnace'''
 
'''Furnace'''
Line 1,294: Line 2,415:
 
Values:
 
Values:
  
* 0-200 for progress arrow
+
* 0–200 for progress arrow
* 0-200 for fuel indicator
+
* 0–200 for fuel indicator
  
 
Ranges are presumably in in-game ticks
 
Ranges are presumably in in-game ticks
Line 1,301: Line 2,422:
 
'''Enchantment Table'''
 
'''Enchantment Table'''
  
Properties:  
+
Properties: 0, 1 or 2 depending on the “enchantment slot” being given.
 
 
* 0-2 depending on the "enchantment slot" being given.
 
* 4-6 for the tool-tip shown on mouse hover over the enchantment slot (set to -1 to hide it)
 
  
 
Values: The enchantment's level.
 
Values: The enchantment's level.
Line 1,316: Line 2,434:
 
'''Anvil'''
 
'''Anvil'''
  
* 0: Maximum cost
+
* 0: Repair Cost
  
 
'''Brewing Stand'''
 
'''Brewing Stand'''
Line 1,329: Line 2,447:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x32 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Window ID || Unsigned Byte || The id of the window that the action occurred in.
+
! Field Name
|-
+
! Field Type
| Action number || Short || Every action that is to be accepted has a unique number. This field corresponds to that number.
+
! Notes
|-
+
|-
| Accepted || Bool || Whether the action was accepted.
+
|rowspan="3"| 0x32
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Window ID
 +
| Byte
 +
| The ID of the window that the action occurred in
 +
|-
 +
| Action Number
 +
| Short
 +
| Every action that is to be accepted has a unique number. This field corresponds to that number.
 +
|-
 +
| Accepted
 +
| Boolean
 +
| Whether the action was accepted
 +
|}
  
 
==== Update Sign ====
 
==== Update Sign ====
Line 1,344: Line 2,475:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="7" | 0x33 || rowspan=7 | Play || rowspan=7 | Client
+
! Bound To
| X || Int || Block X Coordinate
+
! Field Name
|-
+
! Field Type
| Y || Short || Block Y Coordinate
+
! Notes
|-
+
|-
| Z || Int || Block Z Coordinate
+
|rowspan="5"| 0x33
|-
+
|rowspan="5"| Play
| Line 1 || String || First line of text in the sign
+
|rowspan="5"| Client
|-
+
| Location
| Line 2 || String || Second line of text in the sign
+
| Position
|-
+
|  
| Line 3 || String || Third line of text in the sign
+
|-
|-
+
| Line 1
| Line 4 || String || Fourth line of text in the sign
+
| [[Chat]]
|}
+
| First line of text in the sign
 +
|-
 +
| Line 2
 +
| [[Chat]]
 +
| Second line of text in the sign
 +
|-
 +
| Line 3
 +
| [[Chat]]
 +
| Third line of text in the sign
 +
|-
 +
| Line 4
 +
| [[Chat]]
 +
| Fourth line of text in the sign
 +
|}
  
 
==== Maps ====
 
==== Maps ====
  
If the first byte of the array is 0, the next two bytes are X start and Y start and the rest of the bytes are the colors in that column.
+
Updates a rectangular area on a map.
 
 
If the first byte of the array is 1, the rest of the bytes are in groups of three: (data, x, y). The lower half of the data is the type (always 0 under vanilla) and the upper half is the direction.
 
 
 
If the first byte of the array is 2, the second byte is the map scale.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x34 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Item Damage || VarInt || The damage value of the map being modified
+
!colspan="2"| Field Name
|-
+
!colspan="2"| Field Type
| Length || Short || Length of following byte array
+
! Notes
|-
+
|-
| Data || Byte Array || Array data
+
|rowspan="12"| 0x34
|}
+
|rowspan="12"| Play
 +
|rowspan="12"| Client
 +
|colspan="2"| Item Damage
 +
|colspan="2"| VarInt
 +
| The damage value (map ID) of the map being modified
 +
|-
 +
|colspan="2"| Scale
 +
|colspan="2"| Byte
 +
|
 +
|-
 +
|colspan="2"| Icon Count
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="3"| Icon
 +
| Direction And Type
 +
|rowspan="3"| Array
 +
| Byte
 +
| 0xF0 = Direction, 0x0F = Type
 +
|-
 +
| X
 +
| Byte
 +
|
 +
|-
 +
| Z
 +
| Byte
 +
|
 +
|-  
 +
|colspan="2"| Columns
 +
|colspan="2"| Byte
 +
| Number of columns updated
 +
|-
 +
|colspan="2"| Rows
 +
|colspan="2"| Optional Byte
 +
| Only if Columns is more than 0; number of rows updated
 +
|-
 +
|colspan="2"| X
 +
|colspan="2"| Optional Byte
 +
| Only if Columns is more than 0; x offset of the westernmost column
 +
|-
 +
|colspan="2"| Z
 +
|colspan="2"| Optional Byte
 +
| Only if Columns is more than 0; z offset of the northernmost row
 +
|-
 +
|colspan="2"| Length
 +
|colspan="2"| Optional VarInt
 +
| Only if Columns is more than 0; length of the following array
 +
|-
 +
|colspan="2"| Data
 +
|colspan="2"| Optional Array of Unsigned Byte
 +
| Only if Columns is more than 0; see {{Minecraft Wiki|Map item format}}
 +
|}
  
 
==== Update Block Entity ====
 
==== Update Block Entity ====
Line 1,386: Line 2,577:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x35 || rowspan=6 | Play || rowspan=6 | Client
+
! Bound To
| X || Int ||
+
! Field Name
|-
+
! Field Type
| Y || Short ||
+
! Notes
|-
+
|-
| Z || Int ||
+
|rowspan="3"| 0x35
|-
+
|rowspan="3"| Play
| Action || Unsigned Byte || The type of update to perform
+
|rowspan="3"| Client
|-
+
| Location
| Data length || Short || Varies
+
| Position
|-
+
|  
| NBT Data || Byte Array || Present if data length > 0. Compressed with [[wikipedia:Gzip|gzip]]. Varies, but based on the NBT chunk storage format as can be found in the Minecraft Wiki (http://www.minecraftwiki.net/Chunk_Format)
+
|-
|}
+
| Action
 +
| Unsigned Byte
 +
| The type of update to perform, see below
 +
|-
 +
| NBT Data
 +
| Optional [[NBT|NBT Tag]]
 +
| If not present then it's a TAG_END (0)
 +
|}
  
'''Actions'''
+
''Action'' field:
  
* '''1''': Set mob displayed inside a mob spawner
+
* '''1''': Set SpawnPotentials of a mob spawner
 
* '''2''': Set command block text (command and last execution status)
 
* '''2''': Set command block text (command and last execution status)
* '''3''': Set rotation and skin of mob head
+
* '''3''': Set the level, primary, and secondary powers of a beacon
* '''4''': Set type of flower in flower pot
+
* '''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
  
 
==== Sign Editor Open ====
 
==== Sign Editor Open ====
Line 1,414: Line 2,614:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x36 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| X || Int || X in block coordinates
+
! Field Name
|-
+
! Field Type
| Y || Int || Y in block coordinates
+
! Notes
|-
+
|-
| Z || Int || Z in block coordinates
+
|rowspan="1"| 0x36
|}
+
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Location
 +
| Position
 +
|  
 +
|}
  
 
==== Statistics ====
 
==== Statistics ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To  
+
! Packet ID
! colspan="2" | Field Name
+
! State
! Field Type !! Notes
+
! Bound To  
|-
+
!colspan="2"| Field Name
| rowspan="3" | 0x37 || rowspan=3 | Play || rowspan=3 | Client
+
!colspan="2"| Field Type
| colspan="2" | Count || VarInt || Number of entries
+
! Notes
|-
+
|-
| rowspan=2 | Entry
+
|rowspan="3"| 0x37
| Statistic's name || String || https://gist.github.com/thinkofdeath/a1842c21a0cf2e1fb5e0
+
|rowspan="3"| Play
|-
+
|rowspan="3"| Client
| Value || VarInt || The amount to set it to
+
|colspan="2"| Count
|}
+
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="2"| Statistic
 +
| Name
 +
|rowspan="2"| Array
 +
| String
 +
| [https://gist.github.com/thinkofdeath/a1842c21a0cf2e1fb5e0 https://gist.github.com/thinkofdeath/a1842c21a0cf2e1fb5e0]
 +
|-
 +
| Value
 +
| VarInt
 +
| The amount to set it to
 +
|}
  
 
==== Player List Item ====
 
==== Player List Item ====
Line 1,444: Line 2,662:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x38 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Player name || String || Supports chat colouring, limited to 16 characters.
+
!colspan="4"| Field Name
|-
+
!colspan="3"| Field Type
| Online || Bool || The client will remove the user from the list if false.
+
! Notes
|-
+
|-
| Ping || Short || Ping, presumably in ms.
+
|rowspan="19"| 0x38
|}
+
|rowspan="19"| Play
 +
|rowspan="19"| Client
 +
|colspan="4"| Action
 +
|colspan="3"| VarInt
 +
| Determines the rest of the Player format after the UUID
 +
|-
 +
|colspan="4"| Number Of Players
 +
|colspan="3"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="17"| Player
 +
|colspan="3"| UUID
 +
|rowspan="17"| Array
 +
|colspan="2"| UUID
 +
|
 +
|-
 +
! Action
 +
!colspan="2"| Field Name
 +
!colspan="2"|
 +
!
 +
|-
 +
|rowspan="10"| 0: add player
 +
|colspan="2"| Name
 +
|colspan="2"| String
 +
|
 +
|-
 +
|colspan="2"| Number Of Properties
 +
|colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
|rowspan="4"| Property
 +
| Name
 +
|rowspan="4"| Array
 +
| String
 +
|
 +
|-
 +
| Value
 +
| String
 +
|  
 +
|-  
 +
| Is Signed
 +
| Boolean
 +
|  
 +
|-
 +
| Signature
 +
| Optional String
 +
| Only if Is Signed is true
 +
|-
 +
|colspan="2"| Gamemode
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
|colspan="2"| Ping
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
|colspan="2"| Has Display Name
 +
|colspan="2"| Boolean
 +
|
 +
|-
 +
|colspan="2"| Display Name
 +
|colspan="2"| Optional [[Chat]]
 +
| Only if Has Display Name is true
 +
|-
 +
| 1: update gamemode
 +
|colspan="2"| Gamemode
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
| 2: update latency
 +
|colspan="2"| Ping
 +
|colspan="2"| VarInt
 +
|
 +
|-
 +
|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"|
 +
|
 +
|}
  
 
==== Player Abilities ====
 
==== Player Abilities ====
  
 
The latter 2 floats are used to indicate the walking and flying speeds respectively, while the first byte is used to determine the value of 4 booleans.
 
The latter 2 floats are used to indicate the walking and flying speeds respectively, while the first byte is used to determine the value of 4 booleans.
+
 
 
The flags are whether damage is disabled (god mode, 8, bit 3), whether the player can fly (4, bit 2), whether the player is flying (2, bit 1), and whether the player is in creative mode (1, bit 0).
 
The flags are whether damage is disabled (god mode, 8, bit 3), whether the player can fly (4, bit 2), whether the player is flying (2, bit 1), and whether the player is in creative mode (1, bit 0).
+
 
 
To get the values of these booleans, simply AND (&) the byte with 1,2,4 and 8 respectively, to get the 0 or 1 bitwise value. To set them OR (|) them with their repspective masks.
 
To get the values of these booleans, simply AND (&) the byte with 1,2,4 and 8 respectively, to get the 0 or 1 bitwise value. To set them OR (|) them with their repspective masks.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x39 || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Flags || Byte ||
+
! Field Name
|-
+
! Field Type
| Flying speed || Float|| previous integer value divided by 250
+
! Notes
|-
+
|-
| Walking speed || Float || previous integer value divided by 250
+
|rowspan="3"| 0x39
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Client
 +
| Flags
 +
| Byte
 +
| Bit mask, see above
 +
|-
 +
| Flying Speed
 +
| Float
 +
|  
 +
|-
 +
| Walking Speed
 +
| Float
 +
|  
 +
|}
  
 
==== Tab-Complete ====
 
==== Tab-Complete ====
Line 1,478: Line 2,796:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2| 0x3A  || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Count || VarInt || Number of following strings
+
! Field Name
|-
+
! Field Type
| Match || String || One eligible command, note that each command is sent separately instead of in a single string, hence the need for Count
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x3A
 +
  |rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Matches
 +
| Array of String
 +
| One eligible command, note that each command is sent separately instead of in a single string, hence the need for Count
 +
|}
  
 
==== Scoreboard Objective ====
 
==== Scoreboard Objective ====
  
This is sent to the client when it should create a new scoreboard or remove one.
+
This is sent to the client when it should create a new {{Minecraft Wiki|scoreboard}} objective or remove one.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x3B || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Objective name || String || An unique name for the objective
+
! Field Name
|-
+
! Field Type
| Objective value || String || The text to be displayed for the score.
+
! Notes
|-
+
|-
| Create/Remove || Byte || 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.  
+
|rowspan="4"| 0x3B
|}
+
|rowspan="4"| Play
 +
|rowspan="4"| Client
 +
| Objective Name
 +
| String
 +
| An unique name for the objective
 +
|-
 +
| Mode
 +
| Byte
 +
| 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text.  
 +
|-
 +
| Objective Value
 +
| Optional String
 +
| Only if mode is 0 or 2. The text to be displayed for the score
 +
|-
 +
| Type
 +
| Optional String
 +
| Only if mode is 0 or 2. “integer” or “hearts”
 +
|}
  
 
==== Update Score ====
 
==== Update Score ====
Line 1,506: Line 2,852:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="4" | 0x3C || rowspan=4 | Play || rowspan=4 | Client
+
! Bound To
| Item Name || String || An unique name to be displayed in the list.
+
! Field Name
|-
+
! Field Type
| Update/Remove || Byte || 0 to create/update an item. 1 to remove an item.
+
! Notes
|-
+
|-
| Score Name || String || The unique name for the scoreboard to be updated. Only sent when Update/Remove does not equal 1.
+
|rowspan="4"| 0x3C
|-
+
|rowspan="4"| Play
| Value || Int || The score to be displayed next to the entry. Only sent when Update/Remove does not equal 1.
+
|rowspan="4"| Client
|}
+
| Score Name
{{Warning|The final String and Int are only sent if the Update/Remove Byte does not equal 1}}
+
| String
 +
| The name of the score to be updated or removed
 +
|-
 +
| Action
 +
| Byte
 +
| 0 to create/update an item. 1 to remove an item.
 +
|-
 +
| Objective Name
 +
| String
 +
| 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.
 +
|}
  
 
==== Display Scoreboard ====
 
==== Display Scoreboard ====
Line 1,524: Line 2,884:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x3D || rowspan=2 | Play || rowspan=2 | Client
+
! Bound To
| Position || Byte || The position of the scoreboard. 0 = list, 1 = sidebar, 2 = belowName.
+
! Field Name
|-
+
! Field Type
| Score Name || String || The unique name for the scoreboard to be displayed.
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x3D
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Position
 +
| Byte
 +
| The position of the scoreboard. 0: list, 1: sidebar, 2: below name.
 +
|-
 +
| Score Name
 +
| String
 +
| The unique name for the scoreboard to be displayed.
 +
|}
  
 
==== Teams ====
 
==== Teams ====
Line 1,537: Line 2,908:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="8" | 0x3E || rowspan=8 | Play || rowspan=8 | Client
+
! Bound To
| Team Name || String || A unique name for the team. (Shared with scoreboard).
+
! Field Name
|-
+
! Field Type
| Mode || Byte || If 0 then the team is created.  
+
! Notes
 +
|-
 +
|rowspan="10"| 0x3E
 +
|rowspan="10"| Play
 +
|rowspan="10"| Client
 +
| Team Name
 +
| String
 +
| A unique name for the team. (Shared with scoreboard).
 +
|-
 +
| Mode
 +
| Byte
 +
| If 0 then the team is created.
 +
 
 
If 1 then the team is removed.  
 
If 1 then the team is removed.  
  
Line 1,550: Line 2,933:
  
 
If 4 then players are removed from the team.
 
If 4 then players are removed from the team.
|-
+
|-
| Team Display Name || String || Only if Mode = 0 or 2.  
+
| Team Display Name
|-
+
| Optional String
| Team Prefix || String || Only if Mode = 0 or 2. Displayed before the players' name that are part of this team.
+
| Only if Mode = 0 or 2.
|-
+
|-
| Team Suffix || String || Only if Mode = 0 or 2. Displayed after the players' name that are part of this team.
+
| Team Prefix
|-
+
| Optional String
| Friendly fire || Byte || Only if Mode = 0 or 2; 0 for off, 1 for on, 3 for seeing friendly invisibles
+
| Only if Mode = 0 or 2. Displayed before the players' name that are part of this team
|-
+
|-
| Player count || Short || Only if Mode = 0 or 3 or 4. Number of players in the array
+
| Team Suffix
|-
+
| Optional String
| Players || Array of strings || Only if Mode = 0 or 3 or 4. Players to be added/remove from the team.
+
| Only if Mode = 0 or 2. Displayed after the players' name that are part of this team
|}
+
|-
 +
| Friendly Fire
 +
| Optional Byte
 +
| Only if Mode = 0 or 2. 0 for off, 1 for on, 3 for seeing friendly invisibles
 +
|-
 +
| Name Tag Visibility
 +
| Optional String
 +
| Only if Mode = 0 or 2. always, hideForOtherTeams, hideForOwnTeam, never
 +
|-
 +
| Color
 +
| Optional Byte
 +
| Only if Mode = 0 or 2. Same as [[Chat]] colors
 +
|-
 +
| Player Count
 +
| Optional VarInt
 +
| Only if Mode = 0 or 3 or 4. Number of players in the array
 +
|-
 +
| Players
 +
| Optional Array of String
 +
| Only if Mode = 0 or 3 or 4. Players to be added/remove from the team. Max 40 characters so may be uuid's later
 +
|}
  
 
==== Plugin Message ====
 
==== Plugin Message ====
Line 1,568: Line 2,971:
 
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>.
 
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/
+
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"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x3F || rowspan=3 | Play || rowspan=3 | Client
+
! Bound To
| Channel || String || Name of the "channel" used to send the data.
+
! Field Name
|-
+
! Field Type
| Length || Short || Length of the following byte array
+
! Notes
|-
+
|-
| Data || Byte Array || Any data.
+
|rowspan="2"| 0x3F
|}
+
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Channel
 +
| String
 +
| Name of the [[plugin channel]] used to send the data
 +
|-
 +
| Data
 +
| Byte Array
 +
| Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].
 +
|}
  
 
==== Disconnect ====
 
==== Disconnect ====
Line 1,586: Line 2,998:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x40 || rowspan=1 | Play || rowspan=1 | Client
+
! Bound To
| Reason || String || Displayed to the client when the connection terminates. Must be valid JSON.
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
| 0x40
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Reason
 +
| [[Chat]]
 +
| Displayed to the client when the connection terminates.
 +
|}
 +
 
 +
==== 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"| 0x41
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Difficulty
 +
| Unsigned Byte
 +
| 0: peaceful, 1: easy, 2: normal, 3: hard
 +
|}
 +
 
 +
==== Combat Event ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="6"| 0x42
 +
|rowspan="6"| Play
 +
|rowspan="6"| Client
 +
| Event
 +
| VarInt
 +
| 0: enter combat, 1: end combat, 2: entity dead
 +
|-
 +
| Duration
 +
| Optional VarInt
 +
| Only for end combat
 +
|-
 +
| Player ID
 +
| Optional VarInt
 +
| Only for entity dead
 +
|-
 +
| Entity ID
 +
| Optional Int
 +
| Only for end combat and entity dead
 +
|-
 +
| Message
 +
| String
 +
| Only for entity dead
 +
|}
 +
 
 +
==== Camera ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x43
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Camera ID
 +
| VarInt
 +
|
 +
|}
 +
 
 +
==== World Border ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="18"| 0x44
 +
|rowspan="18"| Play
 +
|rowspan="18"| Client
 +
|colspan="2"| Action
 +
| VarInt
 +
| Determines the format of the rest of the packet
 +
|-
 +
! Action
 +
! Field Name
 +
!
 +
!
 +
|-
 +
| 0: set size
 +
| Radius
 +
| Double
 +
| meters
 +
|-
 +
|rowspan="3"| 1: lerp size
 +
| Old Radius
 +
| Double
 +
| meters
 +
|-
 +
| New Radius
 +
| Double
 +
| meters
 +
|-
 +
| Speed
 +
| VarLong
 +
| number of real-time ticks/seconds (?) until New Radius is reached. From experiments, it appears that Notchian server does not sync world border speed to game ticks, so it gets out of sync with server lag
 +
|-
 +
|rowspan="2"| 2: set center
 +
| X
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|
 +
|-
 +
|rowspan="8"| 3: initialize
 +
| X
 +
| Double
 +
|
 +
|-
 +
| Z
 +
| Double
 +
|
 +
|-
 +
| Old Radius
 +
| Double
 +
|
 +
|-
 +
| New Radius
 +
| Double
 +
|
 +
|-
 +
| Speed
 +
| VarLong
 +
|
 +
|-
 +
| Portal Teleport Boundary
 +
| VarInt
 +
| Resulting coordinates from a portal teleport are limited to +-value. Usually 29999984.
 +
|-
 +
| Warning Time
 +
| VarInt
 +
|
 +
|-
 +
| Warning Blocks
 +
| VarInt
 +
|
 +
|-
 +
|rowspan="1"| 4: set warning time
 +
| Warning Time
 +
| VarInt
 +
| unit?
 +
|-
 +
|rowspan="1"| 5: set warning blocks
 +
| Warning Blocks
 +
| VarInt
 +
|
 +
|}
 +
 
 +
==== Title ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="9"| 0x45
 +
|rowspan="9"| Play
 +
|rowspan="9"| Client
 +
|colspan="2"| Action
 +
| VarInt
 +
|  
 +
|-
 +
! Action
 +
! Field Name
 +
!
 +
!
 +
|-
 +
| 0: set title
 +
| Title Text
 +
| [[Chat]]
 +
|
 +
|-
 +
| 1: set subtitle
 +
| Subtitle Text
 +
| [[Chat]]
 +
|
 +
|-
 +
|rowspan="3"| 2: set times and display
 +
| Fade In
 +
| Int
 +
| ticks
 +
|-
 +
| Stay
 +
| Int
 +
| ticks
 +
|-
 +
| Fade Out
 +
| Int
 +
| ticks
 +
|-
 +
| 3: hide
 +
| ''no fields''
 +
|
 +
|
 +
|-
 +
| 4: reset
 +
| ''no fields''
 +
|
 +
|
 +
|}
 +
 
 +
“Hide” makes the title disappear, but if you run times again the same title will appear. “Reset” erases the text.
 +
 
 +
==== Set Compression ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x46
 +
|rowspan="1"| Play
 +
|rowspan="1"| Client
 +
| Threshold
 +
| VarInt
 +
| Packets of this size or higher may be compressed
 +
|}
 +
 
 +
==== Player List Header/Footer ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x47
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Header
 +
| [[Chat]]
 +
|
 +
|-
 +
| Footer
 +
| [[Chat]]
 +
|
 +
|}
 +
 
 +
==== Resource Pack Send ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x48
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| URL
 +
| String
 +
| The URL to the resource pack.
 +
|-
 +
| Hash
 +
| String
 +
| 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
 +
|}
 +
 
 +
==== Update Entity NBT ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x49
 +
|rowspan="2"| Play
 +
|rowspan="2"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Tag
 +
| [[NBT|NBT Tag]]
 +
|
 +
|}
  
 
=== Serverbound ===
 
=== Serverbound ===
Line 1,599: Line 3,327:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x00 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Keep Alive ID || Int ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x00
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Keep Alive ID
 +
| VarInt
 +
|  
 +
|}
  
 
==== Chat Message ====
 
==== Chat Message ====
  
 
The default server will check the message to see if it begins with a '/'. If it doesn't, the username of the sender is prepended and sent to all other clients (including the original sender). If it does, the server assumes it to be a command and attempts to process it. A message longer than 100 characters will cause the server to kick the client. This change was initially done by allowing the client to not slice the message up to 119 (the previous limit), without changes to the server. For this reason, the vanilla server kept the code to cut messages at 119, but this isn't a protocol limitation and can be ignored.
 
The default server will check the message to see if it begins with a '/'. If it doesn't, the username of the sender is prepended and sent to all other clients (including the original sender). If it does, the server assumes it to be a command and attempts to process it. A message longer than 100 characters will cause the server to kick the client. This change was initially done by allowing the client to not slice the message up to 119 (the previous limit), without changes to the server. For this reason, the vanilla server kept the code to cut messages at 119, but this isn't a protocol limitation and can be ignored.
 
For more information, see [[Chat]].
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x01 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Message || String ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x01
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Message
 +
| String
 +
| The client sends the raw input, not [[Chat]]
 +
|}
  
 
==== Use Entity ====
 
==== Use Entity ====
Line 1,624: Line 3,368:
 
A Notchian server only accepts this packet if the entity being attacked/used is visible without obstruction and within a 4-unit radius of the player's position.
 
A Notchian server only accepts this packet if the entity being attacked/used is visible without obstruction and within a 4-unit radius of the player's position.
  
Note that middle-click in creative mode is interpreted by the client and sent as a Creative Inventory Action packet instead.
+
Note that middle-click in creative mode is interpreted by the client and sent as a [[#Creative Inventory Action|Creative Inventory Action]] packet instead.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=2 | 0x02 || rowspan=2 | Play || rowspan=2 | Server
+
! Bound To
| Target || Int ||
+
! Field Name
|-
+
! Field Type
| Mouse || Byte || 0 = Right-click, 1 = Left-click
+
! Notes
|}
+
|-
 +
|rowspan="5"| 0x02
 +
|rowspan="5"| Play
 +
|rowspan="5"| Server
 +
| Target
 +
| VarInt
 +
|  
 +
|-
 +
| Type
 +
| VarInt
 +
| 0: interact, 1: attack, 2: interact at
 +
|-
 +
| Target X
 +
| Optional Float
 +
| Only if Type is interact at
 +
|-
 +
| Target Y
 +
| Optional Float
 +
| Only if Type is interact at
 +
|-
 +
| Target Z
 +
| Optional Float
 +
| Only if Type is interact at
 +
|}
  
 
==== Player ====
 
==== Player ====
Line 1,639: Line 3,406:
 
This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).
 
This packet is used to indicate whether the player is on ground (walking/swimming), or airborne (jumping/falling).
  
When dropping from sufficient height, fall damage is applied when this state goes from False to True. The amount of damage applied is based on the point where it last changed from True to False. Note that there are several movement related packets containing this state.
+
When dropping from sufficient height, fall damage is applied when this state goes from false to true. The amount of damage applied is based on the point where it last changed from true to false. Note that there are several movement related packets containing this state.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x03 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| On Ground || Bool || True if the client is on the ground, False otherwise
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x03
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| On Ground
 +
| Boolean
 +
| True if the client is on the ground, false otherwise
 +
|}
  
 
==== Player Position ====
 
==== Player Position ====
  
Updates the players XYZ position on the server.  
+
Updates the player's XYZ position on the server.
If <code>HeadY - FeetY</code> is less than <code>0.1</code> or greater than <code>1.65</code>, the stance is illegal and the client will be kicked with the message “Illegal Stance”.
+
 
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 units will result in the client being kicked for "You moved too quickly :( (Hacking?)"
+
If the distance between the last known position of the player on the server and the new position set by this packet is greater than 100 units, this will result in the client being kicked for “You moved too quickly :( (Hacking?)
Also if the fixed-point number of X or Z is set greater than <code>3.2E7D</code> the client will be kicked for "Illegal position"
+
 
 +
If the distance is greater than 10 units, the server will log the warning message "<name> moved too quickly!", followed by two coordinate triples (maybe movement delta?), but will not kick the client.
 +
 
 +
Also if the fixed-point number of X or Z is set greater than 3.2×10<sup>7</sup> the client will be kicked for “Illegal position”.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=5| 0x04 || rowspan=5 | Play || rowspan=5 | Server
+
! Bound To
| X || Double || Absolute position
+
! Field Name
|-
+
! Field Type
| FeetY || Double || Absolute feet position, normally HeadY - 1.62. Used to modify the players bounding box when going up stairs, crouching, etc…
+
! Notes
|-
+
|-
| HeadY || Double || Absolute head position
+
|rowspan="4"| 0x04
|-
+
|rowspan="4"| Play
| Z || Double || Absolute position
+
|rowspan="4"| Server
|-
+
| X
| On Ground || Bool || True if the client is on the ground, False otherwise
+
| Double
|}
+
| Absolute position
 +
|-
 +
| Feet Y
 +
| Double
 +
| Absolute position, normally Head Y - 1.62
 +
|-
 +
| Z
 +
| Double
 +
| Absolute position
 +
|-
 +
| On Ground
 +
| Boolean
 +
| True if the client is on the ground, false otherwise
 +
|}
  
 
==== Player Look ====
 
==== Player Look ====
 
 
[[File:Minecraft-trig-yaw.png|thumb|The unit circle for yaw]]
 
[[File:Minecraft-trig-yaw.png|thumb|The unit circle for yaw]]
 
 
[[File:Yaw.png|thumb|The unit circle of yaw, redrawn]]
 
[[File:Yaw.png|thumb|The unit circle of yaw, redrawn]]
  
Line 1,682: Line 3,472:
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
 
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
  
The yaw of player (in degrees), standing at point (x0,z0) and looking towards point (x,z) one can be calculated with:
+
The yaw of player (in degrees), standing at point (x0, z0) and looking towards point (x, z) one can be calculated with:
  l = x-x0
 
  w = z-z0
 
  c = sqrt( l*l + w*w )
 
  alpha1 = -arcsin(l/c)/PI*180
 
  alpha2 =  arccos(w/c)/PI*180
 
  if alpha2 > 90 then
 
    yaw = 180 - alpha1
 
  else
 
    yaw = alpha1
 
  
Pitch is measured in degrees, where 0 is looking straight ahead, -90 is looking straight up, and 90 is looking straight down.
+
l = x-x0
 +
w = z-z0
 +
c = sqrt( l*l + w*w )
 +
alpha1 = -arcsin(l/c)/PI*180
 +
alpha2 =  arccos(w/c)/PI*180
 +
if alpha2 > 90 then
 +
    yaw = 180 - alpha1
 +
else
 +
    yaw = alpha1
  
 
You can get a unit vector from a given yaw/pitch via:
 
You can get a unit vector from a given yaw/pitch via:
  x = -cos(pitch) * sin(yaw)
+
 
  y = -sin(pitch)
+
x = -cos(pitch) * sin(yaw)
  z =  cos(pitch) * cos(yaw)
+
y = -sin(pitch)
 +
z =  cos(pitch) * cos(yaw)
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=3| 0x05 || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Yaw || Float || Absolute rotation on the X Axis, in degrees
+
! Field Name
|-
+
! Field Type
| Pitch || Float || Absolute rotation on the Y Axis, in degrees
+
! Notes
|-
+
|-
| On Ground || Bool || True if the client is on the ground, False otherwise
+
|rowspan="3"| 0x05
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Yaw
 +
| Float
 +
| Absolute rotation on the X Axis, in degrees
 +
|-
 +
| Pitch
 +
| Float
 +
| Absolute rotation on the Y Axis, in degrees
 +
|-
 +
| On Ground
 +
| Boolean
 +
| True if the client is on the ground, False otherwise
 +
|}
  
 
==== Player Position And Look ====
 
==== Player Position And Look ====
  
A combination of Player Look and Player position.  
+
A combination of [[#Player Look|Player Look]] and [[#Player Position|Player Position]].
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=7| 0x06 || rowspan=7 | Play || rowspan=7 | Server
+
! Bound To
| X || Double || Absolute position
+
! Field Name
|-
+
! Field Type
| FeetY || Double || Absolute feet position. Is normally HeadY - 1.62. Used to modify the players bounding box when going up stairs, crouching, etc…
+
! Notes
|-
+
|-
| HeadY || Double || Absolute head position
+
|rowspan="6"| 0x06
|-
+
|rowspan="6"| Play
| Z || Double || Absolute position
+
|rowspan="6"| Server
|-
+
| X
| Yaw || Float || Absolute rotation on the X Axis, in degrees
+
| Double
|-
+
| Absolute position
| Pitch || Float || Absolute rotation on the Y Axis, in degrees
+
|-
|-
+
| Feet Y
| On Ground || Bool || True if the client is on the ground, False otherwise
+
| Double
|}
+
| Absolute feet position, normally Head Y - 1.62
 +
|-
 +
| Z
 +
| Double
 +
| Absolute position
 +
|-
 +
| Yaw
 +
| Float
 +
| Absolute rotation on the X Axis, in degrees
 +
|-
 +
| Pitch
 +
| Float
 +
| Absolute rotation on the Y Axis, in degrees
 +
|-
 +
| On Ground
 +
| Boolean
 +
| True if the client is on the ground, false otherwise
 +
|}
  
 
==== Player Digging ====
 
==== Player Digging ====
  
Sent when the player mines a block. A Notchian server only accepts digging packets with coordinates within a 6-unit radius of the player's position.
+
Sent when the player mines a block. A Notchian server only accepts digging packets with coordinates within a 6-unit radius of the player's position.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="5" | 0x07 || rowspan=5 | Play || rowspan=5 | Server
+
! Bound To
| Status || Byte || The action the player is taking against the block (see below)
+
! Field Name
|-
+
! Field Type
| X || Int || Block position
+
! Notes
|-
+
|-
| Y || Unsigned Byte || Block position
+
|rowspan="3"| 0x07
|-
+
|rowspan="3"| Play
| Z || Int || Block position
+
|rowspan="3"| Server
|-
+
| Status
| Face || Byte || The face being hit (see below)
+
| Byte
|}
+
| The action the player is taking against the block (see below)
 +
|-
 +
| Location
 +
| Position
 +
| Block position
 +
|-
 +
| Face
 +
| Byte
 +
| The face being hit (see below)
 +
|}
  
 
Status can (currently) be one of six values:
 
Status can (currently) be one of six values:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Meaning !! Value
+
! Meaning
|-
+
! Value
| Started digging || <code>0</code>
+
|-
|-
+
| Started digging
| Cancelled digging || <code>1</code>
+
| <code>0</code>
|-
+
|-
| Finished digging || <code>2</code>
+
| Cancelled digging
|-
+
| <code>1</code>
| Drop item stack || <code>3</code>
+
|-
|-
+
| Finished digging
| Drop item || <code>4</code>
+
| <code>2</code>
|-
+
|-
| Shoot arrow / finish eating || <code>5</code>
+
| Drop item stack
|}
+
| <code>3</code>
 +
|-
 +
| Drop item
 +
| <code>4</code>
 +
|-
 +
| Shoot arrow / finish eating
 +
| <code>5</code>
 +
|}
  
Notchian clients send a 0 (started digging) when they start digging and a 2 (finished digging) once they think they are finished. If digging is aborted, the client simply send a 1 (Cancel digging).
+
Notchian clients send a 0 (started digging) when they start digging and a 2 (finished digging) once they think they are finished. If digging is aborted, the client simply send a 1 (cancel digging).
  
Status code 4 (drop item) is a special case. In-game, when you use the Drop Item command (keypress 'q'), a dig packet with a status of 4, and all other values set to 0, is sent from client to server. Status code 3 is similar, but drops the entire stack.
+
Status code 4 (drop item) is a special case. In-game, when you use the Drop Item command (keypress 'q'), a dig packet with a status of 4, and all other values set to 0, is sent from client to server. Status code 3 is similar, but drops the entire stack.
  
 
Status code 5 (shoot arrow / finish eating) is also a special case. The x, y and z fields are all set to 0 like above, with the exception of the face field, which is set to 255.
 
Status code 5 (shoot arrow / finish eating) is also a special case. The x, y and z fields are all set to 0 like above, with the exception of the face field, which is set to 255.
Line 1,780: Line 3,616:
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
| Value || 0 || 1 || 2 || 3 || 4 || 5
+
! Value
|-
+
| 0
| Offset || -Y || +Y || -Z || +Z || -X || +X
+
| 1
|}
+
| 2
 +
| 3
 +
| 4
 +
| 5
 +
|-
 +
! Offset
 +
| -Y
 +
| +Y
 +
| -Z
 +
| +Z
 +
| -X
 +
| +X
 +
|}
  
In 1.7.3, when a player opens a door with left click the server receives Packet 0xE+start digging and opens the door.
+
==== Player Block Placement ====
  
==== Player Block Placement ====
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="8" | 0x08 || rowspan=8 | Play || rowspan=8 | Server
+
! Bound To
| X || Int || Block position
+
! Field Name
|-
+
! Field Type
| Y || Unsigned Byte || Block position
+
! Notes
|-
+
|-
| Z || Int || Block position
+
|rowspan="6"| 0x08
|-
+
|rowspan="6"| Play
| Direction || Byte || The offset to use for block/item placement (see below)
+
|rowspan="6"| Server
|-
+
| Location
| Held item || [[Slot_Data|Slot]] ||
+
| Position
|-
+
| Block position
| Cursor position X || Byte || The position of the crosshair on the block
+
|-
|-
+
| Face
| Cursor position Y || Byte ||
+
| Byte
|-
+
| The face on which the block is placed (see above)
| Cursor position Z || Byte ||
+
|-
|}
+
| Held Item
In normal operation (ie placing a block), this packet is sent once, with the values set normally.
+
| [[Slot Data|Slot]]
 +
|  
 +
|-
 +
| Cursor Position X
 +
| Byte
 +
| The position of the crosshair on the block
 +
|-
 +
| Cursor Position Y  
 +
| Byte
 +
|  
 +
|-
 +
| Cursor Position Z
 +
| Byte
 +
|  
 +
|}
  
This packet has a special case where X, Y, Z, and Direction are all -1. (Note that Y is unsigned so set to 255.) This special packet indicates that the currently held item for the player should have its state updated such as eating food, shooting bows, using buckets, etc.
+
In normal operation (i.e. placing a block), this packet is sent once, with the values set normally.
  
In a Notchian Beta client, the block or item ID corresponds to whatever the client is currently holding, and the client sends one of these packets any time a right-click is issued on a surface, so no assumptions can be made about the safety of the ID.  However, with the implementation of server-side inventory, a Notchian server seems to ignore the item ID, instead operating on server-side inventory information and holding selection. The client has been observed (1.2.5 and 1.3.2) to send both real item IDs and -1 in a single session.
+
This packet has a special case where X, Y, Z, and Direction are all -1. (Note that Y is unsigned so set to 255.) This special packet indicates that the currently held item for the player should have its state updated such as eating food, pulling back bows, using buckets, etc.
  
Special note on using buckets: When using buckets, the Notchian client might send two packets: first a normal and then a special case. The first normal packet is sent when you're looking at a block (e.g. the water you want to scoop up). This normal packet does not appear to do anything with a Notchian server. The second, special case packet appears to perform the action - based on current position/orientation and with a distance check - it appears that buckets can only be used within a radius of 6 units.
+
In a Notchian Beta client, the block or item ID corresponds to whatever the client is currently holding, and the client sends one of these packets any time a right-click is issued on a surface, so no assumptions can be made about the safety of the ID. However, with the implementation of server-side inventory, a Notchian server seems to ignore the item ID, instead operating on server-side inventory information and holding selection. The client has been observed (1.2.5 and 1.3.2) to send both real item IDs and -1 in a single session.
 +
 
 +
Special note on using buckets: When using buckets, the Notchian client might send two packets: first a normal and then a special case. The first normal packet is sent when you're looking at a block (e.g. the water you want to scoop up). This normal packet does not appear to do anything with a Notchian server. The second, special case packet appears to perform the action based on current position/orientation and with a distance check it appears that buckets can only be used within a radius of 6 units.
  
 
==== Held Item Change ====
 
==== Held Item Change ====
Line 1,823: Line 3,686:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x09 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Slot || Short || The slot which the player has selected (0-8)
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x09
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Slot
 +
| Short
 +
| The slot which the player has selected (0–8)
 +
|}
  
 
==== Animation ====
 
==== Animation ====
{| class="wikitable"
 
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
 
|-
 
| rowspan=2 | 0x0A || rowspan=2 | Play || rowspan=2 | Server
 
| Entity ID || Int || Player ID
 
|-
 
| Animation || Byte || Animation ID
 
|}
 
 
  
Animation can be one of the following values:
+
Sent when the player's arm swings
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Animation
+
! Packet ID
|-
+
! State
| 0 || No animation
+
! Bound To
|-
+
! Field Name
| 1 || Swing arm
+
! Field Type
|-
+
! Notes
| 2 || Damage animation
+
|-
|-
+
|rowspan="1"| 0x0A
| 3 || Leave bed
+
|rowspan="1"| Play
|-
+
|rowspan="1"| Server
| 5 || Eat food
+
| ''no fields''
|-
+
|  
| 6 || Critical effect
+
|  
|-
+
|}
| 7 || Magic critical effect
 
|-
 
| 102 || (unknown)
 
|-
 
| 104 || Crouch
 
|-
 
| 105 || Uncrouch
 
|}
 
  
 
==== Entity Action ====
 
==== Entity Action ====
  
Sent at least when crouching, leaving a bed, or sprinting.
+
Sent at least when crouching, leaving a bed, or sprinting. To send action animation to client use 0x28. The client will send this with Action ID = 3 when “Leave Bed” is clicked.
To send action animation to client use 0x28.
 
The client will send this with Action ID = 3 when "Leave Bed" is clicked.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x0B || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Entity ID || Int || Player ID
+
! Field Name
|-
+
! Field Type
| Action ID || Byte || The ID of the action, see below.
+
! Notes
|-
+
|-
| Jump Boost || Int || Horse jump boost. Ranged from 0 -> 100.
+
|rowspan="3"| 0x0B
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Entity ID
 +
| VarInt
 +
| Player ID
 +
|-
 +
| Action ID
 +
| VarInt
 +
| The ID of the action, see below
 +
|-
 +
| Jump Boost
 +
| VarInt
 +
| Horse jump boost. Ranged from 0 -> 100.
 +
|}
  
 
Action ID can be one of the following values:
 
Action ID can be one of the following values:
  
 
{| class="wikitable"
 
{| class="wikitable"
! ID !! Action
+
! ID
|-
+
! Action
| 1 || Crouch
+
|-
|-
+
| 0
| 2 || Uncrouch
+
| Crouch
|-
+
|-
| 3 || Leave bed
+
| 1
|-
+
| Uncrouch
| 4 || Start sprinting
+
|-
|-
+
| 2
| 5 || Stop sprinting
+
| Leave bed
|-
+
|-
| 6 || Horse jump
+
| 3
|-
+
| Start sprinting
| 5 || Horse interaction ?
+
|-
|}
+
| 4
 +
| Stop sprinting
 +
|-
 +
| 5
 +
| Jump with horse
 +
|-
 +
| 6
 +
| Open inventory
 +
|}
  
 
==== Steer Vehicle ====
 
==== Steer Vehicle ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="4" | 0x0C || rowspan=4 | Play || rowspan=4 | Server
+
! Bound To
| Sideways || Float || Positive to the left of the player
+
! Field Name
|-
+
! Field Type
| Forward || Float || Positive forward
+
! Notes
|-
+
|-
| Jump || Bool ||
+
|rowspan="3"| 0x0C
|-
+
|rowspan="3"| Play
| Unmount || Bool || True when leaving the vehicle
+
|rowspan="3"| Server
|}
+
| Sideways
 +
| Float
 +
| Positive to the left of the player
 +
|-
 +
| Forward
 +
| Float
 +
| Positive forward
 +
|-
 +
| Flags
 +
| Unsigned Byte
 +
| Bit mask. 0x1: jump, 0x2: unmount
 +
|}
  
 
==== Close Window ====
 
==== Close Window ====
  
This packet is sent by the client when closing a window.  
+
This packet is sent by the client when closing a window.
  
Note, notchian clients send a close window message with window id 0 to close their inventory even though there is never an Open Window message for inventory.  
+
Note, Notchian clients send a close window message with Window ID 0 to close their inventory even though there is never an Open Window message for inventory.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x0D || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Window id || byte || This is the id of the window that was closed. 0 for inventory.
+
! Field Name
|}
+
! Field Type
 
+
! Notes
 +
|-
 +
| 0x0D
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Window ID
 +
| Byte
 +
| This is the ID of the window that was closed. 0 for inventory.
 +
|}
  
 
==== Click Window ====
 
==== Click Window ====
Line 1,936: Line 3,830:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x0E || rowspan=6 | Play || rowspan=6 | Server
+
! Bound To
| Window ID || Byte || The id of the window which was clicked. 0 for player inventory.
+
! Field Name
|-
+
! Field Type
| Slot || Short || The clicked slot. See below.
+
! Notes
|-
+
|-
| Button || Byte || The button used in the click. See below.
+
|rowspan="6"| 0x0E
|-
+
|rowspan="6"| Play
| Action number || Short || A unique number for the action, used for transaction handling (See the Transaction packet).
+
|rowspan="6"| Server
|-
+
| Window ID
| Mode || Byte || Inventory operation mode. See below.
+
| Byte
|-
+
| The ID of the window which was clicked. 0 for player inventory.
| Clicked item || [[Slot_Data|Slot]] ||
+
|-
|}
+
| Slot
 +
| Short
 +
| The clicked slot Nr., see below
 +
|-
 +
| Button
 +
| Byte
 +
| The button used in the click, see below
 +
|-
 +
| Action Number
 +
| Short
 +
| A unique number for the action, implemented by Notchian as a counter, starting at 1. Used by the server to send back a [[#Confirm Transaction|Confirm Transaction]].
 +
|-
 +
| Mode
 +
| Byte
 +
| Inventory operation mode, see below
 +
|-
 +
| Clicked item
 +
| [[Slot Data|Slot]]
 +
| The clicked slot. Has to be empty (item ID = -1) for drop mode.
 +
|}
  
 
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
 
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
  
When right-clicking on a stack of items, half the stack will be picked up and half left in the slot. If the stack is an odd number, the half left in the slot will be smaller of the amounts.
+
When right-clicking on a stack of items, half the stack will be picked up and half left in the slot. If the stack is an odd number, the half left in the slot will be smaller of the amounts.
  
The Action number is actually a counter, starting at 1.  This number is used by the server as a transaction ID to send back a [[#0x6A|Transaction packet]].
+
The distinct type of click performed by the client is determined by the combination of the Mode and Button fields.
  
The distinct type of click performed by the client is determined by the combination of the "Mode" and "Button" fields.
 
 
{| class="wikitable"
 
{| class="wikitable"
! Mode !! Button !! Slot !! Trigger
+
! Mode
|-
+
! Button
! rowspan="2" | 0
+
! Slot
| 0 || Normal || Left mouse click
+
! Trigger
|-
+
|-
| 1 || Normal || Right mouse click
+
!rowspan="2"| 0
|-
+
| 0
! rowspan="2" | 1
+
| Normal
| 0 || Normal || Shift + left mouse click
+
| Left mouse click
|-
+
|-
| 1 || Normal || Shift + right mouse click ''(Identical behavior)''
+
| 1
|-
+
| Normal
! rowspan="5" | 2
+
| Right mouse click
| 0 || Normal || Number key 1
+
|-
|-
+
!rowspan="2"| 1
| 1 || Normal || Number key 2
+
| 0
|-
+
| Normal
| 2 || Normal || Number key 3
+
| Shift + left mouse click
|-
+
|-
| ...
+
| 1
| ...
+
| Normal
| ...
+
| Shift + right mouse click ''(identical behavior)''
|-
+
|-
| 8 || Normal || Number key 9
+
!rowspan="5"| 2
|-
+
| 0
! rowspan="1" | 3
+
| Normal
| 2 || Normal || Middle click
+
| Number key 1
|-
+
|-
! rowspan="4" | 4
+
| 1
| 0 || Normal || Drop key (Q)
+
| Normal
|-
+
| Number key 2
| 1 || Normal || Ctrl + Drop key (Ctrl-Q)
+
|-
|-
+
| 2
| 0 || -999 || Left click outside inventory holding nothing ''(No-op)''
+
| Normal
|-
+
| Number key 3
| 1 || -999 || Right click outside inventory holding nothing ''(No-op)''
+
|-
|-
+
|
! rowspan="6" | 5
+
|
| 0 || -999 || Starting left mouse drag ''(Or middle mouse)''
+
|
|-
+
|-
| 4 || -999 || Starting right mouse drag
+
| 8
|-
+
| Normal
| 1 || Normal || Add slot for left-mouse drag
+
| Number key 9
|-
+
|-
| 5 || Normal || Add slot for right-mouse drag
+
!rowspan="1"| 3
|-
+
| 2
| 2 || -999 || Ending left mouse drag
+
| Normal
|-
+
| Middle click
| 6 || -999 || Ending right mouse drag
+
|-
|-
+
!rowspan="4"| 4
! 6  
+
| 0
| 0 || Normal || Double click
+
| Normal*
|}
+
| Drop key (Q) (* Clicked item is different, see above)
 +
|-
 +
| 1
 +
| Normal*
 +
| Ctrl + Drop key (Ctrl-Q) ''(drops full stack)''
 +
|-
 +
| 0
 +
| -999
 +
| Left click outside inventory holding nothing ''(no-op)''
 +
|-
 +
| 1
 +
| -999
 +
| Right click outside inventory holding nothing ''(no-op)''
 +
|-
 +
!rowspan="6"| 5
 +
| 0
 +
| -999
 +
| Starting left mouse drag ''(or middle mouse)''
 +
|-
 +
| 4
 +
| -999
 +
| Starting right mouse drag
 +
|-
 +
| 1
 +
| Normal
 +
| Add slot for left-mouse drag
 +
|-
 +
| 5
 +
| Normal
 +
| Add slot for right-mouse drag
 +
|-
 +
| 2
 +
| -999
 +
| Ending left mouse drag
 +
|-
 +
| 6
 +
| -999
 +
| Ending right mouse drag
 +
|-
 +
! 6
 +
| 0
 +
| Normal
 +
| Double click
 +
|}
  
Starting from version 1.5, "painting mode" is available for use in inventory windows. It is done by picking up stack of something (more than 1 items), then holding mouse button (left, right or middle) and dragging holded stack over empty (or same type in case of right button ) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):
+
Starting from version 1.5, “painting mode” is available for use in inventory windows. It is done by picking up stack of something (more than 1 item), then holding mouse button (left, right or middle) and dragging held stack over empty (or same type in case of right button) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):
  
# packet with mode 5, slot -999 , button (0 for left | 4 for right);
+
# packet with mode 5, slot -999, button (0 for left | 4 for right);
 
# packet for every slot painted on, mode is still 5, button (1 | 5);
 
# packet for every slot painted on, mode is still 5, button (1 | 5);
 
# packet with mode 5, slot -999, button (2 | 6);
 
# packet with mode 5, slot -999, button (2 | 6);
  
If any of the painting packets other than the "progress" ones are sent out of order (for example, a start, some slots, then another start; or a left-click in the middle) the painting status will be reset.
+
If any of the painting packets other than the “progress” ones are sent out of order (for example, a start, some slots, then another start; or a left-click in the middle) the painting status will be reset.
 +
 
 +
The server will send back a [[#Confirm Transaction_2|Confirm Transaction]] packet. If the click was not accepted, the client must reflect that packet before sending more [[#Click Window|Click Window]] packets, otherwise the server will reject them silently. The Notchian server also sends a [[#Window Items|Window Items]] packet for the open window and [[#Set Slot|Set Slot]] packets for the clicked and cursor slot, but only when the click was not accepted, probably to resynchronize client and server.
  
 
==== Confirm Transaction ====
 
==== Confirm Transaction ====
 +
 +
<SpaceManiac> noooo idea why the serverbound confirm transaction packet exists
 +
<SpaceManiac> I think it's sent as a response to the clientbound confirm transaction in some situations, but it's fuzzy
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x0F || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Window ID || Byte || The id of the window that the action occurred in.
+
! Field Name
|-
+
! Field Type
| Action number || Short || Every action that is to be accepted has a unique number. This field corresponds to that number.
+
! Notes
|-
+
|-
| Accepted || Bool || Whether the action was accepted.
+
|rowspan="3"| 0x0F
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Window ID
 +
| Byte
 +
| The ID of the window that the action occurred in
 +
|-
 +
| Action Number
 +
| Short
 +
| Every action that is to be accepted has a unique number. This field corresponds to that number.
 +
|-
 +
| Accepted
 +
| Boolean
 +
| Whether the action was accepted
 +
|}
  
 
==== Creative Inventory Action ====
 
==== Creative Inventory Action ====
  
While the user is in the standard inventory (i.e., not a crafting bench) on a creative-mode server then the server will send this packet:
+
While the user is in the standard inventory (i.e., not a crafting bench) in Creative mode, the player will send this packet.
  
* If an item is dropped into the quick bar
+
Clicking in the creative inventory menu is quite different from non-creative inventory management. Picking up an item with the mouse actually deletes the item from the server, and placing an item into a slot or dropping it out of the inventory actually tells the server to create the item from scratch. (This can be verified by clicking an item that you don't mind deleting, then severing the connection to the server; the item will be nowhere to be found when you log back in.) As a result of this implementation strategy, the "Destroy Item" slot is just a client-side implementation detail that means "I don't intend to recreate this item.". Additionally, the long listings of items (by category, etc.) are a client-side interface for choosing which item to create. Picking up an item from such listings sends no packets to the server; only when you put it somewhere does it tell the server to create the item in that location.
* If an item is picked up from the quick bar (item id is -1)
+
 
 +
This action can be described as "set inventory slot". Picking up an item sets the slot to item ID -1. Placing an item into an inventory slot sets the slot to the specified item. Dropping an item (by clicking outside the window) effectively sets slot -1 to the specified item, which causes the server to spawn the item entity, etc.. All other inventory slots are numbered the same as the non-creative inventory (including slots for the 2x2 crafting menu, even though they aren't visible in the vanilla client).
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x10 || rowspan=2 | Play || rowspan=2 | Server
+
! Bound To
| Slot || Short || Inventory slot
+
! Field Name
|-
+
! Field Type
| Clicked item || [[Slot_Data|Slot]] ||
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x10
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Slot
 +
| Short
 +
| Inventory slot
 +
|-
 +
| Clicked Item
 +
| [[Slot Data|Slot]]
 +
|  
 +
|}
  
 
==== Enchant Item ====
 
==== Enchant Item ====
 +
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="2" | 0x11 || rowspan=2 | Play || rowspan=2 | Server
+
! Bound To
| Window ID || Byte || The ID sent by [[#0x64|Open Window]]
+
! Field Name
|-
+
! Field Type
| Enchantment || Byte || The position of the enchantment on the enchantment table window, starting with 0 as the topmost one.
+
! Notes
|}
+
|-
 +
|rowspan="2"| 0x11
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Window ID
 +
| Byte
 +
| The ID of the enchantment table window sent by [[#Open Window|Open Window]]
 +
|-
 +
| Enchantment
 +
| Byte
 +
| The position of the enchantment on the enchantment table window, starting with 0 as the topmost one
 +
|}
  
 
==== Update Sign ====
 
==== Update Sign ====
  
This message is sent from the client to the server when the "Done" button is pushed after placing a sign.  
+
This message is sent from the client to the server when the “Done” button is pushed after placing a sign.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="7" | 0x12 || rowspan=7 | Play || rowspan=7 | Server
+
! Bound To
| X || Int || Block X Coordinate
+
! Field Name
|-
+
! Field Type
| Y || Short || Block Y Coordinate
+
! Notes
|-
+
|-
| Z || Int || Block Z Coordinate
+
|rowspan="5"| 0x12
|-
+
|rowspan="5"| Play
| Line 1 || String || First line of text in the sign
+
|rowspan="5"| Server
|-
+
| Location
| Line 2 || String || Second line of text in the sign
+
| Position
|-
+
| Block Coordinates
| Line 3 || String || Third line of text in the sign
+
|-
|-
+
| Line 1
| Line 4 || String || Fourth line of text in the sign
+
| [[Chat]]
|}
+
| First line of text in the sign
 +
|-
 +
| Line 2
 +
| [[Chat]]
 +
| Second line of text in the sign
 +
|-
 +
| Line 3
 +
| [[Chat]]
 +
| Third line of text in the sign
 +
|-
 +
| Line 4
 +
| [[Chat]]
 +
| Fourth line of text in the sign
 +
|}
  
 
==== Player Abilities ====
 
==== Player Abilities ====
  
 
The latter 2 bytes are used to indicate the walking and flying speeds respectively, while the first byte is used to determine the value of 4 booleans.
 
The latter 2 bytes are used to indicate the walking and flying speeds respectively, while the first byte is used to determine the value of 4 booleans.
+
 
The flags are whether damage is disabled (god mode, 8, bit 3), whether the player can fly (4, bit 2), whether the player is flying (2, bit 1), and whether the player is in creative mode (1, bit 0).
 
 
To get the values of these booleans, simply AND (&) the byte with 1,2,4 and 8 respectively, to get the 0 or 1 bitwise value. To set them OR (|) them with their repspective masks.
 
 
The vanilla client sends this packet when the player starts/stops flying with the second parameter changed accordingly. All other parameters are ignored by the vanilla server.
 
The vanilla client sends this packet when the player starts/stops flying with the second parameter changed accordingly. All other parameters are ignored by the vanilla server.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="3" | 0x13 || rowspan=3 | Play || rowspan=3 | Server
+
! Bound To
| Flags || Byte ||
+
! Field Name
|-
+
! Field Type
| Flying speed || Float|| previous integer value divided by 250
+
! Notes
|-
+
|-
| Walking speed || Float || previous integer value divided by 250
+
|rowspan="3"| 0x13
|}
+
|rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Flags
 +
| Byte
 +
| Bit mask. 0x08: damage disabled (god mode), 0x04: can fly, 0x02: is flying, 0x01: is Creative
 +
|-
 +
| Flying Speed
 +
| Float
 +
|  
 +
|-
 +
| Walking Speed
 +
| Float
 +
|  
 +
|}
  
 
==== Tab-Complete ====
 
==== Tab-Complete ====
  
Sent when the user presses [tab] while writing text. The payload contains all text behind the cursor.
+
Sent when the user presses ''tab'' while writing text.
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| 0x14  || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Text || String ||
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="3"| 0x14
 +
  |rowspan="3"| Play
 +
|rowspan="3"| Server
 +
| Text
 +
| String
 +
| All text behind the cursor
 +
|-
 +
| Has Position
 +
| Boolean
 +
|
 +
|-
 +
| Looked At Block
 +
| Optional Position
 +
| The position of the block being looked at. Only sent if Has Position is true
 +
|}
  
 
==== Client Settings ====
 
==== Client Settings ====
Line 2,119: Line 4,157:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan="6" | 0x15 || rowspan=6 | Play || rowspan=6 | Server
+
! Bound To
| Locale || String || en_GB
+
! Field Name
|-
+
! Field Type
| View distance || Byte || Client-side render distance(chunks)
+
! Notes
|-
+
|-
| Chat flags || Byte || Chat settings. See notes below.
+
|rowspan="5"| 0x15
|-
+
|rowspan="5"| Play
| Chat colours || Bool || "Colours" multiplayer setting
+
|rowspan="5"| Server
|-
+
| Locale
| Difficulty || Byte || Client-side difficulty from options.txt
+
| String
|-
+
| e.g. en_GB
| Show Cape || Bool || Show Cape multiplayer setting
+
|-
|}
+
| View Distance
 +
| Byte
 +
| Client-side render distance, in chunks
 +
|-
 +
| Chat Mode
 +
| Byte
 +
| 0: enabled, 1: commands only, 2: hidden
 +
|-
 +
| Chat Colors
 +
| Boolean
 +
| “Colors” multiplayer setting
 +
|-
 +
| Displayed Skin Parts
 +
| Unsigned Byte
 +
| Skin parts, see note below
 +
|}
 +
 
 +
''Displayed Skin Parts'' flags:
  
Chat flags has several values packed into one byte.
+
* Bit 0 (0x01): Cape enabled
 +
* Bit 1 (0x02): Jacket enabled
 +
* Bit 2 (0x04): Left Sleeve enabled
 +
* Bit 3 (0x08): Right Sleeve enabled
 +
* Bit 4 (0x10): Left Pants Leg enabled
 +
* Bit 5 (0x20): Right Pants Leg enabled
 +
* Bit 6 (0x40): Hat enabled
  
'''Chat Enabled:''' Bits 0-1. 00: Enabled.  01: Commands only.  10: Hidden.
+
The most significant bit (bit 7, 0x80) appears to be unused.
  
 
==== Client Status ====
 
==== Client Status ====
Line 2,144: Line 4,205:
  
 
{| class="wikitable"
 
{| class="wikitable"
! Packet ID !! Category !! Bound To !! Field Name !! Field Type !! Notes
+
! Packet ID
|-
+
! State
| rowspan=1 | 0x16 || rowspan=1 | Play || rowspan=1 | Server
+
! Bound To
| Action ID || Byte || See below
+
! Field Name
|}
+
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="1"| 0x16
 +
|rowspan="1"| Play
 +
|rowspan="1"| Server
 +
| Action ID
 +
| VarInt
 +
| See below
 +
|}
 +
 
 +
''Action ID'' values:
  
Action ID values:
 
 
{| class="wikitable"
 
{| class="wikitable"
|-
+
|-
! Action ID !! Name
+
! Action ID
|-
+
! Action
| 0 || Perform respawn
+
|-
|-
+
| 0
| 1 || Request stats
+
| Perform respawn
|-
+
|-
| 2 || Open inventory achievement
+
| 1
|}
+
| Request stats
 +
|-
 +
| 2
 +
| ''Taking Inventory'' achievement
 +
|}
  
 
==== Plugin Message ====
 
==== Plugin Message ====
Line 2,166: Line 4,241:
 
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>.
 
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/
+
More documentation on this: [http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ http://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 +
 
 +
Note that the data length is known from the packet length, so there is no need for a length member being sent.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
|rowspan="2"| 0x17
 +
|rowspan="2"| Play
 +
|rowspan="2"| Server
 +
| Channel
 +
| String
 +
| Name of the [[plugin channel]] used to send the data
 +
|-
 +
| Data
 +
| Byte Array
 +
| Any data, depending on the channel. <code><nowiki>MC|</nowiki></code> channels are documented [[plugin channel|here]].
 +
|}
 +
 
 +
==== Spectate ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-