Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
(→‎Entity Metadata: entity IDs shifted, not going to type that table now...)
(Updated to 1.21-pre2)
 
(534 intermediate revisions by 45 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|18w43b, protocol 441]]). 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.20.6, protocol 766]]) to the current pre-release (currently [[Protocol version numbers|1.21-pre2, protocol {{Snapshot PVN|1073742024}}]]). 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 ===
  
−
No changes so far.
+
No changes documented so far.
  
 
=== Packets ===
 
=== Packets ===
Line 18: Line 18:
 
  !colspan="2"| Documentation
 
  !colspan="2"| Documentation
 
  |-
 
  |-
−
!colspan="4"| Handshaking serverbound
+
!colspan="4"| Configuration clientbound
−
{{PacketList|0x00|Handshake}}
+
{{PacketList|0x0F|Clientbound Report Details (configuration)|rel=added}}
 +
{{PacketList|0x10|Clientbound Server Links (configuration)|rel=added}}
 
  |-
 
  |-
−
!colspan="4"| Play clientbound
+
!colspan="4"| Play clientbound
−
{{PacketList|0x22|Chunk Data}}
+
{{PacketList|0x7A|Clientbound Report Details (play)|rel=added}}
−
{{PacketList|0x4E|Entity Sound Effect|rel=added}}
+
{{PacketList|0x7B|Clientbound Server Links (play)|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|pre=unchanged}}
 
−
{{PacketList|0x57|Update Light|rel=added}}
 
−
  |}
 
  
−
== New/modified data types ==
+
== Handshake ==
  
 
No changes so far.
 
No changes so far.
  
−
== Entity Metadata ==
+
== Status ==
  
−
=== Mobs ===
+
No changes so far.
  
−
Entity IDs have shifted with the addition of some new mobs.
+
== Login ==
−
 
 
−
== Block Actions ==
 
  
 
No changes so far.
 
No changes so far.
  
−
== Play ==
+
== Configuration ==
  
 
=== Clientbound ===
 
=== Clientbound ===
  
