Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
(Close Window and Click Window are the same, the new slot is number 45 and there isn't a new mode for the new key (it does nothing in the inventory).)
(Updated to 1.21-pre2)
 
Line 1: Line 1:
−
This page documents the changes from the [[Protocol|last stable Minecraft release]] (currently [[Protocol version numbers|1.8.8, protocol 47]]) to the current pre-release (currently [[Protocol version numbers|15w31a, protocol 49]]). 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.
  
−
== Protocol history ==
+
== Contents ==
  
−
None so far.
+
<div style="float:right;">__TOC__</div>
  
−
== New/modified data types ==
+
=== Data types ===
  
−
None so far.
+
No changes documented so far.
  
−
== Handshaking ==
+
=== Packets ===
−
 
 
−
=== Clientbound ===
 
−
 
 
−
No changes so far.
 
−
 
 
−
=== Serverbound ===
 
−
 
 
−
==== Handshake ====
 
−
 
 
−
This causes the server to switch into the target state.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
−
  ! Packet ID
+
  ! ID
−
  ! State
+
  ! Packet name
−
! Bound To
+
  !colspan="2"| Documentation
−
! Field Name
 
−
! Field Type
 
−
  ! Notes
 
 
  |-
 
  |-
−
  |rowspan="4"| 0x00
+
  !colspan="4"| Configuration clientbound
−
  |rowspan="4"| Handshaking
+
  {{PacketList|0x0F|Clientbound Report Details (configuration)|rel=added}}
−
|rowspan="4"| Server
+
  {{PacketList|0x10|Clientbound Server Links (configuration)|rel=added}}
−
  | Protocol Version
 
−
| VarInt
 
−
| See [[protocol version numbers]] (currently {{Change|47|49}})
 
 
  |-
 
  |-
−
  | Server Address
+
  !colspan="4"| Play clientbound
−
  | String
+
  {{PacketList|0x7A|Clientbound Report Details (play)|rel=added}}
−
| hostname or IP, e.g. localhost or 127.0.0.1<!-- does this support IPv6? -->
+
  {{PacketList|0x7B|Clientbound Server Links (play)|rel=added}}
−
  |-
 
−
| Server Port
 
−
| Unsigned Short
 
−
| default is 25565
 
 
  |-
 
  |-
−
| Next State
+
|}
−
| VarInt
 
−
| 1 for [[#Status|status]], 2 for [[#Login|login]]
 
−
|}
 
−
 
 
−
== Play ==
 
  
−
=== Clientbound ===
+
== Handshake ==
  
 
No changes so far.
 
No changes so far.
  
−
=== Serverbound ===
+
== Status ==
  
−
==== Player Digging ====
+
No changes so far.
  
−
Sent when the player mines a block. A Notchian server only accepts digging packets with coordinates within a 6-unit radius of the player's position.
+
== Login ==
  
−
{| class="wikitable"
+
No changes so far.
−
! Packet ID
 
−
! State
 
−
! Bound To
 
−
! Field Name
 
−
! Field Type
 
−
! Notes
 
−
|-
 
−
|rowspan="3"| 0x07
 
−
|rowspan="3"| Play
 
−
|rowspan="3"| Server
 
−
| Status
 
−
| Byte
 
−
| The action the player is taking against the block (see below)
 
−
|-
 
−
| Location
 
−
| Position
 
−
| Block position
 
−
|-
 
−
| Face
 
−
| Byte
 
−
| The face being hit (see below)
 
−
|}
 
  
−
Status can (currently) be one of six values:
+
== Configuration ==
  
−
{| class="wikitable"
+
=== Clientbound ===
−
! Meaning
 
−
! Value
 
−
|-
 
−
| Started digging
 
−
| <code>0</code>
 
−
|-
 
−
| Cancelled digging
 
−
| <code>1</code>
 
−
|-
 
−
| Finished digging
 
−
| <code>2</code>
 
−
|-
 
−
| Drop item stack
 
−
| <code>3</code>
 
−
|-
 
−
| Drop item
 
−
| <code>4</code>
 
−
|-
 
−
| Shoot arrow / finish eating
 
−
| <code>5</code>
 
−
|-
 
−
| Swap item in Hand
 
−
| <code>6</code>
 
−
|}
 
−
 
 
−
Notchian clients send a 0 (started digging) when they start digging and a 2 (finished digging) once they think they are finished. If digging is aborted, the client simply send a 1 (cancel digging).
 
−
 
 
−
Status code 4 (drop item) is a special case. In-game, when you use the Drop Item command (keypress 'q'), a dig packet with a status of 4, and all other values set to 0, is sent from client to server. Status code 3 is similar, but drops the entire stack.
 
−
 
 
−
Status code 5 (shoot arrow / finish eating) is also a special case. The x, y and z fields are all set to 0 like above, with the exception of the face field, which is set to 255.
 
  
−
Status code 6 is another special case. Used to swap or assign an item to the second hand. The rest of the fields (x, y, z and face) are all set to 0.
+
==== Clientbound Report Details (configuration) ====
  
−
The face can be one of six values, representing the face being hit:
+
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}}
−
|-
 
