Difference between revisions of "Protocol FAQ"
Jump to navigation
Jump to search
(→What's the normal login sequence for a client?: updated login sequence with links to the packets) |
(updated; formatting) |
||
| Line 1: | Line 1: | ||
| − | 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. | + | 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 [irc://irc.freenode.net/mcdevs #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 [[MC-Ver|have a script]] that monitors for new versions of the client and notifies us, allowing us to quickly document new packets. | 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 [[MC-Ver|have a script]] that monitors for new versions of the client and notifies us, allowing us to quickly document new packets. | ||
| − | |||
| − | + | == What's the normal login sequence for a client? == | |
See [[Authentication]] for communication with Mojang's servers. | See [[Authentication]] for communication with Mojang's servers. | ||
| Line 12: | Line 11: | ||
{{Warning|Information might not be totally up to date}} | {{Warning|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: | |
| − | The recommended login sequence looks like this, where C is the client and S is the server: | ||
# Client connects to server | # Client connects to server | ||
| Line 19: | Line 17: | ||
# '''C→S''': [[Protocol#Login Start|Login Start]] | # '''C→S''': [[Protocol#Login Start|Login Start]] | ||
# '''S→C''': [[Protocol#Encryption Request|Encryption Request]] | # '''S→C''': [[Protocol#Encryption Request|Encryption Request]] | ||
| − | # | + | # Client auth |
# '''C→S''': [[Protocol#Encryption Response|Encryption Response]] | # '''C→S''': [[Protocol#Encryption Response|Encryption Response]] | ||
| − | # | + | # Server auth, both enable encryption |
# '''S→C''': [[Protocol#Login Success|Login Success]] | # '''S→C''': [[Protocol#Login Success|Login Success]] | ||
# '''S→C''': [[Protocol#Join Game|Join Game]] | # '''S→C''': [[Protocol#Join Game|Join Game]] | ||
| Line 29: | Line 27: | ||
# '''C→S''': [[Protocol#Player Position And Look 2|Player Position And Look]] (to confirm the spawn position) | # '''C→S''': [[Protocol#Player Position And Look 2|Player Position And Look]] (to confirm the spawn position) | ||
# '''S→C''': inventory, [[Protocol#Map Chunk Bulk|Map Chunk Bulk]], entities, etc | # '''S→C''': inventory, [[Protocol#Map Chunk Bulk|Map Chunk Bulk]], entities, etc | ||
| − | |||
| − | + | == I think I've done everything right, but… == | |
| + | |||
| + | === …my player isn't spawning! === | ||
| − | + | After sending the common-sense packets ([[Protocol#Handshake|Handshake]], [[Protocol#Login Start|Login Start]], [[Protocol#Window Items|inventory]], [[Protocol#Spawn Position|compass]], and [[Protocol#Map_ Chunk Bulk|chunks]]), you need to finally send the player their [[Protocol#Player Position And Look|initial position]] for them to leave the “Loading Map” screen. | |
| − | |||
| − | After sending the common-sense packets ([[ | ||
| − | |||
| − | + | ''Note that if the following steps are taken, a Minecraft client will spawn the player:'' | |
| − | + | # Do Handshake (see [[Protocol Encryption]]) | |
| − | + | # Send [[Protocol#Spawn Position|Spawn Position]] packet | |
| − | + | # Send [[Protocol#Player Position And Look|Player Position And Look]] packet | |
| − | While the above steps are sufficient for Minecraft 1.4.5, it is good form to send | + | 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]]'' | ''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 [[Protocol#Player|Player (0x03)]] through [[Protocol#Player Position And Look|Player Position And Look (0x06)]]). | |
| − | + | ||
| − | For newer clients, your server needs to send 49 chunks ahead of time, not just one. Send a | + | === …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. | ||
[[Category:Protocol Details]] | [[Category:Protocol Details]] | ||
[[Category:Minecraft Modern]] | [[Category:Minecraft Modern]] | ||
Revision as of 22:48, 8 July 2015
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.
Contents
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 have a script that monitors for new versions of the client and notifies us, allowing us to quickly document new packets.
What's the normal login sequence for a client?
See Authentication for communication with Mojang's servers.
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:
- Client connects to 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: Login Success
- S→C: Join Game
- S→C: Spawn Position (“home” spawn, not where the client will spawn on login)
- S→C: Player Abilities
- S→C: Player Position And Look (tells the client they're ready to spawn)
- C→S: Player Position And Look (to confirm the spawn position)
- 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:
- Do Handshake (see Protocol Encryption)
- Send Spawn Position packet
- 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.
