Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
(23w31a)
(Rough draft of the new configuration packets)
Line 13: Line 13:
 
=== Packets ===
 
=== Packets ===
  
−
No changes so far.
+
=== Packets ===
 +
{| class="wikitable"
 +
! ID
 +
! Packet name
 +
!colspan="2"| Documentation
 +
|-
 +
!colspan="4"| Configuration clientbound
 +
{{PacketList|0x00|Plugin Message (configuration)|rel=added}}
 +
{{PacketList|0x01|Disconnect (configuration)|rel=added}}
 +
{{PacketList|0x02|Finish Configuration|rel=added}}
 +
{{PacketList|0x03|Keep Alive (configuration)|rel=added}}
 +
{{PacketList|0x04|Ping (configuration)|rel=added}}
 +
{{PacketList|0x05|Registry Data|rel=added}}
 +
{{PacketList|0x06|Resource Pack (configuration)|rel=added}}
 +
{{PacketList|0x07|Feature Flags|rel=added}}
 +
{{PacketList|0x08|Update Tags|rel=added}}
 +
|-
 +
!colspan="4"| Configuration serverbound
 +
{{PacketList|0x00|Plugin Message (configuration)|rel=added}}
 +
{{PacketList|0x01|Finish Configuration|rel=added}}
 +
{{PacketList|0x02|Keep Alive (configuration)|rel=added}}
 +
{{PacketList|0x03|Pong (configuration)|rel=added}}
 +
{{PacketList|0x04|Resource Pack|rel=added}}
 +
|}
  
 
== New/modified data types ==
 
== New/modified data types ==
Line 68: Line 91:
  
 
No changes so far.
 
No changes so far.
 +
 +
== Configuration ==
 +
 +
=== Clientbound ===
 +
 +
==== Plugin Message (configuration) ====
 +
 +
{{Main|Plugin channels}}
 +
 +
Mods and plugins can use this to send their data. Minecraft itself uses the <code>minecraft:payload</code> channel to send many types of payloads, which are documented [[Plugin_channels|here]].
 +
 +
More documentation on this: [https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 +
 +
Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x00
 +
| rowspan="2"| Configuration
 +
| rowspan="2"| Client
 +
| Channel
 +
| Identifier
 +
| Name of the [[plugin channel]] used to send the data.
 +
|-
 +
| Payload
 +
| Byte Array (1048576)
 +
| Any data, depending on the channel. <code>minecraft:payload</code> payloads are documented [[plugin channel|here]]. The length of this array must be inferred from the packet length.
 +
|}
 +
 +
In Notchian client, the maximum data length is 1048576 bytes.
 +
 +
==== Disconnect (configuration) ====
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x01
 +
| Configuration
 +
| Client
 +
| Reason
 +
| [[Chat]]
 +
| The reason why the player was disconnected.
 +
|}
 +
 +
==== Finish Configuration ====
 +
 +