−
! Value
 
−
| 0
 
−
| 1
 
−
| 2
 
−
| 3
 
−
| 4
 
−
| 5
 
−
|-
 
−
! Offset
 
−
| -Y
 
−
| +Y
 
−
| -Z
 
−
| +Z
 
−
| -X
 
−
| +X
 
−
|}
 
−
 
 
−
 
 
−
==== Held Item Change ====
 
−
 
 
−
Sent when the player changes the slot selection
 
−
 
 
−
{| class="wikitable"
 
 
  ! 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="1"| {{Change|0x09|0x0A}}
+
  | rowspan="3"| 0x0F
−
  |rowspan="1"| Play
+
| rowspan="3"| Configuration
−
  |rowspan="1"| Server
+
| rowspan="3"| Client
−
  | Slot
+
| colspan="2"| Details Count
−
  | Short
+
| colspan="2"| {{Type|VarInt}} (32)
−
  | The slot which the player has selected (0–8)
+
| The number of details in the following array.
−
  |}
+
|-
 +
  | rowspan="2"| Details
 +
| Title
 +
  | rowspan="2"| {{Type|Array}}
 +
  | {{Type|String}} (128)
 +
  |
 +
  |-
 +
| Description
 +
| {{Type|String}} (4096)
 +
  |
 +
|}
  
 +
==== Clientbound Server Links (configuration) ====
  
−
==== Animation ====
+
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).
  
−
Sent when the player's arm swings
+
{| class="wikitable" {{added}}
−
 
 
−
{| class="wikitable"
 
 
  ! 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="1"| {{Change|0x0A|0x0B}}
+
  | rowspan="4"| 0x10
−
  |rowspan="1"| Play
+
  | rowspan="4"| Configuration
−
  |rowspan="1"| Server
+
  | rowspan="4"| Client
−
  | Hand
+
  | colspan="2"| Links Count
−
| Byte
+
  | colspan="2"| {{Type|VarInt}}
−
| Hand used for the animation.
+
  | The number of links in the following array.
−
  |}
 
−
 
 
−
 
 
−
==== Entity Action ====
 
−
 
 
−
Sent at least when crouching, leaving a bed, or sprinting. To send action animation to client use 0x28. The client will send this with Action ID = 3 when “Leave Bed” is clicked.
 
−
 
 
−
{| class="wikitable"
 
−
! Packet ID
 
−
! State
 
−
! Bound To
 
−
! Field Name
 
−
! Field Type
 
−
  ! Notes
 
 
  |-
 
  |-
−
  |rowspan="3"| {{Change|0x0B|0x0C}}
+
  | rowspan="3"| Links
−
  |rowspan="3"| Play
+
  | Is built-in
−
  |rowspan="3"| Server
+
  | rowspan="3"| {{Type|Array}}
−
  | Entity ID
+
  | {{Type|Boolean}}
−
| VarInt
+
  | Determines if the following label is built-in (from enum) or custom (text component).
−
  | Player ID
 
 
  |-
 
  |-
−
  | Action ID
+
  | Label
−
  | VarInt
+
  | {{Type|VarInt}} {{Type|Enum}} / {{Type|Text Component}}
−
  | The ID of the action, see below
+
  | See below.
 
  |-
 
  |-
−
  | Jump Boost
+
  | URL
−
  | VarInt
+
  | {{Type|String}}
−
  | Horse jump boost. Ranged from 0 -> 100.
+
  | Valid URL.
−
|}
+
|}
  
