Pocket Edition Protocol Documentation - Revision history

imported>Orladog: Remove colon

2020-06-08T11:03:51Z

Remove colon

← Older revision		Revision as of 11:03, 8 June 2020
Line 6:		Line 6:
	\|HEADING = Heads up!		\|HEADING = Heads up!
	\|CONTENT = This is information for Minecraft Pocket Edition before it became Bedrock Edition.'''. For the latest Bedrock Edition protocol documentation see [[Bedrock Protocol]].		\|CONTENT = This is information for Minecraft Pocket Edition before it became Bedrock Edition.'''. For the latest Bedrock Edition protocol documentation see [[Bedrock Protocol]].
	}}:		}}

	This is the (unofficial) protocol documentation for {{Minecraft Wiki\|Minecraft Pocket Edition}}. The protocol currently uses [[Wikipedia:UDP\|UDP]] for communication, different from PC (which uses [[Wikipedia:TCP\|TCP]]). The usual UDP issues are still here (lost packets, wrong order, etc.), but the protocol solves a few of those problems using special packet encapsulation, based on TCP. The Minecraft: PE client uses [http://www.raknet.com/ RakNet] as its networking library. Even though it uses RakNet, you can still write software without the library.		This is the (unofficial) protocol documentation for {{Minecraft Wiki\|Minecraft Pocket Edition}}. The protocol currently uses [[Wikipedia:UDP\|UDP]] for communication, different from PC (which uses [[Wikipedia:TCP\|TCP]]). The usual UDP issues are still here (lost packets, wrong order, etc.), but the protocol solves a few of those problems using special packet encapsulation, based on TCP. The Minecraft: PE client uses [http://www.raknet.com/ RakNet] as its networking library. Even though it uses RakNet, you can still write software without the library.

imported>Orladog: Add info about Bedrock Protocol

2020-06-08T11:03:05Z

Add info about Bedrock Protocol

← Older revision		Revision as of 11:03, 8 June 2020
Line 1:		Line 1:
			{{Box
			\|BORDER = #9999FF
			\|BACKGROUND = #99CCFF
			\|WIDTH = 100%
			\|ICON =
			\|HEADING = Heads up!
			\|CONTENT = This is information for Minecraft Pocket Edition before it became Bedrock Edition.'''. For the latest Bedrock Edition protocol documentation see [[Bedrock Protocol]].
			}}:

	This is the (unofficial) protocol documentation for {{Minecraft Wiki\|Minecraft Pocket Edition}}. The protocol currently uses [[Wikipedia:UDP\|UDP]] for communication, different from PC (which uses [[Wikipedia:TCP\|TCP]]). The usual UDP issues are still here (lost packets, wrong order, etc.), but the protocol solves a few of those problems using special packet encapsulation, based on TCP. The Minecraft: PE client uses [http://www.raknet.com/ RakNet] as its networking library. Even though it uses RakNet, you can still write software without the library.		This is the (unofficial) protocol documentation for {{Minecraft Wiki\|Minecraft Pocket Edition}}. The protocol currently uses [[Wikipedia:UDP\|UDP]] for communication, different from PC (which uses [[Wikipedia:TCP\|TCP]]). The usual UDP issues are still here (lost packets, wrong order, etc.), but the protocol solves a few of those problems using special packet encapsulation, based on TCP. The Minecraft: PE client uses [http://www.raknet.com/ RakNet] as its networking library. Even though it uses RakNet, you can still write software without the library.

imported>MarfGamer: Fixed protocol error

2016-10-20T22:17:43Z

Fixed protocol error

← Older revision		Revision as of 22:17, 20 October 2016
Line 121:		Line 121:
	\|		\|
	\|-		\|-
	\| ~~GUID~~		\| MAGIC
	\| ~~long~~		\| magic
	\|		\|
	\|}		\|}

imported>MarfGamer: Added boolean data type for Unconnected Connection Reply 1

2016-10-06T22:35:23Z

Added boolean data type for Unconnected Connection Reply 1

← Older revision		Revision as of 22:35, 6 October 2016
Line 18:		Line 18:
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="row2"		\|- class="row2"
			! class="col0 centeralign" \| boolean
			\| class="col1 centeralign" \| 1
			\| class="col2" \| 0 or 1
			\| class="col3" \| <code>A byte treated as a boolean, 0 is false but anything greater than that is true.</code>
			\|
			\|- class="row3"
	! class="col0 centeralign" \| short		! class="col0 centeralign" \| short
	\| class="col1 centeralign" \| 2		\| class="col1 centeralign" \| 2
	\| class="col2" \| -32768 to 32767		\| class="col2" \| -32768 to 32767
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="~~row3~~"		\|- class="row4"
	! class="col0 centeralign" \| uint24le		! class="col0 centeralign" \| uint24le
	\| class="col1 centeralign" \| 3		\| class="col1 centeralign" \| 3
	\| class="col2" \| 0 to 16777216		\| class="col2" \| 0 to 16777216
	\| class="col3" \| Little-Endian 24-bit unsigned integer. Commonly used by RakNet for counters.		\| class="col3" \| Little-Endian 24-bit unsigned integer. Commonly used by RakNet for counters.
	\|- class="~~row4~~"		\|- class="row5"
	! class="col0 centeralign" \| int		! class="col0 centeralign" \| int
	\| class="col1 centeralign" \| 4		\| class="col1 centeralign" \| 4
	\| class="col2" \| -2147483648 to 2147483647		\| class="col2" \| -2147483648 to 2147483647
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="~~row5~~"		\|- class="row6"
	! class="col0 centeralign" \| long		! class="col0 centeralign" \| long
	\| class="col1 centeralign" \| 8		\| class="col1 centeralign" \| 8
	\| class="col2" \|		\| class="col2" \|
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="~~row6~~"		\|- class="row7"
	! class="col0 centeralign" \| MAGIC		! class="col0 centeralign" \| MAGIC
	\| class="col1 centeralign" \| 16		\| class="col1 centeralign" \| 16
	\| class="col2" \| <code>0x00ffff00fefefefefdfdfdfd12345678</code>		\| class="col2" \| <code>0x00ffff00fefefefefdfdfdfd12345678</code>
	\| class="col3" \| always those hex bytes, corresponding to RakNet's default OFFLINE_MESSAGE_DATA_ID		\| class="col3" \| always those hex bytes, corresponding to RakNet's default OFFLINE_MESSAGE_DATA_ID
	\|- class="~~row7~~"		\|- class="row8"
	! class="col0 centeralign" \| string		! class="col0 centeralign" \| string
	\| class="col1 centeralign" \| unsigned short + string		\| class="col1 centeralign" \| unsigned short + string
	\| class="col2" \| N/A		\| class="col2" \| N/A
	\| class="col3" \| Prefixed by a short containing the length of the string in characters. It appears that only the following ASCII characters can be displayed: !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{\|}~		\| class="col3" \| Prefixed by a short containing the length of the string in characters. It appears that only the following ASCII characters can be displayed: !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{\|}~
	\|- class="~~row8~~"		\|- class="row9"
	! class="col0 centeralign" \| address		! class="col0 centeralign" \| address
	\| class="col1 centeralign" \| 7		\| class="col1 centeralign" \| 7

imported>MarfGamer: /* Offline Connection Response 1 */

2016-10-06T22:30:54Z

Offline Connection Response 1

← Older revision		Revision as of 22:30, 6 October 2016
Line 169:		Line 169:
	! Notes		! Notes
	\|-		\|-
	\|rowspan="3"\| 0x06		\|rowspan="4"\| 0x06
	\| Magic		\| Magic
	\| MAGIC		\| MAGIC
Line 177:		Line 177:
	\| long		\| long
	\|		\|
			\|-
			\| Use security
			\| boolean
			\| Make sure this is false, it is vital for the login sequence to continue!
			\|
	\|-		\|-
	\| MTU		\| MTU

imported>MarfGamer: /* Unconnected Ping */

2016-08-18T01:02:03Z

Unconnected Ping

← Older revision		Revision as of 01:02, 18 August 2016
Line 120:		Line 120:
	\|}		\|}

	<code>0x02</code> is only replied to if there are open connections to the server.		<code>0x02</code> is only replied to if there are open connections to the server. '''Note:''' as of 0.15.6 it seems that the game refreshes it's LAN world list every 4-5 seconds, however it seems the game will still ping in 1 second intervals.

	=== Connected Pong ===		=== Connected Pong ===

imported>Gurun at 15:21, 19 June 2016

2016-06-19T15:21:18Z

← Older revision		Revision as of 15:21, 19 June 2016
Line 552:		Line 552:
	== Game Protocol ==		== Game Protocol ==

	The game protocol is described here: https://confluence.yawk.at/display/PEPROTOCOL and an autoatically generated version for 0.15 is also available in from MiNET at https://github.com/NiclasOlofsson/MiNET/blob/~~realms~~/src/MiNET/MiNET/Net/MCPE%20Protocol%20Documentation.md		The game protocol is described here: https://confluence.yawk.at/display/PEPROTOCOL and an autoatically generated version for 0.15 is also available in from MiNET at https://github.com/NiclasOlofsson/MiNET/blob/master/src/MiNET/MiNET/Net/MCPE%20Protocol%20Documentation.md

	== References ==		== References ==
Line 558:		Line 558:
	* RakNet datagram and message header information: http://jenkinssoftware.com/raknet/manual/systemoverview.html		* RakNet datagram and message header information: http://jenkinssoftware.com/raknet/manual/systemoverview.html
	* Packets can be found in the [http://dragonet.org Dragonet] server code https://github.com/DragonetMC/Dragonet/tree/master/src/main/java/org/dragonet/net/packet		* Packets can be found in the [http://dragonet.org Dragonet] server code https://github.com/DragonetMC/Dragonet/tree/master/src/main/java/org/dragonet/net/packet
	* There is also an automatically generated specification of many of the packages can be found in the MiNET server code https://github.com/NiclasOlofsson/MiNET/blob/master/src/MiNET/MiNET/Net/MCPE%20Protocol%20Documentation.md * The MiNET wiki also contain development notes around some functionality https://github.com/NiclasOlofsson/MiNET/wiki These will be migrated to this wiki in due time.		* There is also an automatically generated specification of many of the packages can be found in the MiNET server code https://github.com/NiclasOlofsson/MiNET/blob/master/src/MiNET/MiNET/Net/MCPE%20Protocol%20Documentation.md
			* The MiNET wiki also contain development notes around some functionality https://github.com/NiclasOlofsson/MiNET/wiki These will be migrated to this wiki in due time.
	* https://confluence.yawk.at/display/PEPROTOCOL		* https://confluence.yawk.at/display/PEPROTOCOL

imported>MarfGamer: Added Incompatible protocol packet (0x19)

2016-06-16T23:01:11Z

Added Incompatible protocol packet (0x19)

← Older revision		Revision as of 23:01, 16 June 2016
Line 160:		Line 160:
	\|}		\|}

	The client sends these to the target server with ever decreasing MTU until the server responds. This is used to discover the MTU size for the connection. If the RakNet protocol does not match your own, respond with ~~ID_INCOMPATIBLE_PROTOCOL (0x19)~~		The client sends these to the target server with ever decreasing MTU until the server responds. This is used to discover the MTU size for the connection. If the RakNet protocol does not match your own, respond with the Incompatible protocol packet

	=== Offline Connection Response 1 ===		=== Offline Connection Response 1 ===
Line 283:		Line 283:
	\|}		\|}

	=== ~~Unconnected Pong~~ ===		=== Incompatible protocol ===
	{\| class="wikitable"		{\| class="wikitable"
	! Packet ID		! Packet ID
Line 290:		Line 290:
	! Notes		! Notes
	\|-		\|-
	\|rowspan="4"\| ~~0x1c~~		\|rowspan="4"\| 0x19
	\| ~~Time~~		\| Protocol
	\| ~~long~~		\| byte
			\|
			\|-
			\| Magic
			\| MAGIC
	\|		\|
	\|-		\|-
Line 299:		Line 303:
	\|		\|
	\|-		\|-
	\| ~~Magic~~		\|}
	\| ~~MAGIC~~
			=== Unconnected Ping ===
			{\| class="wikitable"
			! Packet ID
			! Field Name
			! Field Type
			! Notes
			\|-
			\|rowspan="2"\| 0x01, 0x02
			\| Time
			\| long
	\|		\|
	\|-		\|-
	\| ~~Server info~~		\| GUID
	\| ~~string~~		\| long
	\| <code>MCPE;##Name##;##Protocol Version##;##Client Version##;##Online player count##;##Max player count##;##Server GUID##;</code>. Protocol version is currently (0.14.1) 46. Client version can be left empty or be something like '0.14.1'. Server GUID is a 64-bit unsigned integer, 0 works as a value. Example: <code>MCPE;kitty;46;0.14.1;1;5;18446744071609048444;</code>		\|
	\|}		\|}

imported>MarfGamer: Added note for 0x05, gonna add 0x19 in just a second

2016-06-16T22:57:45Z

Added note for 0x05, gonna add 0x19 in just a second

← Older revision		Revision as of 22:57, 16 June 2016
Line 160:		Line 160:
	\|}		\|}

	The client sends these to the target server with ever decreasing MTU until the server responds. This is used to discover the MTU size for the connection.		The client sends these to the target server with ever decreasing MTU until the server responds. This is used to discover the MTU size for the connection. If the RakNet protocol does not match your own, respond with ID_INCOMPATIBLE_PROTOCOL (0x19)

	=== Offline Connection Response 1 ===		=== Offline Connection Response 1 ===

imported>SadBatman: The ID is an byte/uint8_t. IDs such as 0x84 exceed the 128 that was documented here.

2016-06-12T20:01:56Z

The ID is an byte/uint8_t. IDs such as 0x84 exceed the 128 that was documented here.

← Older revision		Revision as of 20:01, 12 June 2016
Line 15:		Line 15:
	! class="col0 centeralign" \| byte		! class="col0 centeralign" \| byte
	\| class="col1 centeralign" \| 1		\| class="col1 centeralign" \| 1
	\| class="col2" \| ~~-128~~ to ~~127~~		\| class="col2" \| 0 to 255
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="row2"		\|- class="row2"

← Older revision		Revision as of 22:35, 6 October 2016
Line 18:		Line 18:
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="row2"		\|- class="row2"
			! class="col0 centeralign" \| boolean
			\| class="col1 centeralign" \| 1
			\| class="col2" \| 0 or 1
			\| class="col3" \| <code>A byte treated as a boolean, 0 is false but anything greater than that is true.</code>
			\|
			\|- class="row3"
	! class="col0 centeralign" \| short		! class="col0 centeralign" \| short
	\| class="col1 centeralign" \| 2		\| class="col1 centeralign" \| 2
	\| class="col2" \| -32768 to 32767		\| class="col2" \| -32768 to 32767
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="~~row3~~"		\|- class="row4"
	! class="col0 centeralign" \| uint24le		! class="col0 centeralign" \| uint24le
	\| class="col1 centeralign" \| 3		\| class="col1 centeralign" \| 3
	\| class="col2" \| 0 to 16777216		\| class="col2" \| 0 to 16777216
	\| class="col3" \| Little-Endian 24-bit unsigned integer. Commonly used by RakNet for counters.		\| class="col3" \| Little-Endian 24-bit unsigned integer. Commonly used by RakNet for counters.
	\|- class="~~row4~~"		\|- class="row5"
	! class="col0 centeralign" \| int		! class="col0 centeralign" \| int
	\| class="col1 centeralign" \| 4		\| class="col1 centeralign" \| 4
	\| class="col2" \| -2147483648 to 2147483647		\| class="col2" \| -2147483648 to 2147483647
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="~~row5~~"		\|- class="row6"
	! class="col0 centeralign" \| long		! class="col0 centeralign" \| long
	\| class="col1 centeralign" \| 8		\| class="col1 centeralign" \| 8
	\| class="col2" \|		\| class="col2" \|
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="~~row6~~"		\|- class="row7"
	! class="col0 centeralign" \| MAGIC		! class="col0 centeralign" \| MAGIC
	\| class="col1 centeralign" \| 16		\| class="col1 centeralign" \| 16
	\| class="col2" \| <code>0x00ffff00fefefefefdfdfdfd12345678</code>		\| class="col2" \| <code>0x00ffff00fefefefefdfdfdfd12345678</code>
	\| class="col3" \| always those hex bytes, corresponding to RakNet's default OFFLINE_MESSAGE_DATA_ID		\| class="col3" \| always those hex bytes, corresponding to RakNet's default OFFLINE_MESSAGE_DATA_ID
	\|- class="~~row7~~"		\|- class="row8"
	! class="col0 centeralign" \| string		! class="col0 centeralign" \| string
	\| class="col1 centeralign" \| unsigned short + string		\| class="col1 centeralign" \| unsigned short + string
	\| class="col2" \| N/A		\| class="col2" \| N/A
	\| class="col3" \| Prefixed by a short containing the length of the string in characters. It appears that only the following ASCII characters can be displayed: !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{\|}~		\| class="col3" \| Prefixed by a short containing the length of the string in characters. It appears that only the following ASCII characters can be displayed: !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{\|}~
	\|- class="~~row8~~"		\|- class="row9"
	! class="col0 centeralign" \| address		! class="col0 centeralign" \| address
	\| class="col1 centeralign" \| 7		\| class="col1 centeralign" \| 7

← Older revision		Revision as of 20:01, 12 June 2016
Line 15:		Line 15:
	! class="col0 centeralign" \| byte		! class="col0 centeralign" \| byte
	\| class="col1 centeralign" \| 1		\| class="col1 centeralign" \| 1
	\| class="col2" \| ~~-128~~ to ~~127~~		\| class="col2" \| 0 to 255
	\| class="col3" \| <code></code>		\| class="col3" \| <code></code>
	\|- class="row2"		\|- class="row2"