this makes AvailableCommandsPacket way easier to debug, since it separates the concerns of the binary protocol from the high-level object assembly. This should also allow symmetric binary re-encoding of AvailableCommandsPacket when proxying data, which will be very useful for verifying the structure of packets. Among many other benefits, it also allows us to put enum constraints directly inside CommandEnum, which previously wasn't easily possible.
BedrockProtocol
An implementation of the Minecraft: Bedrock Edition protocol in PHP
This library implements all of the packets in the Minecraft: Bedrock Edition protocol, as well as a few extra things needed to support them. However, at the time of writing, it does not include the following:
- Anything related to JWT handling/verification
- Anything related to encryption
- Anything related to compression
Decoding packets
Assuming you've decrypted and decompressed a Minecraft packet successfully, you're next going to want to decode it.
With this library, that's currently done using PacketBatch
, like so:
use pocketmine\network\mcpe\protocol\serializer\PacketBatch;
use pocketmine\network\mcpe\protocol\PacketPool;
use pmmp\encoding\ByteBufferReader;
foreach(PacketBatch::decodePackets(new ByteBufferReader($payload), PacketPool::getInstance()) as $packetObject){
var_dump($packetObject); //tada
}
Encoding packets
This is easy:
use pocketmine\network\mcpe\protocol\serializer\PacketBatch;
use pmmp\encoding\ByteBufferWriter;
/** @var Packet[] $packets */
$stream = new ByteBufferWriter();
PacketBatch::encodePackets($stream, $packets);
$batchPayload = $stream->getData();
Footnotes
This library is a little rough around the edges, since it's only ever been intended for PocketMine-MP usage. It's only recently that this mess has been separated from the core to allow it to be used by other things. This means that API changes might be in order, and your feedback would be nice to drive them. If you want to improve BedrockProtocol, please open issues with suggestions, or better, make pull requests.