Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to: navigation, search
m (Illager Beast: (I did it again))
(Piglin: New field is actually the middle one, IsImmuneToZombification)
 
(208 intermediate revisions by 13 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|18w46a, protocol 445]]). 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.15.2, protocol 578]]) to the current pre-release (currently [[Protocol version numbers|20w09a, protocol 704]]). 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 43: Line 20:
 
!colspan="4"| Handshaking serverbound
 
!colspan="4"| Handshaking serverbound
 
{{PacketList|0x00|Handshake}}
 
{{PacketList|0x00|Handshake}}
|-
 
!colspan="4"| Play clientbound
 
{{PacketList|0x09|Update Block Entity}}
 
{{PacketList|0x22|Chunk Data}}
 
{{PacketList|0x4E|Entity Sound Effect|rel=added}}
 
{{PacketList|{{change|0x4E|0x4F}}|Player List Header And Footer|pre=unchanged}}
 
{{PacketList|{{change|0x4F|0x50}}|Collect Item|pre=unchanged}}
 
{{PacketList|{{change|0x50|0x51}}|Entity Teleport|pre=unchanged}}
 
{{PacketList|{{change|0x51|0x52}}|Advancements|pre=unchanged}}
 
{{PacketList|{{change|0x52|0x53}}|Entity Properties|pre=unchanged}}
 
{{PacketList|{{change|0x53|0x54}}|Entity Effect|pre=unchanged}}
 
{{PacketList|{{change|0x54|0x55}}|Declare Recipes|pre=unchanged}}
 
{{PacketList|{{change|0x55|0x56}}|Tags}}
 
{{PacketList|0x57|Update Light|rel=added}}
 
 
  |}
 
  |}
  
Line 65: Line 28:
 
== Entity Metadata ==
 
== Entity Metadata ==
  
