Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
m (Fix issues in recipe type table.)
m (20w48a: no changes)
 
(279 intermediate revisions by 26 users not shown)
Line 1: Line 1:
This page documents the changes from the [[Protocol|last stable Minecraft release]] (currently [[Protocol version numbers|1.13.2, protocol 404]]) to the current pre-release (currently [[Protocol version numbers|19w03b, protocol 455]]). Note that this page contains bleeding-edge information that may not be completely or correctly documented.
+
This page documents the changes from the [[Protocol|last stable Minecraft release]] (currently [[Protocol version numbers|1.16.4, protocol 754]]) to the current pre-release (currently [[Protocol version numbers|20w48a, protocol 1073741831]]). Note that this page contains bleeding-edge information that may not be completely or correctly documented.
  
 
One who wishes to commandeer the merging of this into [[Protocol]] when an update is made must be sure to respect any changes that may have occurred to the respective packets there.
 
One who wishes to commandeer the merging of this into [[Protocol]] when an update is made must be sure to respect any changes that may have occurred to the respective packets there.
Line 9: Line 9:
 
=== Data types ===
 
=== Data types ===
  
==== Position ====
+
No changes so far.
 
 
64-bit value split in to three parts
 
 
 
* x: 26 MSBs
 
* z: 26 {{change|LSBs|middle bits}}
 
* y: 12 {{change|bits between them|LSBs}}
 
 
 
Encoded as followed:
 
 
 
((x & 0x3FFFFFF) << 38) | {{change|((y & 0xFFF) << 26) {{!}} (z & 0x3FFFFFF)|((z & 0x3FFFFFF) << 12) {{!}} (y & 0xFFF)}}
 
 
 
And decoded as:
 
 
 
val = read_unsigned_long();
 
x = val >> 38;
 
y = {{change|(val >> 26) & 0xFFF|val & 0xFFF}};
 
z = {{change|val << 38 >> 38|(val << 38 >> 38) >> 12}};
 
 
 
Note: The details of bit shifting are rather language dependent; the above may work in Java but probably won't in other languages without some tweaking. In particular, you will usually receive positive numbers even if the actual coordinates are negative. This can be fixed by adding something like the following:
 
 
 
if x >= 2^25 { x -= 2^26 }
 
if y >= 2^11 { y -= 2^12 }
 
if z >= 2^25 { z -= 2^26 }
 
  
 
=== Packets ===
 
=== Packets ===
Line 40: Line 17:
 
  ! Packet name
 
  ! Packet name
 
  !colspan="2"| Documentation
 
  !colspan="2"| Documentation
 +
|-
 +
!colspan="4"| Play serverbound
 +
{{PacketList|0x20|Chunk Data}}
 +
{{PacketList|0x23|Update Light}}
 +
{{PacketList|0x25|Map Data}}
 +
{{PacketList|0x38|Resource Pack Send}}
 
  |-
 
  |-
 
!colspan="4"| Handshaking serverbound
 
!colspan="4"| Handshaking serverbound
 
{{PacketList|0x00|Handshake}}
 
{{PacketList|0x00|Handshake}}
|-
 
!colspan="4"| Play clientbound
 
{{PacketList|0x09|Update Block Entity}}
 
{{PacketList|0x14|Open Horse Window|rel=added}}
 
{{PacketList|0x22|Chunk Data}}
 
{{PacketList|0x26|Map Data}}
 
{{PacketList|0x2C|Open Book|rel=added}}
 
{{PacketList|{{change|0x2C|0x2D}}|Open Sign Editor|pre=unchanged}}
 
{{PacketList|{{change|0x2D|0x2E}}|Craft Recipe Response|pre=unchanged}}
 
{{PacketList|{{change|0x2E|0x2F}}|Player Abilities (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x2F|0x30}}|Combat Event|pre=unchanged}}
 
{{PacketList|{{change|0x30|0x31}}|Player List Item|pre=unchanged}}
 
{{PacketList|{{change|0x31|0x32}}|Face Player|pre=unchanged}}
 
{{PacketList|{{change|0x32|0x33}}|Player Position And Look (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x33|0x34}}|Use Bed|pre=unchanged}}
 
{{PacketList|{{change|0x34|0x35}}|Unlock Recipes|pre=unchanged}}
 
{{PacketList|{{change|0x35|0x36}}|Destroy Entities|pre=unchanged}}
 
{{PacketList|{{change|0x36|0x37}}|Remove Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x37|0x38}}|Resource Pack Send|pre=unchanged}}
 
{{PacketList|{{change|0x38|0x39}}|Respawn|pre=unchanged}}
 
{{PacketList|{{change|0x39|0x3A}}|Entity Head Look|pre=unchanged}}
 
{{PacketList|{{change|0x3A|0x3B}}|Select Advancement Tab|pre=unchanged}}
 
{{PacketList|{{change|0x3B|0x3C}}|World Border|pre=unchanged}}
 
{{PacketList|{{change|0x3C|0x3D}}|Camera|pre=unchanged}}
 
{{PacketList|{{change|0x3D|0x3E}}|Held Item Change (clientbound)|pre=unchanged}}
 
{{PacketList|{{change|0x3E|0x3F}}|Display Scoreboard|pre=unchanged}}
 
{{PacketList|{{change|0x3F|0x40}}|Entity Metadata|pre=unchanged}}
 
{{PacketList|{{change|0x40|0x41}}|Attach Entity|pre=unchanged}}
 
{{PacketList|{{change|0x41|0x42}}|Entity Velocity|pre=unchanged}}
 
{{PacketList|{{change|0x42|0x43}}|Entity Equipment|pre=unchanged}}
 
{{PacketList|{{change|0x43|0x44}}|Set Experience|pre=unchanged}}
 
{{PacketList|{{change|0x44|0x45}}|Update Health|pre=unchanged}}
 
{{PacketList|{{change|0x45|0x46}}|Scoreboard Objective|pre=unchanged}}
 
{{PacketList|{{change|0x46|0x47}}|Set Passengers|pre=unchanged}}
 
{{PacketList|{{change|0x47|0x48}}|Teams|pre=unchanged}}
 
{{PacketList|{{change|0x48|0x49}}|Update Score|pre=unchanged}}
 
{{PacketList|{{change|0x49|0x4A}}|Spawn Position|pre=unchanged}}
 
{{PacketList|{{change|0x4A|0x4B}}|Time Update|pre=unchanged}}
 
{{PacketList|{{change|0x4B|0x4C}}|Title|pre=unchanged}}
 
{{PacketList|{{change|0x4C|0x4D}}|Stop Sound|pre=unchanged}}
 
{{PacketList|{{change|0x4D|0x4E}}|Sound Effect|pre=unchanged}}
 
{{PacketList|0x4F|Entity Sound Effect|rel=added}}
 
{{PacketList|{{change|0x4E|0x50}}|Player List Header And Footer|pre=unchanged}}
 
{{PacketList|{{change|0x4F|0x51}}|Collect Item|pre=unchanged}}
 
{{PacketList|{{change|0x50|0x52}}|Entity Teleport|pre=unchanged}}
 
{{PacketList|{{change|0x51|0x53}}|Advancements|pre=unchanged}}
 
{{PacketList|{{change|0x52|0x54}}|Entity Properties|pre=unchanged}}
 
{{PacketList|{{change|0x53|0x55}}|Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x54|0x56}}|Declare Recipes|pre=unchanged}}
 
{{PacketList|{{change|0x55|0x57}}|Tags}}
 
{{PacketList|0x58|Update Light|rel=added}}
 
{{PacketList|{{change|0x14|0x59}}|Open Window}}
 
{{PacketList|0x5A|Trade List|rel=added}}
 
|-
 
!colspan="4"| Play serverbound
 
{{PacketList|0x1B|Recipe Book Data}}
 
{{PacketList|0x29|Player Block Placement}}
 
 
  |}
 
  |}
  
Line 108: Line 34:
 