Sent by the server to notify the client that all the configuration has finish. The client answers with its own [[#Finish_Configuration_2|Finish Configuration]] whenever it is ready to continue.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x02
 +
| rowspan="1"| Configuration
 +
| rowspan="1"| Client
 +
| colspan="3"| ''no fields''
 +
|}
 +
 +
==== Keep Alive (configuration) ====
 +
 +
The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same payload (see [[#Keep Alive (configuration) 2|serverbound Keep Alive]]). If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.
 +
 +
The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x03
 +
| Configuration
 +
| Client
 +
| Keep Alive ID
 +
| Long
 +
|
 +
|}
 +
 +
==== Ping (configuration) ====
 +
 +
Packet is not used by the Notchian server. When sent to the client, client responds with a [[#Pong (configuration)|Pong]] packet with the same id.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x04
 +
| Configuration
 +
| Client
 +
| ID
 +
| Int
 +
|
 +
|}
 +
 +
==== Registry Data ====
 +
 +
Represents certain registries that are sent from the server and are applied on the client.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x05
 +
| rowspan="1"| Configuration
 +
| rowspan="1"| Client
 +
| Registry Codec
 +
| [[NBT|NBT Tag Compound]]
 +
| Information included below.
 +
|}
 +
 +
 +
The '''Registry Codec''' NBT Tag Compound ([https://gist.github.com/rj00a/f2970a8ce4d09477ec8f16003b9dce86 Default value in JSON as of 1.19], [https://gist.github.com/nikes/aff59b758a807858da131a1881525b14 1.19.2], [https://pastebin.com/guryvw56 1.20.1]) includes three registries: "minecraft:dimension_type", "minecraft:worldgen/biome", and "minecraft:chat_type".
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| minecraft:dimension_type
 +
| TAG_Compound
 +
| The dimension type registry (see below).
 +
|-
 +
| minecraft:worldgen/biome
 +
| TAG_Compound
 +
| The biome registry (see below).
 +
|-
 +
| minecraft:chat_type
 +
| TAG_Compound
 +
| The chat type registry (see below).
 +
|}
 +
 +
Dimension type registry:
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| type
 +
| TAG_String
 +
| The name of the registry. Always "minecraft:dimension_type".
 +
|-
 +
| value
 +
| TAG_List
 +
| List of dimension types registry entries (see below).
 +
|}
 +
 +
Dimension type registry entry:
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| name
 +
| TAG_String
 +
| The name of the dimension type (for example, "minecraft:overworld").
 +
|-
 +
| id
 +
| TAG_Int
 +
| The protocol ID of the dimension (matches the index of the element in the registry list).
 +
|-
 +
| element
 +
| TAG_Compound
 +
| The dimension type (see below).
 +
|}
 +
 +
Dimension type:
 +
 +
{| class="wikitable"
 +
! Name
 +
! Type
 +
!style="width: 250px;" colspan="2"| Meaning
 +
! Values
 +
|-
 +
| piglin_safe
 +
| TAG_Byte
 +
| colspan="2"| Whether piglins shake and transform to zombified piglins.
 +
| 1: true, 0: false.
 +
|-
 +
| has_raids
 +
| TAG_Byte
 +
| colspan="2"| Whether players with the Bad Omen effect can cause a raid.
 +
| 1: true, 0: false.
 +
|-
 +
| monster_spawn_light_level
 +
| TAG_Int or TAG_Compound
 +
| Possibly the light level(s) at which monsters can spawn.
 +
| colspan="2"| When TAG_Int, 0 - 15. When TAG_Compound, contains the fields: type (TAG_String), appears to be always "minecraft:uniform", and value (TAG_Compound), which contains the fields: max_inclusive (TAG_Int), min_inclusive (TAG_Int).
 +
|-
 +
| monster_spawn_block_light_limit
 +
| TAG_Int
 +
| colspan="2"|
 +
|
 +
|-
 +
| natural
 +
| TAG_Byte
 +
| colspan="2"| When false, compasses spin randomly. When true, nether portals can spawn zombified piglins.
 +
| 1: true, 0: false.
 +
|-
 +
| ambient_light
 +
| TAG_Float
 +
| colspan="2"| How much light the dimension has.
 +
| 0.0 to 1.0.
 +
|-
 +
| fixed_time
 +
| Optional TAG_Long
 +
| colspan="2"| If set, the time of the day is the specified value.
 +
| If set, 0 to 24000.
 +
|-
 +
| infiniburn
 +
| TAG_String
 +
| colspan="2"| A resource location defining what block tag to use for infiniburn.
 +
| "#" or minecraft resource "#minecraft:...".
 +
|-
 +
| respawn_anchor_works
 +
| TAG_Byte
 +
| colspan="2"| Whether players can charge and use respawn anchors.
 +
| 1: true, 0: false.
 +
|-
 +
| has_skylight
 +
| TAG_Byte
 +
| colspan="2"| Whether the dimension has skylight access or not.
 +
| 1: true, 0: false.
 +
|-
 +
| bed_works
 +
| TAG_Byte
 +
| colspan="2"| Whether players can use a bed to sleep.
 +
| 1: true, 0: false.
 +
|-
 +
| effects
 +
| TAG_String
 +
| colspan="2"| ?
 +
| "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" or something else.
 +
|-
 +
| min_y
 +
| TAG_Int
 +
| colspan="2"| The minimum Y level.
 +
| A multiple of 16. Example: -64
 +
|-
 +
| height
 +
| TAG_Int
 +
| colspan="2"| The maximum height.
 +
| A multiple of 16. Example: 256
 +
|-
 +
| logical_height
 +
| TAG_Int
 +
| colspan="2"| The maximum height to which chorus fruits and nether portals can bring players within this dimension. (Must be lower than height)
 +
| 0-384.
 +
|-
 +
| coordinate_scale
 +
| TAG_Double
 +
| colspan="2"| The multiplier applied to coordinates when traveling to the dimension.
 +
| 0.00001 - 30000000.0
 +
|-
 +
| ultrawarm
 +
| TAG_Byte
 +
| colspan="2"| Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also causes lava to spread thinner.
 +
| 1: true, 0: false.
 +
|-
 +
| has_ceiling
 +
| TAG_Byte
 +
| colspan="2"| Whether the dimension has a bedrock ceiling or not. When true, causes lava to spread faster.
 +
| 1: true, 0: false.
 +
|}
 +
 +
Biome registry:
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| type
 +
| TAG_String
 +
| The name of the registry. Always "minecraft:worldgen/biome".
 +
|-
 +
| value
 +
| TAG_List
 +
| List of biome registry entries (see below).
 +
|}
 +
 +
Biome registry entry:
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| name
 +
| TAG_String
 +
| The name of the biome (for example, "minecraft:ocean").
 +
|-
 +
| id
 +
| TAG_Int
 +
| The protocol ID of the biome (matches the index of the element in the registry list).
 +
|-
 +
| element
 +
| TAG_Compound
 +
| The biome properties (see below).
 +
|}
 +
 +