−
Action ID can be one of the following values:
 
  
−
{| class="wikitable"
+
{| class="wikitable" {{added}}
 
  ! ID
 
  ! ID
−
  ! Action
+
  ! Name
 +
! Notes
 
  |-
 
  |-
 
  | 0
 
  | 0
−
  | Crouch
+
  | Bug Report
 +
| Displayed on connection error screen; included as a comment in the disconnection report.
 
  |-
 
  |-
 
  | 1
 
  | 1
−
  | Uncrouch
+
  | Community Guidelines
 +
|
 
  |-
 
  |-
 
  | 2
 
  | 2
−
  | Leave bed
+
  | Support
 +
|
 
  |-
 
  |-
 
  | 3
 
  | 3
−
  | Start sprinting
+
  | Status
 +
|
 
  |-
 
  |-
 
  | 4
 
  | 4
−
  | Stop sprinting
+
  | Feedback
 +
|
 
  |-
 
  |-
 
  | 5
 
  | 5
−
  | Jump with horse
+
  | Community
 +
|
 +
|-
 +
| 6
 +
| Website
 +
|
 +
|-
 +
| 7
 +
| Forums
 +
|
 +
|-
 +
| 8
 +
| News
 +
|
 +
|-
 +
| 9
 +
| Announcements
 +
|
 
  |-
 
  |-
−
| <Strike>6</Strike>
 
−
| <Strike>Open inventory</Strike>
 
 
  |}
 
  |}
  
 +
=== Serverbound ===
  
−
==== Steer Vehicle ====
+
No changes so far.
  
−
{| class="wikitable"
+
== Play ==
−
! Packet ID
 
−
! State
 
−
! Bound To
 
−
! Field Name
 
−
! Field Type
 
−
! Notes
 
−
|-
 
−
|rowspan="3"| {{Change|0x0C|0x0D}}
 
−
|rowspan="3"| Play
 
−
|rowspan="3"| Server
 
−
| Sideways
 
−
| Float
 
−
| Positive to the left of the player
 
−
|-
 
−
| Forward
 
−
| Float
 
−
| Positive forward
 
−
|-
 
−
| Flags
 
−
| Unsigned Byte
 
−
| Bit mask. 0x1: jump, 0x2: unmount
 
−
|}
 
  
−
==== Close Window ====
+
=== Clientbound ===
  
−
This packet is sent by the client when closing a window.
+
==== Clientbound Report Details (play) ====
  
−
Note, Notchian clients send a close window message with Window ID 0 to close their inventory even though there is never an Open Window message for inventory.
+
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
 
  |-
 
  |-
−
  | {{Change|0x0D|0x0E}}
+
  | rowspan="3"| 0x7A
−
  |rowspan="1"| Play
+
| rowspan="3"| Configuration
−
  |rowspan="1"| Server
+
| rowspan="3"| Client
−
  | Window ID
+
| colspan="2"| Details Count
−
  | Unsigned Byte
+
| colspan="2"| {{Type|VarInt}} (32)
−
  | This is the ID of the window that was closed. 0 for inventory.