== Entity Metadata ==
 
== Entity Metadata ==
  
=== Entity Metadata Format ===
+
{{#vardefine:meta_prerelease|1}}
 
 
Note that entity metadata is a totally distinct concept from block metadata.  It is not required to send all metadata fields, or even any metadata fields, so long as the terminating entry is correctly sent.
 
 
 
Entity Metadata is an array of entries, each of which looks like the following:
 
 
 
{| class="wikitable"
 
! Name
 
! Type
 
! Meaning
 
|-
 
| Index
 
| Unsigned Byte
 
| Unique index key determining the meaning of the following value, see the table below. If this is <code>0xff</code> then the it is the end of the Entity Metadata array and no more is read.
 
|-
 
| Type
 
| Optional VarInt Enum
 
| Only if Index is not <code>0xff</code>; the type of the index, see the table below
 
|-
 
| Value
 
| Optional ''value of Type''
 
| Only if Index is not <code>0xff</code>: the value of the metadata field
 
|}
 
 
 
{| class="wikitable"
 
! Value of Type field
 
! [[Data types|Type]] of Value field
 
! Notes
 
|-
 
| 0
 
| Byte
 
|
 
|-
 
| 1
 
| VarInt
 
|
 
|-
 
| 2
 
| Float
 
|
 
|-
 
| 3
 
| String
 
|
 
|-
 
| 4
 
| [[Chat]]
 
|
 
|-
 
| 5
 
| OptChat (Boolean + Optional [[Chat]])
 
| [[Chat]] is present if the Boolean is set to true
 
|-
 
| 6
 
| [[Slot]]
 
|
 
|-
 
| 7
 
| Boolean
 
|
 
|-
 
| 8
 
| Rotation
 
| 3 floats: rotation on x, rotation on y, rotation on z
 
|-
 
| 9
 
| [[Data Types#Position|Position]]
 
|
 
|-
 
| 10
 
| OptPosition (Boolean + Optional Position)
 
| Position is present if the Boolean is set to true
 
|-
 
| 11
 
| Direction (VarInt)
 
| (Down = 0, Up = 1, North = 2, South = 3, West = 4, East = 5)
 
|-
 
| 12
 
| OptUUID (Boolean + Optional UUID)
 
| UUID is present if the Boolean is set to true
 
|-
 
| 13
 
| OptBlockID (VarInt)
 
| 0 for absent otherwise, <code><nowiki>id &lt;&lt; 4 | data</nowiki></code>
 
|-
 
| 14
 
| [[NBT]]
 
|
 
|-
 
| 15
 
| [[Data Types#Particle|Particle]]
 
|
 
|- {{Added}}
 
| 16
 
| Villager Data
 
| 3 VarInts: villager type, villager profession, level
 
|}
 
 
 
Villager type (<code>minecraft:villager_type</code> registry):
 
 
 
{| class="wikitable"
 
! Name !! ID
 
|-
 
| <code>minecraft:desert</code> || 0
 
|-
 
| <code>minecraft:jungle</code> || 1
 
|-
 
| <code>minecraft:plains</code> || 2
 
|-
 
| <code>minecraft:savanna</code> || 3
 
|-
 
| <code>minecraft:snow</code> || 4
 
|-
 
| <code>minecraft:swamp</code> || 5
 
|-
 
| <code>minecraft:taiga</code> || 6
 
|}
 
 
 
Villager professions (<code>minecraft:villager_profession</code> registry):
 
 
 
{| class="wikitable"
 
! Name !! ID
 
|-
 
| <code>minecraft:none</code> || 0
 
|-
 
| <code>minecraft:armorer</code> || 1
 
|-
 
| <code>minecraft:butcher</code> || 2
 
|-
 
| <code>minecraft:cartographer</code> || 3
 
|-
 
| <code>minecraft:cleric</code> || 4
 
|-
 
| <code>minecraft:farmer</code> || 5
 
|-
 
| <code>minecraft:fisherman</code> || 6
 
|-
 
| <code>minecraft:fletcher</code> || 7
 
|-
 
| <code>minecraft:leatherworker</code> || 8
 
|-
 
| <code>minecraft:librarian</code> || 9
 
|-
 
| <code>minecraft:mason</code> || 10
 
|-
 
| <code>minecraft:nitwit</code> || 11
 
|-
 
| <code>minecraft:shepherd</code> || 12
 
|-
 
| <code>minecraft:toolsmith</code> || 13
 
|-
 
| <code>minecraft:weaponsmith</code> || 14
 
|}
 
 
 
=== Mobs ===
 
 
 
Entity IDs have shifted with the addition of some new mobs.
 
 
 
=== Itemed Throwable ===
 
 
 
Extends [[#Throwable|Throwable]].
 
 
 
Used for all things that previously extended throwable other than potions, which already had an item.
 
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 6
 
| Slot
 
|colspan="2"| Item
 
| empty (which behaves as if it were a specific item, depending on the subclass)
 
|}
 
 
 
=== Egg ===
 
 
 
Extends [[#Throwable|Throwable]].
 
 
 
No additional metadata.
 
 
 
An empty item behaves as if the item were a <code>minecraft:egg</code>.
 
 
 
=== Ender Pearl ===
 
 
 
Extends [[#Throwable|Throwable]].
 
 
 
No additional metadata.
 
 
 
An empty item behaves as if the item were a <code>minecraft:ender_pearl</code>.
 
 
 
=== Experience Bottle ===
 
 
 
Extends [[#Throwable|Throwable]].
 
 
 
No additional metadata.
 
 
 
<code>minecraft:experience_bottle</code>
 
 
 
=== Snowball ===
 
 
 
Extends [[#Throwable|Throwable]].
 
 
 
No additional metadata.
 
 
 
<code>minecraft:snowball</code>
 
 
 
=== Eye of Ender ===
 
 
 
Extends [[#Entity|Entity]].
 
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 6
 
| Slot
 
|colspan="2"| Item
 
| empty (which behaves as if it were a <code>minecraft:ender_eye</code>)
 
|}
 
 
 
=== Arrow ===
 
 
 
Extends [[#Entity|Entity]].
 
 
 
Abstract base class for [[#TippedArrow|TippedArrow]] (which is used for regular arrows as well as tipped ones) and Spectral Arrow.
 
 
 
{| class="wikitable"
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| rowspan="3" | 6
 
| rowspan="3" | Byte
 
! Bit mask
 
! Meaning
 
| rowspan="3" | 0
 
|-
 
| 0x01
 
| Is critical
 
|-
 
| 0x02
 
| Is noclip (used by loyalty tridents when returning)
 
|-
 
| 7
 
| OptUUID
 
|colspan="2"| Shooter UUID
 
| Empty
 
|- {{added}}
 
| 8
 
| Byte
 
|colspan="2"| Piercing level
 
| 0
 
|}
 
 
 
=== TippedArrow ===
 
 
 
Extends [[#Arrow|Arrow]].
 
 
 
Used for both tipped and regular arrows.  If not tipped, then color is set to -1 and no tipped arrow particles are used.
 
 
 
{| class="wikitable"
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| {{change|8|9}}
 
| VarInt
 
|colspan="2"| Color (-1 for no particles)
 
| -1
 
|}
 
 
 
=== Trident ===
 
 
 
Extends [[#Arrow|Arrow]].
 
 
 
{| class="wikitable"
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| {{change|8|9}}
 
| VarInt
 
|colspan="2"| Loyalty level (enchantment)
 
| 0
 
|}
 
 
 
=== Itemed Fireball ===
 
 
 
Extends [[#Entity|Entity]].
 
 
 
Used for regular and small fireballs.  Not used for dragon fireballs and wither skulls.  Interestingly, regular fireballs do not come from an item.
 
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 6
 
| Slot
 
|colspan="2"| Item
 
| empty (which behaves as if it were a <code>minecraft:fire_charge</code>)
 
|}
 
 
 
=== Fireball ===
 
 
 
Extends {{change|[[#Abstract Fireball|Abstract Fireball]]|[[#Itemed Fireball|Itemed Fireball]]}}.  This is the large fireball shot by ghasts.
 
 
 
No additional metadata.
 
 
 
=== Small Fireball ===
 
  
Extends {{change|[[#Abstract Fireball|Abstract Fireball]]|[[#Itemed Fireball|Itemed Fireball]]}}.  This is the fireball shot by blazes and dispensers with fire charges.
+
{{Warning2|Note that other entities have had metadata shifts due to these changes, not shown here.}}
  
No additional metadata.
+
=== Entity ===
  
=== Fireworks ===
+
{{metadata inherit|Entity}}
 
 
Extends [[#Entity|Entity]].
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 441: Line 48:
 
  ! Default
 
  ! Default
 
  |-
 
  |-
  | 6
+
  |rowspan="9"| {{Metadata id|}}
| [[Slot]]
+
  |rowspan="9"| Byte
|colspan="2"| Firework info
 
| empty
 
|-
 
| 7
 
| {{Change|VarInt|OptUUID}}
 
|colspan="2"| Entity {{change|ID|UUID}} of entity which used firework (for elytra boosting)
 
| 0
 
|- {{Added}}
 
| 8
 
| Boolean
 
|colspan="2"| Shot at angle (from a crossbow)
 
| false
 
|}
 
 
 
=== Illager Beast ===
 
 
 
Extends [[#Monster|Monster]]
 
 
 
No additional metadata.
 
 
 
{| class="wikitable" {{added}}
 
! Status
 
!colspan="2"| Description
 
|-
 
| 4
 
|colspan="2"| Starts the attack animation.
 
|-
 
| 39
 
|colspan="2"| Starts the stun animation.
 
|}
 
 
 
=== Panda ===
 
 
 
Extends [[#Animal|Animal]].
 
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 13
 
| Integer
 
|colspan="2"| Breed timer?  Set to 32 when something happens, and then counts down to 0 again.  At 29 and 14 (before counting down), will play the <code>entity.panda.cant_breed</code> sound event.
 
| 0
 
|-
 
| 14
 
| Integer
 
|colspan="2"| Sneeze timer.  Counts up from 0; when it hits 1 the <code>entity.panda.pre_sneeze</code> event plays and when it hits 21 the <code>entity.panda.sneeze</code> event plays (and it is set back to 0 and the sneeze flag is cleared).
 
| 0
 
|-
 
| 15
 
| Integer
 
|colspan="2"| Eat timer.  If nonzero, counts upwards.
 
| 0
 
|-
 
| 16
 
| Byte
 
|colspan="2"| Main Gene
 
| 0
 
|-
 
| 17
 
| Byte
 
|colspan="2"| Hidden Gene
 
| 0
 
|-
 
|rowspan="6"| 18
 
  |rowspan="6"| Byte
 
 
  ! Bit mask
 
  ! Bit mask
 
  ! Meaning
 
  ! Meaning
  |rowspan="6"| 0
+
  |rowspan="9"| 0
 
  |-
 
  |-
 
  | 0x01
 
  | 0x01
  | Unused
+
  | Is on fire
 
  |-
 
  |-
 
  | 0x02
 
  | 0x02
  | Is sneezing
+
  | Is crouching
 
  |-
 
  |-
 
  | 0x04
 
  | 0x04
  | Is eating
+
  | Unused (previously riding)
 
  |-
 
  |-
 
  | 0x08
 
  | 0x08
  | Unknown
+
  | Is sprinting
 
  |-
 
  |-
 
  | 0x10
 
  | 0x10
  | Unknown
+
  | Is swimming
|}
 
 
 
=== Pillager ===
 
 
 
Extends [[#Abstract Illager|Abstract Illlager]].
 
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
 
  |-
 
  |-
  | 13
+
  | 0x20
  | Boolean
+
  | Is invisible
| colspan="2"| Using crossbow
 
| false
 
|}
 
 
 
=== Ocelot ===
 
 
 
Extends {{change|[[#TameableAnimal|TameableAnimal]]|[[#Ageable|Ageable]]}}.
 
 
 
{| class="wikitable"
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|- {{removed}}
 
| 15
 
| VarInt
 
|colspan="2"| Type (0 = untamed, 1 = tuxedo, 2 = tabby, 3 = siamese).  Used to render regardless as to whether it is tamed or not.
 
| 0
 
|- {{added}}
 
| 13
 
| Boolean
 
|colspan="2"| Is trusting
 
| false
 
|}
 
 
 
{| class="wikitable" {{added}}
 
! Status
 
!colspan="2"| Description
 
 
  |-
 
  |-
  | 40
+
  | 0x40
  |colspan="2"| Spawn smoke particles (trust gaining failed)
+
  | has glowing effect
 
  |-
 
  |-
  | 41
+
  | 0x80
  |colspan="2"| Spawn heart particles (trust gaining succeeded)
+
  | Is flying with an {{Minecraft Wiki|elytra}}
|}
 
 
 
=== Cat ===
 
 
 
Extends [[#TameableAnimal|TameableAnimal]].
 
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
 
  |-
 
  |-
  | 15
+
  | {{Metadata id|}}
 
  | VarInt
 
  | VarInt
  |colspan="2"| Type (0 = tabby, 1 = black, 2 = red, 3 = siamese, 4 = british_shorthair, 5 = calico, 6 = persian, 7 = ragdoll, 8 = white, 9 = all_black)
+
  |colspan="2"| Air ticks
  | 1
+
| 300
 +
|-
 +
| {{Metadata id|}}
 +
| OptChat
 +
|colspan="2"| Custom name
 +
  | empty
 
  |-
 
  |-
  | 16
+
  | {{Metadata id|}}
 
  | Boolean
 
  | Boolean
  |colspan="2"| Unknown
+
  |colspan="2"| Is custom name visible
 
  | false
 
  | false
 
  |-
 
  |-
  | 17
+
  | {{Metadata id|}}
 
  | Boolean
 
  | Boolean
  |colspan="2"| Unknown
+
  |colspan="2"| Is silent
 
  | false
 
  | false
 
  |-
 
  |-
  | 18
+
  | {{Metadata id|}}
| VarInt
 
|colspan="2"| Collar color (values are those {{Minecraft Wiki|Data_values#Dyes|used with dyes}})
 
| 14 (Red)
 
|}
 
 
 
=== Villager ===
 
 
 
Extends [[#Ageable|Ageable]].
 
 
 
{| class="wikitable"
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 13
 
| {{change|VarInt|Villager Data}}
 
|colspan="2"| {{Change|Profession (Farmer = 0, Librarian = 1, Priest = 2, Blacksmith = 3, Butcher = 4, Nitwit = 5)|Villager Data}}
 
| {{change|0|Plains/None/1}}
 
|}
 
 
 
=== Zombie Villager ===
 
 
 
Extends [[#Zombie|Zombie]].
 
 
 
{| class="wikitable"
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 16
 
 
  | Boolean
 
  | Boolean
  |colspan="2"| Is converting
+
  |colspan="2"| Has no gravity
 
  | false
 
  | false
  |-  
+
  |-
| 17
+
  | {{Metadata id|}}
  | {{Change|VarInt|Villager Data}}
+
| Pose
  |colspan="2"| {{Change|Profession|Villager Data}}
+
  |colspan="2"| Pose
  | {{change|0|Plains/None/1}}
+
| STANDING
 +
|- {{added}}
 +
  | {{Metadata id|added}}
 +
| VarInt
 +
|colspan="2"| Ticks frozen in powdered snow
 +
| 0
 
  |}
 
  |}
  
Line 651: Line 118:
 
No changes so far.
 
No changes so far.
  
== Plugin Channels ==
+
== Inventories ==
 
 
=== <code>minecraft:book_open</code> ===
 
{{change|''Server to client''}}
 
  
{{change|When a player right clicks with a signed book. This tells the client to open the book GUI.}}
+
No changes so far.
  
{{change|The payload is a VarInt enum for the selected hand: 0 for the main hand, 1 for the offhand.}}
+
== Plugin Channels ==
  
{{change||Replaced with [[#Open Book|Open Book]] packet.}}
+
No changes so far.
 
 
=== <code>minecraft:trader_list</code> ===
 
{{change|''Server to client''}}
 
 
 
{{change|The list of trades a villager NPC is offering.}}
 
 
 
{{change||Replaced with [[#Trade List|Trade List]] packet.}}
 
  
 
== Play ==
 
== Play ==
  
 
=== Clientbound ===
 
=== Clientbound ===
 
==== Update Block Entity ====
 
 
Sets the block entity associated with the block at the given location.
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="3"| 0x09
 
|rowspan="3"| Play
 
|rowspan="3"| Client
 
| Location
 
| Position
 
|
 
|-
 
| Action
 
| Unsigned Byte
 
| The type of update to perform, see below
 
|-
 
| NBT Data
 
| [[NBT|NBT Tag]]
 
| Data to set.  May be a TAG_END (0), in which case the block entity at the given location is removed (though this is not required since the client will remove the block entity automatically on chunk unload or block removal)
 
|}
 
 
''Action'' field:
 
 
* '''1''': Set data of a mob spawner (everything except for SpawnPotentials: current delay, min/max delay, mob to be spawned, spawn count, spawn range, etc.)
 
* '''2''': Set command block text (command and last execution status)
 
* '''3''': Set the level, primary, and secondary powers of a beacon
 
* '''4''': Set rotation and skin of mob head
 
* '''5''': Declare a conduit
 
* '''6''': Set base color and patterns on a banner
 
* '''7''': Set the data for a Structure tile entity
 
* '''8''': Set the destination for a end gateway
 
* '''9''': Set the text on a sign
 
* '''10''': {{change|Declare a shulker box, no data appears to be sent and the client seems to do fine without this packet. Perhaps it is a leftover from earlier versions?}}
 
* '''11''': Declare a bed
 
* '''12''': {{Change||Set data of a jigsaw block}}
 
* '''13''': {{Change||Set items in a campfire}}
 
 
==== Open Horse Window ====
 
 
{{Change||This packet is used exclusively for opening the horse GUI.  [[#Open Window|Open Window]] is used for all other GUIs, and now has ID 0x59.}}
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="3"| 0x14
 
|rowspan="3"| Play
 
|rowspan="3"| Client
 
| Window ID?
 
| Byte
 
|
 
|-
 
| Number of slots?
 
| VarInt
 
|
 
|-
 
| Entity ID?
 
| Integer
 
|
 
|}
 
  
 
==== Chunk Data ====
 
==== Chunk Data ====
Line 749: Line 134:
 
{{See also|#Unload Chunk}}
 
{{See also|#Unload Chunk}}
  
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimenison the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.  This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with [[#Update Block Entity|Update Block Entity]] later).
+
{{Need Info|How do biomes work now?  The biome change happened at the same time as the seed change, but it's not clear how/if biomes could be computed given that it's not the actual seed...  ([https://www.reddit.com/r/Mojira/comments/e5at6i/a_discussion_for_the_changes_to_how_biomes_are/ /r/mojira discussion] which notes that it seems to be some kind of interpolation, and 3D biomes are only used in the nether)}}
 +
 
 +
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimension the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.  This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with [[#Update Block Entity|Update Block Entity]] later).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 759: Line 146:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="9"| 0x22
+
  |rowspan="11"| 0x20
  |rowspan="9"| Play
+
  |rowspan="11"| Play
  |rowspan="9"| Client
+
  |rowspan="11"| Client
 
  | Chunk X
 
  | Chunk X
 
  | Int
 
  | Int
Line 769: Line 156:
 
  | Int
 
  | Int
 
  | Chunk coordinate (block coordinate divided by 16, rounded down)
 
  | Chunk coordinate (block coordinate divided by 16, rounded down)
  |-
+
  |- {{removed}}
 
  | Full chunk
 
  | Full chunk
 
  | Boolean
 
  | Boolean
Line 777: Line 164:
 
  | VarInt
 
  | VarInt
 
  | Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
 
  | Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
  |- {{Added}}
+
  |-
 
  | Heightmaps
 
  | Heightmaps
 
  | [[NBT]]
 
  | [[NBT]]
  | Compound containing one long array named <code>MOTION_BLOCKING</code>, which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry).
+
  | Compound containing one long array named <code>MOTION_BLOCKING</code>, which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry totaling 36 longs). The Notchian server also adds a <code>WORLD_SURFACE</code> long array, the purpose of which is unknown, but it's not required for the chunk to be accepted.
 +
|-
 +
| Biomes length
 +
| Optional VarInt
 +
| Size of the following array.  Not present if full chunk is false.
 +
|-
 +
| Biomes
 +
| Optional array of VarInt
 +
| <s>1024 biome IDs, ordered by x then z then y, in 4&times;4&times;4 blocks.</s>Possibly something else.  Not present if full chunk is false.
 
  |-  
 
  |-  
 
  | Size
 
  | Size
Line 795: Line 190:
 
  |-
 
  |-
 
  | Block entities
 
  | Block entities
  | Array of [[NBT]]
+
  | Array of [[NBT|NBT Tag]]
 
  | All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 
  | All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 
  |}
 
  |}
  
===== Data structure =====
+
Note that the Notchian client requires an [[#Update View Position|Update View Position]] packet when it crosses a chunk border, otherwise it'll only display render distance + 2 chunks around the chunk it spawned in.
 +
 
 +
The compacted array format has been adjusted so that individual entries no longer span across multiple longs, affecting the main data array and heightmaps.
 +
 
 +
New format, 5 bits per block, containing the following references to blocks in a palette (not shown): <span style="border: solid 2px hsl(0, 90%, 60%)">1</span><span style="border: solid 2px hsl(30, 90%, 60%)">2</span><span style="border: solid 2px hsl(60, 90%, 60%)">2</span><span style="border: solid 2px hsl(90, 90%, 60%)">3</span><span style="border: solid 2px hsl(120, 90%, 60%)">4</span><span style="border: solid 2px hsl(150, 90%, 60%)">4</span><span style="border: solid 2px hsl(180, 90%, 60%)">5</span><span style="border: solid 2px hsl(210, 90%, 60%)">6</span><span style="border: solid 2px hsl(240, 90%, 60%)">6</span><span style="border: solid 2px hsl(270, 90%, 60%)">4</span><span style="border: solid 2px hsl(300, 90%, 60%)">8</span><span style="border: solid 2px hsl(330, 90%, 60%)">0</span><span style="border: solid 2px hsl(0, 90%, 30%)">7</span><span style="border: solid 2px hsl(30, 90%, 30%)">4</span><span style="border: solid 2px hsl(60, 90%, 30%)">3</span><span style="border: solid 2px hsl(90, 90%, 30%)">13</span><span style="border: solid 2px hsl(120, 90%, 30%)">15</span><span style="border: solid 2px hsl(150, 90%, 30%)">16</span><span style="border: solid 2px hsl(180, 90%, 30%)">9</span><span style="border: solid 2px hsl(210, 90%, 30%)">14</span><span style="border: solid 2px hsl(240, 90%, 30%)">10</span><span style="border: solid 2px hsl(270, 90%, 30%)">12</span><span style="border: solid 2px hsl(300, 90%, 30%)">0</span><span style="border: solid 2px hsl(330, 90%, 30%)">2</span>
 +
 
 +
<code>0020863148418841</code> <code><span style="outline: dashed 2px black">0000</span><span style="outline: solid 2px hsl(330, 90%, 60%)">00000</span><span style="outline: solid 2px hsl(300, 90%, 60%)">01000</span><span style="outline: solid 2px hsl(270, 90%, 60%)">00100</span><span style="outline: solid 2px hsl(240, 90%, 60%)">00110</span><span style="outline: solid 2px hsl(210, 90%, 60%)">00110</span><span style="outline: solid 2px hsl(180, 90%, 60%)">00101</span><span style="outline: solid 2px hsl(150, 90%, 60%)">00100</span><span style="outline: solid 2px hsl(120, 90%, 60%)">00100</span><span style="outline: solid 2px hsl(90, 90%, 60%)">00011</span><span style="outline: solid 2px hsl(60, 90%, 60%)">00010</span><span style="outline: solid 2px hsl(30, 90%, 60%)">00010</span><span style="outline: solid 2px hsl(0, 90%, 60%)">00001</span></code><br>
 +
<code>01018A7260F68C87</code> <code><span style="outline: dashed 2px black">0000</span><span style="outline: solid 2px hsl(330, 90%, 30%)">00010</span><span style="outline: solid 2px hsl(300, 90%, 30%)">00000</span><span style="outline: solid 2px hsl(270, 90%, 30%)">01100</span><span style="outline: solid 2px hsl(240, 90%, 30%)">01010</span><span style="outline: solid 2px hsl(210, 90%, 30%)">01110</span><span style="outline: solid 2px hsl(180, 90%, 30%)">01001</span><span style="outline: solid 2px hsl(150, 90%, 30%)">10000</span><span style="outline: solid 2px hsl(120, 90%, 30%)">01111</span><span style="outline: solid 2px hsl(90, 90%, 30%)">01101</span><span style="outline: solid 2px hsl(60, 90%, 30%)">00011</span><span style="outline: solid 2px hsl(30, 90%, 30%)">00100</span><span style="outline: solid 2px hsl(0, 90%, 30%)">00111</span></code>
  
The data section of the packet contains most of the useful data for the chunk.
+
 
 +
 
 +
==== Update Light ====
 +
 
 +
Updates light levels for a chunk.
  
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
!colspan="2"| Field Name
 +
!colspan="2"| Field Type
 +
! Notes
 +
|-
 +
|rowspan="11"| 0x23
 +
|rowspan="11"| Play
 +
|rowspan="11"| Client
 +
|colspan="2"| Chunk X
 +
|colspan="2"| VarInt
 +
| Chunk coordinate (block coordinate divided by 16, rounded down)
 +
|-
 +
|colspan="2"| Chunk Z
 +
|colspan="2"| VarInt
 +
| Chunk coordinate (block coordinate divided by 16, rounded down)
 +
|-
 +
|colspan="2"| Trust Edges
 +
|colspan="2"| Boolean
 +
| If edges should be trusted for light updates.
 
  |-
 
  |-
  ! Field Name
+
  |colspan="2"| ? (Changes unknown)
  ! Field Type
+
  |colspan="2"| {{change|VarInt|VarLong}}
  ! Notes
+
  | ? (Changes unknown)
 
  |-
 
  |-
  | Data
+
  |colspan="2"| ? (Changes unknown)
  | Array of [[#Chunk Section structure|Chunk Section]]
+
  |colspan="2"| {{change|VarInt|VarLong}}
  | The number of elements in the array is equal to the number of bits set in Primary Bit Mask. Sections are sent bottom-to-top, i.e. the first section, if sent, extends from Y=0 to Y=15.
+
  | ? (Changes unknown)
 
  |-
 
  |-
  | Biomes
+
  |colspan="2"| ? (Changes unknown)
  | Optional Int Array
+
  |colspan="2"| {{change|VarInt|VarLong}}
| Only sent if Ground-Up Continuous is true; 256 entries if present
+
| ? (Changes unknown)
|}
 
 
 
===== Chunk Section structure =====
 
 
 
A Chunk Section is defined in terms of other [[data types]]. A Chunk Section consists of the following fields:
 
 
 
{| class="wikitable"
 
 
  |-
 
  |-
  ! Field Name
+
  |colspan="2"| ? (Changes unknown)
! Field Type
+
  |colspan="2"| {{change|VarInt|VarLong}}
! Notes
+
  | ? (Changes unknown)
  |- {{added}}
 
  | Block count
 
| Short
 
| Number of non-air blocks present in the chunk section, for lighting purposes.  "Non-air" is defined as any block other than air, cave air, and void air (in particular, note that fluids such as water are still counted).
 
 
  |-
 
  |-
  | Bits Per Block
+
  |rowspan="2"| Sky Light arrays
  | Unsigned Byte
+
| Length
  | Determines how many bits are used to encode a block. Note that not all numbers are valid here.
+
|rowspan="2"| Array
 +
  | VarInt
 +
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | Palette
+
  | Sky Light array
  | Varies
+
  | Array of 2048 bytes
  | See below for the format.
+
  | There is 1 array for each bit set to true in the sky light mask, starting with the lowest value.  Half a byte per light value.
 
  |-
 
  |-
  | Data Array Length
+
  |rowspan="2"| Block Light arrays
 +
| Length
 +
|rowspan="2"| Array
 
  | VarInt
 
  | VarInt
  | Number of longs in the following array
+
  | Length of the following array in bytes (always 2048)
 
  |-
 
  |-
  | Data Array
+
  | Block Light array
  | Array of Long
+
  | Array of 2048 bytes
  | Compacted list of 4096 indices pointing to state IDs in the Palette
+
  | There is 1 array for each bit set to true in the block light mask, starting with the lowest value. Half a byte per light value.
|- {{removed}}
 
| Block Light
 
  | Byte Array
 
| Half byte per block
 
|- {{removed}}
 
| Sky Light
 
| Optional Byte Array
 
| Only if in the Overworld; half byte per block
 
 
  |}
 
  |}
  
Data Array{{change|, Block Light, and Sky Light are|is}} given for each block with increasing x coordinates, within rows of increasing z coordinates, within layers of increasing y coordinates.  {{change|For the half-byte light arrays, even-indexed items (those with an even x coordinate, starting at 0) are packed into the ''low bits'', odd-indexed into the ''high bits''.}}
+
 
 +
 
  
 
==== Map Data ====
 
==== Map Data ====
Line 871: Line 284:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="17"| 0x26
+
  |rowspan="18"| 0x25
  |rowspan="17"| Play
+
  |rowspan="18"| Play
  |rowspan="17"| Client
+
  |rowspan="18"| Client
 
  |colspan="2"| Map ID
 
  |colspan="2"| Map ID
 
  |colspan="2"| VarInt
 
  |colspan="2"| VarInt
Line 881: Line 294:
 
  |colspan="2"| Byte
 
  |colspan="2"| Byte
 
  | From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
 
  | From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
  |-  
+
  |- {{removed}}
 
  |colspan="2"| Tracking Position
 
  |colspan="2"| Tracking Position
 
  |colspan="2"| Boolean
 
  |colspan="2"| Boolean
 
  | Specifies whether player and item frame icons are shown
 
  | Specifies whether player and item frame icons are shown
  |- {{Added}}
+
  |-
 
  |colspan="2"| Locked
 
  |colspan="2"| Locked
 
  |colspan="2"| Boolean
 
  |colspan="2"| Boolean
 
  | True if the map has been locked in a cartography table
 
  | True if the map has been locked in a cartography table
 
  |-  
 
  |-  
 +
|- {{added}}
 +
|colspan="2"| Tracking Position
 +
|colspan="2"| Boolean
 +
| Specifies whether player and item frame icons are shown
 +
|-
 
  |colspan="2"| Icon Count
 
  |colspan="2"| Icon Count
 
  |colspan="2"| VarInt
 
  |colspan="2"| VarInt
  | Number of elements in the following array
+
  | Number of elements in the following array. {{change||Only present if "Tracking Position" is true.}}
 
  |-
 
  |-
  |rowspan="5"| Icon
+
  |rowspan="6"| Icon
 
  | Type
 
  | Type
 
  |rowspan="6"| Array
 
  |rowspan="6"| Array
Line 921: Line 339:
 
  |-  
 
  |-  
 
  |colspan="2"| Columns
 
  |colspan="2"| Columns
  |colspan="2"| Byte
+
  |colspan="2"| Unsigned Byte
 
  | Number of columns updated
 
  | Number of columns updated
 
  |-
 
  |-
Line 1,036: Line 454:
 
  |}
 
  |}
  
==== Open Book ====
 
 
Sent when a player right clicks with a signed book. This tells the client to open the book GUI.
 
 
{| class="wikitable" {{Added}}
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="1"| 0x2C
 
|rowspan="1"| Play
 
|rowspan="1"| Client
 
| Hand
 
| VarInt enum
 
| 0: Main hand, 1: Off hand
 
|}
 
  
==== Entity Sound Effect ====
 
  
Plays a sound effect from an entity.
+
==== Resource Pack Send ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 1,068: Line 466:
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
  |rowspan="5"| 0x4F
+
  |rowspan="3"| 0x38
  |rowspan="5"| Play
+
  |rowspan="3"| Play
  |rowspan="5"| Client
+
  |rowspan="3"| Client
  | Sound ID
+
  | URL
  | VarInt
+
  | String (32767)
| ID of hardcoded sound event ([https://pokechu22.github.io/Burger/18w48a.html#sounds events] as of 18w48a)
+
  | The URL to the resource pack.
|-
 
| Sound Category
 
| VarInt Enum
 
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
 
|-
 
| Entity ID
 
| VarInt
 
|
 
 
  |-
 
  |-
  | Volume
+
  | Hash
  | Float
+
  | String (40)
  | 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients
+
  | 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
|-
 
| Pitch
 
| Float
 
| Float between 0.5 and 2.0 by Notchian clients
 
|}
 
 
 
==== Tags ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="4"| {{Change|0x55|0x57}}
 
|rowspan="4"| Play
 
|rowspan="4"| Client
 
| Block Tags
 
| (See below)
 
| IDs are block IDs
 
|-
 
| Item Tags
 
| (See below)
 
| IDs are item IDs
 
|-
 
| Fluid Tags
 
| (See below)
 
| IDs are fluid IDs
 
|- {{added}}
 
| Entity Tags
 
| (See below)
 
| IDs are entity type IDs
 
|}
 
 
 
==== Declare Recipes ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
|-
 
|rowspan="5"| {{Change|0x54|0x56}}
 
|rowspan="5"| Play
 
|rowspan="5"| Client
 
|colspan="2"| Num Recipes
 
|colspan="2"| VarInt
 
| Number of elements in the following array
 
|-
 
|rowspan="4"| Recipe
 
|{{removed}}| Recipe ID
 
|rowspan="4"| Array
 
|{{removed}}| Identifier
 
|{{removed}}|
 
|-
 
| Type
 
| {{Change|String|Identifier}}
 
| The recipe serializer, see below
 
 
  |- {{Added}}
 
  |- {{Added}}
  | Recipe ID
+
  | Forced
  | Identifier
+
  | Boolean
  |
+
  | The notchian client will be forced to use the ressource pack from the server. If they decline they will be kicked from the server.
|-
 
| Data
 
| Optional, varies
 
| Additional data for the recipe.  For some types, there will be no data.
 
|}
 
 
 
Recipe serializers:
 
 
 
{| class="wikitable"
 
! Serializer
 
! Description
 
! Data
 
|-
 
| <code>{{change||minecraft:}}crafting_shapeless</code>
 
| Shapeless crafting recipe.  All items in the ingredient list must be present, but in any order/slot.
 
| As follows:
 
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Group
 
    | String
 
    | Used to group similar recipes together in the recipe book.  Tag is present in recipe JSON.
 
    |-
 
    | Ingredient count
 
    | VarInt
 
    | Number of elements in the following array
 
    |-
 
    | Ingredients
 
    | Array of Ingredient
 
    |
 
    |-
 
    | Result
 
    | [[Slot]]
 
    |
 
    |}
 
|-
 
| <code>{{change||minecraft:}}crafting_shaped</code>
 
| Shaped crafting recipe.  All items must be present in the same pattern (which may be flipped horizontally or translated)
 
| As follows:
 
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Width
 
    | VarInt
 
    |
 
    |-
 
    | Height
 
    | VarInt
 
    |
 
    |-
 
    | Group
 
    | String
 
    | Used to group similar recipes together in the recipe book.  Tag is present in recipe JSON.
 
    |-
 
    | Ingredients
 
    | Array of Ingredient
 
    | Length is width * height.  Indexed by x + (y * width).
 
    |-
 
    | Result
 
    | [[Slot]]
 
    |
 
    |}
 
|-
 
| <code>{{change||minecraft:}}crafting_special_armordye</code>
 
| Recipe for dying leather armor
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_bookcloning</code>
 
| Recipe for copying contents of written books
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_mapcloning</code>
 
| Recipe for copying maps
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_mapextending</code>
 
| Recipe for adding paper to maps
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_firework_rocket</code>
 
| Recipe for making firework rockets
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_firework_star</code>
 
| Recipe for making firework stars
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_firework_star_fade</code>
 
| Recipe for making firework stars fade between multiple colors
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_repairitem</code>
 
| Recipe for repairing items via crafting
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_tippedarrow</code>
 
| Recipe for crafting tipped arrows
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_bannerduplicate</code>
 
| Recipe for copying banner patterns
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_banneraddpattern</code>
 
| Recipe for adding patterns to banners
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_shielddecoration</code>
 
| Recipe for applying a banner's pattern to a shield
 
| None
 
|-
 
| <code>{{change||minecraft:}}crafting_special_shulkerboxcoloring</code>
 
| Recipe for recoloring a shulker box
 
| None
 
|- {{Added}}
 
| <code>minecraft:crafting_special_suspiciousstew</code>
 
| Recipe for crafting suspicious stew with various affects.
 
| None
 
|-
 
| <code>{{change||minecraft:}}smelting</code>
 
| Smelting recipe
 
|rowspan="4"| All of these have the same format, as follows:
 
  {| class="wikitable"
 
    ! Name
 
    ! Type
 
    ! Description
 
    |-
 
    | Group
 
    | String
 
    | Used to group similar recipes together in the recipe book.
 
    |-
 
    | Ingredient
 
    | Ingredient
 
    |
 
    |-
 
    | Result
 
    | [[Slot]]
 
    |
 
    |-
 
    | Experience
 
    | Float
 
    |
 
    |-
 
    | Cooking time
 
    | VarInt
 
    |
 
    |}
 
|- {{Added}}
 
| <code>minecraft:blasting</code>
 
| Recipes in a blast furnace.
 
|- {{Added}}
 
| <code>minecraft:smoking</code>
 
| Recipes in a smoker.
 
|- {{Added}}
 
| <code>minecraft:campfire_cooking</code>
 
| Recipes in a campfire.
 
|}
 
 
 
Ingredient is defined as:
 
 
 
{| class="wikitable"
 
! Name
 
! Type
 
! Description
 
|-
 
| Count
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Items
 
| Array of [[Slot]]
 
| Any item in this array may be used for the recipe.  The count of each item should be 1.
 
|}
 
 
 
==== Update Light ====
 
 
 
Updates light levels for a chunk.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="8"| 0x58
 
|rowspan="8"| Play
 
|rowspan="8"| Client
 
| Chunk X
 
| VarInt
 
| Chunk coordinate (block coordinate divided by 16, rounded down)
 
|-
 
| Chunk Z
 
| VarInt
 
| Chunk coordinate (block coordinate divided by 16, rounded down)
 
|-
 
| Sky Light Mask
 
| VarInt
 
| Mask containing 18 bits, with the lowest bit corresponding to chunk section -1 (in the void, y=-16 to y=-1) and the highest bit for chunk section 16 (above the world, y=256 to y=271)
 
|-
 
| Block Light Mask
 
| VarInt
 
| Mask containing 18 bits, with the same order as sky light
 
|-
 
| Empty Sky Light Mask
 
| VarInt
 
| Mask containing 18 bits, which indicates sections that have 0 for all their sky light values.  If a section is set in both this mask and the main sky light mask, it is ignored for this mask and it is included in the sky light arrays (the notchian server does not create such masks). If it is only set in this mask, it is not included in the sky light arrays.
 
|-
 
| Empty Block Light Mask
 
| VarInt
 
| Mask containing 18 bits, which indicates sections that have 0 for all their block light values.  If a section is set in both this mask and the main block light mask, it is ignored for this mask and it is included in the block light arrays (the notchian server does not create such masks).  If it is only set in this mask, it is not included in the block light arrays.
 
|-
 
| Sky Light arrays
 
| Array of arrays of 2048 bytes
 
| There is 1 array for each bit set to true in the sky light mask, starting with the lowest value.  Half a byte per light value.
 
|-
 
| Block Light arrays
 
| Array of arrays of 2048 bytes
 
| There is 1 array for each bit set to true in the block light mask, starting with the lowest value.  Half a byte per light value.
 
|}
 
 
 
Individual block or sky light arrays are is given for each block with increasing x coordinates, within rows of increasing z coordinates, within layers of increasing y coordinates. Even-indexed items (those with an even x coordinate, starting at 0) are packed into the low bits, odd-indexed into the high bits.
 
 
 
==== Open Window ====
 
 
 
This is sent to the client when it should open an inventory, such as a chest, workbench, or furnace. This message is not sent anywhere for clients opening their own inventory.  {{change||For horses, use [[#Open Horse Window|Open Horse Window]]}}
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="5"| {{change|0x14|0x59}}
 
|rowspan="5"| Play
 
|rowspan="5"| Client
 
| Window ID
 
| {{change|Unsigned Byte|VarInt}}
 
| A unique id number for the window to be displayed. Notchian server implementation is a counter, starting at 1.
 
|-
 
| Window Type
 
| {{change|String (32)|VarInt}}
 
| The window type to use for display. {{change|See [[Inventory]] for a list|contained in the <code>minecraft:menu</code> regisry}}.
 
|-
 
| Window Title
 
| [[Chat]]
 
| The title of the window
 
|- {{removed}}
 
| Number Of Slots
 
| Unsigned Byte
 
| Number of slots in the window (excluding the number of slots in the player inventory). Always 0 for non-storage windows (e.g. Workbench, Anvil).
 
|- {{removed}}
 
| Entity ID
 
| Optional Int
 
| EntityHorse's EID. Only sent when Window Type is “EntityHorse”
 
 
  |}
 
  |}
  
==== Trade List ====
 
 
The list of trades a villager NPC is offering.
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
!colspan="2"| Field Type
 
! Notes
 
|-
 
|rowspan="10"| 0x5A
 
|rowspan="10"| Play
 
|rowspan="10"| Client
 
|-
 
| colspan="2" | Window ID
 
| colspan="2" | VarInt
 
| The ID of the window that is open; this is an int rather than a byte.
 
|-
 
| colspan="2" | Size
 
| colspan="2" | Byte
 
| The number of trades in the following array
 
|-
 
| rowspan="7" | Trades
 
| Input item 1
 
| rowspan="7" | Array
 
| [[Slot]]
 
| The first item the villager is buying
 
|-
 
| Output item
 
| [[Slot]]
 
| The item the villager is selling
 
|-
 
| Has second item
 
| Boolean
 
| Whether there is a second item
 
|-
 
| Input item 2
 
| Optional [[Slot]]
 
| The second item the villager is buying; only present if they have a second item.
 
|-
 
| Trade disabled
 
| Boolean
 
| True if the trade is disabled; false if the trade is enabled.
 
|-
 
| Number of trade uses
 
| Integer
 
| Number of times the trade has been used so far
 
|-
 
| Maximum number of trade uses
 
| Integer
 
| Number of times this trade can be used
 
|}
 
  
 
=== Serverbound ===
 
=== Serverbound ===
  
==== Recipe Book Data ====
+
No changes so far.
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
!colspan="2"| Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="11"| 0x1B
 
|rowspan="11"| Play
 
|rowspan="11"| Server
 
|colspan="2"| Type
 
| VarInt
 
| Determines the format of the rest of the packet
 
|-
 
! Type
 
! Field Name
 
!
 
!
 
|-
 
| 0: Displayed Recipe
 
| Recipe ID
 
| Identifier
 
| A recipe ID
 
|-
 
|rowspan="8"| 1: Recipe Book States
 
| Crafting Recipe Book Open
 
| Boolean
 
| Whether the player has the crafting recipe book currently opened/active.
 
|-
 
| Crafting Recipe Filter Active
 
| Boolean
 
| Whether the player has the crafting recipe book filter option currently active.
 
|-
 
| Smelting Recipe Book Open
 
| Boolean
 
| Whether the player has the smelting recipe book currently opened/active.
 
|-
 
| Smelting Recipe Filter Active
 
| Boolean
 
| Whether the player has the smelting recipe book filter option currently active.
 
|- {{Added}}
 
| Blasting Recipe Book Open
 
| Boolean
 
| May be swapped with smoking recipe book.  Also, the notchian client appears to use the same value for both of those books currently.
 
|- {{Added}}
 
| Blasting Recipe Filter Active
 
| Boolean
 
| May be swapped with smoking recipe book.  Also, the notchian client appears to use the same value for both of those books currently.
 
|- {{Added}}
 
| Smoking Recipe Book Open
 
| Boolean
 
|
 
|- {{Added}}
 
| Smoking Recipe Filter Active
 
| Boolean
 
|
 
|}
 
 
 
The Recipe Book Status type is sent when one of the states changes.
 
 
 
==== Player Block Placement ====
 
 
 
{| class="wikitable"
 
|-
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="9"| 0x29
 
|rowspan="9"| Play
 
|rowspan="9"| Server
 
|{{removed}}| Location
 
|{{removed}}| Position
 
|{{removed}}| Block position
 
|- {{removed}}
 
| Face
 
| VarInt Enum
 
| The face on which the block is placed (as documented at [[#Player Digging|Player Digging]])
 
|-
 
| Hand
 
| VarInt Enum
 
| The hand from which the block is placed; 0: main hand, 1: off hand
 
|- {{added}}
 
| Location
 
| Position
 
| Block position
 
|- {{added}}
 
| Face
 
| VarInt Enum
 
| The face on which the block is placed (as documented at [[#Player Digging|Player Digging]])
 
|-
 
| Cursor Position X
 
| Float
 
| The position of the crosshair on the block, from 0 to 1 increasing from west to east
 
|-
 
| Cursor Position Y
 
| Float
 
| The position of the crosshair on the block, from 0 to 1 increasing from bottom to top
 
|-
 
| Cursor Position Z
 
| Float
 
| The position of the crosshair on the block, from 0 to 1 increasing from north to south
 
|- {{added}}
 
| Inside block
 
| Boolean
 
| True when the player's head is inside of a block.
 
|}
 
 
 
Upon placing a block, this packet is sent once.
 
 
 
The Cursor Position X/Y/Z fields (also known as in-block coordinates) are calculated using raytracing. The unit corresponds to sixteen pixel in the default resource pack. For example, let's say a slab is being placed against the south face of a full block. The Cursor Position X will be higher if the player was pointing near the right (east) edge of the face, lower if pointing near the left. The Cursor Position Y will be used to determine whether it will appear as a bottom slab (values 0.0–0.5) or as a top slab (values 0.5-1.0). The Cursor Position Z should be 1.0 since the player was looking at the southernmost part of the block.
 
 
 
{{Change||Inside block is true when a player's head (specifically eyes) are inside of a block's collision.  In 1.13 and later versions, collision is rather complicated and individual blocks can have multiple collision boxes.  For instance, a ring of vines has a non-colliding hole in the middle.  This value is only true when the player is directly in the box.  In practice, though, this value is only used by scaffolding to place in front of the player when sneaking inside of it (other blocks will place behind when you intersect with them -- try with glass for instance).}}
 
  
 
== Handshaking ==
 
== Handshaking ==
Line 1,618: Line 512:
 
  | Protocol Version
 
  | Protocol Version
 
  | VarInt
 
  | VarInt
  | See [[protocol version numbers]] (currently {{change|404|455}})
+
  | See [[protocol version numbers]] (currently {{change|754|1073741831}})
 
  |-
 
  |-
 
  | Server Address
 
  | Server Address
 
  | String
 
  | String
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information.
+
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
 
  |-  
 
  |-  
 
  | Server Port
 
  | Server Port

Latest revision as of 18:05, 25 November 2020

This page documents the changes from the last stable Minecraft release (currently 1.16.4, protocol 754) to the current pre-release (currently 20w48a, protocol 1073741831). Note that this page contains bleeding-edge information that may not be completely or correctly documented.

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

Contents

Data types

No changes so far.

Packets

ID Packet name Documentation
Play serverbound
0x20 Chunk Data Current Pre
0x23 Update Light Current Pre
0x25 Map Data Current Pre
0x38 Resource Pack Send Current Pre
Handshaking serverbound
0x00 Handshake Current Pre

New/modified data types

No changes so far.

Entity Metadata

Warning.png Note that other entities have had metadata shifts due to these changes, not shown here.

Entity

The base class.

Index Type Meaning Default
0 Byte Bit mask Meaning 0
0x01 Is on fire
0x02 Is crouching
0x04 Unused (previously riding)
0x08 Is sprinting
0x10 Is swimming
0x20 Is invisible
0x40 has glowing effect
0x80 Is flying with an elytra
1 VarInt Air ticks 300
2 OptChat Custom name empty
3 Boolean Is custom name visible false
4 Boolean Is silent false
5 Boolean Has no gravity false
6 Pose Pose STANDING
7 VarInt Ticks frozen in powdered snow 0

Block Actions

No changes so far.

Inventories

No changes so far.

Plugin Channels

No changes so far.

Play

Clientbound

Chunk Data

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

The server only sends skylight information for chunk pillars in the Overworld, it's up to the client to know in which dimension the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent. This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with Update Block Entity later).

Packet ID State Bound To Field Name Field Type Notes
0x20 Play Client Chunk X Int Chunk coordinate (block coordinate divided by 16, rounded down)
Chunk Z Int Chunk coordinate (block coordinate divided by 16, rounded down)
Full chunk Boolean See Chunk Format
Primary Bit Mask VarInt Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
Heightmaps NBT Compound containing one long array named MOTION_BLOCKING, which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry totaling 36 longs). The Notchian server also adds a WORLD_SURFACE long array, the purpose of which is unknown, but it's not required for the chunk to be accepted.
Biomes length Optional VarInt Size of the following array. Not present if full chunk is false.
Biomes Optional array of VarInt 1024 biome IDs, ordered by x then z then y, in 4×4×4 blocks.Possibly something else. Not present if full chunk is false.
Size VarInt Size of Data in bytes
Data Byte array See data structure in Chunk Format
Number of block entities VarInt Number of elements in the following array
Block entities Array of NBT Tag All block entities in the chunk. Use the x, y, and z tags in the NBT to determine their positions.

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

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

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

0020863148418841 0000000000100000100001100011000101001000010000011000100001000001
01018A7260F68C87 0000000100000001100010100111001001100000111101101000110010000111


Update Light

Updates light levels for a chunk.

Packet ID State Bound To Field Name Field Type Notes
0x23 Play Client Chunk X VarInt Chunk coordinate (block coordinate divided by 16, rounded down)
Chunk Z VarInt Chunk coordinate (block coordinate divided by 16, rounded down)
Trust Edges Boolean If edges should be trusted for light updates.
? (Changes unknown) VarInt VarLong ? (Changes unknown)
? (Changes unknown) VarInt VarLong ? (Changes unknown)
? (Changes unknown) VarInt VarLong ? (Changes unknown)
? (Changes unknown) VarInt VarLong ? (Changes unknown)
Sky Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Sky Light array Array of 2048 bytes There is 1 array for each bit set to true in the sky light mask, starting with the lowest value. Half a byte per light value.
Block Light arrays Length Array VarInt Length of the following array in bytes (always 2048)
Block Light array Array of 2048 bytes There is 1 array for each bit set to true in the block light mask, starting with the lowest value. Half a byte per light value.



Map Data

Updates a rectangular area on a map item.

Packet ID State Bound To Field Name Field Type Notes
0x25 Play Client Map ID VarInt Map ID of the map being modified
Scale Byte From 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel)
Tracking Position Boolean Specifies whether player and item frame icons are shown
Locked Boolean True if the map has been locked in a cartography table
Tracking Position Boolean Specifies whether player and item frame icons are shown
Icon Count VarInt Number of elements in the following array. Only present if "Tracking Position" is true.
Icon Type Array VarInt enum See below
X Byte Map coordinates: -128 for furthest left, +127 for furthest right
Z Byte Map coordinates: -128 for highest, +127 for lowest
Direction Byte 0-15
Has Display Name Boolean
Display Name Optional Chat Only present if previous Boolean is true
Columns Unsigned Byte Number of columns updated
Rows Optional Byte Only if Columns is more than 0; number of rows updated
X Optional Byte Only if Columns is more than 0; x offset of the westernmost column
Z Optional Byte Only if Columns is more than 0; z offset of the northernmost row
Length Optional VarInt Only if Columns is more than 0; length of the following array
Data Optional Array of Unsigned Byte Only if Columns is more than 0; see Map item format

For icons, a direction of 0 is a vertical icon and increments by 22.5° (360/16).

Types are based off of rows and columns in map_icons.png:

Icon type Result
0 White arrow (players)
1 Green arrow (item frames)
2 Red arrow
3 Blue arrow
4 White cross
5 Red pointer
6 White circle (off-map players)
7 Small white circle (far-off-map players)
8 Mansion
9 Temple
10 White Banner
11 Orange Banner
12 Magenta Banner
13 Light Blue Banner
14 Yellow Banner
15 Lime Banner
16 Pink Banner
17 Gray Banner
18 Light Gray Banner
19 Cyan Banner
20 Purple Banner
21 Blue Banner
22 Brown Banner
23 Green Banner
24 Red Banner
25 Black Banner
26 Treasure marker


Resource Pack Send

Packet ID State Bound To Field Name Field Type Notes
0x38 Play Client URL String (32767) The URL to the resource pack.
Hash String (40) A 40 character hexadecimal and lowercase SHA-1 hash of the resource pack file. (must be lower case in order to work)
If it's not a 40 character hexadecimal string, the client will not use it for hash verification and likely waste bandwidth — but it will still treat it as a unique id
Forced Boolean The notchian client will be forced to use the ressource pack from the server. If they decline they will be kicked from the server.


Serverbound

No changes so far.

Handshaking

Clientbound

There are no clientbound packets in the Handshaking state, since the protocol immediately switches to a different state after the client sends the first packet.

Serverbound

Handshake

This causes the server to switch into the target state.

Packet ID State Bound To Field Name Field Type Notes
0x00 Handshaking Server Protocol Version VarInt See protocol version numbers (currently 754 1073741831)
Server Address String Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect. The Notchian server does not use this information. Note that SRV records are a complete redirect, e.g. if _minecraft._tcp.example.com points to mc.example.org, users connecting to example.com will provide mc.example.org as server address in addition to connecting to it.
Server Port Unsigned Short Default is 25565. The Notchian server does not use this information.
Next State VarInt Enum 1 for status, 2 for login

Status

Clientbound

No changes so far.

Serverbound

No changes so far.

Login

Clientbound

No changes so far.

Serverbound

No changes so far.