=== Mobs ===
+
{{#vardefine:meta_prerelease|1}}
  
Entity IDs have shifted with the addition of some new mobs.
+
=== Hoglin ===
  
=== Arrow ===
+
{{Metadata inherit|Hoglin|inherits=Animal|start_at=16}}
  
Extends [[#Entity|Entity]].
+
No additional metadata.
 
 
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 ===
+
=== Piglin ===
  
Extends [[#Arrow|Arrow]].
+
{{Metadata inherit|Piglin|inherits=Monster|start_at=15}}
 
 
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"
 
{| class="wikitable"
Line 116: Line 46:
 
  ! Default
 
  ! Default
 
  |-
 
  |-
  | {{change|8|9}}
+
  | {{Metadata id|}}
  | VarInt
+
  | Boolean
|colspan="2"| Color (-1 for no particles)
+
  |colspan="2"| Is baby
| -1
+
  | false
|}
 
 
 
=== 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
 
|}
 
 
 
=== Fireworks ===
 
 
 
Extends [[#Entity|Entity]].
 
 
 
{| class="wikitable"
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 6
 
| [[Slot]]
 
  |colspan="2"| Firework info
 
  | empty
 
 
  |-
 
  |-
  | 7
+
  | {{Metadata id|}}
| VarInt
 
|colspan="2"| Entity ID of entity which used firework (for elytra boosting)
 
| 0
 
|- {{Added}}
 
| 8
 
 
  | Boolean
 
  | Boolean
  |colspan="2"| Shot at angle (from a crossbow)
+
  |colspan="2"| Is immune to zombification
 
  | false
 
  | false
|}
 
 
=== Illager Beast ===
 
 
Extends [[#Monster|Monster]]
 
 
No additional metadata.
 
 
{| class="wikitable" {{added}}
 
! Status
 
!colspan="2"| Description
 
|-
 
| 4
 
|colspan="2"| Starts the attack animation.
 
 
  |-
 
  |-
  | 39
+
  | {{Metadata id|}}
|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
 
! Meaning
 
|rowspan="6"| 0
 
|-
 
| 0x01
 
| Unused
 
|-
 
| 0x02
 
| Is sneezing
 
|-
 
| 0x04
 
| Is eating
 
|-
 
| 0x08
 
| Unknown
 
|-
 
| 0x10
 
| Unknown
 
|}
 
 
 
=== Pillager ===
 
 
 
Extends [[#Abstract Illager|Abstract Illlager]].
 
 
 
{| class="wikitable" {{added}}
 
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 13
 
 
  | Boolean
 
  | Boolean
  | colspan="2"| Using crossbow
+
  |colspan="2"| Is charging crossbow
 
  | false
 
  | false
 
  |}
 
  |}
  
=== Ocelot ===
+
=== {{Change|Zombie Pigman|Zombified Piglin}} ===
  
Extends {{change|[[#TameableAnimal|TameableAnimal]]|[[#Ageable|Ageable]]}}.
+
{{Metadata inherit|{{Change|Zombie Pigman|Zombified Piglin}}|inherits=Zombie|start_at=18}}
  
{| class="wikitable"
+
No additional metadata.
! 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}}
+
== Block Actions ==
! Status
 
!colspan="2"| Description
 
|-
 
| 40
 
|colspan="2"| Spawn smoke particles (trust gaining failed)
 
|-
 
| 41
 
|colspan="2"| Spawn heart particles (trust gaining succeeded)
 
|}
 
  
=== Cat ===
+
No changes so far.
  
Extends [[#TameableAnimal|TameableAnimal]].
+
== Inventories ==
  
{| class="wikitable" {{added}}
+
No changes so far.
! Index
 
! Type
 
!style="width: 250px;" colspan="2"| Meaning
 
! Default
 
|-
 
| 15
 
| 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)
 
| 1
 
|-
 
| 16
 
| Boolean
 
|colspan="2"| Unknown
 
| false
 
|-
 
| 17
 
| Boolean
 
|colspan="2"| Unknown
 
| false
 
|-
 
| 18
 
| VarInt
 
|colspan="2"| Collar color (values are those {{Minecraft Wiki|Data_values#Dyes|used with dyes}})
 
| 14 (Red)
 
|}
 
  
== Block Actions ==
+
== Plugin Channels ==
  
 
No changes so far.
 
No changes so far.
Line 325: Line 84:
 
=== Clientbound ===
 
=== Clientbound ===
  
==== Update Block Entity ====
+
No changes so far.
 
 
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''': 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}}
 
 
 
==== Chunk Data ====
 
{{Main|Chunk Format}}
 
{{See also|#Unload Chunk}}
 
 
 
The server only sends skylight information for chunk pillars in the {{Minecraft Wiki|Overworld}}, it's up to the client to know in which dimenison the player is currently located. You can also infer this information from the primary bitmask and the amount of uncompressed bytes sent.  This packet also sends all block entities in the chunk (though sending them is not required; it is still legal to send them with [[#Update Block Entity|Update Block Entity]] later).
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="9"| 0x22
 
|rowspan="9"| Play
 
|rowspan="9"| Client
 
| Chunk X
 
| Int
 
| Chunk coordinate (block coordinate divided by 16, rounded down)
 
|-
 
| Chunk Z
 
| Int
 
| Chunk coordinate (block coordinate divided by 16, rounded down)
 
|-
 
| Ground-Up Continuous
 
| Boolean
 
| See [[Chunk Format#Ground-up continuous|Chunk Format]]
 
|-
 
| Primary Bit Mask
 
| VarInt
 
| Bitmask with bits set to 1 for every 16×16×16 chunk section whose data is included in Data. The least significant bit represents the chunk section at the bottom of the chunk column (from y=0 to y=15).
 
|- {{Added}}
 
| Heightmaps
 
| [[NBT]]
 
| Compound containing one long array named <code>MOTION_BLOCKING</code>, which is a heightmap for the highest solid block at each position in the chunk (as a compacted long array with 256 entries at 9 bits per entry).
 
|-
 
| Size
 
| VarInt
 
| Size of Data in bytes
 
|-
 
| Data
 
| Byte array
 
| See [[Chunk Format#Data structure|data structure]] in Chunk Format
 
|-
 
| Number of block entities
 
| VarInt
 
| Number of elements in the following array
 
|-
 
| Block entities
 
| Array of [[NBT]]
 
| All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
 
|}
 
 
 
===== Data structure =====
 
 
 
The data section of the packet contains most of the useful data for the chunk.
 
 
 
{| class="wikitable"
 
|-
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
| Data
 
| Array of [[#Chunk Section structure|Chunk Section]]
 
| The number of elements in the array is equal to the number of bits set in Primary Bit Mask. Sections are sent bottom-to-top, i.e. the first section, if sent, extends from Y=0 to Y=15.
 
|-
 
| Biomes
 
| Optional Int Array
 
| Only sent if Ground-Up Continuous is true; 256 entries if present
 
|}
 
 
 
===== Chunk Section structure =====
 
 
 
A Chunk Section is defined in terms of other [[data types]]. A Chunk Section consists of the following fields:
 
 
 
{| class="wikitable"
 
|-
 
! Field Name
 
! Field Type
 
! Notes
 
|- {{added}}
 
| Block count
 
| Short
 
| Number of non-air blocks present in the chunk section, for lighting purposes.  "Non-air" is defined as any block other than air, cave air, and void air (in particular, note that fluids such as water are still counted).
 
|-
 
| Bits Per Block
 
| Unsigned Byte
 
| Determines how many bits are used to encode a block. Note that not all numbers are valid here.
 
|-
 
| Palette
 
| Varies
 
| See below for the format.
 
|-
 
| Data Array Length
 
| VarInt
 
| Number of longs in the following array
 
|-
 
| Data Array
 
| Array of Long
 
| Compacted list of 4096 indices pointing to state IDs in the Palette
 
|- {{removed}}
 
| Block Light
 
| Byte Array
 
| Half byte per block
 
|- {{removed}}
 
| Sky Light
 
| Optional Byte Array
 
| Only if in the Overworld; half byte per block
 
|}
 
 
 
Data Array{{change|, Block Light, and Sky Light are|is}} given for each block with increasing x coordinates, within rows of increasing z coordinates, within layers of increasing y coordinates.  {{change|For the half-byte light arrays, even-indexed items (those with an even x coordinate, starting at 0) are packed into the ''low bits'', odd-indexed into the ''high bits''.}}
 
 
 
==== Entity Sound Effect ====
 
 
 
Plays a sound effect from an entity.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="5"| 0x4E
 
|rowspan="5"| Play
 
|rowspan="5"| Client
 
| Sound ID
 
| VarInt
 
| ID of hardcoded sound event ([https://pokechu22.github.io/Burger/1.13.2.html#sounds events] as of 1.13.2)
 
|-
 
| Sound Category
 
| VarInt Enum
 
| The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
 
|-
 
| Entity ID
 
| VarInt
 
|
 
|-
 
| Volume
 
| Float
 
| 1.0 is 100%, capped between 0.0 and 1.0 by Notchian clients
 
|-
 
| Pitch
 
| Float
 
| Float between 0.5 and 2.0 by Notchian clients
 
|}
 
 
 
==== Tags ====
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="4"| {{Change|0x55|0x56}}
 
|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
 
|}
 
 
 
==== Update Light ====
 
 
 
Updates light levels for a chunk.
 
 
 
{| class="wikitable"
 
! Packet ID
 
! State
 
! Bound To
 
! Field Name
 
! Field Type
 
! Notes
 
|-
 
|rowspan="8"| 0x57
 
|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.  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.  However, this seems to be written into incorrectly, and is always 0; instead block light values are put into the sky light mask. ([https://bugs.mojang.com/browse/MC-138918 MC-138918])
 
|-
 
| 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.
 
  
 
=== Serverbound ===
 
=== Serverbound ===
Line 627: Line 115:
 
  | Protocol Version
 
  | Protocol Version
 
  | VarInt
 
  | VarInt
  | See [[protocol version numbers]] (currently {{change|404|445}})
+
  | See [[protocol version numbers]] (currently {{change|578|704}})
 
  |-
 
  |-
 
  | 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:22, 26 February 2020

This page documents the changes from the last stable Minecraft release (currently 1.15.2, protocol 578) to the current pre-release (currently 20w09a, protocol 704). 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
Handshaking serverbound
0x00 Handshake Current Pre

New/modified data types

No changes so far.

Entity Metadata

Hoglin

Extends Animal.

No additional metadata.

Piglin

Extends Monster.

Index Type Meaning Default
15 Boolean Is baby false
16 Boolean Is immune to zombification false
17 Boolean Is charging crossbow false

Zombie Pigman Zombified Piglin

Extends Zombie.

No additional metadata.

Block Actions

No changes so far.

Inventories

No changes so far.

Plugin Channels

No changes so far.

Play

Clientbound

No changes so far.

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