−
==== Chunk Data ====
+
==== Clientbound Report Details (configuration) ====
−
{{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).
+
Contains a list of key-value text entries that are included in any crash or disconnection report generated during connection to the server.
  
−
{| class="wikitable"
+
{| class="wikitable" {{added}}
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
−
  ! Field Name
+
  ! colspan="2"| Field Name
−
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
−
  |rowspan="8"| 0x22
+
  | rowspan="3"| 0x0F
−
  |rowspan="8"| Play
+
  | rowspan="3"| Configuration
−
  |rowspan="8"| Client
+
  | rowspan="3"| Client
−
  | Chunk X
+
  | colspan="2"| Details Count
−
  | Int
+
  | colspan="2"| {{Type|VarInt}} (32)
−
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  | The number of details in the following array.
 
  |-
 
  |-
−
  | Chunk Z
+
  | rowspan="2"| Details
−
  | Int
+
  | Title
−
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
| rowspan="2"| {{Type|Array}}
 +
  | {{Type|String}} (128)
 +
|
 
  |-
 
  |-
−
  | Ground-Up Continuous
+
  | Description
−
  | Boolean
+
  | {{Type|String}} (4096)
−
  | See [[Chunk Format#Ground-up continuous|Chunk Format]]
+
  |
 +
|}
 +
 
 +
==== Clientbound Server Links (configuration) ====
 +
 
 +
This packet contains a list of links that the Notchian client will display in the menu available from the pause menu. Link labels can be built-in or custom (i.e., any text).
 +
 
 +
{| class="wikitable" {{added}}
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 
  |-
 
  |-
−
  | Primary Bit Mask
+
  | rowspan="4"| 0x10
−
  | VarInt
+
  | rowspan="4"| Configuration
−
  | 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).
+
  | rowspan="4"| Client
−
  |-
+
  | colspan="2"| Links Count
−
  | Size
+
  | colspan="2"| {{Type|VarInt}}
−
| VarInt
+
  | The number of links in the following array.
−
  | Size of Data in bytes
 
 
  |-
 
  |-
−
  | Data
+
  | rowspan="3"| Links
−
  | Byte array
+
| Is built-in
−
  | See [[Chunk Format#Data structure|data structure]] in Chunk Format
+
  | rowspan="3"| {{Type|Array}}
 +
  | {{Type|Boolean}}
 +
| Determines if the following label is built-in (from enum) or custom (text component).
 
  |-
 
  |-
−
  | Number of block entities
+
  | Label
−
  | VarInt
+
  | {{Type|VarInt}} {{Type|Enum}} / {{Type|Text Component}}
−
  | Number of elements in the following array
+
  | See below.
 
  |-
 
  |-
−
  | Block entities
+
  | URL
−
  | Array of [[NBT|NBT Tag]]
+
  | {{Type|String}}
−
  | All block entities in the chunk.  Use the x, y, and z tags in the NBT to determine their positions.
+
  | Valid URL.
−
|}
+
|}
  
−
===== Data structure =====
 
  
−
The data section of the packet contains most of the useful data for the chunk.
+
{| class="wikitable" {{added}}
−
 
+
! ID
−
{| class="wikitable"
+
! Name
 +
! Notes
 +
|-
 +
| 0
 +
| Bug Report
 +
| Displayed on connection error screen; included as a comment in the disconnection report.
 +
|-
 +
| 1
 +
| Community Guidelines
 +
|
 +
|-
 +
| 2
 +
| Support
 +
|
 
  |-
 
  |-
−
  ! Field Name
+
  | 3
−
  ! Field Type
+
  | Status
−
  ! Notes
+
  |
 
  |-
 
  |-
−
  | Data
+
  | 4
−
  | Array of [[#Chunk Section structure|Chunk Section]]
+
  | Feedback
−
  | 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
+
  | 5
−
  | Optional Int Array
+
  | Community
−
  | 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
+
  | 6
−
! Field Type
+
  | Website
−
! Notes
+
  |  
−
|- {{added}}
 
−
  | Block count
 
−
  | Short
 
−
  | Number of non-air blocks present in the chunk, for lighting purposes
 
 
  |-
 
  |-
−
  | Bits Per Block
+
  | 7
−
  | Unsigned Byte
+
  | Forums
−
  | Determines how many bits are used to encode a block. Note that not all numbers are valid here.
+
  |  
 
  |-
 
  |-
−
  | Palette
+
  | 8
−
  | Varies
+
  | News
−
  | See below for the format.
+
  |  
 
  |-
 
  |-
−
  | Data Array Length
+
  | 9
−
  | VarInt
+
  | Announcements
−
  | 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''.}}
+
=== Serverbound ===
  
−
==== Entity Sound Effect ====
+
No changes so far.
  
−
Plays a sound effect from an entity.
+
== Play ==
 +
 
 +
=== Clientbound ===
 +
 
 +
==== Clientbound Report Details (play) ====
  
−
{| class="wikitable"
+
Contains a list of key-value text entries that are included in any crash or disconnection report generated during connection to the server.
 +
 
 +
{| class="wikitable" {{added}}
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
−
  ! Field Name
+
  ! colspan="2"| Field Name
−
  ! Field Type
+
  ! colspan="2"| Field Type
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
−
  |rowspan="5"| 0x4E
+
  | rowspan="3"| 0x7A
−
  |rowspan="5"| Play
+
  | rowspan="3"| Configuration
−
  |rowspan="5"| Client
+
  | rowspan="3"| Client
−
  | Sound ID
+
  | colspan="2"| Details Count
−
  | VarInt
+
  | colspan="2"| {{Type|VarInt}} (32)
−
  | ID of hardcoded sound event ([https://pokechu22.github.io/Burger/1.13.2.html#sounds events] as of 1.13.2)
+
  | The number of details in the following array.
 
  |-
 
  |-
−
  | Sound Category
+
  | rowspan="2"| Details
−
  | VarInt Enum
+
  | Title
−
  | The category that this sound will be played from ([https://gist.github.com/konwboj/7c0c380d3923443e9d55 current categories])
+
| rowspan="2"| {{Type|Array}}
 +
  | {{Type|String}} (128)
 +
|
 
  |-
 
  |-
−
  | Entity ID
+
  | Description
−
  | VarInt
+
  | {{Type|String}} (4096)
 
  |
 
  |
−
|-
+
|}
−
| 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
 
−
|}
 
  
−
==== Update Light ====
+
==== Clientbound Server Links (play) ====
  
−
Updates light levels for a chunk.
+
This packet contains a list of links that the Notchian client will display in the menu available from the pause menu. Link labels can be built-in or custom (i.e., any text).
  
−
{| class="wikitable"
+
{| class="wikitable" {{added}}
 
  ! Packet ID
 
  ! Packet ID
 
  ! State
 
  ! State
 
  ! Bound To
 
  ! Bound To
−
  ! Field Name
+
  ! colspan="2"| Field Name
−
  ! Field Type
+
  ! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="4"| 0x7B
 +
| rowspan="4"| Configuration
 +
| rowspan="4"| Client
 +
| colspan="2"| Links Count
 +
| colspan="2"| {{Type|VarInt}}
 +
| The number of links in the following array.
 +
|-
 +
| rowspan="3"| Links
 +
| Is built-in
 +
| rowspan="3"| {{Type|Array}}
 +
| {{Type|Boolean}}
 +
| Determines if the following label is built-in (from enum) or custom (text component).
 +
|-
 +
| Label
 +
| {{Type|VarInt}} {{Type|Enum}} / {{Type|Text Component}}
 +
| See below.
 +
|-
 +
| URL
 +
| {{Type|String}}
 +
| Valid URL.
 +
|}
 +
 
 +
{| class="wikitable" {{added}}
 +
! ID
 +
! Name
 
  ! Notes
 
  ! Notes
 
  |-
 
  |-
−
  |rowspan="6"| 0x57
+
  | 0
−
  |rowspan="6"| Play
+
| Bug Report
−
  |rowspan="6"| Client
+
| Displayed on connection error screen; included as a comment in the disconnection report.
−
  | Chunk X
+
|-
−
  | VarInt
+
  | 1
−
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
| Community Guidelines
 +
  |  
 +
|-
 +
  | 2
 +
  | Support
 +
  |  
 
  |-
 
  |-
−
  | Chunk Z
+
  | 3
−
  | VarInt
+
  | Status
−
  | Chunk coordinate (block coordinate divided by 16, rounded down)
+
  |  
 
  |-
 
  |-
−
  | Block Light Mask
+
  | 4
−
  | VarInt
+
  | Feedback
−
  | 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)
+
  |  
 
  |-
 
  |-
−
  | Sky Light Mask
+
  | 5
−
  | VarInt
+
  | Community
−
  | Mask containing 18 bits, with the same order as block light
+
  |  
 
  |-
 
  |-
−
  | Block Light arrays
+
  | 6
−
  | Array of arrays of 2048 bytes
+
  | Website
−
  | 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.
+
  |  
 
  |-
 
  |-
−
  | Sky Light arrays
+
  | 7
−
  | Array of arrays of 2048 bytes
+
  | Forums
−
  | 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 ===
 
−
 
 
−
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.
 
−
 
 
−
{| class="wikitable"
 
−
! Packet ID
 
−
! State
 
−
! Bound To
 
−
! Field Name
 
−
! Field Type
 
−
! Notes
 
 
  |-
 
  |-
−
  |rowspan="4"| 0x00
+
  | 8
−
|rowspan="4"| Handshaking
+
  | News
−
|rowspan="4"| Server
+
  |  
−
  | Protocol Version
 
−
  | VarInt
 
−
| See [[protocol version numbers]] (currently {{change|404|441}})
 
 
  |-
 
  |-
−
  | Server Address
+
  | 9
−
  | String
+
  | Announcements
−
  | Hostname or IP, e.g. localhost or 127.0.0.1, that was used to connect.  The Notchian server does not use this information.
+
  |  
−
|-
 
−
| Server Port
 
−
| Unsigned Short
 
−
| Default is 25565.  The Notchian server does not use this information.
 
 
  |-
 
  |-
−
| Next State
 
−
| VarInt Enum
 
−
| 1 for [[#Status|status]], 2 for [[#Login|login]]
 
 
  |}
 
  |}
−
 
−
== Status ==
 
−
 
−
=== Clientbound ===
 
−
 
−
No changes so far.
 
  
 
=== Serverbound ===
 
=== Serverbound ===
  
 
No changes so far.
 
No changes so far.
−
 
−
== Login ==
 
−
 
−
=== Clientbound ===
 
−
 
−
No changes so far.
 
−
 
−
=== Serverbound ===
 
−
 
−
No changes so far.
 
−
 
  
 
[[Category:Minecraft Modern]]
 
[[Category:Minecraft Modern]]

Latest revision as of 10:40, 8 June 2024

This page documents the changes from the last stable Minecraft release (currently 1.20.6, protocol 766) to the current pre-release (currently 1.21-pre2, protocol Snapshot 200). 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 documented so far.

Packets

ID Packet name Documentation
Configuration clientbound
0x0F Clientbound Report Details (configuration) Pre
0x10 Clientbound Server Links (configuration) Pre
Play clientbound
0x7A Clientbound Report Details (play) Pre
0x7B Clientbound Server Links (play) Pre

Handshake

No changes so far.

Status

No changes so far.

Login

No changes so far.

Configuration

Clientbound

Clientbound Report Details (configuration)

Contains a list of key-value text entries that are included in any crash or disconnection report generated during connection to the server.

Packet ID State Bound To Field Name Field Type Notes
0x0F Configuration Client Details Count VarInt (32) The number of details in the following array.
Details Title Array String (128)
Description String (4096)

Clientbound Server Links (configuration)

This packet contains a list of links that the Notchian client will display in the menu available from the pause menu. Link labels can be built-in or custom (i.e., any text).

Packet ID State Bound To Field Name Field Type Notes
0x10 Configuration Client Links Count VarInt The number of links in the following array.
Links Is built-in Array Boolean Determines if the following label is built-in (from enum) or custom (text component).
Label VarInt Enum / Text Component See below.
URL String Valid URL.


ID Name Notes
0 Bug Report Displayed on connection error screen; included as a comment in the disconnection report.
1 Community Guidelines
2 Support
3 Status
4 Feedback
5 Community
6 Website
7 Forums
8 News
9 Announcements

Serverbound

No changes so far.

Play

Clientbound

Clientbound Report Details (play)

Contains a list of key-value text entries that are included in any crash or disconnection report generated during connection to the server.

Packet ID State Bound To Field Name Field Type Notes
0x7A Configuration Client Details Count VarInt (32) The number of details in the following array.
Details Title Array String (128)
Description String (4096)

Clientbound Server Links (play)

This packet contains a list of links that the Notchian client will display in the menu available from the pause menu. Link labels can be built-in or custom (i.e., any text).

Packet ID State Bound To Field Name Field Type Notes
0x7B Configuration Client Links Count VarInt The number of links in the following array.
Links Is built-in Array Boolean Determines if the following label is built-in (from enum) or custom (text component).
Label VarInt Enum / Text Component See below.
URL String Valid URL.
ID Name Notes
0 Bug Report Displayed on connection error screen; included as a comment in the disconnection report.
1 Community Guidelines
2 Support
3 Status
4 Feedback
5 Community
6 Website
7 Forums
8 News
9 Announcements

Serverbound

No changes so far.

Retrieved from "https://wiki.vg/index.php?title=Pre-release_protocol&oldid=19307"