Biome properties:
 +
 +
{| class="wikitable"
 +
! colspan="3"|Name
 +
! colspan="2"|Type
 +
!style="width: 250px;" colspan="2"| Meaning
 +
! colspan="2"|Values
 +
|-
 +
| colspan="3"|has_precipitation
 +
| colspan="2"|TAG_Byte
 +
| colspan="2"| Determines whether or not the biome has precipitation.
 +
| colspan="2"| 1: true, 0: false.
 +
|-
 +
| colspan="3"| depth
 +
| colspan="2"| Optional TAG_Float
 +
| colspan="2"| The depth factor of the biome.
 +
| colspan="2"| The default values vary between 1.5 and -1.8.
 +
|-
 +
| colspan="3"| temperature
 +
| colspan="2"| TAG_Float
 +
| colspan="2"| The temperature factor of the biome.
 +
| colspan="2"| The default values vary between 2.0 and -0.5.
 +
|-
 +
| colspan="3"| scale
 +
| colspan="2"| Optional TAG_Float
 +
| colspan="2"| ?
 +
| colspan="2"| The default values vary between 1.225 and 0.0.
 +
|-
 +
| colspan="3"| downfall
 +
| colspan="2"| TAG_Float
 +
| colspan="2"| ?
 +
| colspan="2"| The default values vary between 1.0 and 0.0.
 +
|-
 +
| colspan="3"| category
 +
| colspan="2"| Optional TAG_String
 +
| colspan="2"| The category of the biome.
 +
| colspan="2"| Known values are "ocean", "plains", "desert", "forest", "extreme_hills", "taiga", "swamp", "river", "nether", "the_end", "icy", "mushroom", "beach", "jungle", "mesa", "savanna", and "none".
 +
|-
 +
| colspan="3"| temperature_modifier
 +
| colspan="2"| Optional TAG_String
 +
| colspan="2"| ?
 +
| colspan="2"| The only known value is "frozen".
 +
|-
 +
| rowspan="13"| effects
 +
| colspan="2"| sky_color
 +
| rowspan="11"| TAG_Compound
 +
| TAG_Int
 +
| colspan="2"| The color of the sky.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| colspan="2"| water_fog_color
 +
| TAG_Int
 +
| colspan="2"| Possibly the tint color when swimming.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| colspan="2"| fog_color
 +
| TAG_Int
 +
| colspan="2"| Possibly the color of the fog effect when looking past the view distance.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| colspan="2"| water_color
 +
| TAG_Int
 +
| colspan="2"| The tint color of the water blocks.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| colspan="2"| foliage_color
 +
| Optional TAG_Int
 +
| colspan="2"| The tint color of the grass.
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| colspan="2"| grass_color
 +
| Optional TAG_Int
 +
| colspan="2"| ?
 +
| Example: 8364543, which is #7FA1FF in RGB.
 +
|-
 +
| colspan="2"| grass_color_modifier
 +
| Optional TAG_String
 +
| colspan="2"| Unknown, likely affects foliage color.
 +
| If set, known values are "swamp" and "dark_forest".
 +
|-
 +
| colspan="2"| music
 +
| Optional TAG_Compound
 +
| colspan="2"| Music properties for the biome.
 +
| If present, contains the fields: replace_current_music (TAG_Byte), sound (TAG_String), max_delay (TAG_Int), min_delay (TAG_Int).
 +
|-
 +
| colspan="2"| ambient_sound
 +
| Optional TAG_String
 +
| colspan="2"| Ambient soundtrack.
 +
| If present, the ID of a soundtrack. Example: "minecraft:ambient.basalt_deltas.loop".
 +
|-
 +
| colspan="2"| additions_sound
 +
| Optional TAG_Compound
 +
| colspan="2"| Additional ambient sound that plays randomly.
 +
| If present, contains the fields: sound (TAG_String), tick_chance (TAG_Double).
 +
|-
 +
| colspan="2"| mood_sound
 +
| Optional TAG_Compound
 +
| colspan="2"| Additional ambient sound that plays at an interval.
 +
| If present, contains the fields: sound (TAG_String), tick_delay (TAG_Int), offset (TAG_Double), block_search_extent (TAG_Int).
 +
|-
 +
| rowspan="2"| particle
 +
| probability
 +
| rowspan="2"| Optional TAG_Compound
 +
| TAG_FLOAT
 +
| rowspan="2"| Particles that appear randomly in the biome.
 +
| Possibly the probability of spawning the particle.
 +
| ?
 +
|-
 +
| options
 +
| TAG_COMPOUND
 +
| The properties of the particle to spawn.
 +
| Contains the field "type" (TAG_String), which identifies the particle type.
 +
|}
 +
 +
