Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
(Chunk format changed)
(→‎Chunk Data: Document chunk section changes)
Line 54: Line 54:
 
{{Main|Chunk Format}}
 
{{Main|Chunk Format}}
 
{{See also|#Unload Chunk}}
 
{{See also|#Unload Chunk}}
 
{{Need Info|Unknown changes}}
 
  
 
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).
 
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).
Line 102: Line 100:
 
  | 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 =====
 +
 +
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, for lighting purposes
 +
|-
 +
| 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 ====
 
==== Entity Sound Effect ====

Revision as of 21:35, 24 October 2018

This page documents the changes from the last stable Minecraft release (currently 1.13.2, protocol 404) to the current pre-release (currently 18w43b, protocol 441). 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
Play clientbound
0x22 Chunk Data Current Pre
0x4E Entity Sound Effect Pre
0x4E 0x4F Player List Header And Footer Current (unchanged)
0x4F 0x50 Collect Item Current (unchanged)
0x50 0x51 Entity Teleport Current (unchanged)
0x51 0x52 Advancements Current (unchanged)
0x52 0x53 Entity Properties Current (unchanged)
0x53 0x54 Entity Effect Current (unchanged)
0x54 0x55 Declare Recipes Current (unchanged)
0x55 0x56 Tags Current (unchanged)
0x57 Unknown 2 Pre

New/modified data types

No changes so far.

Entity Metadata

No changes so far.

Block Actions

No changes so far.

Play

Clientbound

Chunk Data

Main article: Chunk Format
See also: #Unload Chunk

The server only sends skylight information for chunk pillars in the 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 later).

Packet ID State Bound To Field Name Field Type Notes
0x22 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)
Ground-Up Continuous 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).
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.
Data structure

The data section of the packet contains most of the useful data for the chunk.

Field Name Field Type Notes
Data Array of 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:

Field Name Field Type Notes
Block count Short Number of non-air blocks present in the chunk, for lighting purposes
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
Block Light Byte Array Half byte per block
Sky Light Optional Byte Array Only if in the Overworld; half byte per block

Data Array, 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. 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.

Packet ID State Bound To Field Name Field Type Notes
0x4E Play Client Sound ID VarInt ID of hardcoded sound event (events as of 1.13.2)
Sound Category VarInt Enum The category that this sound will be played from (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

Unknown 2

Huh.png The following information needs to be added to this page:
?????

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 404 441)
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.
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.