nethergames/bedrock-protocol

This package is abandoned and no longer maintained. The author suggests using the pocketmine/bedrock-protocol package instead.

An implementation of the Minecraft: Bedrock Edition protocol in PHP

dev-master 2021-11-30 20:19 UTC

This package is auto-updated.

Last update: 2021-11-30 20:19:08 UTC


README

CI

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:

$batch = new PacketBatch($payload);
foreach($batch->getPackets($packetPool, $protocolContext, $maxPackets) as [$packetObject, $packetPayload]){
  if($packetObject !== null){
    $packetObject->decode(PacketSerializer::decoder($packetPayload, 0, $protocolContext));
    var_dump($packetObject); //tada
  }else{
    var_dump("Got unknown packet", $packetPayload);
  }
}

Encoding packets

This is easy:

/** @var Packet[] $packets */
$batch = PacketBatch::fromPackets($protocolContext, ...$packets);
$batchPayload = $batch->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.