Chat registry:
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| type
 +
| TAG_String
 +
| The name of the registry. Always "minecraft:chat_type".
 +
|-
 +
| value
 +
| TAG_List
 +
| List of chat type registry entries (see below).
 +
|}
 +
 +
Chat type:
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| name
 +
| TAG_String
 +
| The type's name (eg "minecraft:chat")
 +
|-
 +
| id
 +
| TAG_Int
 +
|
 +
|-
 +
| elements
 +
| TAG_Compound
 +
| "chat" and "narration" TAG_Compound's (see below)
 +
|}
 +
 +
Chat type "chat" and "narration":
 +
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| translation_key
 +
| TAG_String
 +
|
 +
|-
 +
| style
 +
| TAG_Compound
 +
| Similar to Chat JSON (only present in "chat" TAG_Compound)
 +
|-
 +
| parameters
 +
| TAG_List of TAG_String
 +
| Values can be "sender", "target" and "content"
 +
|}
 +
 +
==== Resource Pack ====
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="5"| 0x06
 +
| rowspan="5"| Configuration
 +
| rowspan="5"| Client
 +
| URL
 +
| String (32767)
 +
| The URL to the resource pack.
 +
|-
 +
| Hash
 +
| String (40)
 +
| A 40 character hexadecimal and lowercase [[wikipedia:SHA-1|SHA-1]] hash of the resource pack file.<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
 +
|-
 +
| Forced
 +
| Boolean
 +
| The notchian client will be forced to use the resource pack from the server. If they decline they will be kicked from the server.
 +
|-
 +
| Has Prompt Message
 +
| Boolean
 +
| <code>true</code> If the next field will be sent <code>false</code> otherwise. When <code>false</code>, this is the end of the packet
 +
|-
 +
| Prompt Message
 +
| Optional [[Chat]]
 +
| This is shown in the prompt making the client accept or decline the resource pack.
 +
|}
 +
 +
==== Feature Flags ====
 +
 +
Used to enable and disable features, generally experimental ones, on the client.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x07
 +
| rowspan="2"| Configuration
 +
| rowspan="2"| Client
 +
| Total Features
 +
| VarInt
 +
| Number of features that appear in the array below.
 +
|-
 +
| Feature Flags
 +