+
| The number of details in the following array.
−
  |}
+
|-
 +
  | rowspan="2"| Details
 +
| Title
 +
  | rowspan="2"| {{Type|Array}}
 +
| {{Type|String}} (128)
 +
|
 +
  |-
 +
  | Description
 +
  | {{Type|String}} (4096)
 +
  |
 +
|}
  
−
==== Click Window ====
+
==== Clientbound Server Links (play) ====
  
−
This packet is sent by the player when it clicks on a slot in a window.
+
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
 
  ! Notes
 
  |-
 
  |-
−
  |rowspan="6"| {{Change|0x0E|0x0F}}
+
  | rowspan="4"| 0x7B
−
  |rowspan="6"| Play
+
  | rowspan="4"| Configuration
−
  |rowspan="6"| Server
+
  | rowspan="4"| Client
−
  | Window ID
+
  | colspan="2"| Links Count
−
  | Unsigned Byte
+
  | colspan="2"| {{Type|VarInt}}
−
  | The ID of the window which was clicked. 0 for player inventory.
+
  | The number of links in the following array.
 
  |-
 
  |-
−
  | Slot
+
  | rowspan="3"| Links
−
  | Short
+
| Is built-in
−
  | The clicked slot Nr., see below
+
| rowspan="3"| {{Type|Array}}
 +
  | {{Type|Boolean}}
 +
  | Determines if the following label is built-in (from enum) or custom (text component).
 
  |-
 
  |-
−
  | Button
+
  | Label
−
  | Byte
+
  | {{Type|VarInt}} {{Type|Enum}} / {{Type|Text Component}}
−
  | The button used in the click, see below
+
  | See below.
 
  |-
 
  |-
−
  | Action Number
+
  | URL
−
  | Short
+
  | {{Type|String}}
