Protocol FAQ

From wiki.vg
Revision as of 09:06, 24 October 2016 by C4K3 (talk | contribs) (I think I've done everything right, but…: typo)
Jump to: navigation, search

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.freenode.net.

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.

Warning.png Information might not be totally up to date

The recommended login sequence looks like this, where C is the client and S is the server:

  1. Client connects to server
  2. C→S: Handshake State=2
  3. C→S: Login Start
  4. S→C: Encryption Request
  5. Client auth
  6. C→S: Encryption Response
  7. Server auth, both enable encryption
  8. S→C: Login Success
  9. S→C: Join Game
  10. S→C: Plugin Message: MC|Brand with the server's brand (Optional)
  11. S→C: Server Difficulty (Optional)
  12. S→C: Spawn Position (“home” spawn, not where the client will spawn on login)
  13. S→C: Player Abilities
  14. C→S: Plugin Message: MC|Brand with the client's brand (Optional)
  15. C→S: Client Settings
  16. S→C: Player Position And Look (Required, tells the client they're ready to spawn)
  17. C→S: Teleport Confirm
  18. C→S: Player Position And Look (to confirm the spawn position)
  19. C→S: Client Status (sent either before or while receiving chunks, further testing needed, server handles correctly if not sent)
  20. S→C: inventory, Map Chunk Bulk, entities, etc

I think I've done everything right, but…

…my player isn't spawning!

After sending the common-sense packets (Handshake, Login Start, inventory, compass, and chunks), you need to finally send the player their initial position for them to leave the “Loading Map” screen.

Note that if the following steps are taken, a Minecraft client will spawn the player:

  1. Do Handshake (see Protocol Encryption)
  2. Send Spawn Position packet
  3. Send Player Position And Look packet

While the above steps are sufficient for Minecraft 1.4.5, it is good form to send packets that inform the client about the world around the player before allowing the player to spawn.

…my client isn't receiving complete map chunks!

Main article: How to Write a Client

The standard Minecraft server sends full chunks only when your client is sending player status update packets (any of Player (0x03) through Player Position And Look (0x06)).

…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 is attempting a legacy ping, this happens if your server did not respond to the Server List Ping properly, including if it sent malformed json.

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 OP permission level of 2, or else the client will refuse to open the command block. (The op permission level is set with the Entity Status packet)

To actually open the command block:

  1. CS: Player Block Placement (0x1C), with the position being the command block that was right-clicked.
  2. SC: Update Block Entity (0x09), with the NBT of the command block.

And to save it, use the MC|AutoCmd plugin channel.