| Identifier Array
 +
|
 +
|}
 +
 +
As of 23w31a, the following feature flags are available:
 +
 +
* minecraft:vanilla - enables vanilla features</li>
 +
* minecraft:bundle - enables support for the bundle</li>
 +
* minecraft:trade_rebalance - enables support for the rebalanced villager trades</li>
 +
 +
==== Update Tags ====
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="3"| 0x08
 +
| rowspan="3"| Configuration
 +
| rowspan="3"| Client
 +
| colspan="2"| Length of the array
 +
| colspan="2"| VarInt
 +
|
 +
|-
 +
| rowspan="2"| Array of tags
 +
| Tag type
 +
| rowspan="2"| Array
 +
| Identifier
 +
| Tag identifier (Vanilla required tags are <code>minecraft:block</code>, <code>minecraft:item</code>, <code>minecraft:fluid</code>, <code>minecraft:entity_type</code>, and <code>minecraft:game_event</code>)
 +
|-
 +
| Array of Tag
 +
| (See below)
 +
|
 +
|}
 +
 +
Tags look like:
 +
 +
{| class="wikitable"
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| colspan="2"| Length
 +
| colspan="2"| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| rowspan="3"| Tags
 +
| Tag name
 +
| rowspan="3"| Array
 +
| Identifier
 +
|
 +
|-
 +
| Count
 +
| VarInt
 +
| Number of elements in the following array
 +
|-
 +
| Entries
 +
| Array of VarInt
 +
| Numeric ID of the given type (block, item, etc.).
 +
|}
 +
 +
More information on tags is available at: https://minecraft.gamepedia.com/Tag
 +
 +
And a list of all tags is here: https://minecraft.gamepedia.com/Tag#List_of_tags
 +
 +
 +
=== Serverbound ===
 +
 +
==== Plugin Message (configuration) ====
 +
 +
{{Main|Plugin channels}}
 +
 +
Mods and plugins can use this to send their data. Minecraft itself uses the <code>minecraft:payload</code> channel to send many types of payloads, which are documented [[Plugin_channels|here]].
 +
 +
More documentation on this: [https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/ https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/]
 +
 +
Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="2"| 0x00
 +
| rowspan="2"| Configuration
 +
| rowspan="2"| Server
 +
| Channel
 +
| Identifier
 +
| Name of the [[plugin channel]] used to send the data.
 +
|-
 +
| Payload
 +
| Byte Array (32767)
 +
| Any data, depending on the channel. <code>minecraft:payload</code> payloads are documented [[plugin channel|here]]. The length of this array must be inferred from the packet length.
 +
|}
 +
 +
In Notchian server, the maximum data length is 32767 bytes.
 +
 +
==== Finish Configuration ====
 +
 +
