Release 4.0.0-BETA15

changelogs/3.26.md

@@ -0,0 +1,11 @@
+**For Minecraft: Bedrock Edition 1.18.0**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 3.x.y version will also run on these releases and do not need API bumps.
+Plugin developers should **only** update their required API to this version if you need the changes in this build.
+
+**WARNING: If your plugin uses the protocol, you're not shielded by API change constraints.** You should consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you do.
+
+# 3.26.0
+- Added support for Minecraft: Bedrock Edition 1.18.0.
+- Removed compatibility with earlier versions.

changelogs/4.0.md

@@ -1758,3 +1758,10 @@ Released 30th November 2021.
 
 ## Fixes
 - Fixed `ConsoleReaderThread` spawning many zombie processes when running a server inside a Docker container.
+
+# 4.0.0-BETA15
+Released 30th November 2021.
+
+## General
+- Added support for Minecraft: Bedrock 1.18.0
+- Removed support for earlier versions.

composer.json

@@ -7,7 +7,7 @@
    "require": {
       "php": "^8.0",
       "php-64bit": "*",
-      "ext-chunkutils2": "^0.3.0",
+      "ext-chunkutils2": "^0.3.1",
       "ext-crypto": "^0.3.1",
       "ext-ctype": "*",
       "ext-curl": "*",
@@ -34,8 +34,8 @@
       "adhocore/json-comment": "^1.1",
       "fgrosse/phpasn1": "^2.3",
       "netresearch/jsonmapper": "^4.0",
-      "pocketmine/bedrock-data": "^1.4.0+bedrock-1.17.40",
-      "pocketmine/bedrock-protocol": "^6.0.0+bedrock-1.17.40",
+      "pocketmine/bedrock-data": "^1.5.0+bedrock-1.18.0",
+      "pocketmine/bedrock-protocol": "^7.0.0+bedrock-1.18.0",
       "pocketmine/binaryutils": "^0.2.1",
       "pocketmine/callback-validator": "^1.0.2",
       "pocketmine/classloader": "^0.2.0",

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "fb545e4c8e17b0b07e8e20986b64e5a6",
+    "content-hash": "b515e7eebbf12a6251d2df817ce56dbc",
     "packages": [
         {
             "name": "adhocore/json-comment",
@@ -249,16 +249,16 @@
         },
         {
             "name": "pocketmine/bedrock-data",
-            "version": "1.4.0+bedrock-1.17.40",
+            "version": "1.5.0+bedrock-1.18.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/pmmp/BedrockData.git",
-                "reference": "f29b7be8fa3046d2ee4c6421485b97b3f5b07774"
+                "reference": "482c679aa5ed0b81c088c2b1ff0b8110a94c8a6c"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/pmmp/BedrockData/zipball/f29b7be8fa3046d2ee4c6421485b97b3f5b07774",
-                "reference": "f29b7be8fa3046d2ee4c6421485b97b3f5b07774",
+                "url": "https://api.github.com/repos/pmmp/BedrockData/zipball/482c679aa5ed0b81c088c2b1ff0b8110a94c8a6c",
+                "reference": "482c679aa5ed0b81c088c2b1ff0b8110a94c8a6c",
                 "shasum": ""
             },
             "type": "library",
@@ -269,22 +269,22 @@
             "description": "Blobs of data generated from Minecraft: Bedrock Edition, used by PocketMine-MP",
             "support": {
                 "issues": "https://github.com/pmmp/BedrockData/issues",
-                "source": "https://github.com/pmmp/BedrockData/tree/bedrock-1.17.40"
+                "source": "https://github.com/pmmp/BedrockData/tree/bedrock-1.18.0"
             },
-            "time": "2021-10-19T16:55:41+00:00"
+            "time": "2021-11-30T18:30:46+00:00"
         },
         {
             "name": "pocketmine/bedrock-protocol",
-            "version": "6.0.0+bedrock-1.17.40",
+            "version": "7.0.0+bedrock-1.18.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/pmmp/BedrockProtocol.git",
-                "reference": "906bafec4fc41f548749ce01d120902b25c1bbfe"
+                "reference": "040a883a4abb8c9b93114d5278cb5fecc635da82"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/pmmp/BedrockProtocol/zipball/906bafec4fc41f548749ce01d120902b25c1bbfe",
-                "reference": "906bafec4fc41f548749ce01d120902b25c1bbfe",
+                "url": "https://api.github.com/repos/pmmp/BedrockProtocol/zipball/040a883a4abb8c9b93114d5278cb5fecc635da82",
+                "reference": "040a883a4abb8c9b93114d5278cb5fecc635da82",
                 "shasum": ""
             },
             "require": {
@@ -316,9 +316,9 @@
             "description": "An implementation of the Minecraft: Bedrock Edition protocol in PHP",
             "support": {
                 "issues": "https://github.com/pmmp/BedrockProtocol/issues",
-                "source": "https://github.com/pmmp/BedrockProtocol/tree/6.0.0+bedrock-1.17.40"
+                "source": "https://github.com/pmmp/BedrockProtocol/tree/7.0.0+bedrock-1.18.0"
             },
-            "time": "2021-11-21T20:56:18+00:00"
+            "time": "2021-11-30T19:02:41+00:00"
         },
         {
             "name": "pocketmine/binaryutils",
@@ -3510,7 +3510,7 @@
     "platform": {
         "php": "^8.0",
         "php-64bit": "*",
-        "ext-chunkutils2": "^0.3.0",
+        "ext-chunkutils2": "^0.3.1",
         "ext-crypto": "^0.3.1",
         "ext-ctype": "*",
         "ext-curl": "*",

src/VersionInfo.php

@@ -31,7 +31,7 @@ use function str_repeat;
 
 final class VersionInfo{
 	public const NAME = "PocketMine-MP";
-	public const BASE_VERSION = "4.0.0-BETA14";
+	public const BASE_VERSION = "4.0.0-BETA15";
 	public const IS_DEVELOPMENT_BUILD = false;
 	public const BUILD_CHANNEL = "beta";
 

src/data/bedrock/LegacyBiomeIdToStringIdMap.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+*/
+
+declare(strict_types=1);
+
+namespace pocketmine\data\bedrock;
+
+use pocketmine\utils\SingletonTrait;
+use Webmozart\PathUtil\Path;
+
+final class LegacyBiomeIdToStringIdMap extends LegacyToStringBidirectionalIdMap{
+	use SingletonTrait;
+
+	public function __construct(){
+		parent::__construct(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'biome_id_map.json'));
+	}
+}

src/network/mcpe/ChunkRequestTask.php

@@ -69,7 +69,7 @@ class ChunkRequestTask extends AsyncTask{
 
 	public function onRun() : void{
 		$chunk = FastChunkSerializer::deserializeTerrain($this->chunk);
-		$subCount = ChunkSerializer::getSubChunkCount($chunk);
+		$subCount = ChunkSerializer::getSubChunkCount($chunk) + ChunkSerializer::LOWER_PADDING_SIZE;
 		$encoderContext = new PacketSerializerContext(GlobalItemTypeDictionary::getInstance()->getDictionary());
 		$payload = ChunkSerializer::serializeFullChunk($chunk, RuntimeBlockMapping::getInstance(), $encoderContext, $this->tiles);
 		$this->setResult($this->compressor->compress(PacketBatch::fromPackets($encoderContext, LevelChunkPacket::create($this->chunkX, $this->chunkZ, $subCount, null, $payload))->getBuffer()));

src/network/mcpe/handler/PreSpawnPacketHandler.php

@@ -104,6 +104,7 @@ class PreSpawnPacketHandler extends PacketHandler{
 			false,
 			sprintf("%s %s", VersionInfo::NAME, VersionInfo::VERSION()->getFullVersion(true)),
 			[],
+			0,
 			GlobalItemTypeDictionary::getInstance()->getDictionary()->getEntries()
 		));
 

src/network/mcpe/serializer/ChunkSerializer.php

@@ -24,6 +24,8 @@ declare(strict_types=1);
 namespace pocketmine\network\mcpe\serializer;
 
 use pocketmine\block\tile\Spawnable;
+use pocketmine\data\bedrock\BiomeIds;
+use pocketmine\data\bedrock\LegacyBiomeIdToStringIdMap;
 use pocketmine\nbt\TreeRoot;
 use pocketmine\network\mcpe\convert\RuntimeBlockMapping;
 use pocketmine\network\mcpe\protocol\serializer\NetworkNbtSerializer;
@@ -32,10 +34,14 @@ use pocketmine\network\mcpe\protocol\serializer\PacketSerializerContext;
 use pocketmine\utils\Binary;
 use pocketmine\utils\BinaryStream;
 use pocketmine\world\format\Chunk;
+use pocketmine\world\format\PalettedBlockArray;
 use pocketmine\world\format\SubChunk;
+use function chr;
 use function count;
+use function str_repeat;
 
 final class ChunkSerializer{
+	public const LOWER_PADDING_SIZE = 4;
 
 	private function __construct(){
 		//NOOP
@@ -58,11 +64,22 @@ final class ChunkSerializer{
 
 	public static function serializeFullChunk(Chunk $chunk, RuntimeBlockMapping $blockMapper, PacketSerializerContext $encoderContext, ?string $tiles = null) : string{
 		$stream = PacketSerializer::encoder($encoderContext);
+
+		//TODO: HACK! fill in fake subchunks to make up for the new negative space client-side
+		for($y = 0; $y < self::LOWER_PADDING_SIZE; $y++){
+			$stream->putByte(8); //subchunk version 8
+			$stream->putByte(0); //0 layers - client will treat this as all-air
+		}
+
 		$subChunkCount = self::getSubChunkCount($chunk);
 		for($y = Chunk::MIN_SUBCHUNK_INDEX, $writtenCount = 0; $writtenCount < $subChunkCount; ++$y, ++$writtenCount){
 			self::serializeSubChunk($chunk->getSubChunk($y), $blockMapper, $stream, false);
 		}
-		$stream->put($chunk->getBiomeIdArray());
+
+		//TODO: right now we don't support 3D natively, so we just 3Dify our 2D biomes so they fill the column
+		$encodedBiomePalette = self::serializeBiomesAsPalette($chunk);
+		$stream->put(str_repeat($encodedBiomePalette, 25));
+
 		$stream->putByte(0); //border block array count
 		//Border block entry format: 1 byte (4 bits X, 4 bits Z). These are however useless since they crash the regular client.
 
@@ -116,4 +133,39 @@ final class ChunkSerializer{
 
 		return $stream->getBuffer();
 	}
+
+	private static function serializeBiomesAsPalette(Chunk $chunk) : string{
+		$biomeIdMap = LegacyBiomeIdToStringIdMap::getInstance();
+		$biomePalette = new PalettedBlockArray($chunk->getBiomeId(0, 0));
+		for($x = 0; $x < 16; ++$x){
+			for($z = 0; $z < 16; ++$z){
+				$biomeId = $chunk->getBiomeId($x, $z);
+				if($biomeIdMap->legacyToString($biomeId) === null){
+					//make sure we aren't sending bogus biomes - the 1.18.0 client crashes if we do this
+					$biomeId = BiomeIds::OCEAN;
+				}
+				for($y = 0; $y < 16; ++$y){
+					$biomePalette->set($x, $y, $z, $biomeId);
+				}
+			}
+		}
+
+		$biomePaletteBitsPerBlock = $biomePalette->getBitsPerBlock();
+		$encodedBiomePalette =
+			chr(($biomePaletteBitsPerBlock << 1) | 1) . //the last bit is non-persistence (like for blocks), though it has no effect on biomes since they always use integer IDs
+			$biomePalette->getWordArray();
+
+		//these LSHIFT by 1 uvarints are optimizations: the client expects zigzag varints here
+		//but since we know they are always unsigned, we can avoid the extra fcall overhead of
+		//zigzag and just shift directly.
+		$biomePaletteArray = $biomePalette->getPalette();
+		if($biomePaletteBitsPerBlock !== 0){
+			$encodedBiomePalette .= Binary::writeUnsignedVarInt(count($biomePaletteArray) << 1);
+		}
+		foreach($biomePaletteArray as $p){
+			$encodedBiomePalette .= Binary::writeUnsignedVarInt($p << 1);
+		}
+
+		return $encodedBiomePalette;
+	}
 }