People very, very often have questions regarding the Minecraft Modern Protocol, so we'll try to address some of the most common ones on this document. If you're still having trouble, join us on IRC, channel #mcdevs on irc.libera.chat.
- 1 Is the protocol documentation complete?
- 2 What's the normal login sequence for a client?
- 3 What does the normal status ping sequence look like?
- 4 Offline mode
- 5 I think I've done everything right, but…
- 5.1 …my player isn't spawning!
- 5.2 …my client isn't receiving complete map chunks!
- 5.3 …all connecting clients spasm and jerk uncontrollably!
- 5.4 …the client is trying to send an invalid packet that begins with 0xFE01
- 5.5 …the client disconnects after some time with a "Timed out" error
- 5.6 ...my client isn't sending a Login Start packet!
- 6 How do I open/save a command block?
Is the protocol documentation complete?
Depending on your definition, yes! All packet types are known and their layout documented. Some finer details are missing, but everything you need to make functional programs is present. We also collect information on the pre-release protocol changes, allowing us to quickly document new releases.
What's the normal login sequence for a client?
See Authentication for communication with Mojang's servers.
The recommended login sequence looks like this, where C is the client and S is the server:
- Client connects to the server
- C→S: Handshake State=2
- C→S: Login Start
- S→C: Encryption Request
- Client auth
- C→S: Encryption Response
- Server auth, both enable encryption
- S → C: Set Compression (Optional, enables compression)
- S → C: Login Success
- C → S: Login Acknowledged
- S → C: Login (play)
- S → C: Plugin Message:
minecraft:brandwith the server's brand (Optional)
- S → C: Change Difficulty (Optional)
- S → C: Player Abilities (Optional)
- C → S: Plugin Message:
minecraft:brandwith the client's brand (Optional)
- C → S: Client Information
- S → C: Set Held Item
- S → C: Update Recipes
- S → C: Update Tags
- S → C: Entity Event (for the ; see Entity statuses#Player)
- S → C: Commands
- S → C: Recipe
- S → C: Player Position
- S → C: Player Info (Add Player action)
- S → C: Player Info (Update latency action)
- S → C: Set Center Chunk
- S → C: Light Update (One sent for each chunk in a square centered on the player's position)
- S → C: Chunk Data and Update Light (One sent for each chunk in a square centered on the player's position)
- S → C: Initialize World Border (Once the world is finished loading)
- S → C: Set Default Spawn Position (“home” spawn, not where the client will spawn on login)
- S → C: Synchronize Player Position (Required, tells the client they're ready to spawn)
- C → S: Confirm Teleportation
- C → S: Set Player Position and Rotation (to confirm the spawn position)
- C → S: Client Command (sent either before or while receiving chunks, further testing needed, server handles correctly if not sent)
- S → C: inventory, entities, etc
What does the normal status ping sequence look like?
When a Notchian client and server exchange information in a status ping, the exchange of packets will be as follows:
- C → S: Handshake with Next State set to 1 (Status)
- Client and Server set protocol state to Status.
- C → S: Status Request
- S → C: Status Response
- C → S: Ping Request
- S → C: Pong Response
- Both sides close the connection
(Note that C is the Notchian client and S is the Notchian server).
If the server is in offline mode, it will not send the Encryption Request packet, and likewise, the client should not send Encryption Response. In this case, encryption is never enabled, and no authentication is performed.
I think I've done everything right, but…
…my player isn't spawning!
The Minecraft client will wait at the "Loading Terrain..." screen until late in the login sequence. At the time of writing (version 1.20.2), the server must send the Set Default Spawn Position before the client will spawn the player and the player must be either in the loaded chunk (sent via Chunk Data and Update Light) or below the minimum world height or above the maximum world height (teleported via Synchronize Player Position). In past versions, you could either (1.19.3 through 1.20.1) send the default spawn position packet or (pre-1.19.3) send the player position packet. In general, try sending packets that inform the client about the player's position in the world in order to get past the loading terrain screen.
As of 1.20.2, the minimum packets that need to be received and sent by the server in order to get the client past the loading terrain screen and into the world appear to be:
- Receive Handshake
- Receive Login Start
- Send Login Success
- Receive Login Acknowledged
- Send Registry Data (Configuration)
- Send Finish Configuration (Clientbound)
- Receive Finish Configuration (Serverbound)
- Send Login (Play)
- Send Chunk Data and Update Light and/or Synchronize Player Position (see above)
- Send Set Default Spawn Position
The most difficult part of this may be sending any necessary NBTs in the [Protocol#Registry_Data|Registry Data] packet. You will probably need to record one from the standard server and replay it. Or you can find someone who has done that already, for example in the PrismarineJS/minecraft-data repo on GitHub. Then you'll need to transform the JSON representation to binary NBT.
…my client isn't receiving complete map chunks!
Main article: How to Write a Client
…all connecting clients spasm and jerk uncontrollably!
For newer clients, your server needs to send 49 chunks ahead of time, not just one. Send a 7×7 square of chunks, centered on the connecting client's position, before spawning them.
…the client is trying to send an invalid packet that begins with 0xFE01
…the client disconnects after some time with a "Timed out" error
The server is expected to send a Keep Alive packet every 1-15 seconds (if the server does not send a keep alive within 20 seconds of state change to Play, the client will disconnect from the server for Timed Out), and the client should respond with the serverbound version of that packet. If either party does not receive keep alives for some period of time, they will disconnect.
...my client isn't sending a Login Start packet!
By default, the Notchian server and client may group packets depending on if Nagle's TCP algorithm is enabled - the primary objective of Nagle's algorithm is to reduce the total number of packets needed to be sent over the network, increasing the efficiency. Nagle's algorithm is achieved by delaying each TCP packet to check if there are any more that are about to be sent to group them. You may not see a Login Start packet as you may not have parsed anything past the packet's length, because of this, you'll need to separate packets based off of the packet length.
How do I open/save a command block?
The process to actually open the command block window clientside is somewhat complex; the client actually uses the Update Block Entity (0x09) packet to open it.
First, the client must have at least an Entity Status packet)of 2, or else the client will refuse to open the command block. (The op permission level is set with the
To actually open the command block:
- C→S: Player Block Placement (0x1C), with the position being the command block that was right-clicked.
- S→C: Update Block Entity (0x09), with the NBT of the command block.
And to save it, use the
MC|AutoCmd plugin channel.