Sent by the client to notify the client that all the configuration has finished. It is sent after the server sends its own [[#Finish_Configuration|Finish Configuration]].
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="1"| 0x01
 +
| rowspan="1"| Configuration
 +
| rowspan="1"| Server
 +
| colspan="3"| ''no fields''
 +
|}
 +
 +
==== Keep Alive (configuration) ====
 +
 +
The server will frequently send out a keep-alive (see [[#Keep Alive (configuration)|clientbound Keep Alive]]), each containing a random ID. The client must respond with the same packet.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x02
 +
| Configuration
 +
| Server
 +
| Keep Alive ID
 +
| Long
 +
|
 +
|}
 +
 +
==== Pong (configuration) ====
 +
 +
Response to the clientbound packet ([[#Ping (configuration)|Ping]]) with the same id.
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x03
 +
| Configuration
 +
| Server
 +
| ID
 +
| Int
 +
| id is the same as the ping packet
 +
|}
 +
 +
==== Resource Pack ====
 +
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| 0x04
 +
| Configuration
 +
| Server
 +
| Result
 +
| VarInt Enum
 +
| 0: successfully loaded, 1: declined, 2: failed download, 3: accepted.
 +
|}
  
  
 
[[Category:Minecraft Modern]]
 
[[Category:Minecraft Modern]]

Revision as of 23:30, 2 August 2023

This page documents the changes from the last stable Minecraft release (currently 1.20.1, protocol 763) to the current pre-release (currently 23w31a, protocol Snapshot 144). 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

Packets

ID Packet name Documentation
Configuration clientbound
0x00 Plugin Message (configuration) Pre
0x01 Disconnect (configuration) Pre
0x02 Finish Configuration Pre
0x03 Keep Alive (configuration) Pre
0x04 Ping (configuration) Pre
0x05 Registry Data Pre
0x06 Resource Pack (configuration) Pre
0x07 Feature Flags Pre
0x08 Update Tags Pre
Configuration serverbound
0x00 Plugin Message (configuration) Pre
0x01 Finish Configuration Pre
0x02 Keep Alive (configuration) Pre
0x03 Pong (configuration) Pre
0x04 Resource Pack Pre

New/modified data types

No changes so far.

Entity Metadata

No changes so far.

Entity

No changes so far.

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.

Status

Clientbound

No changes so far.

Serverbound

No changes so far.

Login

Clientbound

No changes so far.

Serverbound

No changes so far.

Configuration

Clientbound

Plugin Message (configuration)

Main article: Plugin channels

Mods and plugins can use this to send their data. Minecraft itself uses the minecraft:payload channel to send many types of payloads, which are documented here.

More documentation on this: https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/

Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.

Packet ID State Bound To Field Name Field Type Notes
0x00 Configuration Client Channel Identifier Name of the plugin channel used to send the data.
Payload Byte Array (1048576) Any data, depending on the channel. minecraft:payload payloads are documented here. The length of this array must be inferred from the packet length.

In Notchian client, the maximum data length is 1048576 bytes.

Disconnect (configuration)

Packet ID State Bound To Field Name Field Type Notes
0x01 Configuration Client Reason Chat The reason why the player was disconnected.

Finish Configuration

Sent by the server to notify the client that all the configuration has finish. The client answers with its own Finish Configuration whenever it is ready to continue.

Packet ID State Bound To Field Name Field Type Notes
0x02 Configuration Client no fields

Keep Alive (configuration)

The server will frequently send out a keep-alive, each containing a random ID. The client must respond with the same payload (see serverbound Keep Alive). If the client does not respond to them for over 30 seconds, the server kicks the client. Vice versa, if the server does not send any keep-alives for 20 seconds, the client will disconnect and yields a "Timed out" exception.

The Notchian server uses a system-dependent time in milliseconds to generate the keep alive ID value.

Packet ID State Bound To Field Name Field Type Notes
0x03 Configuration Client Keep Alive ID Long

Ping (configuration)

Packet is not used by the Notchian server. When sent to the client, client responds with a Pong packet with the same id.

Packet ID State Bound To Field Name Field Type Notes
0x04 Configuration Client ID Int

Registry Data

Represents certain registries that are sent from the server and are applied on the client.

Packet ID State Bound To Field Name Field Type Notes
0x05 Configuration Client Registry Codec NBT Tag Compound Information included below.


The Registry Codec NBT Tag Compound (Default value in JSON as of 1.19, 1.19.2, 1.20.1) includes three registries: "minecraft:dimension_type", "minecraft:worldgen/biome", and "minecraft:chat_type".

Name Type Notes
minecraft:dimension_type TAG_Compound The dimension type registry (see below).
minecraft:worldgen/biome TAG_Compound The biome registry (see below).
minecraft:chat_type TAG_Compound The chat type registry (see below).

Dimension type registry:

Name Type Notes
type TAG_String The name of the registry. Always "minecraft:dimension_type".
value TAG_List List of dimension types registry entries (see below).

Dimension type registry entry:

Name Type Notes
name TAG_String The name of the dimension type (for example, "minecraft:overworld").
id TAG_Int The protocol ID of the dimension (matches the index of the element in the registry list).
element TAG_Compound The dimension type (see below).

Dimension type:

Name Type Meaning Values
piglin_safe TAG_Byte Whether piglins shake and transform to zombified piglins. 1: true, 0: false.
has_raids TAG_Byte Whether players with the Bad Omen effect can cause a raid. 1: true, 0: false.
monster_spawn_light_level TAG_Int or TAG_Compound Possibly the light level(s) at which monsters can spawn. When TAG_Int, 0 - 15. When TAG_Compound, contains the fields: type (TAG_String), appears to be always "minecraft:uniform", and value (TAG_Compound), which contains the fields: max_inclusive (TAG_Int), min_inclusive (TAG_Int).
monster_spawn_block_light_limit TAG_Int
natural TAG_Byte When false, compasses spin randomly. When true, nether portals can spawn zombified piglins. 1: true, 0: false.
ambient_light TAG_Float How much light the dimension has. 0.0 to 1.0.
fixed_time Optional TAG_Long If set, the time of the day is the specified value. If set, 0 to 24000.
infiniburn TAG_String A resource location defining what block tag to use for infiniburn. "#" or minecraft resource "#minecraft:...".
respawn_anchor_works TAG_Byte Whether players can charge and use respawn anchors. 1: true, 0: false.
has_skylight TAG_Byte Whether the dimension has skylight access or not. 1: true, 0: false.
bed_works TAG_Byte Whether players can use a bed to sleep. 1: true, 0: false.
effects TAG_String ? "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" or something else.
min_y TAG_Int The minimum Y level. A multiple of 16. Example: -64
height TAG_Int The maximum height. A multiple of 16. Example: 256
logical_height TAG_Int The maximum height to which chorus fruits and nether portals can bring players within this dimension. (Must be lower than height) 0-384.
coordinate_scale TAG_Double The multiplier applied to coordinates when traveling to the dimension. 0.00001 - 30000000.0
ultrawarm TAG_Byte Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also causes lava to spread thinner. 1: true, 0: false.
has_ceiling TAG_Byte Whether the dimension has a bedrock ceiling or not. When true, causes lava to spread faster. 1: true, 0: false.

Biome registry:

Name Type Notes
type TAG_String The name of the registry. Always "minecraft:worldgen/biome".
value TAG_List List of biome registry entries (see below).

Biome registry entry:

Name Type Notes
name TAG_String The name of the biome (for example, "minecraft:ocean").
id TAG_Int The protocol ID of the biome (matches the index of the element in the registry list).
element TAG_Compound The biome properties (see below).

Biome properties:

Name Type Meaning Values
has_precipitation TAG_Byte Determines whether or not the biome has precipitation. 1: true, 0: false.
depth Optional TAG_Float The depth factor of the biome. The default values vary between 1.5 and -1.8.
temperature TAG_Float The temperature factor of the biome. The default values vary between 2.0 and -0.5.
scale Optional TAG_Float ? The default values vary between 1.225 and 0.0.
downfall TAG_Float ? The default values vary between 1.0 and 0.0.
category Optional TAG_String The category of the biome. Known values are "ocean", "plains", "desert", "forest", "extreme_hills", "taiga", "swamp", "river", "nether", "the_end", "icy", "mushroom", "beach", "jungle", "mesa", "savanna", and "none".
temperature_modifier Optional TAG_String ? The only known value is "frozen".
effects sky_color TAG_Compound TAG_Int The color of the sky. Example: 8364543, which is #7FA1FF in RGB.
water_fog_color TAG_Int Possibly the tint color when swimming. Example: 8364543, which is #7FA1FF in RGB.
fog_color TAG_Int Possibly the color of the fog effect when looking past the view distance. Example: 8364543, which is #7FA1FF in RGB.
water_color TAG_Int The tint color of the water blocks. Example: 8364543, which is #7FA1FF in RGB.
foliage_color Optional TAG_Int The tint color of the grass. Example: 8364543, which is #7FA1FF in RGB.
grass_color Optional TAG_Int ? Example: 8364543, which is #7FA1FF in RGB.
grass_color_modifier Optional TAG_String Unknown, likely affects foliage color. If set, known values are "swamp" and "dark_forest".
music Optional TAG_Compound Music properties for the biome. If present, contains the fields: replace_current_music (TAG_Byte), sound (TAG_String), max_delay (TAG_Int), min_delay (TAG_Int).
ambient_sound Optional TAG_String Ambient soundtrack. If present, the ID of a soundtrack. Example: "minecraft:ambient.basalt_deltas.loop".
additions_sound Optional TAG_Compound Additional ambient sound that plays randomly. If present, contains the fields: sound (TAG_String), tick_chance (TAG_Double).
mood_sound Optional TAG_Compound Additional ambient sound that plays at an interval. If present, contains the fields: sound (TAG_String), tick_delay (TAG_Int), offset (TAG_Double), block_search_extent (TAG_Int).
particle probability Optional TAG_Compound TAG_FLOAT Particles that appear randomly in the biome. Possibly the probability of spawning the particle. ?
options TAG_COMPOUND The properties of the particle to spawn. Contains the field "type" (TAG_String), which identifies the particle type.

Chat registry:

Name Type Notes
type TAG_String The name of the registry. Always "minecraft:chat_type".
value TAG_List List of chat type registry entries (see below).

Chat type:

Name Type Notes
name TAG_String The type's name (eg "minecraft:chat")
id TAG_Int
elements TAG_Compound "chat" and "narration" TAG_Compound's (see below)

Chat type "chat" and "narration":

Name Type Notes
translation_key TAG_String
style TAG_Compound Similar to Chat JSON (only present in "chat" TAG_Compound)
parameters TAG_List of TAG_String Values can be "sender", "target" and "content"

Resource Pack

Packet ID State Bound To Field Name Field Type Notes
0x06 Configuration 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.
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 resource pack from the server. If they decline they will be kicked from the server.
Has Prompt Message Boolean true If the next field will be sent false otherwise. When false, this is the end of the packet
Prompt Message Optional Chat This is shown in the prompt making the client accept or decline the resource pack.

Feature Flags

Used to enable and disable features, generally experimental ones, on the client.

Packet ID State Bound To Field Name Field Type Notes
0x07 Configuration Client Total Features VarInt Number of features that appear in the array below.
Feature Flags Identifier Array

As of 23w31a, the following feature flags are available:

  • minecraft:vanilla - enables vanilla features
  • minecraft:bundle - enables support for the bundle
  • minecraft:trade_rebalance - enables support for the rebalanced villager trades

Update Tags

Packet ID State Bound To Field Name Field Type Notes
0x08 Configuration Client Length of the array VarInt
Array of tags Tag type Array Identifier Tag identifier (Vanilla required tags are minecraft:block, minecraft:item, minecraft:fluid, minecraft:entity_type, and minecraft:game_event)
Array of Tag (See below)

Tags look like:

Field Name Field Type Notes
Length VarInt Number of elements in the following array
Tags Tag name Array Identifier
Count VarInt Number of elements in the following array
Entries Array of VarInt Numeric ID of the given type (block, item, etc.).

More information on tags is available at: https://minecraft.gamepedia.com/Tag

And a list of all tags is here: https://minecraft.gamepedia.com/Tag#List_of_tags


Serverbound

Plugin Message (configuration)

Main article: Plugin channels

Mods and plugins can use this to send their data. Minecraft itself uses the minecraft:payload channel to send many types of payloads, which are documented here.

More documentation on this: https://dinnerbone.com/blog/2012/01/13/minecraft-plugin-channels-messaging/

Note that the length of Data is known only from the packet length, since the packet has no length field of any kind.

Packet ID State Bound To Field Name Field Type Notes
0x00 Configuration Server Channel Identifier Name of the plugin channel used to send the data.
Payload Byte Array (32767) Any data, depending on the channel. minecraft:payload payloads are documented here. The length of this array must be inferred from the packet length.

In Notchian server, the maximum data length is 32767 bytes.

Finish Configuration

Sent by the client to notify the client that all the configuration has finished. It is sent after the server sends its own Finish Configuration.

Packet ID State Bound To Field Name Field Type Notes
0x01 Configuration Server no fields

Keep Alive (configuration)

The server will frequently send out a keep-alive (see clientbound Keep Alive), each containing a random ID. The client must respond with the same packet.

Packet ID State Bound To Field Name Field Type Notes
0x02 Configuration Server Keep Alive ID Long

Pong (configuration)

Response to the clientbound packet (Ping) with the same id.

Packet ID State Bound To Field Name Field Type Notes
0x03 Configuration Server ID Int id is the same as the ping packet

Resource Pack

Packet ID State Bound To Field Name Field Type Notes
0x04 Configuration Server Result VarInt Enum 0: successfully loaded, 1: declined, 2: failed download, 3: accepted.
Retrieved from "https://wiki.vg/index.php?title=Pre-release_protocol&oldid=18327"