−
| A unique number for the action, implemented by Notchian as a counter, starting at 1. Used by the server to send back a [[#Confirm Transaction|Confirm Transaction]].
+
  | Valid URL.
−
|-
+
|}
−
  | Mode
 
−
| Byte
 
−
| Inventory operation mode, see below
 
−
|-
 
−
| Clicked item
 
−
| [[Slot Data|Slot]]
 
−
| The clicked slot. Has to be empty (item ID = -1) for drop mode.
 
−
|}
 
  
−
See [[Inventory#Windows|inventory windows]] for further information about how slots are indexed.
+
{| class="wikitable" {{added}}
−
 
+
  ! ID
−
When right-clicking on a stack of items, half the stack will be picked up and half left in the slot. If the stack is an odd number, the half left in the slot will be smaller of the amounts.
+
  ! Name
−
 
+
  ! Notes
−
The distinct type of click performed by the client is determined by the combination of the Mode and Button fields.
 
−
 
 
−
{| class="wikitable"
 
−
  ! Mode
 
−
! Button
 
−
  ! Slot
 
−
  ! Trigger
 
 
  |-
 
  |-
−
!rowspan="2"| 0
 
 
  | 0
 
  | 0
−
  | Normal
+
  | Bug Report
−
  | Left mouse click
+
  | Displayed on connection error screen; included as a comment in the disconnection report.
 
  |-
 
  |-
 
  | 1
 
  | 1
−
  | Normal
+
  | Community Guidelines
−
  | Right mouse click
+
  |  
 
  |-
 
  |-
−
  !rowspan="2"| 1
+
  | 2
−
| 0
+
  | Support
−
  | Normal
+
  |  
−
  | Shift + left mouse click
 
 
  |-
 
  |-
−
  | 1
+
  | 3
−
  | Normal
+
  | Status
−
  | Shift + right mouse click ''(identical behavior)''
+
  |  
 
  |-
 
  |-
−
  !rowspan="5"| 2
+
  | 4
−
  | 0
+
  | Feedback
−
  | Normal
+
  |  
−
| Number key 1
 
 
  |-
 
  |-
−
  | 1
+
  | 5
−
  | Normal
+
  | Community
−
  | Number key 2
+
  |  
 
  |-
 
  |-
−
  | 2
+
  | 6
−
  | Normal
+
  | Website
−
  | Number key 3
+
  |  
 
  |-
 
  |-
−
  | ⋮
+
  | 7
−
  | ⋮
+
  | Forums
−
  | ⋮
+
  |  
 
  |-
 
  |-
 
  | 8
 
  | 8
−
  | Normal
+
  | News
−
  | Number key 9
+
  |  
−
|-
 
−
!rowspan="1"| 3
 
−
| 2
 
−
| Normal
 
−
| Middle click
 
−
|-
 
−
!rowspan="4"| 4
 
−
| 0
 
−
| Normal*
 
−
| Drop key (Q) (* Clicked item is different, see above)
 
 
  |-
 
  |-
−
  | 1
+
  | 9
−
  | Normal*
+
  | Announcements
−
  | Ctrl + Drop key (Ctrl-Q) ''(drops full stack)''
+
  |  
 
  |-
 
  |-
−
| 0
 
−
| -999
 
−
| Left click outside inventory holding nothing ''(no-op)''
 
−
|-
 
−
| 1
 
−
| -999
 
−
| Right click outside inventory holding nothing ''(no-op)''
 
−
|-
 
−
!rowspan="6"| 5
 
−
| 0
 
−
| -999
 
−
| Starting left mouse drag ''(or middle mouse)''
 
−
|-
 
−
| 4
 
−
| -999
 
−
| Starting right mouse drag
 
−
|-
 
−
| 1
 
−
| Normal
 
−
| Add slot for left-mouse drag
 
−
|-
 
−
| 5
 
−
| Normal
 
−
| Add slot for right-mouse drag
 
−
|-
 
−
| 2
 
−
| -999
 
−
| Ending left mouse drag
 
−
|-
 
−
| 6
 
−
| -999
 
−
| Ending right mouse drag
 
−
|-
 
−
! 6
 
−
| 0
 
−
| Normal
 
−
| Double click
 
 
  |}
 
  |}
−
 
−
Starting from version 1.5, “painting mode” is available for use in inventory windows. It is done by picking up stack of something (more than 1 item), then holding mouse button (left, right or middle) and dragging held stack over empty (or same type in case of right button) slots. In that case client sends the following to server after mouse button release (omitting first pickup packet which is sent as usual):
 
−
 
−
# packet with mode 5, slot -999, button (0 for left | 4 for right);
 
−
# packet for every slot painted on, mode is still 5, button (1 | 5);
 
−
# packet with mode 5, slot -999, button (2 | 6);
 
−
 
−
If any of the painting packets other than the “progress” ones are sent out of order (for example, a start, some slots, then another start; or a left-click in the middle) the painting status will be reset.
 
−
 
−
The server will send back a [[#Confirm Transaction_2|Confirm Transaction]] packet. If the click was not accepted, the client must reflect that packet before sending more [[#Click Window|Click Window]] packets, otherwise the server will reject them silently. The Notchian server also sends a [[#Window Items|Window Items]] packet for the open window and [[#Set Slot|Set Slot]] packets for the clicked and cursor slot, but only when the click was not accepted, probably to resynchronize client and server.
 
−
 
−
== Status ==
 
−
 
−
=== Clientbound ===
 
−
 
−
No changes so far.
 
  
 
=== Serverbound ===
 
=== Serverbound ===
Line 456: Line 279:
 
No changes so far.
 
No changes so far.
  
−
== Login ==
+
[[Category:Minecraft Modern]]
−
 
 
−
=== Clientbound ===
 
−
 
 
−
No changes so far.
 
−
 
 
−
=== Serverbound ===
 
−
 
 
−
No changes so far.
 

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"