arabskills/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

dev-master 2024-10-29 17:37 UTC

Requires

• php: ^8.1
• ext-json: *
• pocketmine/binaryutils: ^0.2.0
• pocketmine/color: ^0.2.0 || ^0.3.0
• pocketmine/math: ^0.3.0 || ^0.4.0 || ^1.0.0
• pocketmine/nbt: ^1.0.0
• ramsey/uuid: ^4.1

Requires (Dev)

• phpstan/phpstan: 1.11.9
• phpstan/phpstan-phpunit: ^1.0.0
• phpstan/phpstan-strict-rules: ^1.0.0
• phpunit/phpunit: ^9.5 || ^10.0

LGPL-3.0

README

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:

foreach(PacketBatch::decodePackets(new BinaryStream($payload), PacketPool::getInstance()) as $packetObject){
    var_dump($packetObject); //tada
}

Encoding packets

This is easy:

/** @var Packet[] $packets */
$stream = new BinaryStream();
PacketBatch::encodePackets($stream, $packets);
$batchPayload = $stream->getBuffer();

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.