Release 5.17.1

Co-authored-by: IvanCraft623 <57236932+IvanCraft623@users.noreply.github.com>

.gitattributes

@@ -4,6 +4,7 @@
 *.sh text eol=lf
 *.txt text eol=lf
 *.properties text eol=lf
+*.neon text eol=lf
 *.bat text eol=crlf
 *.cmd text eol=crlf
 *.ps1 text eol=crlf

.github/PULL_REQUEST_TEMPLATE.md

@@ -34,7 +34,10 @@ Requires translations:
 
 ## Tests
 <!--
-Details should be provided of tests done. Simply saying "tested" or equivalent is not acceptable.
-
-Attach scripts or actions to test this pull request, as well as the result
+PRs which have not been tested MUST be marked as draft.
 -->
+I tested this PR by doing the following (tick all that apply):
+- [ ] Writing PHPUnit tests (commit these in the `tests/phpunit` folder)
+- [ ] Playtesting using a Minecraft client (provide screenshots or a video)
+- [ ] Writing a test plugin (provide the code and sample output)
+- [ ] Other (provide details)

.github/dependabot.yml

@@ -3,6 +3,38 @@ updates:
 - package-ecosystem: composer
   directory: "/"
   schedule:
-    interval: daily
+    interval: weekly
     time: "10:00"
   open-pull-requests-limit: 10
+  ignore:
+    #only allow patch updates for locale-data - this has to be updated manually due to codegen
+    - dependency-name: pocketmine/locale-data
+      update-types:
+        - "version-update:semver-major"
+        - "version-update:semver-minor"
+  groups:
+    production-patch-updates:
+      dependency-type: production
+      patterns:
+        - "*"
+      update-types:
+        - "patch"
+    development-patch-updates:
+      dependency-type: development
+      patterns:
+        - "*"
+      update-types:
+        - "patch"
+    phpstan:
+      patterns:
+        - "phpstan/*"
+
+- package-ecosystem: gitsubmodule
+  directory: "/"
+  schedule:
+    interval: daily
+
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly

.github/workflows/build-docker-image.yml

@@ -0,0 +1,104 @@
+name: Update Docker Hub images
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    name: Update Docker Hub images
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Clone pmmp/PocketMine-Docker repository
+        uses: actions/checkout@v4
+        with:
+          repository: pmmp/PocketMine-Docker
+          fetch-depth: 1
+
+      - name: Get tag names
+        id: tag-name
+        run: |
+          VERSION=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{')
+          echo TAG_NAME=$VERSION >> $GITHUB_OUTPUT
+          echo MAJOR=$(echo $VERSION | cut -d. -f1) >> $GITHUB_OUTPUT
+          echo MINOR=$(echo $VERSION | cut -d. -f1-2) >> $GITHUB_OUTPUT
+
+      - name: Download new release information
+        run: curl -f -L ${{ github.server_url }}/${{ github.repository }}/releases/download/${{ steps.tag-name.outputs.TAG_NAME }}/build_info.json -o new_build_info.json
+
+      - name: Detect channel
+        id: channel
+        run: echo CHANNEL=$(jq -r '.channel' new_build_info.json) >> $GITHUB_OUTPUT
+
+      - name: Get name of Docker repository name
+        id: docker-repo-name
+        run: echo NAME=$(echo "${GITHUB_REPOSITORY,,}") >> $GITHUB_OUTPUT
+
+      - name: Build image for tag
+        uses: docker/build-push-action@v6.6.1
+        with:
+          push: true
+          context: ./pocketmine-mp
+          tags: |
+            ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
+          build-args: |
+            PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
+            PMMP_REPO=${{ github.repository }}
+
+      - name: Build image for major tag
+        if: steps.channel.outputs.CHANNEL == 'stable'
+        uses: docker/build-push-action@v6.6.1
+        with:
+          push: true
+          context: ./pocketmine-mp
+          tags: |
+            ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
+          build-args: |
+            PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
+            PMMP_REPO=${{ github.repository }}
+
+      - name: Build image for minor tag
+        if: steps.channel.outputs.CHANNEL == 'stable'
+        uses: docker/build-push-action@v6.6.1
+        with:
+          push: true
+          context: ./pocketmine-mp
+          tags: |
+            ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
+          build-args: |
+            PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
+            PMMP_REPO=${{ github.repository }}
+
+      - name: Build image for latest tag
+        if: steps.channel.outputs.CHANNEL == 'stable'
+        uses: docker/build-push-action@v6.6.1
+        with:
+          push: true
+          context: ./pocketmine-mp
+          tags: |
+            ${{ steps.docker-repo-name.outputs.NAME }}:latest
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:latest
+          build-args: |
+            PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
+            PMMP_REPO=${{ github.repository }}

.github/workflows/discord-release-embed.php

@@ -0,0 +1,117 @@
+<?php
+
+declare(strict_types=1);
+
+namespace pocketmine;
+
+use pocketmine\utils\Internet;
+use function dirname;
+use function fwrite;
+use function is_array;
+use function json_decode;
+use function json_encode;
+use const JSON_THROW_ON_ERROR;
+use const STDERR;
+
+require dirname(__DIR__, 2) . '/vendor/autoload.php';
+
+/**
+ * @phpstan-return array<string, mixed>
+ */
+function generateDiscordEmbed(string $version, string $channel, string $description, string $detailsUrl, string $sourceUrl, string $pharDownloadUrl, string $buildLogUrl, int $newsPingRoleId, ?string $phpDownloadUrl) : array{
+	if($phpDownloadUrl !== null){
+		$phpEmbedLink = " | [PHP Binaries]($phpDownloadUrl)";
+	}else{
+		$phpEmbedLink = "";
+	}
+	return [
+		"content" => "<@&$newsPingRoleId> New PocketMine-MP release: $version ($channel)",
+		"embeds" => [
+			[
+				"title" => "New PocketMine-MP release: $version ($channel)",
+				"description" => <<<DESCRIPTION
+$description
+
+[Details]($detailsUrl) | [Source Code]($sourceUrl) | [Build Log]($buildLogUrl) | [Download]($pharDownloadUrl)$phpEmbedLink
+DESCRIPTION,
+				"url" => $detailsUrl,
+				"color" => $channel === "stable" ? 0x57ab5a : 0xc69026
+			]
+		]
+	];
+}
+
+if(count($argv) !== 6){
+	fwrite(STDERR, "Required arguments: github repo, version, API token, webhook URL, ping role ID\n");
+	exit(1);
+}
+[, $repo, $tagName, $token, $hookURL, $newsPingRoleId] = $argv;
+
+$result = Internet::getURL('https://api.github.com/repos/' . $repo . '/releases/tags/' . $tagName, extraHeaders: [
+	'Authorization: token ' . $token
+]);
+if($result === null){
+	fwrite(STDERR, "failed to access GitHub API\n");
+	return;
+}
+if($result->getCode() !== 200){
+	fwrite(STDERR, "Error accessing GitHub API: " . $result->getCode() . "\n");
+	fwrite(STDERR, $result->getBody() . "\n");
+	exit(1);
+}
+
+$releaseInfoJson = json_decode($result->getBody(), true, JSON_THROW_ON_ERROR);
+if(!is_array($releaseInfoJson)){
+	fwrite(STDERR, "Invalid release JSON returned from GitHub API\n");
+	exit(1);
+}
+$buildInfoPath = 'https://github.com/' . $repo . '/releases/download/' . $tagName . '/build_info.json';
+
+$buildInfoResult = Internet::getURL($buildInfoPath, extraHeaders: [
+	'Authorization: token ' . $token
+]);
+if($buildInfoResult === null){
+	fwrite(STDERR, "missing build_info.json\n");
+	exit(1);
+}
+if($buildInfoResult->getCode() !== 200){
+	fwrite(STDERR, "error accessing build_info.json: " . $buildInfoResult->getCode() . "\n");
+	fwrite(STDERR, $buildInfoResult->getBody() . "\n");
+	exit(1);
+}
+
+$buildInfoJson = json_decode($buildInfoResult->getBody(), true, JSON_THROW_ON_ERROR);
+if(!is_array($buildInfoJson)){
+	fwrite(STDERR, "invalid build_info.json\n");
+	exit(1);
+}
+$detailsUrl = $buildInfoJson["details_url"];
+$sourceUrl = $buildInfoJson["source_url"];
+$pharDownloadUrl = $buildInfoJson["download_url"];
+$buildLogUrl = $buildInfoJson["build_log_url"];
+$phpBinaryUrl = $buildInfoJson["php_download_url"] ?? null;
+
+$description = $releaseInfoJson["body"];
+
+$discordPayload = generateDiscordEmbed(
+	$buildInfoJson["base_version"],
+	$buildInfoJson["channel"],
+	$description,
+	$detailsUrl,
+	$sourceUrl,
+	$pharDownloadUrl,
+	$buildLogUrl,
+	(int) $newsPingRoleId,
+	$phpBinaryUrl
+);
+
+$response = Internet::postURL(
+	$hookURL,
+	json_encode($discordPayload, JSON_THROW_ON_ERROR),
+	extraHeaders: ['Content-Type: application/json']
+);
+if($response?->getCode() !== 204){
+	fwrite(STDERR, "failed to send Discord webhook\n");
+	fwrite(STDERR, $response?->getBody() ?? "no response body\n");
+	exit(1);
+}

.github/workflows/discord-release-notify.yml

@@ -0,0 +1,38 @@
+name: Notify Discord webhook of release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP and tools
+        uses: shivammathur/setup-php@2.31.1
+        with:
+          php-version: 8.2
+
+      - name: Restore Composer package cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/composer/files
+            ~/.cache/composer/vcs
+          key: "composer-v2-cache-${{ hashFiles('./composer.lock') }}"
+          restore-keys: |
+            composer-v2-cache-
+
+      - name: Install Composer dependencies
+        run: composer install --no-dev --prefer-dist --no-interaction --ignore-platform-reqs
+
+      - name: Get actual tag name
+        id: tag-name
+        run: echo TAG_NAME=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{') >> $GITHUB_OUTPUT
+
+      - name: Run webhook post script
+        run: php .github/workflows/discord-release-embed.php ${{ github.repository }} ${{ steps.tag-name.outputs.TAG_NAME }} ${{ github.token }} ${{ secrets.DISCORD_RELEASE_WEBHOOK }} ${{ secrets.DISCORD_NEWS_PING_ROLE_ID }}

.github/workflows/draft-release.yml

@@ -11,19 +11,21 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
+      matrix:
+        php-version: [8.2]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@2.12.0
+        uses: shivammathur/setup-php@2.31.1
         with:
-          php-version: 8.0
+          php-version: ${{ matrix.php-version }}
 
       - name: Restore Composer package cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.cache/composer/files
@@ -35,48 +37,71 @@ jobs:
       - name: Install Composer dependencies
         run: composer install --no-dev --prefer-dist --no-interaction --ignore-platform-reqs
 
-      - name: Patch VersionInfo
+      - name: Calculate build number
+        id: build-number
         run: |
-          BUILD_NUMBER=2000+$GITHUB_RUN_NUMBER #to stay above jenkins
+          BUILD_NUMBER=$((2000+$GITHUB_RUN_NUMBER)) #to stay above jenkins
           echo "Build number: $BUILD_NUMBER"
-          sed -i "s/const BUILD_NUMBER = 0/const BUILD_NUMBER = ${BUILD_NUMBER}/" src/VersionInfo.php
+          echo BUILD_NUMBER=$BUILD_NUMBER >> $GITHUB_OUTPUT
 
       - name: Minify BedrockData JSON files
-        run: php resources/vanilla/.minify_json.php
+        run: php vendor/pocketmine/bedrock-data/.minify_json.php
 
       - name: Build PocketMine-MP.phar
-        run: php -dphar.readonly=0 build/server-phar.php --git ${{ github.sha }}
+        run: php -dphar.readonly=0 build/server-phar.php --git ${{ github.sha }} --build ${{ steps.build-number.outputs.BUILD_NUMBER }}
 
       - name: Get PocketMine-MP release version
         id: get-pm-version
         run: |
-          echo ::set-output name=PM_VERSION::$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BASE_VERSION;')
-          echo ::set-output name=MCPE_VERSION::$(php -r 'require "vendor/autoload.php"; echo \pocketmine\network\mcpe\protocol\ProtocolInfo::MINECRAFT_VERSION_NETWORK;')
-          echo ::set-output name=PM_VERSION_SHORT::$(php -r 'require "vendor/autoload.php"; $v = explode(".", \pocketmine\VersionInfo::BASE_VERSION); array_pop($v); echo implode(".", $v);')
-          echo ::set-output name=PM_VERSION_MD::$(php -r 'require "vendor/autoload.php"; echo str_replace(".", "", \pocketmine\VersionInfo::BASE_VERSION);')
+          echo PM_VERSION=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BASE_VERSION;') >> $GITHUB_OUTPUT
+          echo MCPE_VERSION=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\network\mcpe\protocol\ProtocolInfo::MINECRAFT_VERSION_NETWORK;') >> $GITHUB_OUTPUT
+          echo PM_VERSION_SHORT=$(php -r 'require "vendor/autoload.php"; $v = explode(".", \pocketmine\VersionInfo::BASE_VERSION); array_pop($v); echo implode(".", $v);') >> $GITHUB_OUTPUT
+          echo PM_VERSION_MD=$(php -r 'require "vendor/autoload.php"; echo str_replace(".", "", \pocketmine\VersionInfo::BASE_VERSION);') >> $GITHUB_OUTPUT
+          echo CHANGELOG_SUFFIX=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BUILD_CHANNEL === "stable" ? "" : "-" . \pocketmine\VersionInfo::BUILD_CHANNEL;') >> $GITHUB_OUTPUT
+          echo PRERELEASE=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BUILD_CHANNEL === "stable" ? "false" : "true";') >> $GITHUB_OUTPUT
+
+      - name: Generate PHP binary download URL
+        id: php-binary-url
+        run: |
+          echo PHP_BINARY_URL="${{ github.server_url }}/${{ github.repository_owner }}/PHP-Binaries/releases/tag/php-${{ matrix.php-version }}-latest" >> $GITHUB_OUTPUT
 
       - name: Generate build info
-        run: php build/generate-build-info-json.php ${{ github.sha }} ${{ steps.get-pm-version.outputs.PM_VERSION }} ${{ github.repository }} > build_info.json
+        run: |
+          php build/generate-build-info-json.php \
+            ${{ github.sha }} \
+            ${{ steps.get-pm-version.outputs.PM_VERSION }} \
+            ${{ github.repository }} \
+            ${{ steps.build-number.outputs.BUILD_NUMBER }} \
+            ${{ github.run_id }} \
+            ${{ steps.php-binary-url.outputs.PHP_BINARY_URL }} \
+            > build_info.json
+
+      - name: Generate core permission doc for doc.pmmp.io
+        run: php tools/generate-permission-doc.php rst
 
       - name: Upload release artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: release_artifacts
           path: |
             ${{ github.workspace }}/PocketMine-MP.phar
             ${{ github.workspace }}/start.*
             ${{ github.workspace }}/build_info.json
+            ${{ github.workspace }}/core-permissions.rst
 
       - name: Create draft release
-        uses: ncipollo/release-action@v1.8.6
+        uses: ncipollo/release-action@v1.14.0
         with:
-          artifacts: ${{ github.workspace }}/PocketMine-MP.phar,${{ github.workspace }}/start.*,${{ github.workspace }}/build_info.json
+          artifacts: ${{ github.workspace }}/PocketMine-MP.phar,${{ github.workspace }}/start.*,${{ github.workspace }}/build_info.json,${{ github.workspace }}/core-permissions.rst
           commit: ${{ github.sha }}
           draft: true
+          prerelease: ${{ steps.get-pm-version.outputs.PRERELEASE }}
           name: PocketMine-MP ${{ steps.get-pm-version.outputs.PM_VERSION }}
           tag: ${{ steps.get-pm-version.outputs.PM_VERSION }}
           token: ${{ secrets.GITHUB_TOKEN }}
           body: |
             **For Minecraft: Bedrock Edition ${{ steps.get-pm-version.outputs.MCPE_VERSION }}**
 
-            Please see the [changelogs](/changelogs/${{ steps.get-pm-version.outputs.PM_VERSION_SHORT }}.md#${{ steps.get-pm-version.outputs.PM_VERSION_MD }}) for details.
+            Please see the [changelogs](${{ github.server_url }}/${{ github.repository }}/blob/${{ steps.get-pm-version.outputs.PM_VERSION }}/changelogs/${{ steps.get-pm-version.outputs.PM_VERSION_SHORT }}${{ steps.get-pm-version.outputs.CHANGELOG_SUFFIX }}.md#${{ steps.get-pm-version.outputs.PM_VERSION_MD }}) for details.
+
+            :information_source: Download the recommended PHP binary [here](${{ steps.php-binary-url.outputs.PHP_BINARY_URL }}).

.github/workflows/main-php-matrix.yml

@@ -0,0 +1,156 @@
+name: CI (all supported PHP versions)
+
+on:
+  workflow_call:
+    inputs:
+      php:
+        description: 'PHP version in X.Y format'
+        required: true
+        type: string
+
+      #these are parameterized to ease updating
+      pm-version-major:
+        description: 'PocketMine-MP major version'
+        default: 5
+        type: number
+      image:
+        description: 'Runner image to use'
+        default: 'ubuntu-20.04'
+        type: string
+
+jobs:
+  phpstan:
+    name: PHPStan analysis
+    runs-on: ${{ inputs.image }}
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: pmmp/setup-php-action@3.1.0
+        with:
+          php-version: ${{ inputs.php }}
+          install-path: "./bin"
+          pm-version-major: ${{ inputs.pm-version-major }}
+
+      - name: Restore Composer package cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/composer/files
+            ~/.cache/composer/vcs
+          key: "composer-v2-cache-${{ inputs.php }}-${{ hashFiles('./composer.lock') }}"
+          restore-keys: |
+            composer-v2-cache-
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-interaction
+
+      - name: Run PHPStan
+        run: ./vendor/bin/phpstan analyze --no-progress --memory-limit=2G
+
+  phpunit:
+    name: PHPUnit tests
+    runs-on: ${{ inputs.image }}
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: pmmp/setup-php-action@3.1.0
+        with:
+          php-version: ${{ inputs.php }}
+          install-path: "./bin"
+          pm-version-major: ${{ inputs.pm-version-major }}
+
+      - name: Restore Composer package cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/composer/files
+            ~/.cache/composer/vcs
+          key: "composer-v2-cache-${{ inputs.php }}-${{ hashFiles('./composer.lock') }}"
+          restore-keys: |
+            composer-v2-cache-
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-interaction
+
+      - name: Run PHPUnit tests
+        run: ./vendor/bin/phpunit --bootstrap vendor/autoload.php --fail-on-warning tests/phpunit
+
+  integration:
+    name: Integration tests
+    runs-on: ${{ inputs.image }}
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Setup PHP
+        uses: pmmp/setup-php-action@3.1.0
+        with:
+          php-version: ${{ inputs.php }}
+          install-path: "./bin"
+          pm-version-major: ${{ inputs.pm-version-major }}
+
+      - name: Restore Composer package cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/composer/files
+            ~/.cache/composer/vcs
+          key: "composer-v2-cache-${{ inputs.php }}-${{ hashFiles('./composer.lock') }}"
+          restore-keys: |
+            composer-v2-cache-
+
+      - name: Install Composer dependencies
+        run: composer install --no-dev --prefer-dist --no-interaction
+
+      - name: Run integration tests
+        run: ./tests/travis.sh -t4
+
+  codegen:
+    name: Generated Code consistency checks
+    runs-on: ${{ inputs.image }}
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: pmmp/setup-php-action@3.1.0
+        with:
+          php-version: ${{ inputs.php }}
+          install-path: "./bin"
+          pm-version-major: ${{ inputs.pm-version-major }}
+
+      - name: Restore Composer package cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/composer/files
+            ~/.cache/composer/vcs
+          key: "composer-v2-cache-${{ inputs.php }}-${{ hashFiles('./composer.lock') }}"
+          restore-keys: |
+            composer-v2-cache-
+
+      - name: Install Composer dependencies
+        run: composer install --no-dev --prefer-dist --no-interaction
+
+      - name: Update generated code
+        run: composer update-codegen
+
+      - name: Verify code is unchanged
+        run: |
+          git diff
+          git diff --quiet

.github/workflows/main.yml

@@ -6,182 +6,17 @@ on:
   workflow_dispatch:
 
 jobs:
-  build-php:
-    name: Prepare PHP
-    runs-on: ${{ matrix.image }}
-
-    strategy:
-      matrix:
-        image: [ubuntu-20.04]
-        php: [8.0.9]
-
-    steps:
-      - uses: actions/checkout@v2 #needed for build.sh
-      - name: Check for PHP build cache
-        id: php-build-cache
-        uses: actions/cache@v2
-        with:
-          path: "./bin"
-          key: "php-build-generic-${{ matrix.php }}-${{ matrix.image }}-${{ hashFiles('./tests/gh-actions/build.sh') }}"
-
-      - name: Compile PHP
-        if: steps.php-build-cache.outputs.cache-hit != 'true'
-        run: ./tests/gh-actions/build.sh "${{ matrix.php }}"
-
-  phpstan:
-    name: PHPStan analysis
-    needs: build-php
-    runs-on: ${{ matrix.image }}
-
+  all-php-versions:
+    name: PHP ${{ matrix.php }}
     strategy:
       fail-fast: false
       matrix:
-        image: [ubuntu-20.04]
-        php: [8.0.9]
+        php: ["8.1", "8.2", "8.3"]
 
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Restore PHP build cache
-        id: php-build-cache
-        uses: actions/cache@v2
-        with:
-          path: "./bin"
-          key: "php-build-generic-${{ matrix.php }}-${{ matrix.image }}-${{ hashFiles('./tests/gh-actions/build.sh') }}"
-
-      - name: Kill build on PHP build cache miss (should never happen)
-        if: steps.php-build-cache.outputs.cache-hit != 'true'
-        run: exit 1
-
-      - name: Install cached PHP's dependencies
-        if: steps.php-build-cache.outputs.cache-hit == 'true'
-        run: ./tests/gh-actions/install-dependencies.sh
-
-      - name: Prefix PHP to PATH
-        run: echo "$(pwd)/bin/php7/bin" >> $GITHUB_PATH
-
-      - name: Install Composer
-        run: curl -sS https://getcomposer.org/installer | php
-
-      - name: Restore Composer package cache
-        uses: actions/cache@v2
-        with:
-          path: |
-            ~/.cache/composer/files
-            ~/.cache/composer/vcs
-          key: "composer-v2-cache-${{ matrix.php }}-${{ hashFiles('./composer.lock') }}"
-          restore-keys: |
-            composer-v2-cache-
-
-      - name: Install Composer dependencies
-        run: php composer.phar install --prefer-dist --no-interaction
-
-      - name: Run PHPStan
-        run: ./vendor/bin/phpstan analyze --no-progress --memory-limit=2G
-
-  phpunit:
-    name: PHPUnit tests
-    needs: build-php
-    runs-on: ${{ matrix.image }}
-    strategy:
-      fail-fast: false
-      matrix:
-        image: [ubuntu-20.04]
-        php: [8.0.9]
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-
-      - name: Restore PHP build cache
-        id: php-build-cache
-        uses: actions/cache@v2
-        with:
-          path: "./bin"
-          key: "php-build-generic-${{ matrix.php }}-${{ matrix.image }}-${{ hashFiles('./tests/gh-actions/build.sh') }}"
-
-      - name: Kill build on PHP build cache miss (should never happen)
-        if: steps.php-build-cache.outputs.cache-hit != 'true'
-        run: exit 1
-
-      - name: Install cached PHP's dependencies
-        if: steps.php-build-cache.outputs.cache-hit == 'true'
-        run: ./tests/gh-actions/install-dependencies.sh
-
-      - name: Prefix PHP to PATH
-        run: echo "$(pwd)/bin/php7/bin" >> $GITHUB_PATH
-
-      - name: Install Composer
-        run: curl -sS https://getcomposer.org/installer | php
-
-      - name: Restore Composer package cache
-        uses: actions/cache@v2
-        with:
-          path: |
-            ~/.cache/composer/files
-            ~/.cache/composer/vcs
-          key: "composer-v2-cache-${{ matrix.php }}-${{ hashFiles('./composer.lock') }}"
-          restore-keys: |
-            composer-v2-cache-
-
-      - name: Install Composer dependencies
-        run: php composer.phar install --prefer-dist --no-interaction
-
-      - name: Run PHPUnit tests
-        run: ./vendor/bin/phpunit --bootstrap vendor/autoload.php --fail-on-warning tests/phpunit
-
-  integration:
-    name: Integration tests
-    needs: build-php
-    runs-on: ${{ matrix.image }}
-    strategy:
-      fail-fast: false
-      matrix:
-        image: [ubuntu-20.04]
-        php: [8.0.9]
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-
-      - name: Restore PHP build cache
-        id: php-build-cache
-        uses: actions/cache@v2
-        with:
-          path: "./bin"
-          key: "php-build-generic-${{ matrix.php }}-${{ matrix.image }}-${{ hashFiles('./tests/gh-actions/build.sh') }}"
-
-      - name: Kill build on PHP build cache miss (should never happen)
-        if: steps.php-build-cache.outputs.cache-hit != 'true'
-        run: exit 1
-
-      - name: Install cached PHP's dependencies
-        if: steps.php-build-cache.outputs.cache-hit == 'true'
-        run: ./tests/gh-actions/install-dependencies.sh
-
-      - name: Prefix PHP to PATH
-        run: echo "$(pwd)/bin/php7/bin" >> $GITHUB_PATH
-
-      - name: Install Composer
-        run: curl -sS https://getcomposer.org/installer | php
-
-      - name: Restore Composer package cache
-        uses: actions/cache@v2
-        with:
-          path: |
-            ~/.cache/composer/files
-            ~/.cache/composer/vcs
-          key: "composer-v2-cache-${{ matrix.php }}-${{ hashFiles('./composer.lock') }}"
-          restore-keys: |
-            composer-v2-cache-
-
-      - name: Install Composer dependencies
-        run: php composer.phar install --no-dev --prefer-dist --no-interaction
-
-      - name: Run integration tests
-        run: ./tests/travis.sh -t4
+    uses: ./.github/workflows/main-php-matrix.yml
+    with:
+      php: ${{ matrix.php }}
+    secrets: inherit
 
   codestyle:
     name: Code Style checks
@@ -190,13 +25,15 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup PHP and tools
-        uses: shivammathur/setup-php@2.9.0
+        uses: shivammathur/setup-php@2.31.1
         with:
-          php-version: 8.0
-          tools: php-cs-fixer
+          php-version: 8.2
+          tools: php-cs-fixer:3.49
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run PHP-CS-Fixer
-        run: php-cs-fixer fix --dry-run --diff
+        run: php-cs-fixer fix --dry-run --diff --ansi

.github/workflows/support.yml

@@ -8,12 +8,19 @@ jobs:
   support:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/support-requests@v2
+      - uses: dessant/support-requests@v4
         with:
           github-token: ${{ github.token }}
           support-label:  "Support request"
           issue-comment: >
-            Thanks, but this issue tracker is not intended for support requests. Please read the guidelines on [submitting an issue](https://github.com/pmmp/PocketMine-MP/blob/master/CONTRIBUTING.md#creating-an-issue).
+            Hi, we only accept **bug reports** on this issue tracker, but this issue looks like a support request.
+
+
+            Instead of creating an issue, try the following:
+
+            - Check our [Documentation](https://doc.pmmp.io) to see if you can find answers there
+
+            - Ask the community on our [Discord server](https://discord.gg/bmSAZBG) or our [Forums](https://forums.pmmp.io)
 
 
             [Docs](https://pmmp.rtfd.io) | [Discord](https://discord.gg/bmSAZBG) | [Forums](https://forums.pmmp.io)

.github/workflows/update-php-versions.php

@@ -1,51 +0,0 @@
-<?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);
-
-const VERSIONS = [
-	"7.3",
-	"7.4",
-	"8.0"
-];
-
-$workflowFile = file_get_contents(__DIR__ . '/main.yml');
-$newWorkflowFile = $workflowFile;
-foreach(VERSIONS as $v){
-	$releaseInfo = file_get_contents("https://secure.php.net/releases?json&version=$v");
-	if($releaseInfo === false){
-		throw new \RuntimeException("Failed to contact php.net API");
-	}
-	$data = json_decode($releaseInfo, true);
-	if(!is_array($data) || !isset($data["version"]) || !is_string($data["version"]) || preg_match('/^\d+\.\d+\.\d+(-[A-Za-z\d]+)?$/', $data["version"]) === 0){
-		throw new \RuntimeException("Invalid data returned by API");
-	}
-	$updated = preg_replace("/$v\.\d+/", $data["version"], $newWorkflowFile);
-	if($updated !== $newWorkflowFile){
-		echo "Updated $v revision to " . $data["version"] . "\n";
-	}
-	$newWorkflowFile = $updated;
-}
-
-if($workflowFile !== $newWorkflowFile){
-	echo "Writing modified workflow file\n";
-	file_put_contents(__DIR__ . '/main.yml', $newWorkflowFile);
-}

.github/workflows/update-updater-api.yml

@@ -8,30 +8,76 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    concurrency: update-updater-api # only one job can run at a time, to avoid git conflicts when updating the repository
 
     steps:
       - name: Install jq
         run: sudo apt update && sudo apt install jq -y
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
-          repository: pmmp/update.pmmp.io
+          repository: ${{ github.repository_owner }}/update.pmmp.io
           ssh-key: ${{ secrets.UPDATE_PMMP_IO_DEPLOY_KEY }}
 
       - name: Get actual tag name
         id: tag-name
-        run: echo ::set-output name=TAG_NAME::$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{')
+        run: echo TAG_NAME=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{') >> $GITHUB_OUTPUT
 
       - name: Download new release information
         run: curl -f -L ${{ github.server_url }}/${{ github.repository }}/releases/download/${{ steps.tag-name.outputs.TAG_NAME }}/build_info.json -o new_build_info.json
 
-      - name: Detect channel
+      - name: Detect channels
         id: channel
-        run: echo ::set-output name=CHANNEL::$(jq -r '.channel' new_build_info.json)
-
-      - name: Copy release information
         run: |
-          cp new_build_info.json channels/${{ steps.channel.outputs.CHANNEL }}.json
+          CHANNEL=$(jq -r '.channel' new_build_info.json)
+          VERSION=${{ steps.tag-name.outputs.TAG_NAME }}
+          echo CHANNEL=$CHANNEL >> $GITHUB_OUTPUT
+          if [ "$CHANNEL" == "stable" ]; then
+            echo MAJOR=$(echo $VERSION | cut -d. -f1) >> $GITHUB_OUTPUT
+            echo MINOR=$(echo $VERSION | cut -d. -f1-2) >> $GITHUB_OUTPUT
+          else
+            echo MAJOR=$(echo $VERSION | cut -d. -f1)-$CHANNEL >> $GITHUB_OUTPUT
+            echo MINOR=$(echo $VERSION | cut -d. -f1-2)-$CHANNEL >> $GITHUB_OUTPUT
+          fi
+
+      - name: Update channel info
+        run: |
+          function version_id() {
+            major=$(echo $1 | cut -d. -f1)
+            minor=$(echo $1 | cut -d. -f2)
+            patch=$(echo $1 | cut -d. -f3)
+            echo $(((major * 1000000) + (minor * 1000) + patch))
+          }
+
+          function update_channel() {
+            local target_file_name="$1"
+            local new_file_name="$2"
+
+            local old_version_id
+            local new_version_id
+
+            if [ ! -f "$target_file_name" ]; then
+              echo "Creating channel file: $target_file_name"
+              cp "$new_file_name" "$target_file_name"
+            else
+              old_version_id=$(version_id "$(jq -r '.base_version' "$target_file_name")")
+              new_version_id=$(version_id "$(jq -r '.base_version' "$new_file_name")")
+
+              echo "Old version ID: $old_version_id"
+              echo "New version ID: $new_version_id"
+
+              if [ $new_version_id -ge $old_version_id ]; then #suffixed versions will have the same version ID - assume they'll always be newer
+                echo "Updating channel file: $target_file_name ($old_version_id -> $new_version_id)"
+                cp "$new_file_name" "$target_file_name"
+              else
+                echo "Version $new_version_id is less than $old_version_id, not updating channel file: $target_file_name"
+              fi
+            fi
+          }
+
+          update_channel "channels/${{ steps.channel.outputs.CHANNEL }}.json" "new_build_info.json"
+          update_channel "channels/${{ steps.channel.outputs.MAJOR }}.json" "new_build_info.json"
+          update_channel "channels/${{ steps.channel.outputs.MINOR }}.json" "new_build_info.json"
           rm new_build_info.json
 
       - name: Commit changes

.gitignore

@@ -53,3 +53,6 @@ Documentation/*
 # php-cs-fixer
 /.php_cs.cache
 /.php-cs-fixer.cache
+
+# install-local-protocol.sh
+/composer-local-protocol.*

.gitmodules

@@ -1,12 +1,6 @@
-[submodule "resources/locale"]
-	path = resources/locale
-	url = https://github.com/pmmp/Language.git
 [submodule "tests/plugins/DevTools"]
 	path = tests/plugins/DevTools
 	url = https://github.com/pmmp/DevTools.git
 [submodule "build/php"]
 	path = build/php
 	url = https://github.com/pmmp/php-build-scripts.git
-[submodule "resources/vanilla"]
-	path = resources/vanilla
-	url = https://github.com/pmmp/BedrockData.git

.idea/codeStyles/Project.xml

@@ -30,6 +30,13 @@
         <option name="USE_TAB_CHARACTER" value="true" />
       </indentOptions>
     </codeStyleSettings>
+    <codeStyleSettings language="Markdown">
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
     <codeStyleSettings language="PHP">
       <option name="CLASS_BRACE_STYLE" value="1" />
       <option name="METHOD_BRACE_STYLE" value="1" />
@@ -62,6 +69,11 @@
         <option name="USE_TAB_CHARACTER" value="true" />
       </indentOptions>
     </codeStyleSettings>
+    <codeStyleSettings language="Shell Script">
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
     <codeStyleSettings language="neon">
       <indentOptions>
         <option name="USE_TAB_CHARACTER" value="true" />

.idea/fileTemplates/includes/PHP File Header.php

@@ -16,6 +16,6 @@
  * @link http://www.pocketmine.net/
  *
  *
-*/
+ */
 
 declare(strict_types=1);

.php-cs-fixer.php

@@ -18,6 +18,9 @@ return (new PhpCsFixer\Config)
 		'array_syntax' => [
 			'syntax' => 'short'
 		],
+		'binary_operator_spaces' => [
+			'default' => 'single_space'
+		],
 		'blank_line_after_namespace' => true,
 		'blank_line_after_opening_tag' => true,
 		'blank_line_before_statement' => [
@@ -33,16 +36,47 @@ return (new PhpCsFixer\Config)
 		],
 		'declare_strict_types' => true,
 		'elseif' => true,
+		'fully_qualified_strict_types' => true,
 		'global_namespace_import' => [
 			'import_constants' => true,
 			'import_functions' => true,
 			'import_classes' => null,
 		],
+		'header_comment' => [
+			'comment_type' => 'comment',
+			'header' => <<<BODY
+
+ ____            _        _   __  __ _                  __  __ ____
+|  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+| |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+|  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+|_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+
+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/
+
+
+BODY,
+			'location' => 'after_open'
+		],
 		'indentation_type' => true,
+		'logical_operators' => true,
+		'native_constant_invocation' => [
+			'scope' => 'namespaced'
+		],
 		'native_function_invocation' => [
 			'scope' => 'namespaced',
 			'include' => ['@all'],
 		],
+		'new_with_braces' => [
+			'named_class' => true,
+			'anonymous_class' => false,
+		],
 		'no_closing_tag' => true,
 		'no_empty_phpdoc' => true,
 		'no_extra_blank_lines' => true,
@@ -61,10 +95,26 @@ return (new PhpCsFixer\Config)
 			],
 			'sort_algorithm' => 'alpha'
 		],
+		'phpdoc_align' => [
+			'align' => 'vertical',
+			'tags' => [
+				'param',
+			]
+		],
+		'phpdoc_line_span' => [
+			'property' => 'single',
+			'method' => null,
+			'const' => null
+		],
 		'phpdoc_trim' => true,
 		'phpdoc_trim_consecutive_blank_line_separation' => true,
+		'return_type_declaration' => [
+			'space_before' => 'one'
+		],
+		'single_blank_line_at_eof' => true,
 		'single_import_per_statement' => true,
 		'strict_param' => true,
+		'unary_operator_spaces' => true,
 	])
 	->setFinder($finder)
 	->setIndent("\t")

BUILDING.md

@@ -2,25 +2,24 @@
 ## Pre-requisites
 - A bash shell (git bash is sufficient for Windows)
 - [`git`](https://git-scm.com) available in your shell
-- PHP 7.4 or newer available in your shell
+- PHP 8.2 or newer available in your shell
 - [`composer`](https://getcomposer.org) available in your shell
 
 ## Custom PHP binaries
 Because PocketMine-MP requires several non-standard PHP extensions and configuration, PMMP provides scripts to build custom binaries for running PocketMine-MP, as well as prebuilt binaries.
 
-- [Prebuilt binaries](https://jenkins.pmmp.io/job/PHP-7.4-Aggregate)
+- [Prebuilt binaries](https://github.com/pmmp/PHP-Binaries/releases)
 - [Compile scripts](https://github.com/pmmp/php-build-scripts) are provided as a submodule in the path `build/php`
 
 If you use a custom binary, you'll need to replace `composer` usages in this guide with `path/to/your/php path/to/your/composer.phar`.
 
 ## Setting up environment
-1. `git clone --recursive https://github.com/pmmp/PocketMine-MP.git`
+1. `git clone https://github.com/pmmp/PocketMine-MP.git`
 2. `composer install`
 
 ## Checking out a different branch to build
 1. `git checkout <branch to checkout>`
-2. `git submodule update --init`
-3. Re-run `composer install` to synchronize dependencies.
+2. Re-run `composer install` to synchronize dependencies.
 
 ## Optimizing for release builds
 1. Add the flags `--no-dev --classmap-authoritative` to your `composer install` command. This will reduce build size and improve autoloading speed.
@@ -30,11 +29,5 @@ Run `composer make-server` using your preferred PHP binary. It'll drop a `Pocket
 
 You can also use the `--out` option to change the output filename.
 
-There is a bug in PHP that might cause an error which looks like this:
-```
-Fatal error: Uncaught BadMethodCallException: unable to create temporary file in PocketMine-MP/build/server-phar.php:119
-```
-You can work around it by setting `ulimit -n` to some bigger number, e.g. `8192`, or by updating your PHP version to at least 7.4.16 or 8.0.3.
-
 ## Running PocketMine-MP from source code
 Run `src/PocketMine.php` using your preferred PHP binary.

CONTRIBUTING.md

@@ -18,6 +18,59 @@ Larger contributions like feature additions should be preceded by a [Change Prop
 ## Other things you'll need
 - [git](https://git-scm.com/)
 
+## List of `pocketmine` namespaces which are in other repos
+PocketMine-MP has several dependencies which are independent from the main server code. Most of them use the `pocketmine` namespace.
+Some of these add extra classes to packages which already exist in PocketMine-MP.
+
+Take a look at the table below if you can't find the class or function you're looking for.
+
+| Source URL                                                      | Namespace, class or function                                                                                                             |
+|:----------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|
+| [pmmp/BedrockProtocol](https://github.com/pmmp/BedrockProtocol) | `pocketmine\network\mcpe\protocol`                                                                                                       |
+| [pmmp/BinaryUtils](https://github.com/pmmp/BinaryUtils)         | `pocketmine\utils\BinaryDataException`</br>`pocketmine\utils\BinaryStream`</br>`pocketmine\utils\Binary`                                 |
+| [pmmp/Color](https://github.com/pmmp/Color)                     | `pocketmine\color`                                                                                                                       |
+| [pmmp/ErrorHandler](https://github.com/pmmp/ErrorHandler)       | `pocketmine\errorhandler`                                                                                                                |
+| [pmmp/Log](https://github.com/pmmp/Log)                         | `AttachableLogger`</br>`BufferedLogger`</br>`GlobalLogger`</br>`LogLevel`</br>`Logger`</br>`PrefixedLogger`</br>`SimpleLogger`           |
+| [pmmp/Math](https://github.com/pmmp/Math)                       | `pocketmine\math`                                                                                                                        |
+| [pmmp/NBT](https://github.com/pmmp/NBT)                         | `pocketmine\nbt`                                                                                                                         |
+| [pmmp/RakLibIpc](https://github.com/pmmp/RakLibIpc)             | `raklib\server\ipc`                                                                                                                      |
+| [pmmp/RakLib](https://github.com/pmmp/RakLib)                   | `raklib`                                                                                                                                 |
+| [pmmp/Snooze](https://github.com/pmmp/Snooze)                   | `pocketmine\snooze`                                                                                                                      |
+| [pmmp/ext-chunkutils2](https://github.com/pmmp/ext-chunkutils2) | `pocketmine\world\format\LightArray`</br>`pocketmine\world\format\PalettedBlockArray`</br>`pocketmine\world\format\io\SubChunkConverter` |
+| [pmmp/ext-morton](https://github.com/pmmp/ext-morton)           | `morton2d_decode`</br>`morton2d_encode`</br>`morton3d_decode`</br>`morton3d_encode`                                                      |
+| [pmmp/ext-libdeflate](https://github.com/pmmp/ext-libdeflate)   | `libdeflate_deflate_compress`</br>`libdeflate_gzip_compress`</br>`libdeflate_zlib_compress`                                              |
+
+## Choosing a target branch
+PocketMine-MP has three primary branches of development.
+
+| Type of change                                                                              | `stable` |          `minor-next`           | `major-next` |
+|:--------------------------------------------------------------------------------------------|:--------:|:-------------------------------:|:------------:|
+| Bug fixes                                                                                   |    ✔️    |               ✔️                |      ✔️      |
+| Improvements to API docs                                                                    |    ✔️    |               ✔️                |      ✔️      |
+| Cleaning up code                                                                            |    ❌     |               ✔️                |      ✔️      |
+| Changing code formatting or style                                                           |    ❌     |               ✔️                |      ✔️      |
+| Addition of new core features                                                               |    ❌     |    🟡 Only if non-disruptive    |      ✔️      |
+| Changing core behaviour (e.g. making something use threads)                                 |    ❌     |               ✔️                |      ✔️      |
+| Addition of new configuration options                                                       |    ❌     |       🟡 Only if optional       |      ✔️      |
+| Addition of new API classes, methods or constants                                           |    ❌     |               ✔️                |      ✔️      |
+| Deprecating API classes, methods or constants                                               |    ❌     |               ✔️                |      ✔️      |
+| Adding optional parameters to an API method                                                 |    ❌     |               ✔️                |      ✔️      |
+| Changing API behaviour                                                                      |    ❌     | 🟡 Only if backwards-compatible |      ✔️      |
+| Removal of API                                                                              |    ❌     |                ❌                |      ✔️      |
+| Backwards-incompatible API change (e.g. renaming a method)                                  |    ❌     |                ❌                |      ✔️      |
+| Backwards-incompatible internals change (e.g. changing things in `pocketmine\network\mcpe`) |    ❌     |               ✔️                |      ✔️      |
+
+### Notes
+- **Non-disruptive** means that usage should not be significantly altered by the change.
+  - Examples of **non-disruptive** changes include adding new commands, or gameplay features like blocks and items.
+  - Examples of **disruptive** changes include changing the way the server is run, world format changes (since those require downtime for the user to convert their world).
+- **API** includes all public and protected classes, functions and constants (unless marked as `@internal`).
+  - Private members are not part of the API, **unless in a trait**.
+  - The `pocketmine\network\mcpe` package is considered implicitly `@internal` in its entirety (see its [README](src/network/mcpe/README.md) for more details).
+- Minecraft's protocol changes are considered necessary internal changes, and are **not** subject to the same rules.
+  - Protocol changes must always be released in a new minor version, since they disrupt user experience by requiring a client update.
+- BC-breaking changes to the internal network API are allowed, but only in new minor versions. This ensures that plugins which use the internal network API will not break (though they shouldn't use such API anyway).
+
 ## Making a pull request
 The basic procedure to create a pull request is:
 1. [Fork the repository on GitHub](https://github.com/pmmp/PocketMine-MP/fork). This gives you your own copy of the repository to make changes to.
@@ -35,45 +88,58 @@ Depending on the changes, maintainers might ask you to make changes to the PR to
 ### Requirements
 The following are required as a minimum for pull requests. PRs that don't meet these requirements will be declined unless updated to meet them.
 
-#### Licensing
-PocketMine-MP is licensed under [LGPLv3 license](LICENSE).
-By proposing a pull request, you agree to your code being distributed within PocketMine-MP under the same license.
-If you take code from other projects, that code MUST be licensed under an LGPL-compatible license.
-
-#### PRs should be about exactly ONE thing
-If you want to make multiple changes, those changes should each be contributed as separate pull requests. **DO NOT** mix unrelated changes.
-
-#### PRs must not include unnecessary/unrelated changes
-Do not include changes which aren't strictly necessary. This makes it harder to review a PR, because the code diff becomes larger and harder to review.
-This means:
-- don't reformat or rearrange existing code
-- don't change things that aren't related to the PR's objective
-- don't rewrite existing code just to make it "look nicer"
-- don't change PhpDocs to native types in code you didn't write
-
-#### Tests must be provided
-Where possible, PHPUnit tests should be written for new or changed code.
-If that's not possible (e.g. for in-game functionality), the code must be tested manually and details of the tests done must be provided.
-**Simply saying "Tested" is not acceptable** and will lead to your PR being declined.
-
-#### Comments and documentation must be written in American English
-English is the shared languages of all current maintainers.
-
-#### Code must be in the PocketMine-MP style
-It's your responsibility to ensure your code matches the formatting and styling of the rest of the code.
-If you use PhpStorm, a `Project` code style is provided, which you can use to automatically format new code.
-You can also use [`php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to format your code.
+- **All code must be licensed under the [LGPLv3 license](LICENSE)** as per PocketMine-MP's own license, or a compatible license.
+  - By proposing a pull request, you agree to your code being distributed within PocketMine-MP under the same license.
+  - If you take code from other projects, that code MUST be licensed under an LGPL-compatible license.
+- **PRs should be about ONE thing**
+  - If you want to make multiple changes, those changes should each be contributed as separate pull requests. **DO NOT** mix unrelated changes.
+  - **Do not include unnecessary changes.** This makes the code diff larger and more noisy, making it harder to review.
+    - Don't change things that aren't related to the PR's objective
+    - Don't reformat or rearrange existing code without a good reason related to the PR's objective
+    - Don't rewrite existing code just to make it "look nicer"
+    - Don't change PhpDocs to native types in code you didn't write, unless that's the objective of the PR
+- **Test code changes, and tell us what tests have been done.**
+  - Where possible, PHPUnit tests should be written for new or changed code. If that's not possible (e.g. for in-game functionality), the code must be tested manually and details of the tests done must be provided.
+  - **Simply saying "Tested" is not acceptable** and could lead to your PR being declined.
+- **Code, comments and documentation must be written in American English.** English is the shared languages of all current maintainers.
+- **Code must be in the PocketMine-MP style.**
+  - It's your responsibility to ensure your code matches the formatting and styling of the rest of the code.
+  - If you use PhpStorm, a `Project` code style is provided, which you can use to automatically format new code.
+  - You can also use [`php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to format your code.
+- **Use `final` and `private` wherever possible**.
+  - Changing from `private` to `protected` or `final` to non-`final` doesn't break backwards compatibility, but the opposite does.
+  - `private` and `final` also enable certain performance optimizations which are otherwise not possible.
+  - `private` members can be freely changed, added and removed in the future, so it's ideal for internal functions. Abusing `protected` makes internal improvements inconvenient.
+  - "Let's leave it protected/public in case someone needs it for ... idk what" is **not a valid reason to expose things**. If there isn't a clear reason for something to be accessible from the outside, don't expose it.
+  - **This is a lesson learned through years of experience.** You may not like it, but it's for the best.
+- **Immutable things are almost always preferred.**
+  - Do not add unnecessary setters or public writable properties to classes. As above, "Let's leave it in case someone needs it" is **not a valid reason to expose things**.
+  - Mutable classes and properties are unpredictable, since code has no way to know if the object it's working with might be randomly modified by another part of the code. This makes it harder to maintain code and debug issues.
+  - Most classes exist only to hold some data. These are called "data transfer objects" (DTOs). These types of classes should pretty much always be immutable.
+  - Make use of `final`, `private` and `readonly` modifiers.
 
 ### Recommendations
-
+- **Be patient.** Reviewing pull requests takes a lot of time and energy, and maintainers are often unavailable or busy. Your PR might not receive attention for a while.
+  - Remember, PRs with small diffs are much easier to review. Small PRs are generally reviewed and merged much faster than large ones.
+- **Start small.** Try fixing minor bugs or doing something isolated (e.g. adding a new block or item) before attempting larger changes.
+  - This helps you get familiar with the codebase, the contribution process, and the expectations of maintainers.
+  - Check out the [issues page]() for something that you could tackle without too much effort.
+- **Do not copy-paste other people's code**. Many PRs involve discussion about the changes, and changes are often requested by reviewers. If you don't understand the code you're copy-pasting, your PR is likely to fail.
 - **Do not edit code directly on github.com.** We recommend learning how to use [`git`](https://git-scm.com). `git` allows you to "clone" a repository onto your computer, so that you can make changes using an IDE.
 - **Use an IDE, not a text editor.** We recommend PhpStorm or VSCode.
+- **Do not make large pull requests without an RFC.**
+  - Large changes should be discussed beforehand using the [RFC / Change Proposal](#rfcs--change-proposals) process.
+  - Large changes are much harder to review, and are more likely to be declined if maintainers don't have a good idea what you're trying to do in advance.
 - **Create a new branch on your fork for each pull request.** This allows you to use the same fork to make multiple pull requests at the same time.
+- **Make your PR diff as small as possible.** Smaller PRs are **much more likely** to be accepted, as they are easier to review.
+  - Avoid moving code around in files if possible.
+  - Don't make random CS changes. This makes the diff noisier and harder to review.
 - **Use descriptive commit titles.** You can see an example [here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
-- **Do not include multiple unrelated changes in one commit.** An atomic style for commits is preferred - this means that changes included in a commit should be part of a single distinct change set. See [this link](https://www.freshconsulting.com/atomic-commits/) for more information on atomic commits. See the [documentation on `git add`](https://git-scm.com/docs/git-add) for information on how to isolate local changes for committing.
-- **Your pull request will be checked and discussed in due time.** Since the team is scattered all around the world, your PR may not receive any attention for some time.
-- **Do not make large pull requests without an RFC.** Large changes should be discussed beforehand using the [RFC / Change Proposal](#rfcs--change-proposals) process. Large changes are much harder to review and are more likely to be declined if maintainers don't have a good idea what you're trying to do in advance.
-- **Do not copy-paste code**. There are potential license issues implicit with copy-pasting, and copy-paste usually indicates a lack of understanding of the actual code. Copy-pasted code is obvious a mile off and **any PR like this is likely to be closed**. If you want to use somebody else's code from a Git repository, **use [GIT's cherry-pick feature](https://git-scm.com/docs/git-cherry-pick)** to cherry-pick the commit.
+- **Split unrelated changes into multiple commits.**
+  - An atomic style for commits is preferred - this means that changes included in a commit should be part of a single distinct change set.
+  - If you need to use "and" or "multiple changes" in your commit message, the commit probably needs to be split up. There are exceptions, but this is a good rule of thumb.
+  - See [this link](https://www.freshconsulting.com/atomic-commits/) for more information on atomic commits.
+  - See the [documentation on `git add -i` or `git add -p`](https://git-scm.com/docs/git-add) for information on how to split up local changes for committing.
 
 
 **Thanks for contributing to PocketMine-MP!**

README.md

@@ -1,39 +1,80 @@
 <p align="center">
-	<a href="https://pmmp.io"><img src="http://cdn.pocketmine.net/img/PocketMine-MP-h.png"></img></a><br>
+	<a href="https://pmmp.io">
+		<!--[if IE]>
+			<img src="https://github.com/pmmp/PocketMine-MP/blob/stable/.github/readme/pocketmine.png" alt="The PocketMine-MP logo" title="PocketMine" loading="eager" />
+		<![endif]-->
+		<picture>
+			<source srcset="https://raw.githubusercontent.com/pmmp/PocketMine-MP/stable/.github/readme/pocketmine-dark-rgb.gif" media="(prefers-color-scheme: dark)">
+			<img src="https://raw.githubusercontent.com/pmmp/PocketMine-MP/stable/.github/readme/pocketmine-rgb.gif" loading="eager" />
+		</picture>
+	</a><br>
 	<b>A highly customisable, open source server software for Minecraft: Bedrock Edition written in PHP</b>
 </p>
 
 <p align="center">
-	<img src="https://github.com/pmmp/PocketMine-MP/workflows/CI/badge.svg" alt="CI" />
-	<a href="https://github.com/pmmp/PocketMine-MP/releases"><img src="https://img.shields.io/github/v/tag/pmmp/PocketMine-MP?label=release&logo=github" alt="GitHub tag (latest semver)" /></a>
-	<a href="https://hub.docker.com/r/pmmp/pocketmine-mp"><img src="https://img.shields.io/docker/v/pmmp/pocketmine-mp?logo=docker&label=image" alt="Docker image version (latest semver)" /></a>
+	<a href="https://github.com/pmmp/PocketMine-MP/actions/workflows/main.yml"><img src="https://github.com/pmmp/PocketMine-MP/workflows/CI/badge.svg" alt="CI" /></a>
+	<a href="https://github.com/pmmp/PocketMine-MP/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/pmmp/PocketMine-MP?label=release&sort=semver"></a>
 	<a href="https://discord.gg/bmSAZBG"><img src="https://img.shields.io/discord/373199722573201408?label=discord&color=7289DA&logo=discord" alt="Discord" /></a>
+	<br>
+	<a href="https://github.com/pmmp/PocketMine-MP/releases"><img alt="GitHub all releases" src="https://img.shields.io/github/downloads/pmmp/PocketMine-MP/total?label=downloads%40total"></a>
+	<a href="https://github.com/pmmp/PocketMine-MP/releases/latest"><img alt="GitHub release (latest by SemVer)" src="https://img.shields.io/github/downloads/pmmp/PocketMine-MP/latest/total?sort=semver"></a>
 </p>
 
-## Getting started
+## What is this?
+PocketMine-MP is a highly customisable server software for Minecraft: Bedrock Edition, built from scratch in PHP, with over 10 years of history.
+
+If you're looking to create a Minecraft: Bedrock server with **custom functionality**, look no further.
+
+- 🧩 **Powerful plugin API** - extend and customise gameplay as you see fit
+- 🗺️ **Rich ecosystem** and **large developer community** - find plugins easily and learn to develop your own
+- 🌐 **Multi-world support** - offer a more varied game experience to players without transferring them to other server nodes
+- 🏎️ **Performance** - get 100+ players onto one server (depending on hardware and plugins)
+- ⤴️ **Continuously updated** - new Minecraft versions are usually supported within days
+
+## :x: PocketMine-MP is NOT a vanilla Minecraft server software.
+**It is poorly suited to hosting vanilla survival servers.**
+It doesn't have many features from the vanilla game, such as vanilla world generation, redstone, mob AI, and various other things.
+
+If you just want to play **vanilla survival multiplayer**, consider using the [official Minecraft: Bedrock server software](https://minecraft.net/download/server/bedrock) instead of PocketMine-MP.
+
+If that's not an option for you, you may be able to add some of PocketMine-MP's missing features using plugins from [Poggit](https://poggit.pmmp.io/plugins), or write plugins to implement them yourself.
+
+## Getting Started
 - [Documentation](http://pmmp.readthedocs.org/)
 - [Installation instructions](https://pmmp.readthedocs.io/en/rtfd/installation.html)
-- [Docker image](https://hub.docker.com/r/pmmp/pocketmine-mp)
+- [Docker image](https://github.com/pmmp/PocketMine-MP/pkgs/container/pocketmine-mp)
 - [Plugin repository](https://poggit.pmmp.io/plugins)
 
-## Discussion/Help
-- [Forums](https://forums.pmmp.io/)
-- [Discord](https://discord.gg/bmSAZBG)
-- [StackOverflow](https://stackoverflow.com/tags/pocketmine)
+## Community & Support
+Join our [Discord](https://discord.gg/bmSAZBG) server to chat with other users and developers.
+
+You can also post questions on [StackOverflow](https://stackoverflow.com/tags/pocketmine) under the tag `pocketmine`.
+
+## Developing Plugins
+If you want to write your own plugins, the following resources may be useful.
+Don't forget you can always ask our community if you need help.
 
-## For developers
- * [Building and running from source](BUILDING.md)
  * [Developer documentation](https://devdoc.pmmp.io) - General documentation for PocketMine-MP plugin developers
- * [Latest API documentation](https://jenkins.pmmp.io/job/PocketMine-MP-doc/doxygen/) - Doxygen documentation generated from development
+ * [Latest release API documentation](https://apidoc.pmmp.io) - Doxygen API documentation generated for each release
+ * [Latest bleeding-edge API documentation](https://apidoc-dev.pmmp.io) - Doxygen API documentation generated weekly from `major-next` branch
  * [DevTools](https://github.com/pmmp/DevTools/) - Development tools plugin for creating plugins
  * [ExamplePlugin](https://github.com/pmmp/ExamplePlugin/) - Example plugin demonstrating some basic API features
+
+## Contributing to PocketMine-MP
+PocketMine-MP accepts community contributions! The following resources will be useful if you want to contribute to PocketMine-MP.
+ * [Building and running PocketMine-MP from source](BUILDING.md)
  * [Contributing Guidelines](CONTRIBUTING.md)
 
 ## Donate
-- Bitcoin Cash (BCH): `qq3r46hn6ljnhnqnfwxt5pg3g447eq9jhvw5ddfear`
+PocketMine-MP is free, but it requires a lot of time and effort from unpaid volunteers to develop. Donations enable us to keep delivering support for new versions and adding features your players love.
+
+You can support development using the following methods:
+
+- [Patreon](https://www.patreon.com/pocketminemp)
 - Bitcoin (BTC): `171u8K9e4FtU6j3e5sqNoxKUgEw9qWQdRV`
 - Stellar Lumens (XLM): `GAAC5WZ33HCTE3BFJFZJXONMEIBNHFLBXM2HJVAZHXXPYA3HP5XPPS7T`
-- [Patreon](https://www.patreon.com/pocketminemp)
+
+Thanks for your support!
 
 ## Licensing information
 This project is licensed under LGPL-3.0. Please see the [LICENSE](/LICENSE) file for details.

SECURITY.md

@@ -7,10 +7,11 @@ GitHub is public and anyone can see the issues you post on the issue tracker, in
 
 **WARNING: You may put live servers at risk by reporting a vulnerability on the GitHub issue tracker.**
 
-**Contact us** by sending an email to [**team@pmmp.io**](mailto:team@pmmp.io?subject=Security%20Vulnerability%20in%20PocketMine-MP). Include the following information:
+**Contact us** by sending an email to [**security@pmmp.io**](mailto:security@pmmp.io). Include the following information:
 
 - Version of PocketMine-MP
 - Detailed description of the vulnerability (e.g. how to exploit it, what the effects are)
+- Your GitHub username, if you wish to be credited for reporting the problem in the security advisory
 
 Please note that we can't guarantee a reply to every email.
 

build/generate-bedrockdata-path-consts.php

@@ -0,0 +1,128 @@
+<?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\build\generate_bedrockdata_path_consts;
+
+use Symfony\Component\Filesystem\Path;
+use function dirname;
+use function fclose;
+use function fopen;
+use function fwrite;
+use function is_file;
+use function scandir;
+use function str_replace;
+use function strtoupper;
+use const PHP_EOL;
+use const pocketmine\BEDROCK_DATA_PATH;
+use const SCANDIR_SORT_ASCENDING;
+use const STDERR;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+function constantify(string $permissionName) : string{
+	return strtoupper(str_replace([".", "-"], "_", $permissionName));
+}
+
+$files = scandir(BEDROCK_DATA_PATH, SCANDIR_SORT_ASCENDING);
+if($files === false){
+	fwrite(STDERR, "Couldn't find any files in " . BEDROCK_DATA_PATH . PHP_EOL);
+	exit(1);
+}
+
+$consts = [];
+
+foreach($files as $file){
+	if($file === '.' || $file === '..'){
+		continue;
+	}
+	if($file[0] === '.'){
+		continue;
+	}
+	$path = Path::join(BEDROCK_DATA_PATH, $file);
+	if(!is_file($path)){
+		continue;
+	}
+
+	foreach([
+		'README.md',
+		'LICENSE',
+		'composer.json',
+	] as $ignored){
+		if($file === $ignored){
+			continue 2;
+		}
+	}
+
+	$consts[] = $file;
+}
+
+$output = fopen(dirname(__DIR__) . '/src/data/bedrock/BedrockDataFiles.php', 'wb');
+if($output === false){
+	fwrite(STDERR, "Couldn't open output file" . PHP_EOL);
+	exit(1);
+}
+fwrite($output, <<<'HEADER'
+<?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 const pocketmine\BEDROCK_DATA_PATH;
+
+final class BedrockDataFiles{
+	private function __construct(){
+		//NOOP
+	}
+
+
+HEADER
+);
+
+foreach($consts as $constName => $fileName){
+	fwrite($output, "\tpublic const " . constantify($fileName) . " = BEDROCK_DATA_PATH . '/$fileName';\n");
+}
+
+fwrite($output, "}\n");
+fclose($output);
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";

build/generate-biome-ids.php

@@ -0,0 +1,133 @@
+<?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\build\generate_biome_ids;
+
+use pocketmine\data\bedrock\BedrockDataFiles;
+use pocketmine\utils\Filesystem;
+use pocketmine\utils\Utils;
+use function asort;
+use function dirname;
+use function fclose;
+use function fopen;
+use function fwrite;
+use function is_array;
+use function is_int;
+use function is_string;
+use function json_decode;
+use function str_replace;
+use function strtoupper;
+use const SORT_NUMERIC;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+const HEADER = <<<'HEADER'
+<?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);
+
+
+HEADER;
+
+/** @return resource */
+function safe_fopen(string $file, string $flags){
+	$result = fopen($file, $flags);
+	if($result === false){
+		throw new \RuntimeException("Failed to open file");
+	}
+	return $result;
+}
+
+function make_const_name(string $name) : string{
+	return strtoupper(str_replace(['.', 'minecraft:'], ['_', ''], $name));
+}
+
+/**
+ * @param int[] $map
+ * @phpstan-param array<string, int> $map
+ */
+function generate(array $map, string $outputFile) : void{
+	$file = safe_fopen($outputFile, 'wb');
+	fwrite($file, HEADER);
+	fwrite($file, <<<'CLASSHEADER'
+namespace pocketmine\data\bedrock;
+
+final class BiomeIds{
+
+	private function __construct(){
+		//NOOP
+	}
+
+
+CLASSHEADER
+);
+	$list = $map;
+	asort($list, SORT_NUMERIC);
+	$lastId = -1;
+	foreach(Utils::stringifyKeys($list) as $name => $id){
+		if($name === ""){
+			continue;
+		}
+		if($id !== $lastId + 1){
+			fwrite($file, "\n");
+		}
+		$lastId = $id;
+		fwrite($file, "\tpublic const " . make_const_name($name) . ' = ' . $id . ';' . "\n");
+	}
+	fwrite($file, "}\n");
+	fclose($file);
+}
+
+$ids = json_decode(Filesystem::fileGetContents(BedrockDataFiles::BIOME_ID_MAP_JSON), true);
+if(!is_array($ids)){
+	throw new \RuntimeException("Invalid biome ID map, expected array for root JSON object");
+}
+$cleanedIds = [];
+foreach($ids as $name => $id){
+	if(!is_string($name) || !is_int($id)){
+		throw new \RuntimeException("Invalid biome ID map, expected string => int map");
+	}
+	$cleanedIds[$name] = $id;
+}
+generate($cleanedIds, dirname(__DIR__) . '/src/data/bedrock/BiomeIds.php');
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";

build/generate-block-serializer-consts.php

@@ -0,0 +1,217 @@
+<?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\build\generate_block_serializer_consts;
+
+use pocketmine\data\bedrock\block\BlockStateData;
+use pocketmine\data\bedrock\block\BlockStateNames;
+use pocketmine\data\bedrock\block\BlockStateStringValues;
+use pocketmine\data\bedrock\block\BlockTypeNames;
+use pocketmine\errorhandler\ErrorToExceptionHandler;
+use pocketmine\nbt\NbtException;
+use pocketmine\network\mcpe\convert\BlockStateDictionary;
+use pocketmine\utils\AssumptionFailedError;
+use pocketmine\utils\Utils;
+use function array_values;
+use function asort;
+use function count;
+use function dirname;
+use function explode;
+use function fclose;
+use function file_get_contents;
+use function fopen;
+use function fwrite;
+use function is_string;
+use function ksort;
+use function mb_strtoupper;
+use function preg_replace;
+use function sort;
+use function strrpos;
+use function strtoupper;
+use function substr;
+use const SORT_STRING;
+use const STDERR;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+class BlockPaletteReport{
+	/**
+	 * @var string[]
+	 * @phpstan-var array<string, string>
+	 */
+	public array $seenTypes = [];
+	/**
+	 * @var string[][]
+	 * @phpstan-var array<string, array<mixed, mixed>>
+	 */
+	public array $seenStateValues = [];
+}
+
+/**
+ * @param BlockStateData[] $states
+ * @phpstan-param list<BlockStateData> $states
+ */
+function generateBlockPaletteReport(array $states) : BlockPaletteReport{
+	$result = new BlockPaletteReport();
+
+	foreach($states as $stateData){
+		$name = $stateData->getName();
+		$result->seenTypes[$name] = $name;
+		foreach(Utils::stringifyKeys($stateData->getStates()) as $k => $v){
+			$result->seenStateValues[$k][$v->getValue()] = $v->getValue();
+			asort($result->seenStateValues[$k]);
+		}
+	}
+
+	ksort($result->seenTypes, SORT_STRING);
+	ksort($result->seenStateValues, SORT_STRING);
+	return $result;
+}
+
+function constifyMcId(string $id) : string{
+	return strtoupper(explode(":", $id, 2)[1]);
+}
+
+function generateClassHeader(string $className) : string{
+	$backslashPos = strrpos($className, "\\");
+	if($backslashPos === false){
+		throw new AssumptionFailedError("Expected a namespaced class FQN");
+	}
+	$namespace = substr($className, 0, $backslashPos);
+	$shortName = substr($className, $backslashPos + 1);
+	return <<<HEADER
+<?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 $namespace;
+
+/**
+ * This class is generated automatically from the block palette for the current version. Do not edit it manually.
+ */
+final class $shortName{
+	private function __construct(){
+		//NOOP
+	}
+
+
+HEADER;
+}
+
+/**
+ * @phpstan-param list<string> $seenIds
+ */
+function generateBlockIds(array $seenIds) : void{
+	$output = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => fopen(dirname(__DIR__) . '/src/data/bedrock/block/BlockTypeNames.php', 'wb'));
+
+	fwrite($output, generateClassHeader(BlockTypeNames::class));
+
+	foreach($seenIds as $id){
+		fwrite($output, "\tpublic const " . constifyMcId($id) . " = \"" . $id . "\";\n");
+	}
+
+	fwrite($output, "}\n");
+	fclose($output);
+}
+
+function generateBlockStateNames(BlockPaletteReport $data) : void{
+	$output = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => fopen(dirname(__DIR__) . '/src/data/bedrock/block/BlockStateNames.php', 'wb'));
+
+	fwrite($output, generateClassHeader(BlockStateNames::class));
+	foreach(Utils::stringifyKeys($data->seenStateValues) as $state => $values){
+		$constName = mb_strtoupper(preg_replace("/^minecraft:/", "mc_", $state) ?? throw new AssumptionFailedError("This regex is not invalid"), 'US-ASCII');
+		fwrite($output, "\tpublic const $constName = \"$state\";\n");
+	}
+
+	fwrite($output, "}\n");
+	fclose($output);
+}
+
+function generateBlockStringValues(BlockPaletteReport $data) : void{
+	$output = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => fopen(dirname(__DIR__) . '/src/data/bedrock/block/BlockStateStringValues.php', 'wb'));
+
+	fwrite($output, generateClassHeader(BlockStateStringValues::class));
+	foreach(Utils::stringifyKeys($data->seenStateValues) as $stateName => $values){
+		$anyWritten = false;
+		sort($values, SORT_STRING);
+		foreach($values as $value){
+			if(!is_string($value)){
+				continue;
+			}
+			$anyWritten = true;
+			$constName = mb_strtoupper(preg_replace("/^minecraft:/", "mc_", $stateName) . "_" . $value, 'US-ASCII');
+			fwrite($output, "\tpublic const $constName = \"$value\";\n");
+		}
+		if($anyWritten){
+			fwrite($output, "\n");
+		}
+	}
+	fwrite($output, "}\n");
+	fclose($output);
+}
+
+if(count($argv) !== 2){
+	fwrite(STDERR, "This script regenerates BlockTypeNames, BlockStateNames and BlockStateStringValues from a given palette file\n");
+	fwrite(STDERR, "Required arguments: path to block palette file\n");
+	exit(1);
+}
+
+$palettePath = $argv[1];
+$paletteRaw = file_get_contents($palettePath);
+if($paletteRaw === false){
+	fwrite(STDERR, "Failed to read block palette file\n");
+	exit(1);
+}
+
+try{
+	$states = BlockStateDictionary::loadPaletteFromString($paletteRaw);
+}catch(NbtException){
+	fwrite(STDERR, "Invalid block palette file $argv[1]\n");
+	exit(1);
+}
+
+$report = generateBlockPaletteReport($states);
+generateBlockIds(array_values($report->seenTypes));
+generateBlockStateNames($report);
+generateBlockStringValues($report);
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";

build/generate-build-info-json.php

@@ -17,27 +17,32 @@
  * @link http://www.pocketmine.net/
  *
  *
-*/
+ */
 
 declare(strict_types=1);
 
+use pocketmine\network\mcpe\protocol\ProtocolInfo;
+use pocketmine\VersionInfo;
+
 require dirname(__DIR__) . '/vendor/autoload.php';
 
-if(count($argv) !== 4){
-	fwrite(STDERR, "required args: <git hash> <tag name> <github repo (owner/name)>");
+if(count($argv) !== 7){
+	fwrite(STDERR, "required args: <git hash> <tag name> <github repo (owner/name)> <build number> <github actions run ID> <PHP binary download URL>\n");
 	exit(1);
 }
 
 echo json_encode([
-	"php_version" => sprintf("%d.%d", PHP_MAJOR_VERSION, PHP_MINOR_VERSION),
-	"base_version" => \pocketmine\VersionInfo::BASE_VERSION,
-	"build" => \pocketmine\VersionInfo::BUILD_NUMBER,
-	"is_dev" => \pocketmine\VersionInfo::IS_DEVELOPMENT_BUILD,
-	"channel" => \pocketmine\VersionInfo::BUILD_CHANNEL,
+	"php_version" => sprintf("%d.%d", PHP_MAJOR_VERSION, PHP_MINOR_VERSION), //deprecated
+	"base_version" => VersionInfo::BASE_VERSION,
+	"build" => (int) $argv[4],
+	"is_dev" => VersionInfo::IS_DEVELOPMENT_BUILD,
+	"channel" => VersionInfo::BUILD_CHANNEL,
 	"git_commit" => $argv[1],
-	"mcpe_version" => \pocketmine\network\mcpe\protocol\ProtocolInfo::MINECRAFT_VERSION_NETWORK,
+	"mcpe_version" => ProtocolInfo::MINECRAFT_VERSION_NETWORK,
 	"date" => time(), //TODO: maybe we should embed this in VersionInfo?
 	"details_url" => "https://github.com/$argv[3]/releases/tag/$argv[2]",
 	"download_url" => "https://github.com/$argv[3]/releases/download/$argv[2]/PocketMine-MP.phar",
 	"source_url" => "https://github.com/$argv[3]/tree/$argv[2]",
-], JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) . "\n";
+	"build_log_url" => "https://github.com/$argv[3]/actions/runs/$argv[5]",
+	"php_download_url" => $argv[6],
+], JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_THROW_ON_ERROR) . "\n";

build/generate-item-type-names.php

@@ -0,0 +1,118 @@
+<?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\build\generate_item_serializer_ids;
+
+use pocketmine\data\bedrock\item\BlockItemIdMap;
+use pocketmine\errorhandler\ErrorToExceptionHandler;
+use pocketmine\network\mcpe\convert\ItemTypeDictionaryFromDataHelper;
+use pocketmine\network\mcpe\protocol\serializer\ItemTypeDictionary;
+use pocketmine\utils\Utils;
+use function asort;
+use function count;
+use function dirname;
+use function explode;
+use function fclose;
+use function file_get_contents;
+use function fopen;
+use function fwrite;
+use function strtoupper;
+use const SORT_STRING;
+use const STDERR;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+function constifyMcId(string $id) : string{
+	return strtoupper(explode(":", $id, 2)[1]);
+}
+
+function generateItemIds(ItemTypeDictionary $dictionary, BlockItemIdMap $blockItemIdMap) : void{
+	$ids = [];
+	foreach($dictionary->getEntries() as $entry){
+		if($entry->getStringId() === "minecraft:air" || $blockItemIdMap->lookupBlockId($entry->getStringId()) !== null){ //blockitems are serialized via BlockStateSerializer
+			continue;
+		}
+		$ids[$entry->getStringId()] = $entry->getStringId();
+	}
+	asort($ids, SORT_STRING);
+
+	$file = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => fopen(dirname(__DIR__) . '/src/data/bedrock/item/ItemTypeNames.php', 'wb'));
+
+	fwrite($file, <<<'HEADER'
+<?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\item;
+
+/**
+ * This class is generated automatically from the item type dictionary for the current version. Do not edit it manually.
+ */
+final class ItemTypeNames{
+
+HEADER
+	);
+
+	foreach(Utils::stringifyKeys($ids) as $id){
+		fwrite($file, "\tpublic const " . constifyMcId($id) . " = \"" . $id . "\";\n");
+	}
+	fwrite($file, "}\n");
+	fclose($file);
+}
+
+if(count($argv) !== 2){
+	fwrite(STDERR, "This script regenerates ItemTypeNames from a given item dictionary file\n");
+	fwrite(STDERR, "Required argument: path to item type dictionary file\n");
+	exit(1);
+}
+
+$raw = file_get_contents($argv[1]);
+if($raw === false){
+	fwrite(STDERR, "Failed to read item type dictionary file\n");
+	exit(1);
+}
+
+$dictionary = ItemTypeDictionaryFromDataHelper::loadFromString($raw);
+$blockItemIdMap = BlockItemIdMap::getInstance();
+generateItemIds($dictionary, $blockItemIdMap);
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";

build/generate-known-translation-apis.php

@@ -17,14 +17,15 @@
  * @link http://www.pocketmine.net/
  *
  *
-*/
+ */
 
 declare(strict_types=1);
 
 namespace pocketmine\build\generate_known_translation_apis;
 
 use pocketmine\lang\Translatable;
-use Webmozart\PathUtil\Path;
+use pocketmine\utils\Utils;
+use Symfony\Component\Filesystem\Path;
 use function array_map;
 use function count;
 use function dirname;
@@ -40,6 +41,7 @@ use function preg_match_all;
 use function str_replace;
 use function strtoupper;
 use const INI_SCANNER_RAW;
+use const SORT_NUMERIC;
 use const SORT_STRING;
 use const STDERR;
 
@@ -73,7 +75,7 @@ const SHARED_HEADER = <<<'HEADER'
  * @link http://www.pocketmine.net/
  *
  *
-*/
+ */
 
 declare(strict_types=1);
 
@@ -94,13 +96,15 @@ function generate_known_translation_keys(array $languageDefinitions) : void{
 /**
  * This class contains constants for all the translations known to PocketMine-MP as per the used version of pmmp/Language.
  * This class is generated automatically, do NOT modify it by hand.
+ *
+ * @internal
  */
 final class KnownTranslationKeys{
 
 HEADER;
 
 	ksort($languageDefinitions, SORT_STRING);
-	foreach($languageDefinitions as $k => $_){
+	foreach(Utils::stringifyKeys($languageDefinitions) as $k => $_){
 		echo "\tpublic const ";
 		echo constantify($k);
 		echo " = \"" . $k . "\";\n";
@@ -126,6 +130,8 @@ function generate_known_translation_factory(array $languageDefinitions) : void{
  * This class contains factory methods for all the translations known to PocketMine-MP as per the used version of
  * pmmp/Language.
  * This class is generated automatically, do NOT modify it by hand.
+ *
+ * @internal
  */
 final class KnownTranslationFactory{
 
@@ -135,17 +141,22 @@ HEADER;
 	$parameterRegex = '/{%(.+?)}/';
 
 	$translationContainerClass = (new \ReflectionClass(Translatable::class))->getShortName();
-	foreach($languageDefinitions as $key => $value){
+	foreach(Utils::stringifyKeys($languageDefinitions) as $key => $value){
 		$parameters = [];
+		$allParametersPositional = true;
 		if(preg_match_all($parameterRegex, $value, $matches) > 0){
 			foreach($matches[1] as $parameterName){
 				if(is_numeric($parameterName)){
 					$parameters[$parameterName] = "param$parameterName";
 				}else{
 					$parameters[$parameterName] = $parameterName;
+					$allParametersPositional = false;
 				}
 			}
 		}
+		if($allParametersPositional){
+			ksort($parameters, SORT_NUMERIC);
+		}
 		echo "\tpublic static function " .
 			functionify($key) .
 			"(" . implode(", ", array_map(fn(string $paramName) => "$translationContainerClass|string \$$paramName", $parameters)) . ") : $translationContainerClass{\n";
@@ -172,7 +183,7 @@ HEADER;
 	echo "Done generating KnownTranslationFactory.\n";
 }
 
-$lang = parse_ini_file(Path::join(\pocketmine\RESOURCE_PATH, "locale", "eng.ini"), false, INI_SCANNER_RAW);
+$lang = parse_ini_file(Path::join(\pocketmine\LOCALE_DATA_PATH, "eng.ini"), false, INI_SCANNER_RAW);
 if($lang === false){
 	fwrite(STDERR, "Missing language files!\n");
 	exit(1);

build/generate-pocketmine-yml-property-consts.php

@@ -0,0 +1,120 @@
+<?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);
+
+use pocketmine\utils\Filesystem;
+use pocketmine\utils\Utils;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+$defaultConfig = yaml_parse(Filesystem::fileGetContents(dirname(__DIR__) . '/resources/pocketmine.yml'));
+
+if(!is_array($defaultConfig)){
+	fwrite(STDERR, "Invalid default pocketmine.yml\n");
+	exit(1);
+}
+
+$constants = [];
+
+/**
+ * @param mixed[]  $properties
+ * @param string[] $constants
+ * @phpstan-param array<string, string> $constants
+ * @phpstan-param-out array<string, string> $constants
+ */
+function collectProperties(string $prefix, array $properties, array &$constants) : void{
+	foreach($properties as $propertyName => $property){
+		$fullPropertyName = ($prefix !== "" ? $prefix . "." : "") . $propertyName;
+
+		$constName = str_replace([".", "-"], "_", strtoupper($fullPropertyName));
+		$constants[$constName] = $fullPropertyName;
+
+		if(is_array($property)){
+			collectProperties($fullPropertyName, $property, $constants);
+		}
+	}
+}
+
+collectProperties("", $defaultConfig, $constants);
+ksort($constants, SORT_STRING);
+
+$file = fopen(dirname(__DIR__) . '/src/YmlServerProperties.php', 'wb');
+if($file === false){
+	fwrite(STDERR, "Failed to open output file\n");
+	exit(1);
+}
+fwrite($file, "<?php\n");
+fwrite($file, <<<'HEADER'
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * 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/
+ *
+ *
+ */
+
+
+HEADER
+);
+fwrite($file, "declare(strict_types=1);\n\n");
+fwrite($file, "namespace pocketmine;\n\n");
+
+fwrite($file, <<<'DOC'
+/**
+ * @internal
+ * Constants for all properties available in pocketmine.yml.
+ * This is generated by build/generate-pocketmine-yml-property-consts.php.
+ * Do not edit this file manually.
+ */
+
+DOC
+);
+fwrite($file, "final class YmlServerProperties{\n");
+fwrite($file, <<<'CONSTRUCTOR'
+
+	private function __construct(){
+		//NOOP
+	}
+
+
+CONSTRUCTOR
+);
+foreach(Utils::stringifyKeys($constants) as $constName => $propertyName){
+	fwrite($file, "\tpublic const $constName = '$propertyName';\n");
+}
+fwrite($file, "}\n");
+
+fclose($file);
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";

build/generate-registry-annotations.php

@@ -17,7 +17,7 @@
  * @link http://www.pocketmine.net/
  *
  *
-*/
+ */
 
 declare(strict_types=1);
 
@@ -29,17 +29,21 @@ use function count;
 use function dirname;
 use function file_get_contents;
 use function file_put_contents;
+use function fwrite;
 use function implode;
+use function is_dir;
 use function ksort;
 use function mb_strtoupper;
 use function preg_match;
 use function sprintf;
+use function str_ends_with;
 use function str_replace;
-use function substr;
 use const SORT_STRING;
+use const STDERR;
 
 if(count($argv) !== 2){
-	die("Provide a path to process");
+	fwrite(STDERR, "Provide a path to process\n");
+	exit(1);
 }
 
 /**
@@ -58,7 +62,7 @@ function generateMethodAnnotations(string $namespaceName, array $members) : stri
 	$memberLines = [];
 	foreach($members as $name => $member){
 		$reflect = new \ReflectionClass($member);
-		while($reflect !== false and $reflect->isAnonymous()){
+		while($reflect !== false && $reflect->isAnonymous()){
 			$reflect = $reflect->getParentClass();
 		}
 		if($reflect === false){
@@ -80,29 +84,24 @@ function generateMethodAnnotations(string $namespaceName, array $members) : stri
 	return implode("\n", $lines);
 }
 
-require dirname(__DIR__) . '/vendor/autoload.php';
-
-foreach(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($argv[1], \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::CURRENT_AS_PATHNAME)) as $file){
-	if(substr($file, -4) !== ".php"){
-		continue;
-	}
+function processFile(string $file) : void{
 	$contents = file_get_contents($file);
 	if($contents === false){
 		throw new \RuntimeException("Failed to get contents of $file");
 	}
 
-	if(preg_match("/^namespace (.+);$/m", $contents, $matches) !== 1 || preg_match('/^((final|abstract)\s+)?class /m', $contents) !== 1){
-		continue;
+	if(preg_match("/(*ANYCRLF)^namespace (.+);$/m", $contents, $matches) !== 1 || preg_match('/(*ANYCRLF)^((final|abstract)\s+)?class /m', $contents) !== 1){
+		return;
 	}
 	$shortClassName = basename($file, ".php");
 	$className = $matches[1] . "\\" . $shortClassName;
 	if(!class_exists($className)){
-		continue;
+		return;
 	}
 	$reflect = new \ReflectionClass($className);
 	$docComment = $reflect->getDocComment();
-	if($docComment === false || preg_match("/^\s*\*\s*@generate-registry-docblock$/m", $docComment) !== 1){
-		continue;
+	if($docComment === false || preg_match("/(*ANYCRLF)^\s*\*\s*@generate-registry-docblock$/m", $docComment) !== 1){
+		return;
 	}
 	echo "Found registry in $file\n";
 
@@ -117,3 +116,17 @@ foreach(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($argv[1],
 	}
 }
 
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+if(is_dir($argv[1])){
+	/** @var string $file */
+	foreach(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($argv[1], \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::CURRENT_AS_PATHNAME)) as $file){
+		if(!str_ends_with($file, ".php")){
+			continue;
+		}
+
+		processFile($file);
+	}
+}else{
+	processFile($argv[1]);
+}

build/make-release.php

@@ -17,31 +17,41 @@
  * @link http://www.pocketmine.net/
  *
  *
-*/
+ */
 
 declare(strict_types=1);
 
 namespace pocketmine\build\make_release;
 
+use pocketmine\utils\Filesystem;
+use pocketmine\utils\Utils;
 use pocketmine\utils\VersionString;
 use pocketmine\VersionInfo;
-use function count;
+use function array_keys;
+use function array_map;
 use function dirname;
 use function fgets;
-use function file_get_contents;
 use function file_put_contents;
 use function fwrite;
+use function getopt;
+use function is_string;
+use function max;
+use function preg_match;
 use function preg_replace;
-use function sleep;
 use function sprintf;
+use function str_pad;
+use function strlen;
+use function strtolower;
 use function system;
 use const STDERR;
 use const STDIN;
+use const STDOUT;
+use const STR_PAD_LEFT;
 
 require_once dirname(__DIR__) . '/vendor/autoload.php';
 
 function replaceVersion(string $versionInfoPath, string $newVersion, bool $isDev, string $channel) : void{
-	$versionInfo = file_get_contents($versionInfoPath);
+	$versionInfo = Filesystem::fileGetContents($versionInfoPath);
 	$versionInfo = preg_replace(
 		$pattern = '/^([\t ]*public )?const BASE_VERSION = "(\d+)\.(\d+)\.(\d+)(?:-(.*))?";$/m',
 		'$1const BASE_VERSION = "' . $newVersion . '";',
@@ -60,50 +70,95 @@ function replaceVersion(string $versionInfoPath, string $newVersion, bool $isDev
 	file_put_contents($versionInfoPath, $versionInfo);
 }
 
-/**
- * @param string[] $argv
- * @phpstan-param list<string> $argv
- */
-function main(array $argv) : void{
-	if(count($argv) < 2){
-		fwrite(STDERR, "Arguments: <channel> [release version] [next version]\n");
+const ACCEPTED_OPTS = [
+	"current" => "Version to insert and tag",
+	"next" => "Version to put in the file after tagging",
+	"channel" => "Release channel to post this build into"
+];
+
+function systemWrapper(string $command, string $errorMessage) : void{
+	system($command, $result);
+	if($result !== 0){
+		echo "error: $errorMessage; aborting\n";
 		exit(1);
 	}
-	if(isset($argv[2])){
-		$currentVer = new VersionString($argv[2]);
-	}else{
-		$currentVer = VersionInfo::VERSION();
+}
+
+function main() : void{
+	$filteredOpts = [];
+	foreach(Utils::stringifyKeys(getopt("", ["current:", "next:", "channel:", "help"])) as $optName => $optValue){
+		if($optName === "help"){
+			fwrite(STDOUT, "Options:\n");
+
+			$maxLength = max(array_map(fn(string $str) => strlen($str), array_keys(ACCEPTED_OPTS)));
+			foreach(ACCEPTED_OPTS as $acceptedName => $description){
+				fwrite(STDOUT, str_pad("--$acceptedName", $maxLength + 4, " ", STR_PAD_LEFT) . ": $description\n");
+			}
+			exit(0);
+		}
+		if(!is_string($optValue)){
+			fwrite(STDERR, "--$optName expects exactly 1 value\n");
+			exit(1);
+		}
+		$filteredOpts[$optName] = $optValue;
 	}
-	if(isset($argv[3])){
-		$nextVer = new VersionString($argv[3]);
+
+	$channel = $filteredOpts["channel"] ?? null;
+	if(isset($filteredOpts["current"])){
+		$currentVer = new VersionString($filteredOpts["current"]);
 	}else{
-		$nextVer = new VersionString(sprintf(
+		$currentVer = new VersionString(VersionInfo::BASE_VERSION);
+	}
+
+	$nextVer = isset($filteredOpts["next"]) ? new VersionString($filteredOpts["next"]) : null;
+
+	$suffix = $currentVer->getSuffix();
+	if($suffix !== ""){
+		if($channel === "stable"){
+			fwrite(STDERR, "error: cannot release a suffixed build into the stable channel\n");
+			exit(1);
+		}
+		if(preg_match('/^([A-Za-z]+)(\d+)$/', $suffix, $matches) !== 1){
+			echo "error: invalid current version suffix \"$suffix\"; aborting\n";
+			exit(1);
+		}
+		$nextVer ??= new VersionString(sprintf(
+			"%u.%u.%u-%s%u",
+			$currentVer->getMajor(),
+			$currentVer->getMinor(),
+			$currentVer->getPatch(),
+			$matches[1],
+			((int) $matches[2]) + 1
+		));
+		$channel ??= strtolower($matches[1]);
+	}else{
+		$nextVer ??= new VersionString(sprintf(
 			"%u.%u.%u",
 			$currentVer->getMajor(),
 			$currentVer->getMinor(),
 			$currentVer->getPatch() + 1
 		));
+		$channel ??= "stable";
 	}
 
 	echo "About to tag version $currentVer. Next version will be $nextVer.\n";
+	echo "$currentVer will be published on release channel \"$channel\".\n";
 	echo "please add appropriate notes to the changelog and press enter...";
 	fgets(STDIN);
-	system('git add "' . dirname(__DIR__) . '/changelogs"');
+	systemWrapper('git add "' . dirname(__DIR__) . '/changelogs"', "failed to stage changelog changes");
 	system('git diff --cached --quiet "' . dirname(__DIR__) . '/changelogs"', $result);
 	if($result === 0){
 		echo "error: no changelog changes detected; aborting\n";
 		exit(1);
 	}
 	$versionInfoPath = dirname(__DIR__) . '/src/VersionInfo.php';
-	replaceVersion($versionInfoPath, $currentVer->getBaseVersion(), false, $argv[1]);
-	system('git commit -m "Release ' . $currentVer->getBaseVersion() . '" --include "' . $versionInfoPath . '"');
-	system('git tag ' . $currentVer->getBaseVersion());
-	replaceVersion($versionInfoPath, $nextVer->getBaseVersion(), true, "");
-	system('git add "' . $versionInfoPath . '"');
-	system('git commit -m "' . $nextVer->getBaseVersion() . ' is next" --include "' . $versionInfoPath . '"');
-	echo "pushing changes in 5 seconds\n";
-	sleep(5);
-	system('git push origin HEAD ' . $currentVer->getBaseVersion());
+	replaceVersion($versionInfoPath, $currentVer->getBaseVersion(), false, $channel);
+	systemWrapper('git commit -m "Release ' . $currentVer->getBaseVersion() . '" --include "' . $versionInfoPath . '"', "failed to create release commit");
+	systemWrapper('git tag ' . $currentVer->getBaseVersion(), "failed to create release tag");
+
+	replaceVersion($versionInfoPath, $nextVer->getBaseVersion(), true, $channel);
+	systemWrapper('git add "' . $versionInfoPath . '"', "failed to stage changes for post-release commit");
+	systemWrapper('git commit -m "' . $nextVer->getBaseVersion() . ' is next" --include "' . $versionInfoPath . '"', "failed to create post-release commit");
 }
 
-main($argv);
+main();

build/server-phar-stub.php

@@ -0,0 +1,168 @@
+<?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\server_phar_stub;
+
+use function clearstatcache;
+use function copy;
+use function fclose;
+use function fflush;
+use function flock;
+use function fopen;
+use function fwrite;
+use function getmypid;
+use function hrtime;
+use function is_dir;
+use function is_file;
+use function mkdir;
+use function number_format;
+use function str_replace;
+use function stream_get_contents;
+use function sys_get_temp_dir;
+use function tempnam;
+use function unlink;
+use const DIRECTORY_SEPARATOR;
+use const LOCK_EX;
+use const LOCK_NB;
+use const LOCK_UN;
+
+/**
+ * Finds the appropriate tmp directory to store the decompressed phar cache, accounting for potential file name
+ * collisions.
+ */
+function preparePharCacheDirectory() : string{
+	clearstatcache();
+
+	$i = 0;
+	do{
+		$tmpPath = sys_get_temp_dir() . '/PocketMine-MP-phar-cache.' . $i;
+		$i++;
+	}while(is_file($tmpPath));
+	if(!@mkdir($tmpPath) && !is_dir($tmpPath)){
+		throw new \RuntimeException("Failed to create temporary directory $tmpPath. Please ensure the disk has enough space and that the current user has permission to write to this location.");
+	}
+
+	return $tmpPath;
+}
+
+/**
+ * Deletes caches left behind by previous server instances.
+ * This ensures that the tmp directory doesn't get flooded by servers crashing in restart loops.
+ */
+function cleanupPharCache(string $tmpPath) : void{
+	clearstatcache();
+
+	/** @var string[] $matches */
+	foreach(new \RegexIterator(
+		new \FilesystemIterator(
+			$tmpPath,
+			\FilesystemIterator::CURRENT_AS_PATHNAME | \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::UNIX_PATHS
+		),
+		'/(.+)\.lock$/',
+		\RegexIterator::GET_MATCH
+	) as $matches){
+		$lockFilePath = $matches[0];
+		$baseTmpPath = $matches[1];
+
+		$file = @fopen($lockFilePath, "rb");
+		if($file === false){
+			//another process probably deleted the lock file already
+			continue;
+		}
+
+		if(flock($file, LOCK_EX | LOCK_NB)){
+			//this tmpfile is no longer in use
+			flock($file, LOCK_UN);
+			fclose($file);
+
+			unlink($lockFilePath);
+			unlink($baseTmpPath . ".tar");
+			unlink($baseTmpPath);
+			echo "Deleted stale phar cache at $baseTmpPath\n";
+		}else{
+			$pid = stream_get_contents($file);
+			fclose($file);
+
+			echo "Phar cache at $baseTmpPath is still in use by PID $pid\n";
+		}
+	}
+}
+
+function convertPharToTar(string $tmpName, string $pharPath) : string{
+	$tmpPharPath = $tmpName . ".phar";
+	copy($pharPath, $tmpPharPath);
+
+	$phar = new \Phar($tmpPharPath);
+	//phar requires phar.readonly=0, and zip doesn't support disabling compression - tar is the only viable option
+	//we don't need phar anyway since we don't need to directly execute the file, only require files from inside it
+	$phar->convertToData(\Phar::TAR, \Phar::NONE);
+	unset($phar);
+	\Phar::unlinkArchive($tmpPharPath);
+
+	return $tmpName . ".tar";
+}
+
+/**
+ * Locks a phar tmp cache to prevent it from being deleted by other server instances.
+ * This code looks similar to Filesystem::createLockFile(), but we can't use that because it's inside the compressed
+ * phar.
+ */
+function lockPharCache(string $lockFilePath) : void{
+	//this static variable will keep the file(s) locked until the process ends
+	static $lockFiles = [];
+
+	$lockFile = fopen($lockFilePath, "wb");
+	if($lockFile === false){
+		throw new \RuntimeException("Failed to open temporary file");
+	}
+	flock($lockFile, LOCK_EX); //this tells other server instances not to delete this cache file
+	fwrite($lockFile, (string) getmypid()); //maybe useful for debugging
+	fflush($lockFile);
+	$lockFiles[$lockFilePath] = $lockFile;
+}
+
+/**
+ * Prepares a decompressed .tar of PocketMine-MP.phar in the system temp directory for loading code from.
+ *
+ * @return string path to the temporary decompressed phar (actually a .tar)
+ */
+function preparePharCache(string $tmpPath, string $pharPath) : string{
+	clearstatcache();
+
+	$tmpName = tempnam($tmpPath, "PMMP");
+	if($tmpName === false){
+		throw new \RuntimeException("Failed to create temporary file");
+	}
+
+	lockPharCache($tmpName . ".lock");
+	return convertPharToTar($tmpName, $pharPath);
+}
+
+$tmpDir = preparePharCacheDirectory();
+cleanupPharCache($tmpDir);
+echo "Preparing PocketMine-MP.phar decompressed cache...\n";
+$start = hrtime(true);
+$cacheName = preparePharCache($tmpDir, __FILE__);
+echo "Cache ready at $cacheName in " . number_format((hrtime(true) - $start) / 1e9, 2) . "s\n";
+
+require 'phar://' . str_replace(DIRECTORY_SEPARATOR, '/', $cacheName) . '/src/PocketMine.php';

build/server-phar.php

@@ -17,13 +17,15 @@
  * @link http://www.pocketmine.net/
  *
  *
-*/
+ */
 
 declare(strict_types=1);
 
 namespace pocketmine\build\server_phar;
 
+use pocketmine\utils\Filesystem;
 use pocketmine\utils\Git;
+use Symfony\Component\Filesystem\Path;
 use function array_map;
 use function count;
 use function dirname;
@@ -32,6 +34,7 @@ use function getcwd;
 use function getopt;
 use function implode;
 use function ini_get;
+use function is_string;
 use function microtime;
 use function preg_quote;
 use function realpath;
@@ -40,12 +43,13 @@ use function rtrim;
 use function sprintf;
 use function str_replace;
 use function unlink;
+use const DIRECTORY_SEPARATOR;
 use const PHP_EOL;
 
 require dirname(__DIR__) . '/vendor/autoload.php';
 
 /**
- * @param string[]    $strings
+ * @param string[] $strings
  *
  * @return string[]
  */
@@ -134,15 +138,29 @@ function main() : void{
 		exit(1);
 	}
 
-	$opts = getopt("", ["out:", "git:"]);
+	$opts = getopt("", ["out:", "git:", "build:"]);
 	if(isset($opts["git"])){
 		$gitHash = $opts["git"];
 	}else{
 		$gitHash = Git::getRepositoryStatePretty(dirname(__DIR__));
 		echo "Git hash detected as $gitHash" . PHP_EOL;
 	}
+	if(isset($opts["build"])){
+		$build = (int) $opts["build"];
+	}else{
+		$build = 0;
+	}
+	if(isset($opts["out"])){
+		if(!is_string($opts["out"])){
+			echo "--out cannot be specified multiple times" . PHP_EOL;
+			exit(1);
+		}
+		$pharPath = $opts["out"];
+	}else{
+		$pharPath = getcwd() . DIRECTORY_SEPARATOR . "PocketMine-MP.phar";
+	}
 	foreach(buildPhar(
-		$opts["out"] ?? getcwd() . DIRECTORY_SEPARATOR . "PocketMine-MP.phar",
+		$pharPath,
 		dirname(__DIR__) . DIRECTORY_SEPARATOR,
 		[
 			'resources',
@@ -150,23 +168,10 @@ function main() : void{
 			'vendor'
 		],
 		[
-			'git' => $gitHash
+			'git' => $gitHash,
+			'build' => $build
 		],
-		<<<'STUB'
-<?php
-
-$tmpDir = sys_get_temp_dir();
-if(!is_readable($tmpDir) or !is_writable($tmpDir)){
-	echo "ERROR: tmpdir $tmpDir is not accessible." . PHP_EOL;
-	echo "Check that the directory exists, and that the current user has read/write permissions for it." . PHP_EOL;
-	echo "Alternatively, set 'sys_temp_dir' to a different directory in your php.ini file." . PHP_EOL;
-	exit(1);
-}
-
-require("phar://" . __FILE__ . "/src/PocketMine.php");
-__HALT_COMPILER();
-STUB
-,
+		Filesystem::fileGetContents(Path::join(__DIR__, 'server-phar-stub.php')) . "\n__HALT_COMPILER();",
 		\Phar::SHA1,
 		\Phar::GZ
 	) as $line){

changelogs/3.23.md

@@ -0,0 +1,14 @@
+**For Minecraft: Bedrock Edition 1.17.30**
+
+### 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.23.0
+- Added support for Minecraft: Bedrock Edition 1.17.30.
+- Removed compatibility with earlier versions.
+
+# 3.23.1
+- Fixed broken build of 3.23.0.

changelogs/3.24.md

@@ -0,0 +1,12 @@
+**For Minecraft: Bedrock Edition 1.17.30**
+
+### 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.24.0
+- PHP 8.0 is now required as a minimum.
+- Fixed stats reporting checking the wrong `pocketmine.yml` property.
+- Fixed `Projectile->move()` not respecting the given `dx`/`dy`/`dz` and using its own motion instead.

changelogs/3.25.md

@@ -0,0 +1,38 @@
+**For Minecraft: Bedrock Edition 1.17.40**
+
+### 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.25.0
+- Added support for Minecraft: Bedrock Edition 1.17.40.
+- Removed compatibility with earlier versions.
+
+# 3.25.1
+- Fixed autosave bug that caused unmodified chunks to be saved at least once (during the first autosave after they were loaded).
+- `Entity->spawnTo()` now has an additional sanity check for matching worlds (might expose a few new errors in plugins).
+- Fixed a missing field in `CraftRecipeAuto` item stack request type.
+
+# 3.25.2
+- Now analysed using level 9 on PHPStan 1.0.0.
+- `ext-pthreads` v4.0.0 or newer is now required.
+- Fixed crash in `Player->showPlayer()` when the target is not in the same world.
+- `Human->setLifetimeTotalXp()` now limits the maximum value to 2^31.
+- Fixed players, who died in hardcore mode and were unbanned, getting re-banned on next server join.
+
+# 3.25.3
+- Fixed crash when players try to pickup XP while already having max XP.
+- Added a sanity check to `Human->setCurrentTotalXp()` to try and catch an elusive bug that's been appearing in the wild - please get in touch if you know how to reproduce it!
+
+# 3.25.4
+- Fixed a long-standing issue with `Player->removeWindow()` breaking inventory UIs on the client.
+
+# 3.25.5
+- Protocol: Fixed incorrect encoding in `StructureSettings`
+- Fixed reading tags from non-docblock comments in script plugins.
+- Build number is now defined in phar metadata instead of being patched into the source code directly.
+
+# 3.25.6
+- Fixed borked build number in release build of 3.25.5.

changelogs/3.26.md

@@ -0,0 +1,32 @@
+**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.
+
+# 3.26.1
+- Fixed a bug in chunk sending that caused double chests to not be paired, signs to be blank, and various other issues.
+
+# 3.26.2
+- Improved error messages shown by `start.cmd`, `start.sh` and `start.ps1` when the PHP binary was not found.
+- The value of PHPRC is now shown when erroring out due to unsatisfied PHP requirements.
+- Removed restriction on the range of valid channels for `auto-updater.channel` in `pocketmine.yml`.
+
+# 3.26.3
+- `PlayerExperienceChangeEvent->setNewProgress()` now performs range checks. This fixes the root of a very old and confusing crash bug which took several years to identify the cause of.
+  - Note that the defective plugin(s) which caused this problem will still cause a server crash, but the plugin responsible will now get blamed correctly.
+
+# 3.26.4
+- Fixed skins appearing black when using RTX resource packs.
+- Fixed chunks containing furnaces in old worlds (pre-2017) being discarded as corrupted.
+  - This was caused by a strict corruption check detecting bad data created by a bug in PocketMine-MP that was fixed in 2017.
+
+# 3.26.5
+- Fixed several denial-of-service attack vectors related to writable book text length and encoding.
+- Fixed several denial-of-service attack vectors related to skin data field lengths.

changelogs/3.27.md

@@ -0,0 +1,15 @@
+**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.27.0
+- Introduced support for protocol encryption.
+  - Encryption is enabled by default.
+  - Fixes login replay attacks.
+  - This may cause some performance degradation.
+  - Encryption can be disabled by setting `network.enable-encryption` to `false` in `pocketmine.yml`. DO NOT do this unless you understand the risks involved.
+- An obsoletion notice has been added to the console during server startup.

changelogs/4.1-beta.md

@@ -0,0 +1,166 @@
+**For Minecraft: Bedrock Edition 1.18.0**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.1.0-BETA1
+Released 22nd January 2022.
+
+## General
+- Game mode names (e.g. `survival`, `creative`) may now be used for the `gamemode` property in `server.properties`.
+- Increased default maximum render distance to 16 chunks. Players with a render distance smaller than this will notice no difference.
+- The setup wizard now prompts for a maximum render distance value.
+- The setup wizard now prompts for an IPv6 port selection. Previously it would always use 19133.
+- `chunk-ticking.disable-block-ticking` now accepts block names like those used in the `/give` command.
+- The `/clear` command now behaves more like vanilla:
+  - The order of inventories is now the same as Bedrock.
+  - The cursor and offhand inventories are now cleared if necessary.
+
+## Technical
+- `PlayerAuthInputPacket` is now used instead of `MovePlayerPacket` for processing movements. This improves position and rotation accuracy.
+- `&&` and `||` are now always used instead of `and` and `or`.
+- New version of `pocketmine/errorhandler` is used by this version, adding support for `ErrorToExceptionHandler::trap()`. This enables reliably capturing `E_WARNING` and `E_NOTICE` from functions such as `yaml_parse()` and friends.
+- New dependency versions are required by this version:
+  - `pocketmine/bedrock-protocol` has been updated from 7.1.0 to [7.3.0](https://github.com/pmmp/BedrockProtocol/releases/tag/7.3.0%2Bbedrock-1.18.0).
+  - `pocketmine/errorhandler` has been updated from 0.3.0 to [0.6.0](https://github.com/pmmp/ErrorHandler/releases/tag/0.6.0).
+
+## API
+### Block
+- The following classes have been added:
+  - `Lectern`
+  - `Pumpkin`
+- The following public API methods have been added:
+  - `Block->getTypeId() : int` - returns an integer which uniquely identifies the block type, ignoring things like facing, colour etc.
+  - `VanillaBlocks::LECTERN()`
+
+### Entity
+- The following classes have been added:
+  - `animation\ItemEntityStackSizeChangeAnimation`
+- The following public API methods have been added:
+  - `object\ItemEntity->isMergeable(object\ItemEntity $other) : bool`
+  - `object\ItemEntity->setStackSize(int $size) : void`
+  - `object\ItemEntity->tryMergeInto(object\ItemEntity $other) : bool`
+  - `ExperienceManager->canAttractXpOrbs() : bool`
+  - `ExperienceManager->setCanAttractXpOrbs(bool $v = true) : void`
+  - `Entity->getSize() : EntitySizeInfo`
+  - `Living->isGliding() : bool`
+  - `Living->isSwimming() : bool`
+  - `Living->setGliding(bool $value = true) : void`
+  - `Living->setSwimming(bool $value = true) : void`
+- The following protected API methods have been added:
+  - `Entity->getBlocksIntersected(float $inset) : \Generator<int, Block, void, void>`
+
+### Event
+- `BlockSpreadEvent` is now called when fire spreads to the positions of blocks it burns away.
+- `BlockFormEvent` is now called when concrete powder turns into concrete due to contact with water.
+- The following classes have been added:
+  - `BlockMeltEvent` - called when ice or snow melts
+  - `ChestPairEvent` - called when two chests try to form a pair
+  - `PlayerToggleGlideEvent` - called when a player starts or stops gliding
+  - `PlayerToggleSwimEvent` - called when a player starts or stops swimming
+
+### Item
+- The following public API methods have been added:
+  - `SplashPotion->getType() : PotionType`
+  - `VanillaItems::AIR()`
+- The following API methods have been deprecated:
+  - `ItemFactory::air()` - use `VanillaItems::AIR()` instead
+
+### Player
+- The following public API methods have been added:
+  - `Player->hasBlockCollision() : bool`
+  - `Player->setHasBlockCollision(bool $value)` - allows controlling spectator-like no-clip behaviour without changing game mode
+  - `Player->toggleSwim(bool $swim) : bool` - called by the network system when the client tries to start/stop swimming
+  - `Player->toggleGlide(bool $glide) : bool` - called by the network system when the client tries to start/stop gliding
+
+### Server
+- The following public API constants have been added:
+  - `Server::DEFAULT_SERVER_NAME`
+  - `Server::DEFAULT_MAX_PLAYERS`
+  - `Server::DEFAULT_PORT_IPV4`
+  - `Server::DEFAULT_PORT_IPV6`
+  - `Server::DEFAULT_MAX_VIEW_DISTANCE`
+
+### Utils
+- Config parsing errors are now always represented by `ConfigLoadException` and include the path to the file in the message.
+- Added `TextFormat::MINECOIN_GOLD`, and support for it to the various `TextFormat` methods.
+- The following public API methods have been added:
+  - `Utils::assumeNotFalse()` - static analysis crutch to silence PHPStan errors without using `ignoreErrors` or `@phpstan-ignore-line`, which are both too coarse.
+- The following public API properties have been added:
+  - `Terminal::$COLOR_MINECOIN_GOLD`
+- The following classes have been added:
+  - `ConfigLoadException`
+- Fixed `Random->nextSignedInt()` to actually return a signed int. Previously it would return any integer value between 0 and 4,294,957,295.
+- Fixed `Random->nextSignedFloat()` to return a float between `-1.0` and `1.0`. Previously it would return any value between `0.0` and `2.0`.
+- `VersionString->getNumber()` output is now structured differently to fix overflow issues caused by the old format.
+
+### World
+- The following classes have been added:
+  - `sound\ItemUseOnBlockSound`
+  - `sound\LecternPlaceBookSound`
+
+## Gameplay
+### Blocks
+- Fire now spreads.
+- Implemented lectern blocks.
+- Added missing sounds for hoeing grass and dirt.
+- Added missing sounds for using a shovel on grass to create grass path.
+- Pumpkins can now be carved using shears.
+
+### Items
+- Dropped items of the same type now merge with each other.
+
+### Misc
+- Implemented player swimming.
+
+# 4.1.0-BETA2
+Released 27th January 2022.
+
+## API
+### Block
+- The following API methods have been added:
+  - `utils\BrewingStandSlot->getSlotNumber() : int`
+  - `utils\FurnaceType->getCookSound() : Sound`
+- The following API constants have been added:
+  - `tile\BrewingStand::BREW_TIME_TICKS`
+
+### Crafting
+- The following API methods have been added:
+  - `CraftingManager->getPotionContainerChangeRecipes() : array<int, array<string, PotionContainerChangeRecipe>>`
+  - `CraftingManager->getPotionTypeRecipes() : array<string, array<string, PotionTypeRecipe>>`
+  - `CraftingManager->registerPotionContainerChangeRecipe(PotionContainerChangeRecipe $recipe) : void`
+  - `CraftingManager->registerPotionTypeRecipe(PotionTypeRecipe $recipe) : void`
+- The following classes have been added:
+  - `BrewingRecipe`
+  - `PotionContainerChangeRecipe`
+  - `PotionTypeRecipe`
+
+### Event
+- The following classes have been added:
+  - `BrewItemEvent` - called when a brewing stand finishes brewing potions; this is called up to 3 times (once for each brewing slot, as needed)
+  - `BrewingFuelUseEvent` - called when a brewing stand consumes blaze powder
+  - `PlayerViewDistanceChangeEvent` - called whenever a player alters their render distance or requests one for the first time when connecting
+
+### World
+#### Sound
+- The following classes have been added:
+  - `BlastFurnaceSound` - the sound made by a blast furnace during smelting
+  - `FurnaceSound` - the sound made by a regular furnace during cooking or smelting
+  - `PotionFinishBrewingSound` - the sound made by a brewing stand when a potion finishes being brewed
+  - `SmokerSound` - the sound made by a smoker during cooking
+
+## Gameplay
+### Blocks
+- Brewing stands can now be used for brewing potions.
+- The visual appearance of a brewing stand now updates correctly when the contents of its inventory changes (adding/removing potions).
+- Added missing sounds for furnace, blast furnace and smoker.
+- Fixed ender chest not dropping itself when mined with a Silk Touch pickaxe.
+- Cobwebs now drop themselves when mined using shears.
+- The correct amount of fall damage is now taken when falling from a height onto hay bales.
+- Fixed block updating bug introduced by beta1 which caused crops and other plants to never grow.
+
+### Misc
+- Added a workaround for client hitbox size bug after swimming which caused the player to be able to fit into one-block-tall gaps.

changelogs/4.1.md

@@ -0,0 +1,142 @@
+**For Minecraft: Bedrock Edition 1.18.0**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.1.0
+Released 7th February 2022.
+
+## General
+- Game mode names (e.g. `survival`, `creative`) may now be used for the `gamemode` property in `server.properties`.
+- Increased default maximum render distance to 16 chunks. Players with a render distance smaller than this will notice no difference.
+- The setup wizard now prompts for a maximum render distance value.
+- The setup wizard now prompts for an IPv6 port selection. Previously it would always use 19133.
+- `chunk-ticking.disable-block-ticking` now accepts block names like those used in the `/give` command.
+- The `/clear` command now behaves more like vanilla:
+  - The order of inventories is now the same as Bedrock.
+  - The cursor and offhand inventories are now cleared if necessary.
+
+## Technical
+- `PlayerAuthInputPacket` is now used instead of `MovePlayerPacket` for processing movements. This improves position and rotation accuracy.
+- `&&` and `||` are now always used instead of `and` and `or`.
+- New version of `pocketmine/errorhandler` is used by this version, adding support for `ErrorToExceptionHandler::trap()`. This enables reliably capturing `E_WARNING` and `E_NOTICE` from functions such as `yaml_parse()` and friends.
+- New dependency versions are required by this version:
+  - `pocketmine/bedrock-protocol` has been updated from 7.1.0 to [7.3.0](https://github.com/pmmp/BedrockProtocol/releases/tag/7.3.0%2Bbedrock-1.18.0).
+  - `pocketmine/errorhandler` has been updated from 0.3.0 to [0.6.0](https://github.com/pmmp/ErrorHandler/releases/tag/0.6.0).
+
+## API
+### Block
+- The following classes have been added:
+  - `Lectern`
+  - `Pumpkin`
+- The following public API methods have been added:
+  - `Block->getTypeId() : int` - returns an integer which uniquely identifies the block type, ignoring things like facing, colour etc.
+  - `VanillaBlocks::LECTERN()`
+  - `utils\BrewingStandSlot->getSlotNumber() : int`
+  - `utils\FurnaceType->getCookSound() : Sound`
+- The following API constants have been added:
+  - `tile\BrewingStand::BREW_TIME_TICKS`
+
+### Crafting
+- The following API methods have been added:
+  - `CraftingManager->getPotionContainerChangeRecipes() : array<int, array<string, PotionContainerChangeRecipe>>`
+  - `CraftingManager->getPotionTypeRecipes() : array<string, array<string, PotionTypeRecipe>>`
+  - `CraftingManager->registerPotionContainerChangeRecipe(PotionContainerChangeRecipe $recipe) : void`
+  - `CraftingManager->registerPotionTypeRecipe(PotionTypeRecipe $recipe) : void`
+- The following classes have been added:
+  - `BrewingRecipe`
+  - `PotionContainerChangeRecipe`
+  - `PotionTypeRecipe`
+
+### Entity
+- The following classes have been added:
+  - `animation\ItemEntityStackSizeChangeAnimation`
+- The following public API methods have been added:
+  - `object\ItemEntity->isMergeable(object\ItemEntity $other) : bool`
+  - `object\ItemEntity->setStackSize(int $size) : void`
+  - `object\ItemEntity->tryMergeInto(object\ItemEntity $other) : bool`
+  - `ExperienceManager->canAttractXpOrbs() : bool`
+  - `ExperienceManager->setCanAttractXpOrbs(bool $v = true) : void`
+  - `Entity->getSize() : EntitySizeInfo`
+  - `Living->isGliding() : bool`
+  - `Living->isSwimming() : bool`
+  - `Living->setGliding(bool $value = true) : void`
+  - `Living->setSwimming(bool $value = true) : void`
+- The following protected API methods have been added:
+  - `Entity->getBlocksIntersected(float $inset) : \Generator<int, Block, void, void>`
+
+### Event
+- `BlockSpreadEvent` is now called when fire spreads to the positions of blocks it burns away.
+- `BlockFormEvent` is now called when concrete powder turns into concrete due to contact with water.
+- The following classes have been added:
+  - `BlockMeltEvent` - called when ice or snow melts
+  - `BrewItemEvent` - called when a brewing stand finishes brewing potions; this is called up to 3 times (once for each brewing slot, as needed)
+  - `BrewingFuelUseEvent` - called when a brewing stand consumes blaze powder
+  - `ChestPairEvent` - called when two chests try to form a pair
+  - `PlayerToggleGlideEvent` - called when a player starts or stops gliding
+  - `PlayerToggleSwimEvent` - called when a player starts or stops swimming
+  - `PlayerViewDistanceChangeEvent` - called whenever a player alters their render distance or requests one for the first time when connecting
+
+### Item
+- The following public API methods have been added:
+  - `SplashPotion->getType() : PotionType`
+  - `VanillaItems::AIR()`
+- The following API methods have been deprecated:
+  - `ItemFactory::air()` - use `VanillaItems::AIR()` instead
+
+### Player
+- The following public API methods have been added:
+  - `Player->hasBlockCollision() : bool`
+  - `Player->setHasBlockCollision(bool $value)` - allows controlling spectator-like no-clip behaviour without changing game mode
+  - `Player->toggleSwim(bool $swim) : bool` - called by the network system when the client tries to start/stop swimming
+  - `Player->toggleGlide(bool $glide) : bool` - called by the network system when the client tries to start/stop gliding
+
+### Server
+- The following public API constants have been added:
+  - `Server::DEFAULT_SERVER_NAME`
+  - `Server::DEFAULT_MAX_PLAYERS`
+  - `Server::DEFAULT_PORT_IPV4`
+  - `Server::DEFAULT_PORT_IPV6`
+  - `Server::DEFAULT_MAX_VIEW_DISTANCE`
+
+### Utils
+- Config parsing errors are now always represented by `ConfigLoadException` and include the path to the file in the message.
+- Added `TextFormat::MINECOIN_GOLD`, and support for it to the various `TextFormat` methods.
+- The following public API methods have been added:
+  - `Utils::assumeNotFalse()` - static analysis crutch to silence PHPStan errors without using `ignoreErrors` or `@phpstan-ignore-line`, which are both too coarse.
+- The following public API properties have been added:
+  - `Terminal::$COLOR_MINECOIN_GOLD`
+- The following classes have been added:
+  - `ConfigLoadException`
+- Fixed `Random->nextSignedInt()` to actually return a signed int. Previously it would return any integer value between 0 and 4,294,957,295.
+- Fixed `Random->nextSignedFloat()` to return a float between `-1.0` and `1.0`. Previously it would return any value between `0.0` and `2.0`.
+- `VersionString->getNumber()` output is now structured differently to fix overflow issues caused by the old format.
+
+### World
+- The following classes have been added:
+  - `sound\BlastFurnaceSound` - the sound made by a blast furnace during smelting
+  - `sound\FurnaceSound` - the sound made by a regular furnace during cooking or smelting
+  - `sound\ItemUseOnBlockSound`
+  - `sound\LecternPlaceBookSound`
+  - `sound\PotionFinishBrewingSound` - the sound made by a brewing stand when a potion finishes being brewed
+  - `sound\SmokerSound` - the sound made by a smoker during cooking
+
+## Gameplay
+### Blocks
+- Fire now spreads.
+- Implemented lectern blocks.
+- Added missing sounds for hoeing grass and dirt.
+- Added missing sounds for using a shovel on grass to create grass path.
+- Pumpkins can now be carved using shears.
+- Brewing stands can now be used for brewing potions.
+- The visual appearance of a brewing stand now updates correctly when the contents of its inventory changes (adding/removing potions).
+- Added missing sounds for furnace, blast furnace and smoker.
+- Fixed ender chest not dropping itself when mined with a Silk Touch pickaxe.
+- Cobwebs now drop themselves when mined using shears.
+- The correct amount of fall damage is now taken when falling from a height onto hay bales.
+
+### Items
+- Dropped items of the same type now merge with each other.

changelogs/4.10.md

@@ -0,0 +1,53 @@
+**For Minecraft: Bedrock Edition 1.19.40**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.10.0
+Released 26th October 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.40.
+- Removed support for older versions.
+
+## Fixes
+- Fixed incorrect command descriptions showing in `/help` when multiple commands use the same name. Previously, the most recently registered command would show, even though it wouldn't actually be invoked.
+- Fixed splash potions affecting players in spectator mode.
+- Fixed `World->addParticle()` sending particles to players who couldn't possibly see them when a list of targets was used.
+- Fixed `World->addSound()` sending sounds to players who couldn't possibly hear them when a list of targets was used.
+
+## Documentation
+- Improved type information available for various API methods in `World`.
+
+# 4.10.1
+Released 7th November 2022.
+
+## Fixes
+- Fixed spawning in the void if spawn terrain in a world is solid at the default spawn position.
+- Fixed totems of undying activating when the player has 1 HP remaining.
+- Fixed durable items such as tools becoming unbreakable when in stacks larger than 1. Now, the durability correctly resets when the tool breaks.
+- TPS below 12 now correctly shows as red in `/status`. Previously, it showed as orange due to a condition ordering bug.
+- Improved handling of missing arguments in user-defined `pocketmine.yml` command aliases. Previously, missing arguments would be filled with an empty string, which caused a variety of unexpected behaviour.
+
+## Internals
+- Added validation for the array given to `BaseInventory->setContents()` to ensure that it contains only `Item` instances.
+- Silenced `PlayerAuthInputPacket` spam when the session is in the "spawn response" state.
+- Updated to PHPStan 1.9.
+
+# 4.10.2
+Released 25th November 2022.
+
+## Fixes
+- Fixed crashes on macOS and Linux when using console colours without the `TERM` environment variable set.
+- Fixed crashdumps not being generated when error messages contained invalid UTF-8 characters.
+
+## Documentation
+- Clarified documentation of caching behaviour for `Internet::getIP()`.
+- Added and improved documentation for many `Inventory` methods.
+- Rewritten documentation for `PlayerCreationEvent` with warnings and more detail.
+
+## Internals
+- Non-arrow projectile damage is now unscaled. Scaling according to velocity is only applied to arrows. This currently doesn't cause any observable change in behaviour, but is required for future additions.

changelogs/4.11-beta.md

@@ -0,0 +1,92 @@
+**For Minecraft: Bedrock Edition 1.19.40**
+
+This is a minor feature release for PocketMine-MP, introducing some new features and improvements.
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.11.0-BETA1
+Released 7th November 2022.
+
+## General
+- Packet receive timings have now been split into two subcategories - Decode and Handle.
+- Console command entry can now be disabled via the `console.enable-input` setting in `pocketmine.yml`.
+    - Best suited for headless servers (e.g. in a Docker container) where the console will never be used anyway.
+    - Disabling the console reader slightly reduces memory usage, because console reading currently requires an additional subprocess.
+- Console command output now appears on the terminal only, and is not written to the log file.
+- The output from console commands now appears with a `Command output |` prefix, instead of as a log message.
+- Introduced validation for the `--data` and `--plugins` command line options.
+- Encrypted resource packs are now supported, by means of adding a `.key` file alongside the pack in the `resource_packs` folder.
+    - e.g. `MyEncryptedPack.zip` -> `MyEncryptedPack.zip.key`
+
+## Gameplay
+- Fixed supporting blocks of dead bush to be in line with vanilla.
+- Sugarcane can now be grown using bonemeal on any part of the sugarcane. Previously, it only worked when used on the bottom block.
+- Fixed modifier values for Instant Damage and Regeneration effects.
+
+## API
+### General
+- Plugins are now always disabled before their dependencies, to ensure that they are able to shutdown properly (e.g. a core plugin depending on a database plugin may want to save data to a DB during `onDisable()`).
+- [`webmozart/path-util`](https://packagist.org/packages/webmozart/path-util) has been deprecated, and will be dropped in favour of [`symfony/filesystem`](https://packagist.org/packages/symfony/filesystem) in PM5.
+    - To prepare for this change, simply replace any usage of `Webmozart\PathUtil\Path` with `Symfony\Component\Filesystem\Path`, which is available as a dependency in this release.
+
+### `pocketmine`
+- The following API methods are now deprecated:
+    - `Server->getPlayerByPrefix()`
+
+### `pocketmine\entity`
+- `EntitySpawnEvent` and `ItemSpawnEvent` are now fired on the first tick after the entity is added to the world. Previously, these events were called directly from the entity constructor, making it impossible to get properties like velocity which are often set after the entity is created.
+- The following API methods are now deprecated:
+    - `Living->hasLineOfSight()`
+
+### `pocketmine\item`
+- The following new API methods have been added:
+    - `public Armor->clearCustomColor() : $this`
+
+### `pocketmine\inventory\transaction`
+- Introduced a `TransactionBuilder` class. This makes it less of a hassle to build an `InventoryTransaction` server-side, since the regular `Inventory` API methods can be used, rather than having to manually create `SlotChangeAction`s.
+
+### `pocketmine\player`
+- The following new API methods have been added:
+    - `public Player->sendToastNotification(string $title, string $body) : void` - makes a grey box appear at the top of the player's screen containing the specified message
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+    - `public static TextFormat::addBase(string $baseFormat, string $string) : string` - used for coloured log messages, changes the base formatting of a string by inserting the given formatting codes after every RESET code
+
+## Internals
+- Improved performance of `ContainerTrait` dropping items on block destroy. (24e72ec109c1442b09558df89b6833cf2f2e0ec7)
+- Avoid repeated calls to `Position->getWorld()` (use local variables). (2940547026db40ce76deb46e992870de3ead79ad)
+- Revamped the way `InventoryManager` handles fake inventory slot mappings for stuff like crafting tables. (e90abecf38d9c57635fa0497514bba7e546a2469)
+- Console polling is now done on the main thread (no longer a performance concern).
+- Console reader subprocess should now automatically die if the server main process is killed, instead of persisting as a zombie.
+- `ConsoleCommandSender` is no longer responsible for relaying broadcast messages to `MainLogger`. A new `BroadcastLoggerForwarder` has been added, which is subscribed to the appropriate server broadcast channels in order to relay messages. This ensures that chat messages and command audit messages are logged.
+- `DelegateInventory` now uses `WeakReference` to track its inventory listener. This allows the delegate to be reused.
+
+# 4.11.0-BETA2
+Released 13th November 2022.
+
+## Configuration
+- The `chunk-ticking.per-tick` setting is now deprecated, and will be removed in a future release.
+  - The functionality of this setting has been removed, since it caused more problems than it solved.
+  - Setting it to zero will still disable chunk ticking (for now), but this should now be done by setting `chunk-ticking.tick-radius` to `0` instead.
+
+## Gameplay
+- Improved chunk random ticking:
+  - Removed the limit on chunks ticked per tick, and its associated config option is no longer respected.
+    - This change significantly improves crop and plant growth with large numbers of players, but may cause higher CPU usage.
+    - This limit was causing a linear decrease in chunk ticking speed with larger numbers of players, leading to worsened gameplay experience.
+  - Every chunk within the configured tick radius of a player will be ticked. Previously, chunks were randomly selected from the radius.
+- Implemented Darkness effect.
+
+## API
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->getChunkTickRadius() : int` - returns the world's simulation radius
+  - `public World->setChunkTickRadius(int $radius) : void` - sets the world's simulation radius
+
+## Internals
+- Non-arrow projectile damage is now unscaled. Scaling according to velocity is only applied to arrows. This currently doesn't cause any observable change in behaviour, but is required for future additions.

changelogs/4.11.md

@@ -0,0 +1,106 @@
+**For Minecraft: Bedrock Edition 1.19.40**
+
+This is a minor feature release for PocketMine-MP, introducing some new features and improvements.
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.11.0
+Released 25th November 2022.
+
+## General
+- Packet receive timings have now been split into two subcategories - Decode and Handle.
+- Console command entry can now be disabled via the `console.enable-input` setting in `pocketmine.yml`.
+  - Best suited for headless servers (e.g. in a Docker container) where the console will never be used anyway.
+  - Disabling the console reader slightly reduces memory usage, because console reading currently requires an additional subprocess.
+- Console command output now appears on the terminal only, and is not written to the log file.
+- The output from console commands now appears with a `Command output |` prefix, instead of as a log message.
+- User-defined `pocketmine.yml` custom commands now use a generic description which makes clear the command is config-defined.
+- Introduced validation for the `--data` and `--plugins` command line options.
+- Encrypted resource packs are now supported, by means of adding a `.key` file alongside the pack in the `resource_packs` folder.
+  - e.g. `MyEncryptedPack.zip` -> `MyEncryptedPack.zip.key`
+  - The file must contain the raw key bytes, and must not end with a newline.
+
+## Configuration
+- The `chunk-ticking.per-tick` setting is now deprecated, and will be removed in a future release.
+  - The functionality of this setting has been removed, since it caused more problems than it solved.
+  - Setting it to zero will still disable chunk ticking (for now), but this should now be done by setting `chunk-ticking.tick-radius` to `0` instead.
+
+## Gameplay
+- Fixed supporting blocks of dead bush to be in line with vanilla.
+- Sugarcane can now be grown using bonemeal on any part of the sugarcane. Previously, it only worked when used on the bottom block.
+- Fixed missing sounds when adding, rotating, or removing items in item frames.
+- Fixed modifier values for Instant Damage and Regeneration effects.
+- Implemented Darkness effect.
+- Improved chunk random ticking:
+  - Removed the limit on chunks ticked per tick, and its associated config option is no longer respected.
+    - This change significantly improves crop and plant growth with large numbers of players.
+    - This limit was causing a linear decrease in chunk ticking speed with larger numbers of players, leading to worsened gameplay experience.
+    - **Warning: This change will result in increased CPU usage if players are spread over a very large area.**
+  - Every chunk within the configured tick radius of a player will be ticked. Previously, chunks were randomly selected from the radius.
+
+## API
+### General
+- Plugins are now always disabled before their dependencies, to ensure that they are able to shutdown properly (e.g. a core plugin depending on a database plugin may want to save data to a DB during `onDisable()`).
+- [`webmozart/path-util`](https://packagist.org/packages/webmozart/path-util) has been deprecated, and will be dropped in favour of [`symfony/filesystem`](https://packagist.org/packages/symfony/filesystem) in PM5.
+    - To prepare for this change, simply replace any usage of `Webmozart\PathUtil\Path` with `Symfony\Component\Filesystem\Path`, which is available as a dependency in this release.
+
+### `pocketmine`
+- The following API methods are now deprecated:
+  - `Server->getPlayerByPrefix()`
+
+### `pocketmine\entity`
+- `EntitySpawnEvent` and `ItemSpawnEvent` are now fired on the first tick after the entity is added to the world. Previously, these events were called directly from the entity constructor, making it impossible to get properties like velocity which are often set after the entity is created.
+- The following API methods are now deprecated:
+  - `Living->hasLineOfSight()`
+
+### `pocketmine\event\block`
+- The following new classes have been added:
+  - `BlockDeathEvent` - event called when coral or coral blocks die due to lack of water
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Armor->clearCustomColor() : $this`
+
+### `pocketmine\inventory\transaction`
+- Introduced a `TransactionBuilder` class. This makes it less of a hassle to build an `InventoryTransaction` server-side, since the regular `Inventory` API methods can be used, rather than having to manually create `SlotChangeAction`s.
+
+### `pocketmine\lang`
+- The following new API methods have been added:
+  - `public Language->getAll() : array<string, string>`
+
+### `pocketmine\player`
+- The following new API methods have been added:
+  - `public Player->sendToastNotification(string $title, string $body) : void` - makes a grey box appear at the top of the player's screen containing the specified message
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+  - `public static TextFormat::addBase(string $baseFormat, string $string) : string` - used for coloured log messages, changes the base formatting of a string by inserting the given formatting codes after every RESET code
+
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->getChunkTickRadius() : int` - returns the world's simulation radius
+  - `public World->setChunkTickRadius(int $radius) : void` - sets the world's simulation radius
+
+### `pocketmine\world\sound`
+- The following new classes have been added:
+  - `ItemFrameAddItemSound`
+  - `ItemFrameRemoveItemSound`
+  - `ItemFrameRotateItemSound`
+
+## Internals
+- Improved performance of `ContainerTrait` dropping items on block destroy. ([link](https://github.com/pmmp/PocketMine-MP/commits/24e72ec109c1442b09558df89b6833cf2f2e0ec7))
+- Avoid repeated calls to `Position->getWorld()` (use local variables). ([link](https://github.com/pmmp/PocketMine-MP/commit/2940547026db40ce76deb46e992870de3ead79ad))
+- Revamped the way `InventoryManager` handles fake inventory slot mappings for stuff like crafting tables. ([link](https://github.com/pmmp/PocketMine-MP/commit/e90abecf38d9c57635fa0497514bba7e546a2469))
+  - Inventories are now mapped on a per-slot basis. This means that more than one inventory can be mapped to the same window ID, which is necessary for correctly handling "UI" inventories like crafting tables.
+  - `InventoryManager->getWindow(int $windowId) : ?Inventory` is replaced by `locateWindowAndSlot` (see below).
+  - Added `InventoryManager->locateWindowAndSlot(int $windowId, int $netSlotId) : array{Inventory, int}` - accepts a window ID and absolute slot ID, and returns the associated inventory and the slot relative to the inventory's own start (for use with `getItem()` etc.).
+  - Slot offset mapping for "UI" inventories is now handled in `InventoryManager->createComplexSlotMapping()` instead of in `TypeConverter`.
+- Console polling is now done on the main thread (no longer a performance concern). ([link](https://github.com/pmmp/PocketMine-MP/commit/b3f03d7ae645de67a54b7300c09b94eeca16298e))
+- Console reader subprocess should now automatically die if the server main process is killed, instead of persisting as a zombie. ([link](https://github.com/pmmp/PocketMine-MP/commit/2585160ca2c4df5758b8b980331307402ff9f0fb))
+- `ConsoleCommandSender` is no longer responsible for relaying broadcast messages to `MainLogger`. A new `BroadcastLoggerForwarder` has been added, which is subscribed to the appropriate server broadcast channels in order to relay messages. This ensures that chat messages and command audit messages are logged. ([link](https://github.com/pmmp/PocketMine-MP/commit/83e5b0adb6fa0dddec377182bb1c7945ac8f7820))
+- `DelegateInventory` now uses `WeakReference` to track its inventory listener. This allows the delegate to be reused. ([link](https://github.com/pmmp/PocketMine-MP/commit/3feaa18f6c10c3a99c0deca75f57ec2d74b92ab4))
+- Non-arrow projectile damage is now unscaled. Scaling according to velocity is only applied to arrows. This currently doesn't cause any observable change in behaviour, but is required for future additions.

changelogs/4.12.md

@@ -0,0 +1,119 @@
+**For Minecraft: Bedrock Edition 1.19.50**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.12.0
+Released 30th November 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.50.
+- Removed support for older versions.
+
+# 4.12.1
+Released 4th December 2022.
+
+## Fixes
+- Fixed items glitching when dragging a stack of items across the crafting grid (desync issues).
+
+# 4.12.2
+Released 15th December 2022.
+
+## Fixes
+- Folder used for plugins (optionally specified by `--plugins`) is no longer required to be writable.
+- Fixed broken writable check for server data folder (`is_writable()` broken on NFS and similar filesystems).
+- `Filesystem::createLockFile()` exceptions now include more information about why the lock file could not be created.
+- Fixed client-side item predictions not being rolled back when cancelling events such as `PlayerItemUseEvent`.
+
+## Dependencies
+- Updated BedrockProtocol to [17.1.0](https://github.com/pmmp/BedrockProtocol/releases/tag/17.1.0+bedrock-1.19.50). This adds some missing `LevelSoundEvent` constants and fixes the values for `ContainerUIIds`.
+
+# 4.12.3
+Released 28th December 2022.
+
+## Fixes
+- Fixed unauthenticated connections taking up player count slots, preventing players from joining.
+- Fixed a possible crash in `World->tickChunk()` when plugins unload chunks during some events.
+- `/gamemode` will now report a failure to change game mode if the player is already in the requested game mode.
+
+# 4.12.4
+Released 3rd January 2023.
+
+## Fixes
+- Added workarounds for an active exploit being used to deny service to servers.
+
+# 4.12.5
+Released 6th January 2023.
+
+## Fixes
+- Removed a workaround for an old client bug in custom form responses. The code contained a denial-of-service vulnerability.
+
+# 4.12.6
+Released 7th January 2023.
+
+## Changes
+- Added a new security measure to `NetworkSession` to detect and ban players who flood the server with packets.
+
+# 4.12.7
+Released 8th January 2023.
+
+## Fixes
+- Fixed players getting kicked when the server lags for too long.
+- Fixed players getting kicked when a debugging session is active and a breakpoint is hit.
+
+# 4.12.8
+Released 9th January 2023.
+
+## Fixes
+- Fixed players getting kicked during PvP.
+- Fixed players randomly getting kicked on Windows (improper rate limit handling wrt. 15ms timer resolution).
+
+# 4.12.9
+Released 16th January 2023.
+
+## Improvements
+### Timings
+- Added new timers:
+  - `Server Mid-Tick Processing` - time spent processing Snooze interrupts between ticks (e.g. incoming network packets)
+  - `Server Tick Update Cycle` - time spent processing regular per-tick updates (e.g. entity movement, world updates, etc.) (`Server->tick()`)
+- `Full Server Tick` timer now counts the total of `Server Mid-Tick Processing` and `Server Tick Update Cycle`, which generates more accurate performance metrics.
+  - Previously, this timer only counted the time spent during regular per-tick updates, and the time recorded by `Server Mid-Tick Processing` was not included in the report at all.
+
+## Fixes
+- Fixed blocks such as pressure plates being able to be placed without the correct supporting blocks if the clicked block was solid.
+- Pressure plates now self-destruct when the block below them is removed.
+- Fixed being unable to place blocks by clicking on the side of a bell (when the click doesn't result in ringing the bell).
+- Fixed various rotation-aware blocks (e.g. stairs) behaving incorrectly when placed by clicking on the side of a replaceable block (e.g. tall grass).
+- Fixed banners being able to be placed on top of blocks such as skulls.
+- Fixed server-side collision boxes of walls and glass (which should connect, but didn't). Note that wall connections still don't show client side - this just fixes the collision boxes.
+- Fixed `PlayerInteractEvent` with `LEFT_CLICK` sometimes firing before `BlockBreakEvent` when breaking blocks.
+
+## Other changes
+- Increased packet batch budget for player sessions.
+
+# 4.12.10
+Released 18th January 2023.
+
+## Fixes
+- Fixed reported server load not including the time spent processing Snooze interrupts between ticks (e.g. incoming network packets).
+- Fixed `Connection Handler` entry in timings report not including time spent receiving packets.
+
+## Note about server load & performance
+This version will report higher apparent server load than previous versions. The actual performance of the server is unchanged; the previous reported load was inaccurate.
+These bugs have been present for nearly 5 years (ever since the first introduction of Snooze in 3.0.0).
+
+# 4.12.11
+Released 22nd January 2023.
+
+## General
+- Code is now tested and analysed using PHP 8.2 in addition to 8.1 and 8.0.
+
+## Fixes
+- Fixed pthreads 5.0.0 incorrectly being treated as compatible.
+- Fixed deprecation errors on PHP 8.2.
+
+## Documentation
+- Updated documentation in `PlayerPreLoginEvent`.

changelogs/4.13-beta.md

@@ -0,0 +1,94 @@
+**For Minecraft: Bedrock Edition 1.19.50**
+
+This is a minor feature release for PocketMine-MP, introducing some new features and improvements.
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.13.0-BETA1
+Released 18th January 2023.
+
+## Gameplay
+- Death message is now shown on the death screen when a player dies.
+- Armour damage is now only increased if the armour reduced the damage taken.
+- Implemented Swift Sneak enchantment.
+- Fixed incorrect collision box calculation of walls and glass/bars when connected. Note: Client-side, wall connections are still broken; this only fixes projectile flight server-side.
+
+## Performance
+- Improved performance of chunk selection for chunk random ticking using a cache. This improves performance of chunk random ticking by 10-20%.
+
+## Localization
+- Added localized description for the `/dumpmemory` command.
+
+## Permissions
+- Added the following new core permissions:
+  - `pocketmine.command.effect.other` - allows the player to use the `/effect` command on other players (default operator only)
+  - `pocketmine.command.effect.self` - allows the player to use the `/effect` command on themselves (default operator only)
+  - `pocketmine.command.enchant.other` - allows the player to use the `/enchant` command on other players (default operator only)
+  - `pocketmine.command.enchant.self` - allows the player to use the `/enchant` command on themselves (default operator only)
+  - `pocketmine.command.gamemode.other` - allows the player to use the `/gamemode` command on other players (default operator only)
+  - `pocketmine.command.gamemode.self` - allows the player to use the `/gamemode` command on themselves (default operator only)
+  - `pocketmine.command.give.other` - allows the player to use the `/give` command on other players (default operator only)
+  - `pocketmine.command.give.self` - allows the player to use the `/give` command on themselves (default operator only)
+  - `pocketmine.command.spawnpoint.other` - allows the player to use the `/spawnpoint` command on other players (default operator only)
+  - `pocketmine.command.spawnpoint.self` - allows the player to use the `/spawnpoint` command on themselves (default operator only)
+  - `pocketmine.command.teleport.other` - allows the player to use the `/teleport` command on other players (default operator only)
+  - `pocketmine.command.teleport.self` - allows the player to use the `/teleport` command on themselves (default operator only)
+  - `pocketmine.command.title.other` - allows the player to use the `/title` command on other players (default operator only)
+  - `pocketmine.command.title.self` - allows the player to use the `/title` command on themselves (default operator only)
+
+## Internals
+- Decoupled `Player->sendMessage()` and `Player->sendTranslation()`.
+- Refactored resource pack loading in `ResourcePackManager` to make it easier to understand.
+- Client-aware translation processing has been moved to `NetworkSession` due to being client-specific.
+- Replaced hardcoded strings with constants in various places.
+- `NetworkSession` destructive cleanup is now deferred to the next session tick. This fixes various `InventoryManager` crashes when kicking players during events.
+- Updated code using `strpos()` to use `str_starts_with()`, `str_ends_with()` and `str_contains()` where appropriate.
+- Added documentation for some internal methods.
+
+## API
+### `pocketmine\command`
+- The following new API methods have been added:
+  - `protected VanillaCommand->fetchPermittedPlayerTarget(...) : ?Player` - fetches a player target according to the given sender permissions, or null if not found or not permitted
+
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Living->getDisplayName() : string` - the name of the entity to be shown in death messages, commands etc.
+
+### `pocketmine\event\world`
+- The following new classes have been added:
+  - `WorldSoundEvent` - called when a sound is played in a world
+  - `WorldParticleEvent` - called when a particle is spawned in a world
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Item->onInteractEntity(Player $player, Entity $entity, Vector3 $clickVector) : bool` - called when a player interacts with an entity with this item in hand
+
+### `pocketmine\lang`
+- `Language->translate()` and `Language->translateString()` no longer parse nested translation in the "base text". This was never intended behaviour, and didn't work beyond the first level anyway.
+
+### `pocketmine\player`
+- The following new interfaces have been added:
+  - `PlayerDataProvider` - implemented by classes which want to offer storage for player data
+- The following new classes have been added:
+  - `DatFilePlayerDataProvider` - the default player data provider, which stores `.dat` files in the `players` folder
+  - `PlayerDataLoadException` - thrown when an error occurs while loading player data
+  - `PlayerDataSaveException` - thrown when an error occurs while saving player data
+- The following API methods have been deprecated:
+  - `Player->sendTranslation()` - use `Player->sendMessage()` instead with a `Translatable` message
+
+### `pocketmine\resourcepacks`
+- The following new API methods have been added:
+  - `public ResourcePackManager->setResourceStack(list<ResourcePack> $resourceStack) : void` - sets the list of resource packs to be applied by players
+  - `public ResourcePackManager->setPackEncryptionKey(string $id, ?string $key) : void` - sets the encryption key to be used for a resource pack
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+  - `public static Filesystem::fileGetContents(...) : string` - a wrapper around `file_get_contents()` which throws an exception on failure
+
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->requestSafeSpawn(?Vector3 $spawn = null) : Promise<Position>` - an async version of `getSafeSpawn()` which generates all the needed chunks before returning

changelogs/4.13.md

@@ -0,0 +1,94 @@
+**For Minecraft: Bedrock Edition 1.19.50**
+
+This is a minor feature release for PocketMine-MP, introducing some new features and improvements.
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.13.0
+Released 30th January 2023.
+
+## Gameplay
+- Death message is now shown on the death screen when a player dies.
+- Armour damage is now only increased if the armour reduced the damage taken.
+- Implemented Swift Sneak enchantment.
+- Fixed incorrect collision box calculation of walls and glass/bars when connected. Note: Client-side, wall connections are still broken; this only fixes projectile flight server-side.
+
+## Performance
+- Improved performance of chunk selection for chunk random ticking using a cache. This improves performance of chunk random ticking by 10-20%.
+
+## Localization
+- Added localized description for the `/dumpmemory` command.
+
+## Permissions
+- Added the following new core permissions:
+  - `pocketmine.command.effect.other` - allows the player to use the `/effect` command on other players (default operator only)
+  - `pocketmine.command.effect.self` - allows the player to use the `/effect` command on themselves (default operator only)
+  - `pocketmine.command.enchant.other` - allows the player to use the `/enchant` command on other players (default operator only)
+  - `pocketmine.command.enchant.self` - allows the player to use the `/enchant` command on themselves (default operator only)
+  - `pocketmine.command.gamemode.other` - allows the player to use the `/gamemode` command on other players (default operator only)
+  - `pocketmine.command.gamemode.self` - allows the player to use the `/gamemode` command on themselves (default operator only)
+  - `pocketmine.command.give.other` - allows the player to use the `/give` command on other players (default operator only)
+  - `pocketmine.command.give.self` - allows the player to use the `/give` command on themselves (default operator only)
+  - `pocketmine.command.spawnpoint.other` - allows the player to use the `/spawnpoint` command on other players (default operator only)
+  - `pocketmine.command.spawnpoint.self` - allows the player to use the `/spawnpoint` command on themselves (default operator only)
+  - `pocketmine.command.teleport.other` - allows the player to use the `/teleport` command on other players (default operator only)
+  - `pocketmine.command.teleport.self` - allows the player to use the `/teleport` command on themselves (default operator only)
+  - `pocketmine.command.title.other` - allows the player to use the `/title` command on other players (default operator only)
+  - `pocketmine.command.title.self` - allows the player to use the `/title` command on themselves (default operator only)
+
+## Internals
+- Decoupled `Player->sendMessage()` and `Player->sendTranslation()`.
+- Refactored resource pack loading in `ResourcePackManager` to make it easier to understand.
+- Client-aware translation processing has been moved to `NetworkSession` due to being client-specific.
+- Replaced hardcoded strings with constants in various places.
+- `NetworkSession` destructive cleanup is now deferred to the next session tick. This fixes various `InventoryManager` crashes when kicking players during events.
+- Updated code using `strpos()` to use `str_starts_with()`, `str_ends_with()` and `str_contains()` where appropriate.
+- Added documentation for some internal methods.
+
+## API
+### `pocketmine\command`
+- The following new API methods have been added:
+  - `protected VanillaCommand->fetchPermittedPlayerTarget(...) : ?Player` - fetches a player target according to the given sender permissions, or null if not found or not permitted
+
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Living->getDisplayName() : string` - the name of the entity to be shown in death messages, commands etc.
+
+### `pocketmine\event\world`
+- The following new classes have been added:
+  - `WorldSoundEvent` - called when a sound is played in a world
+  - `WorldParticleEvent` - called when a particle is spawned in a world
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Item->onInteractEntity(Player $player, Entity $entity, Vector3 $clickVector) : bool` - called when a player interacts with an entity with this item in hand
+
+### `pocketmine\lang`
+- `Language->translate()` and `Language->translateString()` no longer parse nested translation in the "base text". This was never intended behaviour, and didn't work beyond the first level anyway.
+
+### `pocketmine\player`
+- The following new interfaces have been added:
+  - `PlayerDataProvider` - implemented by classes which want to offer storage for player data
+- The following new classes have been added:
+  - `DatFilePlayerDataProvider` - the default player data provider, which stores `.dat` files in the `players` folder
+  - `PlayerDataLoadException` - thrown when an error occurs while loading player data
+  - `PlayerDataSaveException` - thrown when an error occurs while saving player data
+- The following API methods have been deprecated:
+  - `Player->sendTranslation()` - use `Player->sendMessage()` instead with a `Translatable` message
+
+### `pocketmine\resourcepacks`
+- The following new API methods have been added:
+  - `public ResourcePackManager->setResourceStack(list<ResourcePack> $resourceStack) : void` - sets the list of resource packs to be applied by players
+  - `public ResourcePackManager->setPackEncryptionKey(string $id, ?string $key) : void` - sets the encryption key to be used for a resource pack
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+  - `public static Filesystem::fileGetContents(...) : string` - a wrapper around `file_get_contents()` which throws an exception on failure
+
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->requestSafeSpawn(?Vector3 $spawn = null) : Promise<Position>` - an async version of `getSafeSpawn()` which generates all the needed chunks before returning

changelogs/4.14.md

@@ -0,0 +1,21 @@
+**For Minecraft: Bedrock Edition 1.19.60**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.14.0
+Released 8th February 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.60.
+- Removed support for older versions.
+
+# 4.14.1
+Released 15th February 2023.
+
+## Fixes
+- Fixed all players getting kicked with `Receiving packets too fast` if a server tick takes longer than 5 seconds (e.g. because of autosave or GC).
+- Fixed players getting kicked when linking with entities.

changelogs/4.15.md

@@ -0,0 +1,38 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.15.0
+Released 17th February 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.62.
+- Removed support for older versions.
+
+# 4.15.1
+Released 21st February 2023.
+
+## Fixes
+- Fixed dropped items not despawning when in non-ticking chunks.
+- Fixed dropped items not despawning if an infinite pickup delay is set.
+- Fixed infinite despawn delay (never despawn) being ignored for dropped items.
+
+# 4.15.2
+Released 24th February 2023.
+
+## General
+- Accept Minecraft: Bedrock Edition 1.19.63 (identical protocol to 1.19.62, but different version due to Mojang mixup).
+
+## Fixes
+- Fixed `World Population` timer sometimes not being stopped, causing strange results in timings reports.
+
+# 4.15.3
+Released 7th March 2023.
+
+## Fixes
+- Fixed `/dumpmemory` crash when any object contained an `INF` or `NaN` float value.
+- Updated RakLib for security fixes.

changelogs/4.16-beta.md

@@ -0,0 +1,45 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.16.0-BETA1
+Released 4th March 2023.
+
+## General
+- Added granular timings for packet encode, similar to the existing timings for packet decode.
+- Timings now covers several areas of the network system which were previously not counted by network timings, but were counted by total timings. This provides a better insight into the performance of the network system.
+
+## Performance
+- Improved performance of packet batch handling by avoiding unnecessary object allocations.
+- Improved performance of packet broadcasting when the broadcast size is below the batch threshold. Previously, the packets would be encoded once by every recipient, but now they are encoded once and then added to the send buffer of each session in their raw form.
+  - This change mostly affects servers with larger maps, where players are more widely distributed.
+
+## Build system
+- Added a new script `build/generate-bedrockdata-path-consts.php`, which must be run whenever BedrockData is updated. This script generates a class of constants with the file paths of all BedrockData files.
+
+## API
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Entity->getGravity() : float` - returns the entity's gravity acceleration in blocks/tick^2
+  - `public Entity->setGravity(float $gravity) : void` - sets the entity's gravity acceleration in blocks/tick^2
+
+## Internals
+- Now uses [`pocketmine/bedrock-data` 2.0.0](https://github.com/pmmp/BedrockData/releases/tag/2.0.0+bedrock-1.19.60).
+  - This version is now used by both PM4 and PM5, reducing maintenance burden.
+- Now uses [`pocketmine/bedrock-protocol` 19.3.0](https://github.com/pmmp/BedrockProtocol/releases/tag/19.3.0+bedrock-1.19.62).
+  - This version provides new APIs for handling packet batches which enabled improving performance and adding new features, such as detailed packet encode timings.
+- Crafting recipes and creative inventory data are now loaded from `recipes/legacy_recipes.json` and `recipes/legacy_creativeitems.json` respectively. Previously, these were loaded from BedrockData directly, but BedrockData 2.0 now uses a format which can't be supported in 4.x without BC breaks.
+- Added dependencies on [`pocketmine/bedrock-block-upgrade-schema`](https://github.com/pmmp/BedrockBlockUpgradeSchema) and [`pocketmine/bedrock-item-upgrade-schema`](https://github.com/pmmp/BedrockItemUpgradeSchema). These provide mapping files no longer present in BedrockData 2.0.
+- Reduced and/or eliminated most usages of `PacketBatch`, since it only appeared as a throwaway object and was therefore wasting performance.
+- `Compressor` now exposes `getCompressionThreshold()` instead of `willCompress()`, which allows determining whether a batch will be compressed without allocating it.
+- Added `pocketmine\data\bedrock\BedrockDataFiles`, an auto-generated class of constants with the file paths of all BedrockData files. This makes it easier to locate usages, detect unused files and avoid typos.
+
+# 4.16.0-BETA2
+Released 4th March 2023.
+
+## General
+- Fixed incorrect release channel for 4.16.0-BETA1.

changelogs/4.16.md

@@ -0,0 +1,41 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.16.0
+Released 7th March 2023.
+
+## General
+- Added granular timings for packet encode, similar to the existing timings for packet decode.
+- Split `Player Network Send - Compression` timings into two timers, one for `Session Buffer` compression and one for `Broadcast` compression.
+- Timings now covers several areas of the network system which were previously not counted by network timings, but were counted by total timings. This provides a better insight into the performance of the network system.
+
+## Performance
+- Improved performance of packet batch handling by avoiding unnecessary object allocations.
+- Improved performance of packet broadcasting when the broadcast size is below the batch threshold. Previously, the packets would be encoded once by every recipient, but now they are encoded once and then added to the send buffer of each session in their raw form.
+  - This change mostly affects servers with larger maps, where players are more widely distributed.
+- Improved performance of packet broadcasting when the broadcast has only one recipient (allow the session to compress the packet with the rest of its buffer).
+
+## Build system
+- Added a new script `build/generate-bedrockdata-path-consts.php`, which must be run whenever BedrockData is updated. This script generates a class of constants with the file paths of all BedrockData files.
+
+## API
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Entity->getGravity() : float` - returns the entity's gravity acceleration in blocks/tick^2
+  - `public Entity->setGravity(float $gravity) : void` - sets the entity's gravity acceleration in blocks/tick^2
+
+## Internals
+- Now uses [`pocketmine/bedrock-data` 2.0.0](https://github.com/pmmp/BedrockData/releases/tag/2.0.0+bedrock-1.19.60).
+  - This version is now used by both PM4 and PM5, reducing maintenance burden.
+- Now uses [`pocketmine/bedrock-protocol` 19.3.0](https://github.com/pmmp/BedrockProtocol/releases/tag/19.3.0+bedrock-1.19.62).
+  - This version provides new APIs for handling packet batches which enabled improving performance and adding new features, such as detailed packet encode timings.
+- Crafting recipes and creative inventory data are now loaded from `recipes/legacy_recipes.json` and `recipes/legacy_creativeitems.json` respectively. Previously, these were loaded from BedrockData directly, but BedrockData 2.0 now uses a format which can't be supported in 4.x without BC breaks.
+- Added dependencies on [`pocketmine/bedrock-block-upgrade-schema`](https://github.com/pmmp/BedrockBlockUpgradeSchema) and [`pocketmine/bedrock-item-upgrade-schema`](https://github.com/pmmp/BedrockItemUpgradeSchema). These provide mapping files no longer present in BedrockData 2.0.
+- Reduced and/or eliminated most usages of `PacketBatch`, since it only appeared as a throwaway object and was therefore wasting performance.
+- `Compressor` now exposes `getCompressionThreshold()` instead of `willCompress()`, which allows determining whether a batch will be compressed without allocating it.
+- Added `pocketmine\data\bedrock\BedrockDataFiles`, an auto-generated class of constants with the file paths of all BedrockData files. This makes it easier to locate usages, detect unused files and avoid typos.

changelogs/4.17.md

@@ -0,0 +1,39 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.17.0
+Released 14th March 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.70.
+- Removed support for older versions.
+
+# 4.17.1
+Released 22nd March 2023.
+
+## General
+- Docker images for PocketMine-MP are now published on [GitHub Container Registry](https://github.com/pmmp/PocketMine-MP/pkgs/container/pocketmine-mp). The Docker Hub images will stop being maintained in the future.
+- Updated translations.
+
+## Fixes
+- Fixed server crash on empty packets in certain cases.
+- Fixed mushroom blocks dropping the wrong items when broken with a silk-touch tool.
+- Fixed mushroom blocks giving the wrong items when block-picked.
+- Fixed missing ability flag `PRIVILEGED_BUILDER`.
+
+## Internals
+- `update-updater-api.yml` workflow now uses `github.repository_owner` to make it easier to test the workflow on forks.
+- Added version-specific channels to `update.pmmp.io`, such as `4`, `4.18-beta`, `4.17`, etc.
+- Replaced deprecated `::set-output` commands in GitHub Actions workflows.
+- `build/make-release.php` no longer automatically pushes changes, to avoid accidents when testing release workflows on forks.
+
+# 4.17.2
+Released 29th March 2023.
+
+## Fixes
+- Fixed players being unable to join due to the appearance of a new `x5t` field in the JWT header of Xbox Live authentication tokens.

changelogs/4.18-alpha.md

@@ -0,0 +1,91 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are compatible with any previous 4.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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Alpha release warning
+Alpha releases are **experimental**. Features introduced in these releases are subject to change or removal.
+
+APIs which existed **prior** to this version will continue to work as normal, so plugins which use them will continue to work.
+
+### Highlights
+This version makes changes to the internal network system to improve server performance and reduce memory usage.
+
+While these changes don't affect non-internal API, they are still significant enough to warrant a new minor version, as they may break plugins which use the internal network API (not recommended).
+
+# 4.18.0-ALPHA1
+Released 16th March 2023.
+
+## General
+- Improved server performance in congested areas of the world (lots of players and/or entities in the same area).
+
+## API
+### `pocketmine\event\server`
+- The following new classes have been added:
+  - `DataPacketDecodeEvent` - called before a packet is decoded by a `NetworkSession`; useful to mitigate DoS attacks if PocketMine-MP hasn't been patched against new bugs yet
+
+## Internals
+- Introduced new system for broadcasting entity events to network sessions.
+  - This change improves performance when lots of players and/or entities are in the same area.
+  - New interface `EntityEventBroadcaster` and class `StandardEntityEventBroadcaster` have been added to implement this.
+  - All entity-specific `on*()` and `sync*()` methods have been removed from `NetworkSession` (BC break).
+  - `NetworkSession` now accepts an `EntityEventBroadcaster` instance in its constructor.
+  - `NetworkBroadcastUtils::broadcastEntityEvent()` can be used to efficiently broadcast events to unique broadcasters shared by several network sessions.
+- All network sessions now share the same `PacketSerializerContext` and `PacketBroadcaster` by default.
+  - Previously, every session had its own context, meaning that broadcast optimisations were not used, causing significant performance losses compared to 3.x.
+  - This change improves performance in congested areas by allowing reuse of previously encoded packet buffers for all sessions sharing the same context.
+  - Packet broadcasts are automatically encoded separately per unique `PacketSerializerContext` instance. This allows, for example, a multi-version fork to have a separate context for each protocol version, to ensure maximum broadcast efficiency while encoding different packets for different versions.
+  - `PacketSerializerContext` is now passed in `NetworkSession::__construct()`, instead of being created by the session.
+- `StandardPacketBroadcaster` is now locked to a single `PacketSerializer` context, reducing complexity.
+- Introduced `NetworkBroadcastUtils::broadcastPackets()`, replacing `Server->broadcastPackets()`.
+- `Server->broadcastPackets()` has been deprecated. It will be removed in a future version.
+
+# 4.18.0-ALPHA2
+Released 21st March 2023.
+
+## General
+- Included more sections of the network system in Player Network Send timings.
+- Changed the names of some timings to make them more user-friendly.
+- Removed packet IDs from `receivePacket` and `sendPacket` timings, as they were not very useful.
+- Added new specialized timers for the following:
+  - Item entity base ticking (merging)
+  - Player movement processing
+  - Entity movement processing (collision checking section)
+  - Projectile movement (all)
+  - Projectile movement processing (ray tracing section)
+
+## API
+### `pocketmine\crafting`
+- The following new API methods have been added:
+  - `CraftingManager->getCraftingRecipeIndex() : array<int, CraftingRecipe>` - returns a list of all crafting recipes
+  - `CraftingManager->getCraftingRecipeFromIndex(int $index) : ?CraftingRecipe` - returns the crafting recipe at the given index, or null if it doesn't exist
+
+### `pocketmine\inventory\transaction`
+- The following API methods have changed signatures:
+  - `CraftingTransaction->__construct()` now accepts additional arguments `?CraftingRecipe $recipe = null, ?int $repetitions = null`
+- The following new API methods have been added:
+  - `TransactionBuilderInventory->getActualInventory() : Inventory` - returns the actual inventory that this inventory is a proxy for
+
+## Internals
+### Network
+- Introduced support for the `ItemStackRequest` Minecraft: Bedrock network protocol.
+  - This fixes a large number of inventory- and crafting-related bugs.
+  - This also improves server security by closing off many code pathways that might have been used for exploits. `TypeConverter->netItemStackToCore()` is no longer used in server code, and remains for tool usage only.
+  - This system is also significantly more bandwidth-efficient and has lower overhead than the legacy system.
+  - This now opens the gateway to easily implement lots of gameplay features which have been missing for a long time, such as enchanting, anvils, looms, and more.
+  - Significant changes have been made to `pocketmine\network\mcpe\InventoryManager` internals. These shouldn't affect plugins, but may affect plugins which use internal network API.
+  - **No changes have been made to the plugin `InventoryTransaction` API**.
+    - This system has been implemented as a shim for the existing PocketMine-MP transaction system to preserve plugin compatibility. Plugins using `InventoryTransactionEvent` should continue to work seamlessly.
+    - The `InventoryTransaction` API will be redesigned in a future major version to make use of the new information provided by the `ItemStackRequest` system.
+  - `InventoryTransactionPacket` is no longer sent by the client for "regular" inventory actions. However, it is still sent when dropping items, interacting with blocks, and using items.
+- Inventory slot and content syncing is now buffered until the end of the tick. This reduces outbound network usage when the client performs multiple transactions in a single tick (e.g. crafting a stack of items).
+- Renamed some `InventoryManager` internal properties to make them easier to understand.
+- `TypeConverter->createInventoryAction()` has been removed.
+- Packet batch limit has been lowered to `100` packets. With the introduction of `ItemStackRequest`, this is more than sufficient for normal gameplay.
+
+### Other
+- Use `Vector3::zero()` instead of `new Vector3()` in some places.

changelogs/4.18.md

@@ -0,0 +1,123 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are compatible with any previous 4.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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Highlights
+This version significantly improves server performance with many players and/or entities by making changes to the internal network system.
+
+It also introduces support for the newer `ItemStackRequest` protocol, which fixes many bugs and improves server security.
+
+While these changes don't affect non-internal API, they are still significant enough to warrant a new minor version, as they may break plugins which use the internal network API (not recommended).
+
+# 4.18.0
+Released 25th March 2023.
+
+## General
+- Significantly improved server performance in congested areas of the world (lots of players and/or entities in the same area).
+- Included more sections of the network system in `Player Network Send` performance timings.
+- Changed the names of some performance timings to make them more user-friendly.
+- Removed packet IDs from `receivePacket` and `sendPacket` performance timings, as they were not very useful.
+- Added new specialized performance timings for the following:
+  - Item entity base ticking (merging)
+  - Player movement processing
+  - Entity movement processing (collision checking section)
+  - Projectile movement (all)
+  - Projectile movement processing (ray tracing section)
+
+## API
+### `pocketmine\crafting`
+- The following new API methods have been added:
+  - `CraftingManager->getCraftingRecipeIndex() : array<int, CraftingRecipe>` - returns a list of all crafting recipes
+  - `CraftingManager->getCraftingRecipeFromIndex(int $index) : ?CraftingRecipe` - returns the crafting recipe at the given index, or null if it doesn't exist
+
+### `pocketmine\event\server`
+- The following new classes have been added:
+  - `DataPacketDecodeEvent` - called before a packet is decoded by a `NetworkSession`; useful to mitigate DoS attacks if PocketMine-MP hasn't been patched against new bugs yet
+
+### `pocketmine\inventory\transaction`
+- The following API methods have changed signatures:
+  - `CraftingTransaction->__construct()` now accepts additional arguments `?CraftingRecipe $recipe = null, ?int $repetitions = null`
+- The following new API methods have been added:
+  - `TransactionBuilderInventory->getActualInventory() : Inventory` - returns the actual inventory that this inventory is a proxy for
+
+## Internals
+### Network
+- Introduced new system for broadcasting entity events to network sessions.
+  - This change improves performance when lots of players and/or entities are in the same area.
+  - New interface `EntityEventBroadcaster` and class `StandardEntityEventBroadcaster` have been added to implement this.
+  - All entity-specific `on*()` and `sync*()` methods have been removed from `NetworkSession` (internals backwards compatibility break, not covered by API version guarantee).
+  - `NetworkSession` now accepts an `EntityEventBroadcaster` instance in its constructor.
+  - `NetworkBroadcastUtils::broadcastEntityEvent()` can be used to efficiently broadcast events to unique broadcasters shared by several network sessions.
+- All network sessions now share the same `PacketSerializerContext` and `PacketBroadcaster` by default.
+  - Previously, every session had its own context, meaning that broadcast optimisations were not used, causing significant performance losses compared to 3.x.
+  - This change improves performance in congested areas by allowing reuse of previously encoded packet buffers for all sessions sharing the same context.
+  - Packet broadcasts are automatically encoded separately per unique `PacketSerializerContext` instance. This allows, for example, a multi-version fork to have a separate context for each protocol version, to ensure maximum broadcast efficiency while encoding different packets for different versions.
+  - `PacketSerializerContext` is now passed in `NetworkSession::__construct()`, instead of being created by the session.
+- `StandardPacketBroadcaster` is now locked to a single `PacketSerializer` context, reducing complexity.
+- Introduced `NetworkBroadcastUtils::broadcastPackets()`, replacing `Server->broadcastPackets()`.
+- `Server->broadcastPackets()` has been deprecated. It will be removed in a future version.
+- Introduced support for the `ItemStackRequest` Minecraft: Bedrock network protocol.
+  - This fixes a large number of inventory- and crafting-related bugs.
+  - This also improves server security by closing off many code pathways that might have been used for exploits. `TypeConverter->netItemStackToCore()` is no longer used in server code, and remains for tool usage only.
+  - This system is also significantly more bandwidth-efficient and has lower overhead than the legacy system.
+  - This now opens the gateway to easily implement lots of gameplay features which have been missing for a long time, such as enchanting, anvils, looms, and more.
+  - Significant changes have been made to `pocketmine\network\mcpe\InventoryManager` internals. These shouldn't affect plugins, but may affect plugins which use internal network API.
+  - **No changes have been made to the plugin `InventoryTransaction` API**.
+    - This system has been implemented as a shim for the existing PocketMine-MP transaction system to preserve plugin compatibility. Plugins using `InventoryTransactionEvent` should continue to work seamlessly.
+    - The `InventoryTransaction` API will be redesigned in a future major version to make use of the new information provided by the `ItemStackRequest` system.
+  - `InventoryTransactionPacket` is no longer sent by the client for "regular" inventory actions. However, it is still sent when dropping items, interacting with blocks, and using items.
+- Inventory slot and content syncing is now buffered until the end of the tick. This reduces outbound network usage when the client performs multiple transactions in a single tick (e.g. crafting a stack of items).
+- Renamed some `InventoryManager` internal properties to make them easier to understand.
+- `TypeConverter->createInventoryAction()` has been removed.
+- Packet batch limit has been lowered to `100` packets. With the introduction of `ItemStackRequest`, this is more than sufficient for normal gameplay.
+
+### Other
+- Use `Vector3::zero()` instead of `new Vector3()` in some places.
+
+# 4.18.1
+Released 27th March 2023.
+
+## General
+- `RakLibInterface` now logs the name of the currently active session if a crash occurs when processing a packet. This makes it easier to reproduce bugs, which is important to be able to fix them.
+- Added more detailed debugging information to `InventoryManager->syncSelectedHotbarSlot()`.
+
+## Fixes
+- Fixed server crash when attempting to drop more of an item from a stack than available in the inventory.
+- Fixed packet processing errors when editing writable books.
+- Fixed packet processing errors when shift-clicking on the recipe book to craft recipes which draw from a large number of inventory slots.
+
+# 4.18.2
+Released 29th March 2023.
+
+## Fixes
+- Fixed players being unable to join due to the appearance of a new `x5t` field in the JWT header of Xbox Live authentication tokens.
+- Fixed items' durability appearing to reset when moving them around in the inventory.
+
+# 4.18.3
+Released 5th April 2023.
+
+## Fixes
+- Fixed Average Players not being shown on timings reports when custom player classes are used.
+- Fixed incorrect tick violation calculation in timings reports.
+- Fixed not being able to add or remove items from the offhand slot.
+- Fixed creative inventory item count corruption when taking items (some players would see 64x items in the creative inventory after rejoining or changing gamemode).
+- Fixed not being able to drop items directly from the creative inventory on mobile.
+- Fixed `DataPacketReceiveEvent` not being called for packets sent by `EntityEventBroadcaster`.
+- `CreativeInventory::getItem()` and `CreativeInventory::getAll()` now return cloned itemstacks, to prevent accidental modification of the creative inventory.
+
+# 4.18.4
+Released 10th April 2023.
+
+## Fixes
+- Fixed movement becoming broken when the player moves at high speed (e.g. due to high levels of the Speed effect).
+- Updated dependencies to get fixes in `pocketmine/nbt` and `pocketmine/bedrock-protocol`.
+
+## Internals
+### Network
+- Game packets are now rate-limited in a similar manner to packet batches. This helps to more effectively mitigate certain types of DoS attacks.
+- Added a new class `PacketRateLimiter`, implementing functionality previously baked directly into `NetworkSession` in a more generic way to allow reuse.

changelogs/4.19.md

@@ -0,0 +1,111 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are compatible with any previous 4.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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Highlights
+This version introduces support for a new, more advanced version of Timings.
+This improved system provides more detail than the old system, and supports being displayed in a tree view, making it much easier to see which timers contribute to which other timers.
+
+In addition, some minor performance improvements have been made, along with a couple of minor API additions.
+
+# 4.19.0
+Released 11th April 2023.
+
+## General
+- Updated the Timings system.
+  - Timings records now include parent information, allowing them to be displayed in a tree view (e.g. https://timings.pmmp.io/?id=303556).
+  - Timings records now include additional information, such as Peak (max time spent on any single tick), and Ticks (number of ticks the timer was active on).
+  - New timings have been added for every event.
+  - A new timer `Player Network Send - Pre-Spawn Game Data` has been added, and covers most of the time spent handling `ResourcePackClientResponsePacket`, giving a clearer picture of what's happening.
+- Improved performance of the plugin event system.
+  - By introducing some caching, the event system now has 90% less overhead than in previous versions.
+- Improved performance of the random chunk ticking system.
+  - The selection of ticked random chunks, and their validation for ticking, is now cached. This significantly reduces the overhead of chunk selection.
+  - Factions servers and other game modes with big maps and sparsely populated areas will see the most benefit from this change.
+  - Real-world performance benefit of this change is anywhere from 0-20%, depending on server type and configuration.
+- The `timings paste` command now logs a debug message with the server response on failure to paste a timings report.
+
+## API
+### `pocketmine\entity\object`
+- The following API constants have been added:
+  - `ExperienceOrb::DEFAULT_DESPAWN_DELAY` - the default delay in ticks before an experience orb despawns
+  - `ExperienceOrb::NEVER_DESPAWN` - magic value for `setDespawnDelay()` to make an experience orb never despawn
+  - `ExperienceOrb::MAX_DESPAWN_DELAY` - the maximum delay in ticks before an experience orb despawns
+- The following API methods have been added:
+  - `public ExperienceOrb->getDespawnDelay() : int` - returns the delay in ticks before this experience orb despawns
+  - `public ExperienceOrb->setDespawnDelay(int $despawnDelay) : void` - sets the delay in ticks before this experience orb despawns
+- The following properties have been deprecated
+  - `ExperienceOrb->age` - superseded by despawn delay methods
+
+### `pocketmine\event`
+- The following API methods have been added:
+  - `public HandlerList->getListenerList() : list<RegisteredListener>` - returns an ordered list of handlers to be called for the event
+
+### `pocketmine\player`
+- The following API methods have behavioural changes:
+  - `ChunkSelector->selectChunks()` now yields the distance in chunks from the center as the key, instead of an incrementing integer.
+- The following classes have been deprecated:
+  - `PlayerChunkLoader` (this was technically internal, but never marked as such)
+
+### `pocketmine\timings`
+- The following API constants have been deprecated:
+  - `Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX` - this is superseded by timings group support (see `Timings::GROUP_BREAKDOWN`)
+- The following API constants have been added:
+  - `Timings::GROUP_BREAKDOWN` - this group makes a timer appear in the `Minecraft - Breakdown` section of a timings report
+- The following API methods have been added:
+  - `public TimingsHandler->getGroup() : string` - returns the name of the table in which this timer will appear in a timings report
+- The following API methods have changed signatures:
+  - `TimingsHandler->__construct()` now accepts an additional, optional `string $group` parameter, which defaults to `Minecraft`.
+
+### `pocketmine\world`
+#### Highlights
+Ticking chunks is now done using the `ChunkTicker` system, which has a much more fine-grained API than the old `TickingChunkLoader` system, as well as better performance.
+It works similarly to the `ChunkLoader` system, in that chunks will be ticked as long as at least one `ChunkTicker` is registered for them.
+
+#### API changes
+- The following classes have been deprecated:
+  - `TickingChunkLoader` - this has been superseded by the more powerful and performant `ChunkTicker` APIs
+- The following classes have been added:
+  - `ChunkTicker` - an opaque object used for `registerTickingChunk()` to instruct the `World` that we want a chunk to be ticked
+- The following API methods have been added:
+  - `public World->registerTickingChunk(ChunkTicker $ticker, int $chunkX, int $chunkZ) : void` - registers a chunk to be ticked by the given `ChunkTicker`
+  - `public World->unregisterTickingChunk(ChunkTicker $ticker, int $chunkX, int $chunkZ) : void` - unregisters a chunk from being ticked by the given `ChunkTicker`
+
+# 4.19.1
+Released 14th April 2023.
+
+## Fixes
+- Fixed inventory rollbacks when spreading items in ender chests.
+- Fixed inventory rollbacks when shift-clicking to craft and the outputs would have been split across multiple inventory slots.
+- Fixed incorrect spawn terrain generation for newly created worlds.
+- Fixed `chunk-ticking.tick-radius` not disabling chunk ticking when set to `0`.
+- Fixed chunks not being ticked if they previously left a player's simulation distance without leaving their view distance.
+- Fixed height of collision boxes for Grass Path and Farmland blocks.
+
+# 4.19.2
+Released 14th April 2023.
+
+## Fixes
+- Fixed player timings duplication leading to extremely large timings reports when timings runs for a long time with many players.
+- Packet timings are now indexed by class FQN instead of packet ID. This prevents erroneous timer reuse on packet ID reuse (e.g. multi version servers).
+- Fixed entity timings being shared by different classes with the same short name. This led to incorrect timings being reported for some entities when custom entities were used.
+
+# 4.19.3
+Released 21st April 2023.
+
+## General
+- Error IDs for `Packet processing error` disconnects are now split into 4-character chunks to make them easier to type (since they can't be copied from the disconnection screen of a client).
+
+## Fixes
+- Fixed entity-block intersections being checked twice per tick. Besides wasting CPU time, this may have caused unexpected behaviour during entity-block interactions with blocks like water or cacti.
+- Fixed performance issue in network inventory synchronization due item NBT being prepared twice.
+- Fixed `tools/simulate-chunk-selector.php` argument parsing being completely broken (weird behaviour of PHP `getopt()`).
+
+## Internals
+- `TimingsHandler->stopTiming()` now logs an error message if a subtimer wasn't stopped, rather than throwing an exception.
+  - Due to interactions between `try...finally` and unexpected errors, throwing exceptions made it difficult for plugin developers to debug errors in their plugins, since it obscured the original error.

changelogs/4.2.md

@@ -0,0 +1,121 @@
+**For Minecraft: Bedrock Edition 1.18.10**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.2.0
+- Added support for Minecraft: Bedrock Edition 1.18.10.
+
+# 4.2.1
+Released 19th February 2022.
+
+## General
+- Improved performance of `Item::nbtSerialize()` - this will improve performance during world saves.
+- Added more missing changes to the 4.0.0 changelog.
+
+## Fixes
+- Fixed multiple players being able to sleep in the same bed.
+- Fixed hitbox not resetting properly after swimming or gliding.
+
+# 4.2.2
+Released 2nd March 2022.
+
+## Fixes
+- Fixed crash in `/dumpmemory` due to usage of non-printable string keys in `CraftingManager`. Array contents in memory dumps are now rendered as prettified key-value pairs.
+- Fixed output directory for `/dumpmemory`.
+- `PlayerInventory->isHotbarSlot()` now correctly returns `false` when given `9`.
+- Fixed ghost items left in the inventory when dropping tools while mining.
+
+# 4.2.3
+Released 9th March 2022.
+
+## Technical
+- Now analysed using PHPStan 1.4.8.
+- Now using `pocketmine/bedrock-protocol` [`8.0.1`](https://github.com/pmmp/BedrockProtocol/releases/tag/8.0.1%2Bbedrock-1.18.10).
+
+## Fixes
+### Core
+- Fixed a memory leak and other bugs related to plugins disabling themselves during `onEnable()`.
+
+### Gameplay
+- Sweet berry bushes now absorb fall damage.
+- Fixed mycelium spreading onto coarse dirt.
+- Fixed blocks placed during `Block->onIncinerate()` getting overwritten.
+- Fixed shulker boxes being unopenable when underwater.
+- Fixed invisible fire on top of transparent non-flammable blocks.
+
+### API
+- Various APIs accepting `Vector3`, `Position` or `Location` no longer accept objects containing `INF` or `NaN` in any component. Previously, this was allowed, but would cause lots of obscure crashes later on.
+- `Entity->setRotation()` no longer accepts `INF` or `NaN`.
+- Fixed missing bounds check for `ItemFrame->setItemDropChance()`.
+
+# 4.2.4
+Released 18th March 2022.
+
+## Fixes
+- Fixed a crash when handling out-of-bounds meta values on the network.
+
+# 4.2.5
+Released 28th March 2022.
+
+## General
+- The layout of the human-readable part of crashdumps has been changed in an effort to improve the useful information density. It is hoped that this change will cause more useful information to be provided when people paste crash traces on Discord, since all the most important information is now at the top of the file.
+  - Version, git hash, PHP version and OS have been moved to the top of the crashdump.
+  - Backtrace has been moved above code sample.
+- Docker images are now built by GitHub Actions (first live test).
+
+## Technical
+- The methods of `Inventory` and `BaseInventory` have been rearranged to improve coherency.
+
+## Fixes
+### API
+- Enum members of enums created using `EnumTrait` are now able to have single-character names.
+- Registry members of registries created using `RegistryTrait` or `CloningRegistryTrait` now have their names checked for invalid characters.
+- `Entity::__construct()` now uses a guard variable to prevent it from being called multiple times unintentionally. This is necessary because `Entity::__construct()` has side effects.
+- Fixed `PlayerItemHeldEvent` not being called when the content of the held slot was changed (e.g. replacing the held item via inventory menu).
+
+### Gameplay
+- Reduced the appearance of ghost items in unsupported gameplay scenarios using client prediction information. This fixes, for example, the appearance of ghost items when right-clicking on a filled flower pot.
+
+# 4.2.6
+Released 1st April 2022.
+
+## Fixes
+- Fixed buffer length underflow crash in `LoginPacket` handling.
+
+# 4.2.7
+Released 15th April 2022.
+
+## General
+- Added lots more documentation (in comments) about the `aliases` section in `pocketmine.yml`. You can read about this feature in the `aliases` section of the [updated `pocketmine.yml` template](/resources/pocketmine.yml).
+- Improved wording of documentation of `PlayerPreLoginEvent`.
+
+## Fixes
+- Fixed core server crash when a plugin causes another plugin to be disabled during a scheduled task.
+- Fixed core server crash when loading a plugin with an abstract main class.
+- Fixed ghost items in many interaction situations (most notably, using projectiles while looking at an entity or block).
+- Implemented a workaround for a client teleport bug which led to player positions not updating properly when using ender pearls.
+- Fixed buggy movement when teleporting the player during `PlayerToggleSneakEvent`, `PlayerToggleSprintEvent`, `PlayerToggleSwimEvent` and `PlayerToggleGlideEvent`.
+
+# 4.2.8
+Released 17th April 2022.
+
+## Fixes
+- Fixed a memory leak in RakLib which could result in a server crash when players stay online for a long time.
+- Fixed server crash when attempting to load a corrupted empty resource pack.
+- Fixed users with the same name with differerently cased letters being able to duplicate items (userdata is matched by case-insensitive name).
+
+# 4.2.9
+Released 19th April 2022.
+
+## Fixes
+- Fixed several potential crashes when deserializing item NBT (due to insufficient validation of input data).
+
+# 4.2.10
+Released 20th April 2022.
+
+## Fixes
+- Fixed performance issue when chat messages received from the client contain many newlines. This security vulnerability was disclosed publicly necessitating a priority fix.

changelogs/4.20.md

@@ -0,0 +1,79 @@
+**For Minecraft: Bedrock Edition 1.19.80**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are compatible with any previous 4.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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Interim releases
+If you're upgrading from 4.17.x directly to 4.20.x, please also read the following changelogs, as the interim releases contain important changes:
+
+- [4.18.0](https://github.com/pmmp/PocketMine-MP/blob/4.20.0/changelogs/4.18.md#4180) - major performance improvements, internal network changes, minor API additions
+- [4.19.0](https://github.com/pmmp/PocketMine-MP/blob/4.20.0/changelogs/4.19.md#4190) - minor performance improvements, improved timings system, minor API additions
+
+# 4.20.0
+Released 26th April 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.80.
+- Removed support for older versions.
+
+## Fixes
+- Fixed packet processing error when attempting to use a stonecutter.
+- Fixed armor slots containing ghost items when cancelling right-click to equip armor.
+- Fixed crash in `HandlerList->getListenersByPriority()` when no listeners are registered at the given priority.
+
+## API
+### `pocketmine\block`
+- The following API methods have been added:
+  - `public BaseSign->getEditorEntityRuntimeId() : int` - returns the entity runtime ID of the player currently editing this sign, or `null` if none
+  - `public BaseSign->setEditorEntityRuntimeId(?int $editorEntityRuntimeId) : $this` - sets the entity runtime ID of the player currently editing this sign
+
+### `pocketmine\player`
+- The following API methods have been added:
+  - `public Player->openSignEditor(Vector3 $position) : void` - opens the client-side sign editor GUI for the given position
+
+# 4.20.1
+Released 27th April 2023.
+
+## Fixes
+- Fixed server crash when firing a bow while holding arrows in the offhand slot.
+
+## Internals
+- `ItemStackContainerIdTranslator::translate()` now requires an additional `int $slotId` parameter and returns `array{int, int}` (translated window ID, translated slot ID) to be used with `InventoryManager->locateWindowAndSlot()`.
+- `InventoryManager->locateWindowAndSlot()` now checks if the translated slot actually exists in the requested inventory, and returns `null` if not. Previously, it would return potentially invalid slot IDs without checking them, potentially leading to crashes.
+
+# 4.20.2
+Released 4th May 2023.
+
+## Fixes
+- Fixed all types of wooden logs appearing as oak in the inventory.
+- Fixed a performance issue in `BaseInventory->canAddItem()` (missing `continue` causing useless logic to run).
+
+# 4.20.3
+Released 6th May 2023.
+
+## Improvements
+- Reduced memory usage of `RuntimeBlockMapping` from 25 MB to 9 MB. Since every thread has its own copy of the block map, this saves a substantial amount of memory.
+
+## Fixes
+- Fixed players falling through blocks in spectator mode.
+- Fixed timings reports getting bloated by prolific usage of `PluginManager->registerEvent()`.
+  - This was caused by creating a new timings handler for each call, regardless of whether a timer already existed for the given event and callback.
+- Fixed `Full Server Tick` and other records being missing from timings reports.
+  - This was caused by timings handler depth not getting reset when timings was disabled and later re-enabled.
+
+# 4.20.4
+Released 6th May 2023.
+
+## Fixes
+- Fixed players being forced into flight mode in every game mode.
+  - Moral of the story: do not assume anything in Mojang internals does what its name suggests...
+
+# 4.20.5
+Released 30th May 2023.
+
+## Fixes
+- Fixed server crash due to a bug in upstream dependency [`netresearch/jsonmapper`](https://github.com/cweiske/JsonMapper).

changelogs/4.21.md

@@ -0,0 +1,77 @@
+**For Minecraft: Bedrock Edition 1.19.80**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace, and don't use reflection or any internal methods,
+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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+# 4.21.0
+Released 17th May 2023.
+
+## General
+- PHP 8.1 is now required. Most plugins should run without changes, but some might need to be updated due to language-level deprecations.
+- Ticking chunk count is now shown separately from loaded chunk count in the `/status` command, providing useful performance information.
+- Further improved performance of ticking chunk selection.
+- Improved performance of some inventory functions.
+- Reduced server memory footprint in most cases by ~9 MB per thread.
+- Due to large overhead, async network compression is now only used for packets larger than 10 KB by default.
+
+## Configuration
+- Added the following new `pocketmine.yml` configuration options:
+  - `network.async-compression-threshold` - minimum size of packet which will be compressed using `AsyncTask`
+    - Default is 10 KB, which means that very few packets will use async compression in practice. This is because the overhead of compressing async is currently so high that it's not worth it for smaller packets.
+
+## Timings
+- Timings reports no longer include the unused metadata fields `Entities` and `LivingEntities`.
+- Timings reports now correctly calculate the peak time of a timer.
+  - Previously it was incorrectly recorded as the longest time spent in a single tick, rather than the longest time spent in a single activation.
+  - Timings report version has been bumped to `2` to reflect this change.
+- All world-specific timers now have generic aggregate timings, making it much easier to locate performance patterns across all worlds.
+
+## Gameplay
+- Players in spectator mode are no longer able to pick blocks, and now have finite resources similar to survival mode.
+
+## API
+### `pocketmine\world`
+- The following API methods have been added:
+  - `public World->getTickingChunks() : list<int>` - returns a list of chunk position hashes (a la `World::chunkHash()`) which are currently valid for random ticking
+
+### `pocketmine\inventory`
+- The following API methods have been added:
+  - `protected BaseInventory->getMatchingItemCount(int $slot, Item $test, bool $checkDamage, bool $checkTags) : int` - returns the number of items in the given stack if the content of the slot matches the test item, or zero otherwise
+    - This should be overridden if directly extending `BaseInventory` to provide a performance-optimised version. A slow default implementation is provided, but it will be removed in the future.
+  
+## Internals
+### Entity
+- Unused `NameTag` tag is no longer saved for `Human` entities.
+
+### Inventory
+- `BaseInventory` now uses a new internal method `getMatchingItemCount()` to locate items in the inventory without useless cloning. This improves performance of various API methods, such as `addItem()`, `contains()`, and more.
+- Specialization of `Inventory->isSlotEmpty()` in `BaseInventory` subclasses has been added to improve performance of some API methods.
+
+### Network
+- `RuntimeBlockMapping` no longer keeps all block palette NBT data in memory.
+  - This significantly reduces server idle memory footprint.
+  - For multi-version implementations, this will have a significant impact on memory usage, since a different block palette is often required to support each version.
+  - NBT will be lazy-loaded into memory and cached if `getBedrockKnownStates()` is called. However, this is not used by PocketMine-MP under normal circumstances.
+- Removed unnecessary usage of `Utils::validateCallableSignature()` from some internal network pathways, improving performance.
+
+### Scheduler
+- `AsyncPool` no longer double-checks progress updates on completed tasks.
+
+### World
+- Ticking chunks are now tracked in `World->validTickingChunks` and `World->recheckTickingChunks`.
+    - This allows avoiding rechecking every ticking chunk for validity during ticking chunk selection, improving performance.
+    - In some cases, this allows bypassing chunk selection entirely, reducing selection cost to zero.
+- Registered but ineligible ticking chunks are no longer rechecked every tick.
+    - This was causing wasted cycles during async worker backlog.
+    - The internal system must call `markTickingChunkForRecheck()` whenever a ticking chunk's eligibility for ticking has potentially changed, rather than just when it has changed from a yes to a no.
+
+# 4.21.1
+Released 30th May 2023.
+
+## Fixes
+- Fixed server crash due to a bug in upstream dependency [`netresearch/jsonmapper`](https://github.com/cweiske/JsonMapper).

changelogs/4.22.md

@@ -0,0 +1,58 @@
+# 4.22.0
+Released 7th June 2023.
+
+**For Minecraft: Bedrock Edition 1.20.0**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.0.
+
+**Plugin compatibility:** Plugins for previous 4.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## Interim releases
+If you're upgrading from 4.20.x directly to 4.22.x, please also read the following changelogs, as the interim releases contain important changes:
+- [4.21.0](https://github.com/pmmp/PocketMine-MP/blob/4.22.0/changelogs/4.21.md#4210) - PHP 8.1 minimum version, minor performance improvements
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.0.
+- Removed support for older versions.
+
+## Fixes
+- Removed deprecated `ReflectionProperty::setAccessible()` calls.
+- Fixed jukebox music not stopping when destroyed by an explosion.
+
+# 4.22.1
+Released 9th June 2023.
+
+## Fixes
+- Replaced workaround for an old teleporting client bug:
+  - This workaround broke due to an additional client bug introduced by 1.20, causing players to become frozen to observers when teleported.
+  - The original client bug has still not been fixed, meaning a new workaround was needed, but no perfect solution could be found.
+  - The new workaround involves broadcasting teleport movements as regular movements, which causes unwanted interpolation between the old and new positions, but otherwise works correctly. This solution is not ideal, but it is the best we can do for now.
+  - See issues [#4394](https://github.com/pmmp/PocketMine-MP/issues/4394) and [#5810](https://github.com/pmmp/PocketMine-MP/issues/5810) for more details.
+
+# 4.22.2
+Released 1st July 2023.
+
+## Changes
+- Added obsoletion warnings to the server log at the end of the startup sequence.
+
+## Fixes
+- Fixed players being disconnected en masse with "Not authenticated" messages.
+  - This occurred due to a check intended to disable the old authentication key after July 1st.
+  - We expected that the new key would have been deployed by Mojang by now, but it seems like that has not yet happened.
+  - Due to the lack of a hard date for the key changeover, we guessed that July 1st would be a safe bet, but this appears to have backfired.
+  - This version will accept both old and new keys indefinitely.
+  - A security release will be published to remove the old key after the transition occurs.
+
+# 4.22.3
+Released 11th July 2023.
+
+## Fixes
+- Fixed mishandling of NBT leading to a server crash when editing signs.
+- Fixed an edge case crash that could occur in `AsyncTask->__destruct()` when thread-local storage referenced other `AsyncTask` objects.
+
+## Internals
+- Added a concurrency lock to prevent the `update-updater-api` GitHub Action from running for multiple releases at the same time (which would have caused one of them to fail due to git conflicts).

changelogs/4.23.md

@@ -0,0 +1,68 @@
+# 4.23.0
+Released 12th July 2023.
+
+**For Minecraft: Bedrock Edition 1.20.10**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.10.
+
+**Plugin compatibility:** Plugins for previous 4.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.10.
+- Removed support for older versions.
+
+## Fixes
+- Fixed Docker image build failure due to outdated `build/php` submodule.
+
+# 4.23.1
+Released 14th July 2023.
+
+## Fixes
+- Hardened validation of JWT signing keys in `LoginPacket`.
+- Fixed server crash due to a bug in upstream dependency [`netresearch/jsonmapper`](https://github.com/cweiske/JsonMapper).
+
+# 4.23.2
+Released 18th July 2023.
+
+## Fixes
+- Fixed login errors due to a new `sandboxId` field appearing in the Xbox Live authentication data in `LoginPacket`. All clients, regardless of version, are affected by this change.
+
+# 4.23.3
+Released 24th July 2023.
+
+## Documentation
+- Fixed typo in `ChunkSelector::selectChunks()` documentation.
+
+## Fixes
+- Fixed the server not stopping properly during crash conditions on *nix platforms.
+- Fixed `HORSE_EQUIP` and `SMITHING_TABLE_TEMPLATE` container UI types not being handled by `ItemStackContainerIdTranslator`. This bug prevented plugins from implementing missing inventory types.
+- Player emotes no longer broadcast messages to other players. This was unintended behaviour caused by a client-side behavioural change.
+- Shulker boxes no longer support the placement of torches or other similar blocks.
+- Fire can now be placed on upper slabs and the top of upside-down stairs.
+
+# 4.23.4
+Released 1st August 2023.
+
+## Fixes
+- Fixed exponentially increasing lag when many hundreds of non-mergeable dropped items occupied the same space. This disproportionately affected SkyBlock servers due to large cactus farms using water to collect items together. 
+
+# 4.23.5
+Released 9th August 2023.
+
+## General
+- Updated translation data to [pmmp/Language 2.19.6](https://github.com/pmmp/Language/releases/tag/2.19.6).
+
+## Fixes
+- Fixed `PluginBase->saveResource()` leaking file resources when the data file already exists in the plugin's data folder. This bug existed since 2014 and was only discovered recently.
+- Fixed coral blocks becoming dead after calling `getDropsForCompatibleTool()` on them.
+- Fixed `BlockDeathEvent->getOldState()` returning a block which is already dead.
+
+# 4.23.6
+Released 21st August 2023.
+
+## Fixes
+- Added a workaround for armor and other inventories not working correctly after inventory sync. This is caused by a client bug.

changelogs/4.24.md

@@ -0,0 +1,17 @@
+# 4.24.0
+Released 20th September 2023.
+
+**For Minecraft: Bedrock Edition 1.20.30**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.30.
+
+**Plugin compatibility:** Plugins for previous 4.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.30.
+- Removed support for older versions.
+- Updated 4.x obsoletion message.

changelogs/4.25.md

@@ -0,0 +1,16 @@
+# 4.25.0
+Released 26th October 2023.
+
+**For Minecraft: Bedrock Edition 1.20.40**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.40.
+
+**Plugin compatibility:** Plugins for previous 4.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.40.
+- Removed support for older versions.

changelogs/4.26.md

@@ -0,0 +1,16 @@
+# 4.26.0
+Released 6th December 2023.
+
+**For Minecraft: Bedrock Edition 1.20.50**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.50.
+
+**Plugin compatibility:** Plugins for previous 4.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.50.
+- Removed support for older versions.

changelogs/4.3.md

@@ -0,0 +1,77 @@
+**For Minecraft: Bedrock Edition 1.18.30**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.3.0
+Released 20th April 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.18.30.
+- Removed support for older versions.
+
+# 4.3.1
+Released 23rd April 2022.
+
+## Fixes
+- Updated BedrockProtocol dependency to fix incorrect command argument types.
+- Creative players no longer die in the void.
+
+# 4.3.2
+Released 10th May 2022.
+
+## Fixes
+- Fixed an assertion failure in certain edge cases during world generation.
+- Fixed `Entity::setNameTagVisible()` not immediately showing results to players already online.
+
+## Documentation
+- Added more documentation in the template `pocketmine.yml` for the `aliases` config section.
+- Removed useless doc comment in `PlayerChangeSkinEvent`.
+
+# 4.3.3
+Released 16th May 2022.
+
+## General
+- Improved display of parameters in exception stack trace logs.
+- Exception stack traces now include names for dynamic named arguments (i.e. arguments that don't match any parameter of the function), if any were given.
+  - Note: Named arguments which do match parameters are not shown this way, since PHP reduces them to positional arguments for performance reasons.
+
+## Fixes
+- Fixed server crash when chunks are unloaded during chunk generation callbacks
+- Fixed dead coral fan items placing coral fans in the wrong orientation.
+- Fixed max stack size of boat items.
+
+# 4.3.4
+Released 22nd May 2022.
+
+## Fixes
+- Fixed `difficulty` in `server.properties` having no effect - it's now applied to newly generated worlds.
+  - Note: this setting still doesn't behave the same way as vanilla due to potential disruption to existing servers.
+- Fixed paintings not working in newly generated worlds and some other cases.
+- Fixed inventory window switching breaking the inventory UI in some cases (e.g. pressing E while clicking a chest).
+- Fixed minecart items incorrectly stacking.
+- Fixed incorrect light levels in translucent blocks at the top of the world.
+- Fixed teleporting sleeping players causing broken behaviour on the sleeping player's client.
+- Fixed `EntityExplodeEvent->setYield()` accepting values outside the range 0-100.
+- Fixed `ExplosionPrimeEvent->setForce()` accepting negative values (later resulting in crashes).
+
+## Documentation
+- Updated documentation for the following events:
+  - `CommandEvent`
+  - `EntityDespawnEvent`
+  - `EntityExplodeEvent`
+  - `EntitySpawnEvent`
+  - `ExplosionPrimeEvent`
+  - `InventoryTransactionEvent`
+  - `ItemDespawnEvent`
+  - `ItemSpawnEvent`
+  - `PlayerCommandPreprocessEvent`
+  - `PlayerDropItemEvent`
+  - `PlayerItemHeldEvent`
+  - `PlayerKickEvent`
+  - `PlayerQuitEvent`
+  - `PlayerTransferEvent`
+  - `UpdateNotifyEvent`

changelogs/4.4-beta.md

@@ -0,0 +1,77 @@
+**For Minecraft: Bedrock Edition 1.18.30**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.4.0-BETA1
+Released 25th May 2022.
+
+## General
+- The server will now shut itself down if any of the following errors occur during startup:
+  - Any plugin fails to load or enable (plugins loaded by other plugins post-startup are **not** affected by this change) (**PR [#4951](https://github.com/pmmp/PocketMine-MP/pull/4951)**)
+    - The motivation for this change is to prevent situations where plugins failing to load could result in adverse outcomes, such as a world protection plugin leaving a lobby unprotected from griefing.
+    - If you encounter this problem, remove the offending plugin(s) or prevent it from loading using `plugin_list.yml`.
+    - See **PR [#4951](https://github.com/pmmp/PocketMine-MP/pull/4951)** for more detail on this change.
+  - Any world mentioned in `server.properties` or `pocketmine.yml` fails to load (worlds loaded by plugins are **not** affected by this change)
+  - Any world mentioned in `server.properties` or `pocketmine.yml` fails to generate (e.g. due to invalid generator settings)
+- Enabling the server whitelist while the server is running (e.g. using `/whitelist on`) will now kick any non-whitelisted players currently on the server (**PR [#4774](https://github.com/pmmp/PocketMine-MP/pull/4774)**).
+- Help for commands (`/help <name of command>`) now displays a list of aliases of that command.
+- A CRITICAL log message is now generated if a plugin disables itself when enabling, in case the plugin doesn't emit any error of its own.
+- The `/give` command now shows the alias used to find the given item in the success message, instead of the item ID/meta.
+
+## Fixes
+- Block placement has been fixed in many places where it previously didn't work correctly (**PR [#4886](https://github.com/pmmp/PocketMine-MP/pull/4886)**):
+  - torches on top of slabs, upside-down stairs
+  - torches on the back face of stairs
+  - flower pots on top of fences
+  - the list goes on and on ...
+- Fixed backslash escapes not getting properly removed from commands in some cases.
+- Fixed aliases defined in the `aliases` section of `pocketmine.yml` not being treated as quote-aware.
+
+## Gameplay
+- Plants in flower pots can now be removed by right-clicking on the flower pot.
+- Leaves now have a 2% chance of dropping sticks when destroyed by hand (**PR [#5019](https://github.com/pmmp/PocketMine-MP/pull/5019)**).
+- Food exhaustion now matches Bedrock 1.18.30 (**PR [#5034](https://github.com/pmmp/PocketMine-MP/pull/5034)**).
+- Implemented Stonecutter block (**PR [#4732](https://github.com/pmmp/PocketMine-MP/pull/4732)**).
+
+## API
+### Block
+- Added `Block->getSupportType(Facing) : SupportType` (**PR [#4886](https://github.com/pmmp/PocketMine-MP/pull/4886)**).
+  - This is used to determine the kind of support a block face can provide to a block (e.g. a torch) placed on it.
+- Added `utils\SupportType` enum (**PR [#4886](https://github.com/pmmp/PocketMine-MP/pull/4886)**).
+- `tile\Spawnable->isDirty()` and `tile\Spawnable->setDirty()` are now `@deprecated`.
+
+### Command
+- Added `CommandStringHelper::parseQuoteAware()`. This static method contains the code used by `SimpleCommandMap` used to parse quoted command arguments.
+
+### Entity
+- Added `Human::emote()` (**PR [#4610](https://github.com/pmmp/PocketMine-MP/pull/4610)**)
+
+### Event
+- `PlayerCommandPreprocessEvent` is now `@deprecated`, since its functionality is entirely replaced by other, general-purpose events.
+  - Use `CommandEvent` to intercept commands.
+  - Use `PlayerChatEvent` to intercept chat messages.
+  - To convert a chat message into a command, pass it directly to `Server->dispatchCommand()` with the player as sender.
+- Added `PlayerPostChunkSendEvent` (**PR [#4937](https://github.com/pmmp/PocketMine-MP/pull/4937)**).
+- Added `PlayerDeathEvent->setKeepXp()` (**PR [#4015](https://github.com/pmmp/PocketMine-MP/pull/4015)**).
+- `InventoryCloseEvent` is now called **after** the target window has been removed. This fixes various feedback loops caused by trying to open new windows to a player while there was one still active.
+  - As a side effect, this now means that `Player->getCurrentWindow()` will return `null` during `InventoryCloseEvent`. Use `InventoryCloseEvent->getInventory()` instead.
+
+### Item
+- `StringToItemParser` now recognizes `cod`, `raw_cod` and `cooked_cod` aliases.
+
+### Plugin
+- `DisablePluginException` may now be thrown from `Plugin::onEnable()` to make the server gracefully disable the plugin (without crashing) (**PR [#4780](https://github.com/pmmp/PocketMine-MP/pull/4780)**).
+- `PluginManager->registerEvent()` now returns the `RegisteredListener` created for the handler, to permit unregistering it later.
+
+## Internals
+- Private property declarations now use typed properties (PHP 7.4) and promoted constructor properties (PHP 8.0) wherever possible.
+  - Protected and public properties remain unchanged, since they can't be changed without breaking subclasses.
+- Promoted constructor properties are only used when it's consistently possible to promote most or all properties in a class.
+- Simplified and improved legibility of `FormattedCommandAlias`.
+- Added unit tests for the quote-aware command parser used by `SimpleCommandMap`.
+- Various hardcoded values in `block` package classes have been moved to private constants to improve readability.
+- Added various constants used in the `LevelDB` world provider.

changelogs/4.4.md

@@ -0,0 +1,97 @@
+**For Minecraft: Bedrock Edition 1.18.30**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.4.0
+Released 1st June 2022.
+
+## General
+- The server will now shut itself down if any of the following errors occur during startup:
+  - Any plugin fails to load or enable (plugins loaded by other plugins post-startup are **not** affected by this change) (**PR [#4951](https://github.com/pmmp/PocketMine-MP/pull/4951)**)
+    - The motivation for this change is to prevent situations where plugins failing to load could result in adverse outcomes, such as a world protection plugin leaving a lobby unprotected from griefing.
+    - If you encounter this problem, remove the offending plugin(s) or prevent it from loading using `plugin_list.yml`.
+    - See **PR [#4951](https://github.com/pmmp/PocketMine-MP/pull/4951)** for more detail on this change.
+  - Any world mentioned in `server.properties` or `pocketmine.yml` fails to load (worlds loaded by plugins are **not** affected by this change)
+  - Any world mentioned in `server.properties` or `pocketmine.yml` fails to generate (e.g. due to invalid generator settings)
+- Enabling the server whitelist while the server is running (e.g. using `/whitelist on`) will now kick any non-whitelisted players currently on the server (**PR [#4774](https://github.com/pmmp/PocketMine-MP/pull/4774)**).
+- Help for commands (`/help <name of command>`) now displays a list of aliases of that command.
+- A CRITICAL log message is now generated if a plugin disables itself when enabling, in case the plugin doesn't emit any error of its own.
+- The `/give` command now shows the alias used to find the given item in the success message, instead of the item ID/meta.
+
+## Fixes
+- Block placement has been fixed in many places where it previously didn't work correctly (**PR [#4886](https://github.com/pmmp/PocketMine-MP/pull/4886)**):
+  - torches on top of slabs, upside-down stairs
+  - torches on the back face of stairs
+  - flower pots on top of fences
+  - the list goes on and on ...
+- Fixed backslash escapes not getting properly removed from commands in some cases.
+- Fixed aliases defined in the `aliases` section of `pocketmine.yml` not being treated as quote-aware.
+
+## Gameplay
+- Plants in flower pots can now be removed by right-clicking on the flower pot.
+- Leaves now have a 2% chance of dropping sticks when destroyed by hand (**PR [#5019](https://github.com/pmmp/PocketMine-MP/pull/5019)**).
+- Food exhaustion now matches Bedrock 1.18.30 (**PR [#5034](https://github.com/pmmp/PocketMine-MP/pull/5034)**).
+- Implemented Stonecutter block (**PR [#4732](https://github.com/pmmp/PocketMine-MP/pull/4732)**).
+
+## API
+### Block
+- Added `Block->getSupportType(Facing) : SupportType` (**PR [#4886](https://github.com/pmmp/PocketMine-MP/pull/4886)**).
+  - This is used to determine the kind of support a block face can provide to a block (e.g. a torch) placed on it.
+- Added `utils\SupportType` enum (**PR [#4886](https://github.com/pmmp/PocketMine-MP/pull/4886)**).
+- `tile\Spawnable->isDirty()` and `tile\Spawnable->setDirty()` are now `@deprecated`.
+
+### Command
+- Added `CommandStringHelper::parseQuoteAware()`. This static method contains the code used by `SimpleCommandMap` used to parse quoted command arguments.
+
+### Entity
+- Added `Human::emote()` (**PR [#4610](https://github.com/pmmp/PocketMine-MP/pull/4610)**)
+
+### Event
+- `PlayerCommandPreprocessEvent` is now `@deprecated`, since its functionality is entirely replaced by other, general-purpose events.
+  - Use `CommandEvent` to intercept commands.
+  - Use `PlayerChatEvent` to intercept chat messages.
+  - To convert a chat message into a command, pass it directly to `Server->dispatchCommand()` with the player as sender.
+- Added `PlayerPostChunkSendEvent` (**PR [#4937](https://github.com/pmmp/PocketMine-MP/pull/4937)**).
+- Added `PlayerDeathEvent->setKeepXp()` (**PR [#4015](https://github.com/pmmp/PocketMine-MP/pull/4015)**).
+- `InventoryCloseEvent` is now called **after** the target window has been removed. This fixes various feedback loops caused by trying to open new windows to a player while there was one still active.
+  - As a side effect, this now means that `Player->getCurrentWindow()` will return `null` during `InventoryCloseEvent`. Use `InventoryCloseEvent->getInventory()` instead.
+
+### Item
+- `StringToItemParser` now recognizes `cod`, `raw_cod` and `cooked_cod` aliases.
+
+### Plugin
+- `DisablePluginException` may now be thrown from `Plugin::onEnable()` to make the server gracefully disable the plugin (without crashing) (**PR [#4780](https://github.com/pmmp/PocketMine-MP/pull/4780)**).
+- `PluginManager->registerEvent()` now returns the `RegisteredListener` created for the handler, to permit unregistering it later.
+
+## Internals
+- Private property declarations now use typed properties (PHP 7.4) and promoted constructor properties (PHP 8.0) wherever possible.
+  - Protected and public properties remain unchanged, since they can't be changed without breaking subclasses.
+- Promoted constructor properties are only used when it's consistently possible to promote most or all properties in a class.
+- Simplified and improved legibility of `FormattedCommandAlias`.
+- Added unit tests for the quote-aware command parser used by `SimpleCommandMap`.
+- Various hardcoded values in `block` package classes have been moved to private constants to improve readability.
+- Added various constants used in the `LevelDB` world provider.
+
+# 4.4.1
+Released 5th June 2022.
+
+## General
+- The server process will now exit with an error code if plugins, worlds or network interfaces failed to start.
+
+## Fixes
+- Fixed graylisted plugins preventing the server from starting.
+- Fixed `composer make-devtools` command.
+- Fixed the `Maximum memory (manager)` units being incorrectly displayed in `/status`.
+- Fixed `Player->removeCurrentWindow()` breaking inventory windows.
+
+# 4.4.2
+Released 7th June 2022.
+
+## Fixes
+- Fixed a crash when arbitrary item IDs appeared in network items in some cases.
+- Fixed saved paintings being deleted when loaded from disk (regression from 4.3.4).
+- Fixed max stack size of fishing rods.

changelogs/4.5.md

@@ -0,0 +1,28 @@
+**For Minecraft: Bedrock Edition 1.19.0**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.5.0
+Released 7th June 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.0.
+- Removed support for older versions.
+
+# 4.5.1
+Released 8th June 2022.
+
+## Fixes
+- Fixed commands defined in `pocketmine.yml` `aliases` not passing the correct arguments.
+- Updated BedrockProtocol to fix command argument types displayed on client-side command suggestions.
+
+# 4.5.2
+Released 29th June 2022.
+
+## Fixes
+- Fixed terrain getting redrawn when flying in spectator mode (or when using `Player->setHasBlockCollision(false)`).
+- Fixed skulls with the `noDrops` flag set being treated as unknown blocks.

changelogs/4.6.md

@@ -0,0 +1,42 @@
+**For Minecraft: Bedrock Edition 1.19.10**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.6.0
+Released 13th July 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.10.
+- Removed support for older versions.
+
+# 4.6.1
+Released 22nd July 2022.
+
+## Tools
+- `build/generate-registry-annotations.php` now supports processing single files (useful for PhpStorm file watchers).
+
+## API
+- Updated documentation for `AsyncTask`.
+
+## Fixes
+- Fixed incorrect items being displayed in item frames.
+- Fixed books not showing in lecterns.
+- Fixed incorrect damage interval of Wither status effect.
+- Fixed incorrect fire ticks when being set on fire by lava (8 seconds in Bedrock instead of 15).
+- `Entity->attack()` now cancels damage from `FIRE` and `FIRE_TICK` damage causes if the entity is fireproof.
+- Fixed inventory windows getting force-closed when the client attempts to use an enchanting table or anvil.
+
+# 4.6.2
+Released 6th August 2022.
+
+## Core
+- Improved server-side performance of `PlayerAuthInputPacket` handler.
+- Improved client-side performance of `FloatingTextParticle` by using an invisible falling block entity. This offered a roughly 5x performance improvement over using tiny invisible players in local testing.
+
+## Fixes
+- Fixed assert failures and debug spam on debug Minecraft clients related to abilities in `AddPlayerPacket`.
+- Fixed crash in `ReversePriorityQueue` on PHP 8.1 by adding `#[ReturnTypeWillChange]` attribute.

changelogs/4.7.md

@@ -0,0 +1,46 @@
+**For Minecraft: Bedrock Edition 1.19.20**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.7.0
+Released 9th August 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.20.
+- Removed support for older versions.
+
+# 4.7.1
+Released 14th August 2022.
+
+## Fixes
+- Fixed server crash when loading items from disk which have negative meta values.
+- Fixed Turtle Master potions not giving any effects.
+- Unimplemented items are no longer craftable.
+- Fixed incorrect items appearing in item frames (due to an obsolete workaround for 1.19.10).
+
+# 4.7.2
+Released 16th August 2022.
+
+## Fixes
+- Fixed crash when processing player skins with invalid geometry data.
+- Fixed spectator players being able to pick blocks using mousewheel click.
+- Improved supporting requirements for sugarcane.
+
+# 4.7.3
+Released 22nd August 2022.
+
+## General
+- Added complete translations for Spanish and Vietnamese.
+- All continuous integration (static analysis, unit tests, integration tests) are now performed on PHP 8.1 as well as 8.0.
+- InventoryTransaction now verifies that stack sizes of items after the transaction don't exceed the maximum stack size of the item type or the containing inventory.
+
+## Fixes
+- Fixed Normal generator crash on PHP 8.1.
+- Fixed a race condition during async worker shutdown that could lead to tasks executing in the wrong order. This (very rarely) led to a crash in `PopulationTask` due to its preceding `GeneratorRegisterTask` not being executed.
+- Fixed `/give` accepting negative amounts or amounts larger than 32767 (vanilla max).
+- Fixed placement conditions for vines (no longer able to be placed on the side of cacti).
+- Fixed incorrect documentation of `SignText::__construct()`.

changelogs/4.8.md

@@ -0,0 +1,23 @@
+**For Minecraft: Bedrock Edition 1.19.21**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.8.0
+Released 24th August 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.21.
+- Removed support for older versions.
+
+# 4.8.1
+Released 26th August 2022.
+
+## General
+- Crashdumps now include JIT mode information for use by the Crash Archive.
+
+## Fixes
+- Fixed uninitialized offset error in `DyeColorIdMap` when given invalid dye color IDs.

changelogs/4.9.md

@@ -0,0 +1,36 @@
+**For Minecraft: Bedrock Edition 1.19.30**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.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.
+
+# 4.9.0
+Released 20th September 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.30.
+- Removed support for older versions.
+
+# 4.9.1
+Released 11th October 2022.
+
+## Documentation
+- Added and improved documentation for many API methods in `Player` and `Block`.
+- Added missing `@internal` tag for `TaskHandler->setNextRun()`, `TaskHandler->remove()` and `TaskHandler->run()`.
+
+## Fixes
+- Flight state is now locked by the server in spectator mode. This prevents any attempt by the client to toggle flight mode.
+- Fixed entity health exceeding its max health after the expiry of Health Boost effect.
+- Fixed burp sound not being played when a player eats food.
+- Fixed placement conditions for mushrooms - they can now only be placed when the light level at the target is <= 12, or on podzol or mycelium.
+- Fixed sign text appearing to change colour and/or glow when using dye on a sign - since this feature is not yet implemented, no change should occur.
+- Fixed players drowning when sprint-swimming on the surface of water.
+
+## Internals
+- Added more detailed debug logging during the player login sequence.
+- Silenced debug spam during `PreSpawnPacketHandler`, considerably reducing debug noise when players join.
+- Fixed an edge case in `InventoryManager->removeWindow()`. This bug didn't have any effect on stable versions, but caused a `next-minor` development version to crash.
+- `Item`s returned by event getters are now cloned if modifying the result will have no useful side effects.
+- Updated `pocketmine/bedrock-data` to [`1.11.1`](https://github.com/pmmp/BedrockData/tree/1.11.1%2Bbedrock-1.19.30), which reduces bandwidth consumption during logins by not sending useless biome generation data.

changelogs/5.0-beta.md

@@ -0,0 +1,215 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+5.0.0 is a major update to PocketMine-MP, including many new features and API changes. It is **not** compatible with plugins written for previous versions of PocketMine-MP.
+
+**During the beta phase, no new features will be added.**
+
+This stage of development is focused on stability and cleaning up any major issues introduced during the alpha stage.
+
+## WARNING
+**This is a BETA release.** This means that it may be unstable, and is not yet ready for production use.
+
+Since this version has undergone substantial changes compared to 4.x, plugins written for 4.x will need to be updated to work on this version.
+
+Breaking API changes may still occur during the beta phase, but only if they are strictly necessary to fix a problem prior to full release.
+
+**BACK UP your data before testing this.** This version will work with worlds and player data from 4.x,
+BUT any world or player data loaded in 5.0.0 will not work in 4.x due to backwards-incompatible storage format changes.
+
+# 5.0.0-BETA1
+Released 7th March 2023.
+
+**This release includes changes from the following releases:**
+- [All 5.0.0 alpha releases](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/5.0-alpha.md)
+- [4.15.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/4.15.md#4152)
+- [4.15.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/4.15.md#4153)
+- [4.16.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/4.16.md#4160)
+
+## API
+### `pocketmine\block`
+- Improved documentation for the following methods:
+  - `Block->getTypeId()`
+  - `Block->getStateId()`
+  - `Block->describeType()`
+  - `Block->describeState()`
+
+### `pocketmine\command`
+- The following API methods have been renamed:
+  - `Command->getPermission()` -> `Command->getPermissions()`
+
+## Internals
+- The following methods have been renamed:
+  - `Block->computeStateData()` -> `Block->computeTypeAndStateData()`
+  - `Block->decodeStateData()` -> `Block->decodeTypeAndStateData()`
+- Wall state data now packs connections into 7 bits instead of 8.
+
+# 5.0.0-BETA2
+Released 11th April 2023.
+
+**This release includes changes from the following releases:**
+- [4.17.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.17.md#4170)
+- [4.17.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.17.md#4171)
+- [4.17.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.17.md#4172)
+- [4.18.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4180)
+- [4.18.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4181)
+- [4.18.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4182)
+- [4.18.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4183)
+- [4.18.4](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4184)
+- [4.19.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.19.md#4190)
+
+## Tools
+- Added script `tools/generate-bedrock-data-from-packets.php`. This tool accepts a txt file containing base64-encoded packet dumps.
+  - This script has been used to generate data for [BedrockData](https://github.com/pmmp/BedrockData) for several years, but has only now been open-sourced.
+  - It's used to generate data such as crafting recipes, creative inventory data, and various other blobs of data needed to support the current version of Minecraft: Bedrock Edition.
+
+## Gameplay
+- Anvils now damage entities when they fall on top of them.
+
+## API
+### `pocketmine\block\utils`
+- The following API interface requirements have been added (BC breaking):
+  - `public Fallable->getFallDamagePerBlock() : float` (default implementation provided by `FallableTrait`)
+  - `public Fallable->getMaxFallDamage() : float` (default implementation provided by `FallableTrait`)
+
+### `pocketmine\data\bedrock\block`
+- The following new API methods have been added:
+  - `public BlockStateData->getVersionAsString() : string`
+
+#### `pocketmine\data\bedrock\block\upgrade\model`
+- `BlockStateUpgradeSchemaModelBlockRemap` now accepts `null` for `oldState` and `newState`. This makes it easier to generate portable schemas for other languages to read.
+
+### `pocketmine\event\entity`
+- The following new API constants have been added:
+  - `EntityDamageEvent::CAUSE_FALLING_BLOCK`
+  - `EntityDamageEvent::MODIFIER_ARMOR_HELMET`
+
+### `pocketmine\item`
+- The following API methods have signature changes:
+  - `ItemTypeIds::toBlockTypeId()` may now return `null` if the item type ID is not a block.
+
+### `pocketmine\player`
+- The following classes have been removed:
+  - `PlayerChunkLoader` - deprecated in 4.19.0 (this was technically internal, but never marked as such)
+
+## Internals
+- Make use of `Item->canStackWith()` instead of `Item->equals()` wherever possible, to make the code more readable.
+
+# 5.0.0-BETA3
+Released 17th May 2023.
+
+**This release includes changes from the following releases:**
+- [4.19.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.19.md#4191)
+- [4.19.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.19.md#4192)
+- [4.19.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.19.md#4193)
+- [4.20.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4200)
+- [4.20.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4201)
+- [4.20.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4202)
+- [4.20.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4203)
+- [4.20.4](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4204)
+- [4.21.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.21.md#4210)
+
+## General
+- Improved light propagation performance by 10-15%.
+
+## Fixes
+- Fixed late initialization of coral type in `BaseCoral`.
+
+## Tools
+- `tools/generate-blockstate-upgrade-schema.php` has the following improvements:
+  - Now generates better errors when inconsistent blockstate versions are encountered.
+  - Now generates more stable outputs when re-run on the same input.
+  - Output now uses `copiedState` in `remappedStates` where possible. This significantly reduces the size of the output for blocks with partially flattened states.
+
+## Gameplay
+- The following blocks have been added:
+  - Cave Vines
+- The following items have been added:
+  - Glow Berries
+  - Mangrove Boat (incomplete)
+- Fixed flower pots being able to be placed inside flower pots.
+
+## API
+### `pocketmine\block`
+- The following API methods have been renamed:
+  - `Block->isSameType()` -> `Block->hasSameTypeId()`
+  - `Block->describeType()` -> `Block->describeBlockItemState()`
+  - `Block->describeState()` -> `Block->describeBlockOnlyState()`
+- The following API methods have been removed:
+  - `Block->getRequiredTypeDataBits()`
+  - `Block->getRequiredStateDataBits()`
+- The following API methods have been added:
+  - `public Block->generateStatePermutations() : \Generator<int, Block, void, void>` - yields all possible states this block type can be in (used for `RuntimeBlockStateRegistry`)
+- The following API methods have signature changes:
+  - `Sapling::__construct()` now accepts `SaplingType $saplingType` instead of `TreeType $treeType`
+  - `RuntimeBlockStateRegistry->register()` no longer accepts an `$override` parameter.
+- The following classes have been added:
+  - `utils\SaplingType` - enum of all sapling types
+- `utils\TreeType` has been moved to `pocketmine\world\generator\object` namespace.
+
+### `pocketmine\data\bedrock\item\upgrade`
+- The following API methods have been added:
+  - `public ItemIdMetaUpgrader->getSchemas() : array<int, BlockStateUpgradeSchema>` - returns a list of loaded schemas indexed by schema ID
+  - `public ItemIdMetaUpgradeSchema->getRenamedIds() : array<string, string>` - returns a map of old ID -> new ID
+  - `public ItemIdMetaUpgradeSchema->getRemappedMetas() : array<string, array<int, string>>` - returns a map of old ID -> list of old meta -> new ID
+
+### `pocketmine\event\block`
+- The following API methods have been added:
+  - `public BlockGrowEvent->getPlayer() : ?Player` - returns the player that triggered the block growth, or `null` if it was not triggered by a player
+- The following API methods have signature changes:
+  - `BlockGrowEvent::__construct()` now accepts an optional `?Player $player` parameter.
+
+### `pocketmine\event\world`
+- The following classes have been added:
+  - `WorldDisplayNameChangeEvent` - called when a world's display name is changed
+
+### `pocketmine\item`
+- `Boat` now uses a new `BoatType` enum instead of `TreeType`. This is because not all tree types have an associated boat type, and some boat types are not made from tree materials (e.g. bamboo raft).
+  - The following API methods have been removed:
+    - `Boat->getWoodType()`
+  - The following API methods have been added:
+    - `public Boat->getType() : BoatType`
+    - `public Item->getStateId() : int` - returns an encoded ID containing the item type ID and encoded item state
+  - The following API methods have been renamed:
+    - `Item->describeType()` -> `Item->describeState()`
+  - The following classes have been added:
+    - `BoatType` - enum of all boat types
+  - The following API methods have signature changes:
+    - `BoatType::__construct()` now accepts `BoatType $boatType` instead of `TreeType $woodType`.
+
+### `pocketmine\world`
+- The following API methods have been added:
+  - `public World->setDisplayName(string $name) : void`
+
+### `pocketmine\world\format`
+- Fixed outdated documentation for various methods of `Chunk`.
+
+### `pocketmine\world\format\io\data`
+- The following API interface requirements have been added:
+  - `public WorldData->setDisplayName(string $value) : void`
+
+## Internals
+- Reduced global usage in world providers. In the future, we want to have blockstate deserializers etc. injected rather than being global singletons.
+- `BlockStateUpgrader` now always updates the blockstate version, even if no changes were made. PM itself doesn't require this, but it's useful for tools to know whether to upgrade the data again (e.g. in testing scenarios).
+- `BlockStateDictionary` memory usage is now reduced from 9 MB to 3.5 MB using various techniques, including string reuse and binary-encoded states.
+- `RuntimeBlockMapping` has been renamed to `BlockTranslator`.
+- Singletons in the `pocketmine\network\mcpe\convert` package have been centralized under `TypeConverter`. In the future, this will be injected where needed, allowing different converters to be used for different sessions (useful for multiversion).
+- Overriding of serializers and deserializers of items and blocks is now consistently disallowed. Due to the lack of a good reason to allow overriding built-in blocks and items, this is no longer allowed.
+
+# 5.0.0-BETA4
+Released 23rd May 2023.
+
+## General
+- [`ext-pmmpthread` version 6.0.0](https://github.com/pmmp/ext-pmmpthread/releases/6.0.0) (renamed from `ext-pthreads`) is now required. This version has API changes compared to pthreads v5. Please read the linked changelog for details.
+- [`pocketmine/snooze` version 0.5.0](https://github.com/pmmp/Snooze/releases/0.5.0) is now required.
+- `pocketmine/classloader` and `pocketmine/log-pthreads` packages have been removed. The relevant classes from these packages are now included in-house in the `pocketmine/thread` namespace.
+  - `BaseClassLoader` is replaced with `pocketmine\thread\ThreadSafeClassLoader`
+  - `ThreadedLogger` is replaced by `pocketmine\thread\ThreadSafeLogger`
+  - `AttachableThreadedLogger` is replaced by `pocketmine\thread\AttachableThreadSafeLogger`
+  - `ThreadedLoggerAttachment` is replaced by `pocketmine\thread\ThreadSafeLoggerAttachment`
+
+## Fixes
+- Fixed crash on unknown blocks due to late initialization of properties in `UnknownBlock`.
+
+## API changes
+### `pocketmine\scheduler`
+- `AsyncTask->setResult()` now works with thread-safe objects. This was previously not possible due to limitations in the `pthreads` extension.

changelogs/5.0.md

@@ -0,0 +1,791 @@
+# 5.0.0
+Released 1st June 2023.
+
+**For Minecraft: Bedrock Edition 1.19.80**
+
+5.0.0 is a major feature update to PocketMine-MP, including support for Bedrock worlds from 1.13 onwards, a large array of new blocks and items, and various changes to the plugin API.
+
+It is **not** compatible with plugins written for 4.x.y, and plugins may require code changes to work with it.
+
+**As this changelog is quite large, its accuracy and completeness cannot be guaranteed.**
+Make sure you're looking at the [latest revision](https://github.com/pmmp/PocketMine-MP/blob/stable/changelogs/5.0.md), as it may be amended after release.
+
+## Core
+- Worlds are now saved according to the Bedrock 1.19.80 format.
+- Worlds generated by Bedrock from 1.13.0 and up are now supported (previously, only worlds up to 1.12 were supported).
+- `/particle` now accepts strings for particle data instead of integers.
+- `/particle` no longer accepts integers for block or item IDs.
+- The usage of `blockcrack`, `iconcrack` and `blockdust` particle types in `/particle` now follows the same pattern as
+  other particle types, with the data for each being passed in the `data` parameter instead of being baked into the
+  particle name.
+- Commands are now enabled by default in worlds exported from PocketMine-MP to Bedrock.
+
+## Build system
+- `build/generate-block-serializer-consts.php` has been added to generate `BlockTypeNames`, `BlockStateNames` and `BlockStateStringValues` in the `pocketmine\data\bedrock\block` package.
+- `build/generate-item-type-names.php` has been added to generate `ItemTypeNames` in the `pocketmine\data\bedrock\item` package.
+- `build/generate-runtime-enum-serializers.php` has been added to generate `RuntimeEnumSerializer`, `RuntimeEnumSerializerTrait`, and `RuntimeEnumSizeCalculatorTrait` in `pocketmine\data\runtime` package.
+
+## Localization
+- Localized disconnect messages are now used in the following cases:
+  - Server full
+  - Player not on the server whitelist
+  - Player on the server ban list
+  - Invalid skin
+  - Invalid username
+  - Kicked using `/kick`
+  - Banned using `/ban`
+  - Failure to find a safe spawn position
+- Session open, session close and session player name discovery messages are now localized.
+- All permissions now have localized descriptions. These are not currently used by PocketMine-MP, but may be useful for plugins.
+
+## Performance
+- Improved performance of dropping block inventory contents when the block is destroyed.
+- Improved light propagation performance by 10-15%.
+- [`ext-pmmpthread` version 6.0.0](https://github.com/pmmp/ext-pmmpthread/releases/tag/6.0.0) is now used, featuring significant performance improvements for thread-safe objects and various threading use-cases.
+
+## Tools
+- The following tool scripts have been added:
+  - `generate-block-palette-spec.php` - generates a JSON file with a readable overview of blocks, their state
+    properties, and their possible values
+  - `generate-blockstate-upgrade-schema.php` - generates JSON blockstate upgrade schemas like those found
+    in [BedrockBlockUpgradeSchema](https://github.com/pmmp/BedrockBlockUpgradeSchema)
+  - `generate-item-upgrade-schema.php` - generates JSON item ID/meta upgrade schemas like those found
+    in [BedrockItemUpgradeSchema](https://github.com/pmmp/BedrockItemUpgradeSchema)
+  - `generate-bedrock-data-from-packets.php` - generates various files for [BedrockData](https://github.com/pmmp/BedrockData)
+    - This script accepts a txt file containing base64-encoded packet dumps.
+    - This script has been in use for several years, but has only now been open-sourced.
+    - It's used to generate data such as crafting recipes, creative inventory data, and various other blobs of data needed to support the current version of Minecraft: Bedrock Edition.
+
+## Gameplay
+### Blocks
+- Added the following new blocks:
+  - Amethyst Block
+  - Ancient Debris
+  - Azalea Leaves
+  - Basalt
+  - Blackstone blocks, slabs, stairs, and walls
+  - Cakes with Candle & Dyed Candle
+  - Calcite
+  - Candle & Dyed Candle
+  - Cartography Table (not currently usable due to maps not being implemented)
+  - Cauldron
+  - Cave Vines
+  - Chain
+  - Chiseled Deepslate
+  - Chiseled Nether Bricks
+  - Chiseled Polished Blackstone
+  - Chorus Flower
+  - Chorus Plant
+  - Cobbled Deepslate blocks, slabs, stairs, and walls
+  - Copper Ore
+  - Copper block (random oxidation not yet implemented)
+  - Crached Deepslate Tiles
+  - Cracked Deepslate Bricks
+  - Cracked Nether Bricks
+  - Cracked Polished Blackstone Bricks
+  - Crimson buttons, doors, fences, fence gates, hyphae, planks, pressure plates, signs, slabs, stairs, stems, and trapdoors
+  - Crying Obsidian
+  - Cut Copper block, stairs and slabs (random oxidation not yet implemented)
+  - Deepslate
+  - Deepslate Bricks blocks, slabs, stairs, and walls
+  - Deepslate Ores (coal, copper, diamond, emerald, gold, iron, lapis lazuli, redstone)
+  - Deepslate Tiles blocks, slabs, stairs, and walls
+  - Flowering Azalea Leaves
+  - Froglight (pearlescent, verdant, ochre)
+  - Gilded Blackstone
+  - Glow Item Frame
+  - Hanging Roots
+  - Honeycomb Block
+  - Light Block
+  - Lightning Rod
+  - Mangrove Leaves
+  - Mangrove Roots
+  - Mangrove buttons, doors, fences, fence gates, logs, planks, pressure plates, signs, slabs, stairs, trapdoors, and wood
+  - Mud Bricks blocks, slabs, stairs, and walls
+  - Muddy Mangrove Roots
+  - Nether Gold Ore
+  - Netherite Block
+  - Polished Basalt
+  - Polished Blackstone Bricks blocks, slabs, stairs, and walls
+  - Polished Blackstone blocks, buttons, pressure plates, slabs, stairs, and walls
+  - Polished Deepslate blocks, slabs, stairs, and walls
+  - Quartz Bricks
+  - Reinforced Deepslate
+  - Rooted Dirt
+  - Sculk
+  - Shroomlight
+  - Smithing Table
+  - Smooth Basalt
+  - Soul Fire
+  - Soul Lantern
+  - Soul Soil
+  - Soul Torch
+  - Spore Blossom
+  - Tinted Glass
+  - Tuff
+  - Twisting Vines
+  - Warped Wart Block
+  - Warped buttons, doors, fences, fence gates, hyphae, planks, pressure plates, signs, slabs, stairs, stems, and trapdoors
+  - Weeping Vines
+  - Wither Rose
+- Added support for basalt generators
+- Added support for dyeing sign text and making it glow.
+- All-sided logs ("wood", for want of a better name) can now be placed in X, Y, and Z orientations.
+- Coral and coral fans now behave correctly when placed out of water (they no longer immediately die).
+- Fixed dead bush being able to be placed on some invalid blocks (e.g. stone).
+- Fixed lava setting entities on fire for an incorrect duration (Java vs Bedrock inconsistency).
+- Fixed sugarcane not being able to be placed on some blocks.
+- Iron Ore and Gold Ore now drop Raw Iron and Raw Gold respectively, instead of the ore blocks.
+- Item frames can now be placed on the top and bottom of blocks.
+- Stripping logs by right-clicking them with an axe is now supported.
+- TNT can now be ignited by fire charges.
+- Vines can now only be placed on the side of full-cube blocks.
+- Walls now connect when placed, following the pre-1.16 logic. (1.16 logic is planned to be implemented, but currently low priority.)
+- Anvils are now damaged when they hit the ground after falling.
+- Added missing sounds for anvils hitting the ground after falling.
+- Anvils now damage entities when they fall on top of them.
+
+### Items
+- Added the following new items:
+  - Amethyst Shard
+  - Antidote (from Education Edition)
+  - Copper Ingot
+  - Disc Fragment (5)
+  - Echo Shard
+  - Elixir (from Education Edition)
+  - Eye Drops (from Education Edition)
+  - Fire Charge
+  - Glow Berries
+  - Glow Ink Sac
+  - Honey Bottle
+  - Honeycomb
+  - Mangrove Boat (incomplete)
+  - Music Disc (5)
+  - Music Disc (Otherside)
+  - Music Disc (Pigstep)
+  - Netherite Axe
+  - Netherite Boots
+  - Netherite Chestplate
+  - Netherite Helmet
+  - Netherite Ingot
+  - Netherite Leggings
+  - Netherite Pickaxe
+  - Netherite Scrap
+  - Netherite Shovel
+  - Netherite Sword
+  - Phantom Membrane
+  - Raw Copper
+  - Raw Gold
+  - Raw Iron
+  - Spyglass
+  - Suspicious Stew
+  - Tonic (from Education Edition)
+- Glass bottles can now be filled with water by clicking on a water source block.
+- Implemented Swift Sneak enchantment.
+- Armour durability is now only reduced when the wearer receives a type of damage that the armour can protect against.
+- Bells now ring when hit by a projectile.
+
+### Worlds
+- World height of -64 to 319 is now supported.
+- Added support for 3D biomes. This isn't used by PocketMine-MP yet, but is necessary to be able to fully load 1.18 worlds.
+
+## API
+### General
+- Union and mixed native parameter, return and property types are now used where appropriate.
+- Protected and public properties now use native property types wherever possible.
+- Parameter and return typehints have been applied in many places where it wasn't previously possible.
+
+### Dependencies
+- [`ext-pmmpthread` version 6.0.0](https://github.com/pmmp/ext-pmmpthread/releases/6.0.0) (renamed from `ext-pthreads`) is now required. This version features major API changes and improvements. Please read the [upgrading guide](https://github.com/pmmp/ext-pmmpthread/blob/fork/docs/UPGRADING_4.x_to_6.0.md) for details.
+- [`pocketmine/snooze` version 0.5.0](https://github.com/pmmp/Snooze/releases/0.5.0) is now required.
+- [`pocketmine/raklib` version 0.15.0](https://github.com/pmmp/RakLib/releases/0.15.0) is now required.
+- [`pocketmine/raklib-ipc` version 0.2.0](https://github.com/pmmp/RakLibIpc/releases/0.2.0) is now required.
+- `pocketmine/classloader` and `pocketmine/log-pthreads` packages have been removed. The relevant classes from these packages are now included in-house in the `pocketmine/thread` namespace.
+  - `BaseClassLoader` is replaced with `pocketmine\thread\ThreadSafeClassLoader`
+  - `ThreadedLogger` is replaced by `pocketmine\thread\ThreadSafeLogger`
+  - `AttachableThreadedLogger` is replaced by `pocketmine\thread\AttachableThreadSafeLogger`
+  - `ThreadedLoggerAttachment` is replaced by `pocketmine\thread\ThreadSafeLoggerAttachment`
+- `webmozart/path-util` has been removed (replaced by [`symfony/filesystem`](https://github.com/symfony/filesystem)).
+
+### `pocketmine\block`
+#### Highlights
+- Blocks no longer use internal Minecraft IDs and metadata to identify themselves. All APIs associated with legacy IDs
+  and meta have been removed.
+- A new set of runtime IDs generated from `VanillaBlocks` is used to identify block types. These IDs are defined
+  in `BlockTypeIds`.
+  - These new IDs are used for runtime representation of blocks on chunks, and for type comparison purposes.
+  - Block type IDs are used at **runtime only**. **Do not store them in configs or databases**, as they are subject to
+    change without warning.
+  - Block type IDs are **specific to PocketMine-MP** and have no relation to the IDs used by Minecraft.
+  - Block type IDs cannot be negative
+  - Block type IDs must not be reused, even if overriding an already defined block
+- Block state properties (e.g. facing, colour, etc.) are now represented by PM-specific state data instead of legacy
+  metadata. The state data consists of:
+  - Block-item state properties - retained by items when the block is broken (colour, wet/dry, coral type, etc.) - handled by `Block->describeBlockItemState()`
+  - Block-only state data - discarded when the block is broken (facing direction, lit/unlit, powered/unpowered, etc.) - handled by `Block->describeBlockOnlyState()`
+- Chunks now store dynamic state ID derived from the runtime type ID and runtime (PocketMine-MP defined) state data.
+- Introduced "type tags" concept, which allows marking certain blocks as having certain behaviours.
+  - The idea for this system was borrowed from the Minecraft Java tags system.
+  - It's still in very early concept stage, but is currently used for deciding which types of blocks plants can be placed on without needing to enumerate every single ID in every class, eliminating a bunch of boilerplate code and improving consistency.
+- All `Block` descendents now accept `BlockTypeInfo` in the constructor, instead of `BlockBreakInfo`. This allows for future additions without needing to change dozens of overridden constructors.
+- `&$returnedItems` reference parameter is now used in some places such as `Block->onInteract()` to enable actions to return items to players without caring about whether they are in creative or anything else.
+  - This eliminates boilerplate code of deciding whether to set the player's held item or not, as well as automatically dropping any overflow items that don't fit into the inventory.
+  - This is currently used when filling/emptying cauldrons using buckets or glass bottles.
+- Dependency between `RuntimeBlockStateRegistry` (previously `BlockFactory`) and `VanillaBlocks` has been inverted.
+  - Now, blocks types are defined in `VanillaBlocks`
+  - `RuntimeBlockStateRegistry` automatically registers states for blocks defined in `VanillaBlocks`.
+  - Manual registration in `RuntimeBlockStateRegistry` is still required for custom blocks (see section below about registering new blocks).
+- `RuntimeBlockStateRegistry` now has only one purpose - to map internal blockstate IDs to `Block` objects when reading blocks from chunks. It should not be used by plugins unless registering new blocks.
+  - To get a block at runtime, e.g. stone, use `VanillaBlocks::STONE()`
+  - To load a block from **old** config or database data:
+    1. Use `GlobalBlockStateHandlers::getUpgrader()->upgradeIntIdMeta()` to convert it to modern data
+    2. Pass the data to `GlobalBlockStateHandlers::getDeserializer()` to get a blockstate ID
+    3. Pass the blockstate ID to `RuntimeBlockStateRegistry::fromStateId()` to get a `Block` instance
+  - Prefer using `StringToItemParser` wherever possible for configs and databases (see `lookupAliases()` and `lookupBlockAliases()`).
+
+#### Registering new blocks
+##### In a plugin
+To add a vanilla block in a plugin which isn't yet supported by PocketMine-MP, do the following:
+
+1. Get a new type ID using `BlockTypeIds::newId()` - _you'll want to keep this in a property somewhere if you want to
+   compare using `getTypeId()` later_
+2. Set up the block type somewhere - _this can be anywhere you like, e.g. a plugin main class property, but using
+   a `RegistryTrait` class is recommended - you'll need this later to create new instances of the block_
+3. Register the block in `RuntimeBlockStateRegistry` - _this informs the server of all the block's possible states so
+   that it can be read from chunks at runtime_
+4. Register a deserializer for the block's Minecraft ID in `BlockStateToObjectDeserializer` - _needed for the block to
+   be recognized when loaded from disk_
+5. Register a serializer for the block in `BlockObjectToStateSerializer` - _needed for the block to be saved to disk,
+   and to be sent over the network_
+6. Optionally, register a string alias for the block in `StringToItemParser` - _so that it can be given via `/give`_
+
+To see a demo of how to do this in a plugin, see [this example plugin](https://github.com/pmmp/RegisterBlocksDemoPM5).
+
+Registering custom blocks follows a similar process, but requires additional steps to modify `BlockStateDictionary`
+which won't be covered here.
+Since this is not currently officially supported by PocketMine-MP, this won't be covered here.
+
+This is admittedly rather more of a hassle than in PM4, but this system offers significantly more flexibility than the
+old system.
+
+##### As a PocketMine-MP core contribution
+To register a new vanilla block into the core, the process is slightly different:
+
+1. Instead of using `BlockTypeIds::newId()`, add a new constant for the block to `BlockTypeIds`
+2. Register the new block in `VanillaBlocks` - `RuntimeBlockStateRegistry` will automagically take notice of all blocks
+   defined in `VanillaBlocks`
+3. Follow steps 4 onwards above
+
+#### Change list
+- The following classes have been removed:
+  - `BlockIdentifierFlattened`
+  - `BlockLegacyIdHelper`
+  - `BlockLegacyIds`
+  - `BlockLegacyMetadata`
+  - `utils\BlockDataSerializer`
+  - `utils\ColorInMetadataTrait` - `utils\ColoredTrait` now implements colour type data serialization uniformly
+  - `utils\InvalidBlockStateException` - this has been superseded by `pocketmine\data\runtime\InvalidSerializedRuntimeDataException`
+  - `utils\NormalHorizontalFacingInMetadataTrait` - `utils\HorizontalFacingTrait` now implements facing type data serialization uniformly
+  - `utils\PillarRotationInMetadataTrait` - `utils\PillarRotationTrait` now implements rotation type data serialization uniformly
+- The following classes have been renamed:
+  - `BlockFactory` -> `RuntimeBlockStateRegistry` - this class is now exclusively used for mapping state IDs to block instances for runtime chunk block reading
+  - `Skull` -> `MobHead`
+  - `utils\SkullType` -> `utils\MobHeadType`
+  - `utils\TreeType` -> `pocketmine\world\generator\object\TreeType`
+- The following classes have been added:
+  - `BaseCake`
+  - `BaseFire`
+  - `BlockTypeIds` - list of type IDs, one for each entry in `VanillaBlocks`
+  - `BlockTypeInfo`
+  - `BlockTypeTags`
+  - `CakeWithCandle`
+  - `CakeWithDyedCandle`
+  - `Candle`
+  - `CartographyTable`
+  - `Chain`
+  - `CopperOre`
+  - `CopperSlab`
+  - `CopperStairs`
+  - `Copper`
+  - `DyedCandle`
+  - `GildedBlackstone`
+  - `GoldOre`
+  - `HangingRoots`
+  - `IronOre`
+  - `Light`
+  - `LightningRod`
+  - `NetherGoldOre`
+  - `Sculk`
+  - `SmithingTable`
+  - `SoulFire`
+  - `WitherRose`
+  - `utils\CandleTrait`
+  - `utils\CopperOxidation`
+  - `utils\CopperTrait`
+  - `utils\SaplingType` - enum of all sapling types
+  - `utils\WallConnectionType` - enum of all possible wall connection types
+  - `utils\WoodTypeTrait`
+  - `utils\WoodType` - enum of all possible wood types, used for wood material blocks like planks and logs
+- The following API methods have been removed:
+  - `Block->getId()` - for type comparisons, use `Block->getTypeId()` instead
+  - `Block->getMeta()` - for state comparisons, use `Block->getStateId()` instead
+  - `Block->getStateBitmask()`
+  - `Block->readStateFromData()`
+  - `Block->writeStateToItemMeta()`
+  - `Block->writeStateToMeta()`
+  - `BlockFactory->get()` - see notes above about `RuntimeBlockStateRegistry`
+  - `BlockIdentifier->getAllBlockIds()`
+  - `BlockIdentifier->getBlockId()`
+  - `BlockIdentifier->getItemId()`
+  - `BlockIdentifier->getVariant()`
+  - `Door->isPowered()`
+  - `Door->setPowered()`
+  - `MobHead->isNoDrops()` (previously `Skull->isNoDrops()`)
+  - `MobHead->setNoDrops()` (previously `Skull->setNoDrops()`)
+  - `VanillaBlocks::*_GLAZED_TERRACOTTA()` - use `VanillaBlocks::GLAZED_TERRACOTTA()->setColor(DyeColor::WHATEVER())` instead
+  - `utils\FallableTrait->getId()` is no longer required
+  - `utils\FallableTrait->getMeta()` is no longer required
+  - `utils\MobHeadType->getMagicNumber()` (previously `utils\SkullType->getMagicNumber()`)
+  - `utils\MobHeadType::fromMagicNumber()` (previously `utils\SkullType::fromMagicNumber()`)
+- The following constants have been removed:
+  - `Block::INTERNAL_METADATA_BITS`
+  - `Block::INTERNAL_METADATA_MASK`
+- The following API methods have been renamed:
+  - `Block->getFullId()` -> `Block->getStateId()`
+  - `Block->isSameType()` -> `Block->hasSameTypeId()`
+  - `MobHead->getSkullType()` -> `MobHead->getMobHeadType()` (previously `Skull->getSkullType()`)
+  - `MobHead->setSkullType()` -> `MobHead->setMobHeadType()` (previously `Skull->setSkullType()`)
+- The following API methods have signature changes:
+  - `Block->onBreak()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Block->onInteract()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Block->readStateFromWorld()` now returns `Block` - this allows blocks to replace themselves with a different block entirely based on world conditions.
+  - `BlockIdentifier->__construct()` now accepts `int $blockTypeId`, and no longer accepts `int $blockId, int $variant, ?int $itemId`
+  - `ItemFrame->getFacing()` may now return `Facing::UP` and `Facing::DOWN`
+  - `ItemFrame->setFacing()` now accepts `Facing::UP` and `Facing::DOWN`
+  - `Leaves->__construct()` now accepts `LeavesType $leavesType` instead of `TreeType $treeType`
+  - `RuntimeBlockStateRegistry->register()` no longer accepts an `$override` parameter.
+  - `Sapling::__construct()` now accepts `SaplingType $saplingType` instead of `TreeType $treeType`
+  - `utils\SignText::__construct()` now accepts two new optional parameters: `?Color $baseColor` and `bool $glowing`
+  - `utils\SignText::fromBlob()` now accepts two new optional parameters: `?Color $baseColor` and `bool $glowing`
+- The following API methods have been added:
+  - `protected Block->describeBlockOnlyState(RuntimeDataDescriber $w) : void` - describes state properties which are discarded when the block is broken or block-picked, such as facing, powered, etc.
+  - `public Block->describeBlockItemState(RuntimeDataDescriber $w) : void` - describes state properties which are kept by the item when the block is broken or block-picked, such as dye color
+  - `public Block->generateStatePermutations() : \Generator<int, Block, void, void>` - yields all possible states this block type can be in (used for `RuntimeBlockStateRegistry`)
+  - `public Block->getTypeTags() : array<string>`
+  - `public Block->hasTypeTag(string $tag) : bool`
+  - `public Block->isFireProofAsItem() : bool`
+  - `public Block->onProjectileHit(Projectile $projectile, RayTraceResult $hitResult) : void`
+  - `public BlockIdentifier->getBlockTypeId() : int` - returns the block's type ID according to `BlockTypeIds`
+  - `public Furnace->getFurnaceType() : utils\FurnaceType`
+  - `public GlazedTerracotta->getColor() : utils\DyeColor` (from `ColoredTrait`) - this was previously unsupported due to legacy limitations
+  - `public GlazedTerracotta->setColor(utils\DyeColor $color) : $this` (from `ColoredTrait`) - this was previously unsupported due to legacy limitations
+  - `public Leaves->getLeavesType() : utils\LeavesType` - returns the type of leaves
+  - `public Wall->getConnection(int $face) : utils\WallConnectionType`
+  - `public Wall->getConnections() : array<int, utils\WallConnectionType>` - returns the wall's connections and their types (see `utils\WallConnectionType`)
+  - `public Wall->isPost() : bool`
+  - `public Wall->setConnection(int $face, ?utils\WallConnectionType $type) : $this`
+  - `public Wall->setConnections()` - sets the wall's connections and their types (see `utils\WallConnectionType`)
+  - `public Wall->setPost(bool $post) : $this`
+  - `public Wood->isStripped() : bool`
+  - `public Wood->setStripped(bool $stripped) : $this`
+  - `public static BlockBreakInfo::axe(float $hardness, ?ToolTier $toolTier = null, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public static BlockBreakInfo::pickaxe(float $hardness, ?ToolTier $toolTier = null, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public static BlockBreakInfo::shovel(float $hardness, ?ToolTier $toolTier = null, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public static BlockBreakInfo::tier(float $hardness, int $toolType, ToolTier $toolTier, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public tile\Spawnable->getRenderUpdateBugWorkaroundStateProperties(Block $block) : array<string, Tag>` - allows spawnable tiles to spoof block state properties to work around client-side rendering bugs without actually changing the block server-side
+  - `public utils\SignText->getBaseColor() : \pocketmine\color\Color`
+  - `public utils\SignText->isGlowing() : bool`
+- The following classes now use new traits, adding API methods and/or properties:
+  - `FenceGate` uses `utils\WoodTypeTrait`
+  - `GlazedTerracotta` uses `utils\ColoredTrait`
+  - `Planks` uses `utils\WoodTypeTrait`
+  - `Wood` uses `utils\WoodTypeTrait`
+  - `WoodenButton` uses `utils\WoodTypeTrait`
+  - `WoodenDoor` uses `utils\WoodTypeTrait`
+  - `WoodenFence` uses `utils\WoodTypeTrait`
+  - `WoodenPressurePlate` uses `utils\WoodTypeTrait`
+  - `WoodenSlab` uses `utils\WoodTypeTrait`
+  - `WoodenStairs` uses `utils\WoodTypeTrait`
+  - `WoodenTrapdoor` uses `utils\WoodTypeTrait`
+- The following API interface requirements have been added (BC breaking):
+  - `public utils\Fallable->getFallDamagePerBlock() : float` (default implementation provided by `utils\FallableTrait`)
+  - `public utils\Fallable->getLandSound() : ?Sound` (default implementation provided by `utils\FallableTrait`)
+  - `public utils\Fallable->getMaxFallDamage() : float` (default implementation provided by `utils\FallableTrait`)
+  - `public utils\Fallable->onHitGround(FallingBlock $blockEntity) : bool` (default implementation provided by `utils\FallableTrait`)
+
+### `pocketmine\command`
+- Command permissions are now always checked by the server when running a command.
+  - This only affects commands implemented by extending `Command`. Plugins using `PluginBase->onCommand()` are not affected by this change, since they already had permissions checked by the server anyway.
+  - Previously, direct inheritors of `Command` were responsible for checking permissions, which required developers to duplicate the same code in every command, and opened lots of potential for security vulnerabilities.
+  - If you want to do something on permission denied (e.g. sending a special message, or audit logging), you can do so by overriding `Command->testPermission()`, instead of baking the code directly into `Command->execute()`.
+  - If you don't want to use permissions at all, just create a permission with a default of `true` (or belonging to `pocketmine.group.user`) and assign that.
+- `SimpleCommandMap` now requires all commands to have a permission set when registered.
+  - If you actually want to allow everyone to use your command (not advised), you can add a new permission to the `pocketmine.group.user` group, or use `default: true` for `plugin.yml` permissions.
+- The following API methods have changed behaviour:
+  - `Command->testPermissionSilent()` now returns `false` if there are no permissions associated with the command. This is to prevent commands with no permissions being usable by everyone, which has previously been a source of security issues.
+- The following API methods have been added:
+  - `public Command->getPermissions() : list<string>` - returns a list of permissions which grant usage access to this command. A user with one or more of these permissions will be able to invoke the command's `execute()` method
+  - `public Command->setPermissions(list<string> $permissions) : void` - sets the permissions which grant usage access to this command. This should be used instead of `setPermission()` with `;` separators (which is now deprecated)
+
+### `pocketmine\crafting`
+- JSON models have been updated to reflect updated crafting data format.
+- The following enum classes have new members:
+  - `ShapelessRecipeType` has new members `CARTOGRAPHY` and `SMITHING`
+- The following classes have been added:
+  - `ExactRecipeIngredient` - matches an exact item
+  - `MetaWildcardRecipeIngredient` - matches an item with the given legacy Minecraft ID, but any metadata value
+  - `RecipeIngredient` interface
+  - `TagWildcardRecipeIngredient` - matches an item based on its Minecraft tags, e.g. `minecraft:wooden_tier`
+- The following API methods have signature changes:
+  - `FurnaceRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `FurnaceRecipe->getInput()` now returns `RecipeIngredient` instead of `Item`
+  - `PotionContainerChangeRecipe->__construct()` now accepts `string, RecipeIngredient, string` (using Minecraft string IDs instead of legacy integers).
+  - `PotionContainerChangeRecipe->getIngredient()` now returns `RecipeIngredient` instead of `Item`.
+  - `PotionContainerChangeRecipe->getInputItemId()` now returns `string` (using Minecraft string IDs instead of legacy integers).
+  - `PotionContainerChangeRecipe->getOutputItemId()` now returns `string` (using Minecraft string IDs instead of legacy integers).
+  - `PotionTypeRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `PotionTypeRecipe->getIngredient()` now returns `RecipeIngredient` instead of `Item`
+  - `PotionTypeRecipe->getInput()` now returns `RecipeIngredient` instead of `Item`
+  - `ShapedRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `ShapedRecipe->getIngredient()` now returns `?RecipeIngredient` instead of `?Item`
+  - `ShapedRecipe->getIngredientList()` now returns `RecipeIngredient[]` instead of `Item[]`
+  - `ShapedRecipe->getIngredientMap()` now returns `RecipeIngredient[][]` instead of `Item[][]`
+  - `ShapelessRecipe->__construct()` `$type` parameter is now mandatory.
+  - `ShapelessRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `ShapelessRecipe->getIngredientList()` now returns `RecipeIngredient[]` instead of `Item[]`
+
+### `pocketmine\data`
+- New packages `bedrock\block` and `bedrock\item` have been added. These packages contain all the necessary code for loading and saving Bedrock blocks and items from disk.
+- New package `runtime` has been added. This package contains code for serializing runtime data for blocks and items.
+- `LegacyToStringBidirectionalIdMap` has been reduced to `LegacyToStringIdMap`.
+  - Since we never map from string ID to legacy ID, bidirectional mapping is no longer necessary.
+  - This affects the following subclasses:
+    - `LegacyBiomeIdToStringIdMap`
+    - `LegacyBlockIdToStringIdMap`
+    - `LegacyEntityIdToStringIdMap`
+    - `LegacyItemIdToStringIdMap`
+- The following internal API methods have been added:
+  - `public LegacyToStringIdMap->add(string $string, int $legacy) : void` - adds a mapping from a custom legacy ID to custom string ID, needed for upgrading old saved data
+
+### `pocketmine\entity`
+- `Entity` now declares new abstract methods which must be implemented by subclasses:
+  - `public Entity->getInitialDragMultiplier() : float`
+  - `public Entity->getInitialGravity() : float`
+- The following new API methods have been added:
+  - `public Living->getDisplayName() : string`
+- The following API methods have changed signatures:
+  - `EntityFactory->register()` no longer accepts a `$legacyMcpeSaveId` parameter (now handled by internal conversions instead).
+- The following API methods have been renamed:
+  - `Entity->isImmobile()` -> `Entity->hasNoClientPredictions()`
+  - `Entity->setImmobile()` -> `Entity->setNoClientPredictions()`
+- The following internal fields have been renamed:
+  - `Entity->immobile` -> `Entity->noClientPredictions`
+- The following classes have been removed:
+  - `EntityLegacyIds`
+
+### `pocketmine\event`
+- The following classes have inheritance changes:
+  - `block\BlockPlaceEvent` no longer extends `BlockEvent`, and therefore no longer has `getBlock()`. Use `getTransaction()` instead (may contain multiple blocks).
+- `BlockFormEvent` now includes information about the block which caused the event.
+
+- The following new classes have been added:
+  - `world\WorldDisplayNameChangeEvent` - called when a world's display name is changed
+- The following classes have been renamed:
+  - `entity\ExplosionPrimeEvent` -> `entity\EntityPreExplodeEvent`
+- The following API methods have been added:
+  - `public block\BlockFormEvent->getCausingBlock() : Block`
+  - `public block\BlockGrowEvent->getPlayer() : ?Player` - returns the player that triggered the block growth, or `null` if it was not triggered by a player
+  - `public block\BlockPlaceEvent->getTransaction() : BlockTransaction` - returns the transaction containing a list of changed block positions and the blockstates they will be changed to
+  - `public server\DataPacketSendEvent->setPackets(list<ClientboundPacket> $packets) : void`
+- The following API methods have changed signatures:
+  - `block\BlockPlaceEvent->__construct()` now accepts `BlockTransaction $transaction` instead of `Block $blockPlace, Block $blockReplace`
+  - `entity\EntityPreExplodeEvent->__construct()` has the `$force` parameter renamed to `$radius`
+  - `entity\EntityPreExplodeEvent->getForce() : float` -> `entity\EntityPreExplodeEvent->getRadius() : float`
+  - `entity\EntityPreExplodeEvent->setForce(float $force) : void` -> `entity\EntityPreExplodeEvent->setRadius(float $radius) : void`
+- The following API methods have been removed:
+  - `block\BlockPlaceEvent->getBlockReplaced()` - this information is now provided in the `BlockTransaction` object returned by `BlockPlaceEvent->getTransaction()`
+- The following new API constants have been added:
+  - `entity\EntityDamageEvent::CAUSE_FALLING_BLOCK`
+  - `entity\EntityDamageEvent::MODIFIER_ARMOR_HELMET`
+
+### `pocketmine\event\player`
+- `PlayerPreLoginEvent`, `PlayerDuplicateLoginEvent` and `PlayerKickEvent` now supports setting separate log reasons (disconnect reason) and disconnect screen messages.
+- The following classes have been removed:
+  - `PlayerCommandPreprocessEvent`
+- The following API methods have changed signatures:
+  - `PlayerDuplicateLoginEvent->getDisconnectMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerDuplicateLoginEvent->setDisconnectMessage()` now accepts `Translatable|string` instead of `string`
+  - `PlayerKickEvent->getReason()` now returns `Translatable|string` instead of `string`
+  - `PlayerKickEvent->setReason()` now accepts `Translatable|string` instead of `string`
+  - `PlayerLoginEvent->getKickMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerLoginEvent->setKickMessage()` now accepts `Translatable|string` instead of `string`
+  - `PlayerPreLoginEvent->getFinalKickMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerPreLoginEvent->getKickMessage()` now returns `Translatable|string|null` instead of `string|null`
+  - `PlayerPreLoginEvent->setKickFlag()` (previously `setKickReason()`) now accepts `Translatable|string $disconnectReason, Translatable|string|null $disconnectScreenMessage = null` instead of `Translatable|string $message`
+  - `PlayerPreLoginEvent->setKickReason()` now accepts `Translatable|string` for the `$message` parameter instead of `string`
+  - `PlayerQuitEvent->getQuitReason()` now returns `Translatable|string` instead of `string`
+- The following API methods have been removed:
+  - `PlayerChatEvent->getFormat()` (use `PlayerChatEvent->getChatFormatter()` instead)
+  - `PlayerChatEvent->setFormat()` (use `PlayerChatEvent->setChatFormatter()` instead)
+  - `PlayerDuplicateLoginEvent->getDisconnectMessage()` - replaced by `getDisconnectReason()` and `getDisconnectScreenMessage()`
+  - `PlayerDuplicateLoginEvent->setDisconnectMessage()` - replaced by `setDisconnectReason()` and `setDisconnectScreenMessage()`
+  - `PlayerKickEvent->getReason()` - replaced by `getDisconnectReason()` and `getDisconnectScreenMessage()`
+  - `PlayerKickEvent->setReason()` - replaced by `setDisconnectReason()` and `setDisconnectScreenMessage()`
+- The following new API methods have been added:
+  - `public PlayerChatEvent->getChatFormatter() : \pocketmine\player\chat\ChatFormatter` - returns the chat formatter to be used for this event
+  - `public PlayerChatEvent->setChatFormatter(\pocketmine\player\chat\ChatFormatter $formatter) : void` - sets the chat formatter to be used for this event
+  - `public PlayerDeathEvent->getDeathScreenMessage() : Translatable|string` - returns the message to be displayed on the death screen
+  - `public PlayerDeathEvent->setDeathScreenMessage(Translatable|string $deathScreenMessage) : void` - sets the message to be displayed on the death screen
+  - `public PlayerDuplicateLoginEvent->getDisconnectReason() : Translatable|string` - returns the reason for the disconnection displayed in the console and server log
+  - `public PlayerDuplicateLoginEvent->getDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen (the message in `getDisconnectReason()` is used if null is returned)
+  - `public PlayerDuplicateLoginEvent->setDisconnectReason(Translatable|string $disconnectReason) : void` - sets the reason for the disconnection displayed in the console and server log
+  - `public PlayerDuplicateLoginEvent->setDisconnectScreenMessage(Translatable|string|null $disconnectScreenMessage) : void` - sets the message to be displayed on the disconnect screen (the message in `setDisconnectReason()` is used if null is passed)
+  - `public PlayerKickEvent->getDisconnectReason() : Translatable|string` - returns the reason for the disconnection displayed in the console and server log
+  - `public PlayerKickEvent->getDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen (the message in `getDisconnectReason()` is used if null is returned)
+  - `public PlayerKickEvent->setDisconnectReason(Translatable|string $disconnectReason) : void` - sets the reason for the disconnection displayed in the console and server log
+  - `public PlayerKickEvent->setDisconnectScreenMessage(Translatable|string|null $disconnectScreenMessage) : void` - sets the message to be displayed on the disconnect screen (the message in `setDisconnectReason()` is used if null is passed)
+  - `public PlayerPreLoginEvent->getDisconnectScreenMessage(int $flag) : Translatable|string|null` - returns the message to be displayed on the disconnect screen for the specified kick flag, if set
+  - `public PlayerPreLoginEvent->getFinalDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen, taking into account the kick flags set
+- The following classes have inheritance changes:
+  - `PlayerPreLoginEvent` no longer implements `Cancellable`. This caused unexpected behaviour for most plugin devs due to default-ignoring cancelled events, forcing people to usually have to use `@handleCancelled` to handle the event when they wanted to use it.
+- The following API constants have been renamed:
+  - `PlayerPreLoginEvent::KICK_REASON_BANNED` -> `PlayerPreLoginEvent::KICK_FLAG_BANNED`
+  - `PlayerPreLoginEvent::KICK_REASON_PLUGIN` -> `PlayerPreLoginEvent::KICK_FLAG_PLUGIN`
+  - `PlayerPreLoginEvent::KICK_REASON_PRIORITY` -> `PlayerPreLoginEvent::KICK_FLAG_PRIORITY`
+  - `PlayerPreLoginEvent::KICK_REASON_SERVER_FULL` -> `PlayerPreLoginEvent::KICK_FLAG_SERVER_FULL`
+  - `PlayerPreLoginEvent::KICK_REASON_SERVER_WHITELISTED` -> `PlayerPreLoginEvent::KICK_FLAG_SERVER_WHITELISTED`
+- The following API methods have been renamed:
+  - `PlayerPreLoginEvent->clearAllKickReasons()` -> `PlayerPreLoginEvent->clearAllKickFlags()`
+  - `PlayerPreLoginEvent->clearKickReason()` -> `PlayerPreLoginEvent->clearKickFlag()`
+  - `PlayerPreLoginEvent->getFinalKickMessage()` -> `PlayerPreLoginEvent->getFinalDisconnectReason()` (now used for logs only, if a disconnect screen message is set for the highest priority flag)
+  - `PlayerPreLoginEvent->getKickMessage()` -> `PlayerPreLoginEvent->getDisconnectReason()` (now used for logs only, if a disconnect screen message is set for the flag)
+  - `PlayerPreLoginEvent->getKickReasons()` -> `PlayerPreLoginEvent->getKickFlags()`
+  - `PlayerPreLoginEvent->isKickReasonSet()` -> `PlayerPreLoginEvent->isKickFlagSet()`
+  - `PlayerPreLoginEvent->setKickReason()` -> `PlayerPreLoginEvent->setKickFlag()`
+
+### `pocketmine\item`
+#### Highlights
+- `ItemFactory` has been removed. Vanilla item registration is now done via `VanillaItems`.
+  - To get an item at runtime, e.g. iron ingot, use `VanillaItems::IRON_INGOT()`
+  - To get a block as an item, e.g. stone, use `VanillaBlocks::STONE()->asItem()`
+  - To load an item from legacy ID and meta:
+    1. Use `GlobalItemDataHandlers::getUpgrader()->upgradeItemTypeDataInt()` to convert the legacy ID and meta to `SavedItemStackData`
+    2. Pass the itemstack data to `GlobalItemDataHandlers::getDeserializer()` to get an `Item` instance
+- Items no longer use internal Minecraft string IDs and metadata to identify themselves. All APIs associated with legacy
+  IDs and/or meta have been removed.
+- A new set of runtime item IDs generated from `VanillaItems` is now used to identify item types. These IDs are defined
+  in `ItemTypeIds`.
+  - These new IDs are primarily intended for type comparison purposes.
+  - Item type IDs are used at **runtime only**. They should **NOT** be stored in configs or databases, as they are not
+    guaranteed to remain the same between versions.
+- In some cases, items may have additional "type data" which provides extra type information about an item. This
+  replaces item metadata in some cases.
+  - Type data may be used to store dynamic type information such as dye colour, potion type, etc.
+  - Items must have the same type ID **and** type data in order to be stackable.
+- Blocks, when represented as items:
+  - retain their block type data, but not state data (for example, different colours of concrete don't stack, but things
+    like facing don't affect stackability)
+  - use the negative of their block type ID (e.g. a block with type ID `1` will have an item type ID of `-1`).
+- Durable items (e.g. tools, armour) now use NBT `Damage` tag to store durability (like Minecraft 1.13+), instead of
+  legacy meta values.
+- `&$returnedItems` reference parameter is now used in some places (e.g. `onInteractBlock()`) to enable actions to return items to players without caring about whether they are in creative or anything else.
+  - This eliminates boilerplate code of deciding whether to set the player's held item or not, as well as automatically dropping any overflow items that don't fit into the inventory.
+  - This is used for things like filling/emptying buckets and bottles, and equipping armor.
+- Blocks which previously had separate items, such as mob heads and beds, no longer do. Their item form can be acquired using `Block->asItem()` in the same way as every other block. This is facilitated by the new serializer system.
+
+#### Implementing new items
+##### In a plugin
+This follows a similar process to registering blocks.
+
+1. Get a new type ID using `ItemTypeIds::newId()` - _you'll want to keep this in a property somewhere if you want to
+   compare using `getTypeId()` later_
+2. Set up the item type somewhere - _this can be anywhere you like, e.g. a plugin main class property, but using
+   a `RegistryTrait` class is recommended - you'll need this later to create new instances of the item_
+3. Register a deserializer in `ItemDeserializer` - _needed for the item to be recognized when loaded from disk_
+4. Register a serializer in `ItemSerializer` - _needed for the item to be saved to disk, and to be sent over the
+   network_
+5. Optionally, register a string alias for the item in `StringToItemParser` - _so that it can be given via `/give`_
+
+To see a demo of how to do this in a plugin, see [this example plugin](https://github.com/pmmp/RegisterBlocksDemoPM5).
+
+Again, it's acknowledged this is rather more cumbersome than it should be, but this is an ongoing process.
+
+##### As a PocketMine-MP core contribution
+
+To register a new vanilla item into the core, the process is slightly different:
+
+1. Instead of using `ItemTypeIds::newId()`, add a new constant for the block to `ItemTypeIds`
+2. Register the new item in `VanillaItems`
+3. Follow steps 3 onwards from the plugin instructions above
+
+#### Change list
+- `Item` is no longer `json_encode()`-able.
+  - The original purpose of this was to allow items to be serialized to JSON for crafting data generated from `CraftingDataPacket`. Due to changes in the generation methodology, bypassing `Item`s entirely, this is no longer necessary.
+  - In addition, `jsonSerialize()` required the item to know about the method by which it will be serialized (since there is no way to inject context), creating a cyclic dependency between the `Item` implementation and its serialization method.
+  - It's relatively easy to write a replacement method to encode items to JSON as you desire.
+  - `Item::legacyJsonDeserialize()` (previously `Item::jsonDeserialize()`) is retained to allow loading legacy data, although it may be removed in the future.
+- The following classes have been removed:
+  - `Bed`
+  - `ItemFactory`
+  - `ItemIds`
+  - `Skull`
+- The following classes have been added:
+  - `BoatType` - enum of all boat types
+  - `CoralFan`
+  - `HoneyBottle`
+  - `MedicineType`
+  - `Medicine`
+  - `Spyglass`
+  - `SuspiciousStewType`
+  - `SuspiciousStew`
+- The following API methods have been added:
+  - `protected Item->describeState(RuntimeDataDescriber $w) : void` 
+  - `public Armor->clearCustomColor() : $this` - clears the custom color of an armor item
+  - `public ArmorTypeInfo->getToughness() : int`
+  - `public ArmorTypeInfo->isFireProof() : bool`
+  - `public Boat->getType() : BoatType`
+  - `public Dye->setColor(\pocketmine\block\utils\DyeColor $color) : $this`
+  - `public Item->getStateId() : int` - returns a runtime numeric state ID for comparisons including information such as coral type, dye color, etc. - DO NOT save this to disk or databases
+  - `public Item->getTypeId() : int` - returns a runtime numeric type ID for comparisons - DO NOT save this to disk or databases
+  - `public Item->isFireProof() : bool`
+  - `public ItemIdentifer->getTypeId() : int`
+  - `public Potion->setType(PotionType $type) : $this`
+  - `public SplashPotion->setType(PotionType $type) : $this`
+  - `public StringToItemParser->lookupAliases(Item $item) : list<string>` - returns a list of all registered aliases for the given item
+  - `public StringToItemParser->lookupBlockAliases(Block $block) : list<string>` - returns a list of all registered aliases for the given block
+  - `public static ItemIdentifier::fromBlock(Block $block) : self`
+- The following API methods have been removed:
+  - `Boat->getWoodType()`
+  - `Item->getId()` - for type comparisons, use `Item->getTypeId()` instead
+  - `Item->getMeta()` - use the item's specific API methods to compare information such as colour, potion type etc.
+  - `Item->hasAnyDamageValue()` - for meta wildcard recipe ingredients, use `pocketmine\crafting\MetaWildcardRecipeIngredient` instead
+  - `ItemIdentifier->getId()`
+  - `ItemIdentifier->getMeta()`
+- The following API methods have been renamed:
+  - `Item::jsonDeserialize()` -> `Item::legacyJsonDeserialize()`
+- The following API methods have signature changes:
+  - `ArmorTypeInfo->__construct()` now accepts optional parameters `int $toughness` and `bool $fireProof`
+  - `BoatType::__construct()` now accepts `BoatType $boatType` instead of `TreeType $woodType`.
+  - `Item->onAttackEntity()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onClickAir()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onDestroyBlock()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onInteractBlock()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onReleaseUsing()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `ItemIdentifier->__construct()` no longer accepts a `$variant` parameter, and now expects an item type ID for the ID parameter
+  - `LegacyStringToItemParser->addMapping()` now accepts a string for ID, instead of an integer
+- The following API methods have behaviour changes:
+  - `Item->equals()`'s `$checkDamage` parameter is now ignored, as tool damage is now stored as an NBT tag. This parameter wasn't removed due to being followed by a second `bool` parameter, which would potentially end up in the wrong place and silently cause bugs in updated plugins.
+  - `Item->equals()`'s `$checkTags` parameter will now cause tool and armor damage to be checked if true.
+- The following enums have new members:
+  - `ToolTier` has new member `NETHERITE`
+
+### `pocketmine\network`
+- The following API methods have changed signatures:
+  - `NetworkSessionManager->close()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter.
+- The following API methods have changed signatures:
+  - `query\QueryInfo->getPlayerList()` now returns `list<string>` instead of `list<Player>`
+  - `query\QueryInfo->setPlayerList()` now accepts `list<string>` instead of `list<Player>`
+
+### `pocketmine\player`
+- The following API methods have changed signatures:
+  - `Player->disconnect()` now accepts `Translatable|string` for `$reason` instead of `string` (to allow localized disconnect messages)
+  - `Player->disconnect()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter, which is the message to be displayed on the disconnect screen (the message in `$reason` is used if null is passed)
+  - `Player->kick()` now accepts `Translatable|string` for `$reason` instead of `string` (to allow localized kick messages)
+  - `Player->kick()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter, which is the message to be displayed on the disconnect screen (the message in `$reason` is used if null is passed)
+  - `Player->sendJukeboxPopup()` now accepts `Translatable|string` instead of `string, string[]`
+- The following classes have been removed:
+  - `PlayerChunkLoader` - deprecated in 4.19.0 (this was technically internal, but never marked as such)
+
+### `pocketmine\player\chat`
+- The following new classes have been added:
+  - `ChatFormatter` - interface implemented by chat formatters - this is far more powerful than the old API
+  - `LegacyRawChatFormatter` - implements the same behaviour previously used by `PlayerChatEvent->setFormat()`
+  - `StandardChatFormatter` - formats chat messages in the vanilla Minecraft style
+
+### `pocketmine\scheduler`
+- `AsyncTask->setResult()` now works with thread-safe objects. This was previously not possible due to limitations in the `pthreads` extension.
+
+### `pocketmine\world`
+- The following API methods have been added:
+  - `public World->setDisplayName(string $name) : void`
+- The following API methods have changed signatures:
+  - `Explosion->__construct()` has the `$size` parameter renamed to `$radius`
+- The following public properties have been renamed:
+  - `Explosion->size` -> `Explosion->radius`
+
+### `pocketmine\world\format`
+- Chunks are now considered dirty (modified) by default, unless loaded from a `WorldProvider` by `World`. Previously, chunks were considered unmodified by default, which allowed several pathways to bugs.
+- The following classes have been added:
+  - `io\GlobalBlockStateHandlers` - gives access to block data serializer, deserializer, and upgraders
+  - `io\GlobalItemDataHandlers` - gives access to item data serializer, deserializer, and upgraders
+  - `io\LoadedChunkData` - represents a chunk loaded from disk, along with information such as whether the chunk was upgraded and what fixes it requires
+- The following new API methods have been added:
+  - `public SubChunk->getBiomeArray() : PalettedBlockArray`
+- The following classes have been removed:
+  - `BiomeArray` - `PalettedBlockArray` is now used for 3D biome data
+- The following API methods have changed signatures:
+  - `Chunk->getBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `Chunk->setBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `Chunk->__construct()` no longer accepts `BiomeArray` as a parameter (contained in each subchunk instead)
+  - `SubChunk->__construct()` now accepts `int $emptyBlockId, list<PalettedBlockArray> $blockLayers, PalettedBlockArray $biomes, ?LightArray $blockLight, ?LightArray $skyLight` instead of `int, list<PalettedBlockArray>, ?LightArray, ?LightArray`
+  - `io\WorldProvider->loadChunk()` now returns `LoadedChunkData` instead of `ChunkData`
+  - `io\WorldProvider->getAllChunks()` now yields `LoadedChunkData` instead of `ChunkData`
+  - `io\ChunkData->__construct()` now accepts `array<int, SubChunk>, bool $populated` instead of `Chunk $chunk`
+- The following API methods have been renamed:
+  - `Chunk->getFullBlock()` -> `Chunk->getBlockStateId()`
+  - `Chunk->setFullBlock()` -> `Chunk->setBlockStateId()`
+  - `SubChunk->getFullBlock()` -> `SubChunk->getBlockStateId()`
+  - `SubChunk->setFullBlock()` -> `SubChunk->setBlockStateId()`
+- The following API interface requirements have been added:
+  - `public io\data\WorldData->setDisplayName(string $value) : void`
+
+### `pocketmine\world\generator\object`
+- The following API methods have been removed:
+  - `TreeType::fromMagicNumber()`
+  - `TreeType->getMagicNumber()`
+
+### `pocketmine\world\sound`
+- The following classes have been added:
+  - `CopperWaxApplySound`
+  - `CopperWaxRemoveSound`
+  - `DyeUseSound`
+  - `InkSacUseSound`
+- The following enums have new members:
+  - `NoteInstrument` has new members `BELL`, `FLUTE`, `CHIME`, `XYLOPHONE`, `IRON_XYLOPHONE`, `COW_BELL`, `DIDGERIDOO`, `BIT`, `BANJO`, `PLING`
+- The following API methods have been removed:
+  - `NoteInstrument::fromMagicNumber()`
+  - `NoteInstrument->getMagicNumber()`
+
+## Internals
+- All external usages of `KnownTranslationKeys` are now removed. All localized messages are now sent using `Translatable` objects (usually from `KnownTranslationFactory`).
+- All usages of NBT keys now use class constants instead of hardcoded strings (except for an occasional overlooked one).
+- Built-in commands now declare their names inside the class constructor, rather than accepting them as parameters. This improves code consistency.
+- Commands now use an array for permissions internally, instead of a string separated by `;`.
+- Make use of `Item->canStackWith()` instead of `Item->equals()` wherever possible, to make the code more readable.
+- Moved command timings to `Timings`.
+- Overriding of serializers and deserializers of items and blocks is now consistently disallowed. Since overriding stuff is non-cooperative, it doesn't make any sense in plugins, which must coexist with other plugins. If you want to modify the functionality of built-in stuff, you have several alternative options:
+    - Use existing API (e.g. events, API methods) - most uses of overrides in PM4 and earlier were abuses that could have been done with events
+    - Submit feature proposals or pull requests for new API to be added (e.g. new events)
+    - Register completely custom items, and reuse behaviour from the item you want to mimic
+    - Fork PocketMine-MP and alter the code directly - this way your plugins aren't pretending to be cooperative with other plugins
+- `level.dat`, block, item, entity, tile and chunk data are now tagged with a version ID as per `VersionInfo::WORLD_DATA_VERSION`. This allows the server to apply fixes to older worlds if necessary.
+- Protocol creative inventory entries are now cached in `CreativeInventoryCache` to improve performance of initial join and game mode changes.
+- Singletons in the `pocketmine\network\mcpe\convert` package have been centralized under `TypeConverter`. In the future, this will be injected where needed, allowing different converters to be used for different sessions (useful for multiversion).
+- `BlockStateDictionary` memory usage is now reduced from 9 MB to 3.5 MB using various techniques, including string reuse and binary-encoded states.
+- `NetworkSession` disconnect APIs now accept `Translatable|string` instead of `string` to allow localized disconnect messages.
+- `NetworkSession` disconnect methods have been altered to allow specifying a different disconnect reason and disconnection screen message.
+- `RuntimeBlockMapping` has been renamed to `BlockTranslator`.
+
+# 5.0.1
+Released 3rd June 2023.
+
+## Changes
+- [`ext-pmmpthread` version 6.0.1](https://github.com/pmmp/ext-pmmpthread/releases/tag/6.0.1) is now required (for bug fixes).
+
+## Fixes
+- Fixed server crash when breaking blocks placed in the same session (mishandled default block states).
+- Fixed spore blossoms not dropping when broken.
+- Fixed jukebox music not stopping when destroyed by an explosion.
+
+## Documentation
+- Added documentation for `BlockSpreadEvent->__construct()` parameters.

changelogs/5.1.md

@@ -0,0 +1,52 @@
+# 5.1.0
+Released 7th June 2023.
+
+**For Minecraft: Bedrock Edition 1.20.0**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.0.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.0.
+- Removed support for older versions.
+
+# 5.1.1
+Released 7th June 2023.
+
+## Fixes
+- Fixed blockstates being saved with the wrong version ID for 1.20.0.
+
+# 5.1.2
+Released 9th June 2023.
+
+**This release includes changes from the following releases:**
+- [4.22.1](https://github.com/pmmp/PocketMine-MP/blob/4.22.1/changelogs/4.22.md#4221) - Teleportation client bug workarounds
+
+This release contains no other changes.
+
+# 5.1.3
+Released 1st July 2023.
+
+**This release includes changes from the following releases:**
+- [4.22.2](https://github.com/pmmp/PocketMine-MP/blob/4.22.2/changelogs/4.22.md#4222) - Authentication time bomb fix
+
+## General
+- Updated logos to new RGB-style logo. Thanks to @MrCakeSlayer and @HBIDamian for their efforts.
+- Improved error messages generated by the world system when some version tags are missing from `level.dat` in Bedrock worlds.
+- Outsourced Composer dependencies now only receive patch updates automatically (pinned using the `~` constraint).
+  - Minor and major updates now require manually updating `composer.json`, to ensure that the plugin API is not broken by libraries getting randomly updated from one patch release to the next.
+
+## Documentation
+- Updated doc comment for `Player->setGamemode()` to remove outdated information.
+- Added documentation for the `$clickVector` parameter of `Block->onInteract()` to specify that it is relative to the block's position.
+- Added missing `@required` tag for `BlockStateUpgradeSchemaModelBlockRemap->newState`.
+
+## Fixes
+- Fixed blue candles not appearing in the creative inventory.
+- Fixed server crash when block-picking candle cakes.
+- `World->useItemOn()` now ensures that the `$clickVector` components are always in the range of 0-1. Previously, any invalid values were accepted, potentially leading to a crash.

changelogs/5.10.md

@@ -0,0 +1,46 @@
+# 5.10.0
+Released 14th December 2023.
+
+**For Minecraft: Bedrock Edition 1.20.50**
+
+This is a minor feature release, including new gameplay features and minor performance improvements.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- PHP 8.2 is now used by default. PHP 8.1 is still supported, but will be removed in a future 5.x release.
+- Improved timings reports by removing `Breakdown` timings group. This group serves no purpose with tree timings and made for confusing reading.
+
+## Performance
+- Improved performance of `Block::encodeFullState()` in most conditions. This in turn improves performance of `World::setBlock()` and `World::setBlockAt()`.
+- Improved network compression performance by avoiding unnecessary object allocations.
+- Timings now report time spent in individual `Snooze` handlers, making it easier to debug performance issues.
+
+## Gameplay
+### Blocks
+- Implemented crop growth speed modifiers.
+  - The following things now positively affect crop growth speed:
+    - Being planted on or being adjacent to farmland (hydrated farmland offers a larger benefit than dry farmland)
+    - Potential light level of at least 9
+    - Being planted in rows with space between them (or a different type of crop)
+  - The following things now negatively affect crop growth speed:
+    - Improper arrangement (e.g. the same crop on all sides)
+    - Insufficient light level (below 9)
+  - Poorly arranged crops will grow slower in this version. Past versions behaved as if crops were always planted in ideal conditions.
+  - Crops planted in ideal conditions will grow at the same speed as before.
+
+### Items
+- Added the following new items:
+  - All types of Smithing Template
+- Pitcher Pod is now correctly registered. In previous versions, it was mapped to the Pitcher Crop block, causing incorrect name display in commands.
+
+## Internals
+- Cleaned up various getter usages where direct property access is possible.
+- Avoided unnecessary repeated getter calls in some loops.
+- `NetworkSession` may now track `string` instead of `CompressBatchPromise` when a batch was synchronously compressed. This significantly reduces object allocations and improves performance.
+- `NetworkSession` now sends less information to clients on login validation failure. This avoids leaking potentially sensitive error information to clients.
+  - Clients can correlate their disconnects with server-side logs using the `Error ID` shown on the disconnect screen.

changelogs/5.11.md

@@ -0,0 +1,45 @@
+# 5.11.0
+Released 7th February 2024.
+
+**For Minecraft: Bedrock Edition 1.20.60**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.60.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.60.
+- Removed support for earlier versions.
+
+## Fixes
+- Fixed `tools/generate-item-upgrade-schema.php` not correctly handling items whose IDs were changed multiple times.
+- Fixed `ServerKiller` not working correctly in some cases (incorrectly handled wake-up conditions).
+- `ItemBlock`s of `Air` blocks are now always considered as "null" items regardless of count, and don't occupy inventory slots.
+
+## Internals
+- Restructured GitHub Actions CI workflows to make them easier to maintain (no need to update PHP versions in multiple places anymore).
+- GitHub Actions CodeStyle workflow now uses php-cs-fixer 3.49.x.
+- Dependabot updates are now processed weekly instead of daily.
+
+# 5.11.1
+Released 23rd February 2024.
+
+## Fixes
+- Fixed subchunk count calculation in `ChunkSerializer` for non-overworld dimension (useful for dimension plugins).
+- Harden options used for processing JSON data, particularly on the network, to close security issues.
+
+## Documentation
+- Fixed PHPStan signature for `Utils::cloneObjectArray()`.
+
+## Internals
+- Updated GitHub Actions versions to get rid of deprecation warnings.
+
+# 5.11.2
+Released 26th February 2024.
+
+## Fixes
+- Added extra checks for `BookEditPacket` handling.

changelogs/5.12.md

@@ -0,0 +1,63 @@
+# 5.12.0
+Released 28th February 2024
+
+**For Minecraft: Bedrock Edition 1.20.60**
+
+This is a minor feature release, with a few new features and improvements.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added a `--version` command-line option to display the server version and exit.
+
+## Tools
+- Added `tools/generate-biome-ids.php` to generate `pocketmine\data\bedrock\BiomeIds`.
+- Fixed ordering of property values generated by `tools/generate-block-palette-spec.php`.
+
+## API
+### `pocketmine\block`
+- The following new classes have been added:
+  - `utils\LightableTrait` - used by blocks with `getLit()` and `setLit()` methods
+- The following methods have been deprecated:
+  - `Block->isSolid()` - this method returns confusing results which don't match expectations and no one really knows what it actually means
+- `CocoaBlock` now extends `Flowable` to match vanilla Minecraft behaviour.
+
+### `pocketmine\plugin`
+- `PluginManager->registerEvent()` now throws an exception when given a generator function for the event handler.
+- `PluginManager->registerEvents()` now throws an exception if any of the detected event handlers are generator functions. Use `@notHandler` to have the function ignored if intended.
+
+### `pocketmine\promise`
+- The following methods have been added:
+  - `public static Promise::all(list<Promise> $promises) : Promise` - returns a promise that is resolved once all given promises are resolved, or is rejected if any of the promises are rejected.
+
+### `pocketmine\scheduler`
+- The following methods have been deprecated:
+  - `AsyncWorker->getFromThreadStore()` - use class static properties for thread-local storage
+  - `AsyncWorker->removeFromThreadStore()`
+  - `AsyncWorker->saveToThreadStore()`
+
+## Documentation
+- Improved documentation of various methods in `Block`.
+
+## Gameplay
+- The following new items have been added:
+  - Name Tag
+
+## Internals
+- Removed specialization of shutdown logic for `Thread` vs `Worker` (no specialization is required).
+- Authentication system no longer accepts logins signed with the old Mojang root public key.
+- ID to enum mappings in `pocketmine\data` now use a new `match` convention to allow static analysis to ensure that all enum cases are handled.
+- Updated version of `pocketmine/bedrock-protocol` allows avoiding decoding of some itemstack data from the client in most cases, improving performance.
+
+# 5.12.1
+Released 13th March 2024.
+
+## Fixes
+- Fixed `Player Network Receive - Decompression` timings not being stopped correctly when receiving an uncompressed packet.
+
+## Internals
+- Removed hardcoded batch packet size limit. This was already covered by other limits anyway.

changelogs/5.13.md

@@ -0,0 +1,16 @@
+# 5.13.0
+Released 13th March 2024.
+
+**For Minecraft: Bedrock Edition 1.20.70**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.70.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.70.
+- Removed support for earlier versions.

changelogs/5.14.md

@@ -0,0 +1,94 @@
+# 5.14.0
+Released 5th April 2024.
+
+**For Minecraft: Bedrock Edition 1.20.70**
+
+This is a minor feature release, including performance improvements, minor gameplay features, new API features, and various internal improvements.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for a `--no-log-file` command-line option, which disables the creation of a `server.log` file.
+  - **Use this with caution.** If you don't have another mechanism for collecting logs (e.g. Docker), this may make debugging harder.
+- Added support for automatic `server.log` rotation. When the `server.log` exceeds 32 MB, it will be renamed and moved to the `log_archive` folder in the server's data directory.
+  - Files in the `log_archive` folder can be safely modified or deleted without stopping the server.
+  - We suggest a cron job or similar to manage old log files (e.g. deleting or compressing them).
+- Added a new cache mechanism for `PocketMine-MP.phar`. This has several advantages:
+  - Caches are now reused by all threads - this significantly reduces `/tmp` usage (previously every thread generated its own cache, wasting lots of space)
+  - Dead cache files are automatically cleaned up by new servers - this means that a server crash loop won't flood `/tmp` anymore
+- `/status` now reports a more accurate number of threads on Windows.
+- Large resource packs are now able to be properly downloaded from the server.
+- Larger player skin sizes are now accepted by the server.
+- Improved logging from world providers to reduce spam when chunks contain invalid data.
+- Added more error logging for Anvil, PMAnvil and MCRegion worlds.
+- PHP deprecation warnings no longer cause the server to crash. This should make it easier for server owners to update to newer PHP versions.
+
+## Performance
+- Improved world loading performance. This was achieved through a combination of changes:
+  - Improvements to `BlockStateUpgrader` to avoid unnecessary work
+  - Improvements to `BlockStateUpgradeSchema` to clean up stupid code
+  - Improvements to `BlockStateReader` unused state handling
+  - Optimizations to `RegistryTrait` (see below)
+- Improved performance of `RegistryTrait::__callStatic()` accessor by introducing a fast-path optimization. Ensure that you access registries with the correct function name case to benefit from this.
+  - This improves the performance of `VanillaBlocks::WHATEVER()`, `VanillaItems`, etc.
+
+## Tools
+- `tools/generate-blockstate-upgrade-schema.php` now supports generating schemas using `flattenedValueRemaps` (described in [BlockStateUpgradeSchema](https://github.com/pmmp/BedrockBlockUpgradeSchema/releases/tag/4.0.0)).
+
+## Gameplay
+- Added sounds for armour equipping and unequipping.
+- Added sound for picking berries from a sweet berry bush.
+
+## API
+### `pocketmine\block\utils`
+- The following enum cases have been added:
+  - `BannerPatternType::GLOBE`
+  - `BannerPatternType::PIGLIN`
+
+### `pocketmine\event\player`
+- The following classes have been added:
+  - `PlayerResourcePackOfferEvent` - called before the server tells a connecting client which resource packs are available to download - allows customizing the pack list and other options
+
+### `pocketmine\item`
+- The following API methods have been added:
+  - `public ArmorMaterial->getEquipSound() : ?\pocketmine\world\Sound` - returns the sound to play when this armour is equipped or unequipped
+- The following API methods have signature changes:
+  - `ArmorMaterial->__construct()` now accepts an optional `?Sound $equipSound` parameter
+
+### `pocketmine\utils`
+- The following API methods have signature changes:
+  - `MainLogger->__construct()` now accepts `null` for the `$logFile` parameter - this disables the creation of a logger thread and log file
+  - `MainLogger->__construct()` now accepts an optional `?string $logArchiveDir` parameter. If set, this enables log archiving in the specified directory when the current log file exceeds 32 MB.
+
+## Dependencies
+- Now uses [`pocketmine/bedrock-block-upgrade-schema` version 4.0.0](https://github.com/pmmp/BedrockBlockUpgradeSchema/releases/tag/4.0.0).
+- Now uses [`pmmp/ext-pmmpthread` version 6.1.0](https://github.com/pmmp/ext-pmmpthread/releases/tag/6.1.0).
+- Now uses [`pocketmine/errorhandler` version 0.7.0](https://github.com/pmmp/ErrorHandler/releases/tag/0.7.0).
+- Now uses [`pocketmine/raklib` version 1.1.0](https://github.com/pmmp/RakLib/releases/tag/1.1.0).
+- Now uses [`pocketmine/raklib-ipc` version 1.0.0](https://github.com/pmmp/RakLibIpc/releases/tag/1.0.0).
+
+## Internals
+- (Re)Added support for RakLib packet ACK receipts. This was used to throttle resource pack sending and prevent network overloading.
+  - Added `NetworkSession->sendDataPacketWithReceipt()` to make use of this feature.
+  - `PacketSender` now requires an additional `?int $receiptId` parameter.
+- `ResourcePackPacketHandler` now uses `sendDataPacketWithReceipt()` to send resource packs, and delays sending the next chunk until the current one is acknowledged.
+- `ResourcePackPacketHandler` now accepts resource pack info directly in the constructor, instead of `ResourcePackManager`. This eases the implementation of `PlayerResourcePackOfferEvent`.
+- Increased `ZlibCompressor::DEFAULT_MAX_DECOMPRESSION_SIZE` to 8 MB (previously 2 MB). While this weakens server security, it appears to be necessary to deal with extremely bloated Persona skins.
+- Increased max split packet parts accepted by `RakLib` to 512 (previously 128). Again, this is necessary to deal with extremely bloated Persona skins.
+- Added a new cache mechanism for `PocketMine-MP.phar`.
+  - `ext-phar`'s default mechanism is extremely wasteful (generating a separate cache file per thread), and doesn't clean up after itself.
+  - The new cache mechanism is shared between all threads, and automatically cleans up stale caches.
+  - The phar stub (`build/server-phar-stub.php`) now converts the phar contents into a `.tar`, and decompresses all the files into `$TMPDIR/PocketMine-MP-phar-cache.<random>/`.
+  - `phar://` URIs still work with this system, but `new Phar(__FILE__)` must be replaced by `new PharData(__FILE__)` within PocketMine-MP core code.
+  - Backtraces from a `phar`'d server will now point to a location in the extracted phar cache, rather than the phar itself.
+- `block_factory_consistency_check` test (actually for `RuntimeBlockStateRegistry`) now stores less data, and is no longer affected by changes to internal state ID construction.
+
+# 5.14.1
+Released 5th April 2024.
+
+## Fixes
+- Fixed incorrect `pmmpthread` version check in server bootstrap.

changelogs/5.15.md

@@ -0,0 +1,16 @@
+# 5.15.0
+Released 25th April 2024.
+
+**For Minecraft: Bedrock Edition 1.20.80**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.80.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.80.
+- Removed support for earlier versions.

changelogs/5.16.md

@@ -0,0 +1,26 @@
+# 5.16.0
+Released 13th June 2024.
+
+**For Minecraft: Bedrock Edition 1.21.0**
+
+This is a support release for Minecraft: Bedrock Edition 1.21.0.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.21.0.
+- Removed support for earlier versions.
+- Generated permission docs are now included with every release.
+- Crash throttle message (which appears when the server crashed after being up for less than 120 seconds) now shows the server uptime as well as the wait time. This should make it clearer how the wait time is decided.
+
+## Tools
+- Added `install-local-protocol.sh` script. This allows installing local copies of protocol dependencies without needing to create releases. Useful for integration testing when doing protocol updates.
+
+## Fixes
+- Attacking an entity with a higher damage weapon while it's on attack cooldown from a lower damage weapon (switching) no longer causes additional knockback to the victim.
+- Wooden stairs can now be used as fuel in furnaces.
+- Fixed incorrect description of the permission `pocketmine.command.save.perform`.

changelogs/5.17.md

@@ -0,0 +1,38 @@
+# 5.17.0
+Released 10th July 2024.
+
+**For Minecraft: Bedrock Edition 1.21.2**
+
+This is a support release for Minecraft: Bedrock Edition 1.21.2.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.21.2.
+- Removed support for earlier versions.
+
+## API
+### `pocketmine\player`
+- The following methods have been added:
+  - `public function closeAllForms() : void` - closes the current viewing form and forms in queue.
+
+## Fixes
+- Bowl can now be used as fuel.
+- Bells always drops themselves even when using an incompatible tool.
+
+# 5.17.1
+Released 13th August 2024.
+
+## Documentation
+- Added a note about `BlockStateData::CURRENT_VERSION`.
+
+## Fixes
+- Fixed anvil placement rotation to match vanilla.
+- Fixed outdated `BedrockWorldData` version, this was preventing use newer worlds.
+
+## Internals
+- Dependabot: PHPStan and patch updates are now grouped into a single PR.

changelogs/5.2.md

@@ -0,0 +1,79 @@
+# 5.2.0
+Released 4th July 2023.
+
+**For Minecraft: Bedrock Edition 1.20.0**
+
+This is a minor technical update, including changes to AsyncTask error handling and support for BedrockBlockUpgradeSchema version 3.0.0.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## Core
+- [BedrockBlockUpgradeSchema version 3.0.0](https://github.com/pmmp/BedrockBlockUpgradeSchema/releases/tag/3.0.0) is now supported.
+- [`ext-pmmpthread` version 6.0.4](https://github.com/pmmp/ext-pmmpthread/releases/tag/6.0.4) is now required (bug fixes required to support technical changes in this release).
+
+## Performance
+- Improved performance of `AsyncPool->submitTask()` and `AsyncPool->submitTaskToWorker()`.
+- Added new timings for `AsyncTask->onProgressUpdate()` and `AsyncTask->onCompletion()`.
+
+## Gameplay
+### Blocks
+- Added the following new blocks:
+  - Cherry Button
+  - Cherry Door
+  - Cherry Fence
+  - Cherry Fence Gate
+  - Cherry Leaves
+  - Cherry Log
+  - Cherry Planks
+  - Cherry Pressure Plate
+  - Cherry Sign
+  - Cherry Slab
+  - Cherry Stairs
+  - Cherry Trapdoor
+  - Cherry Wood
+  - Glow Lichen
+  - Piglin Head
+
+## Tools
+- `generate-block-upgrade-schema.php` now supports generating schemas a la BedrockBlockUpgradeSchema version 3.0.0, using `newFlattenedName` to reduce schema size.
+- Improved property remapping detection in `generate-block-upgrade-schema.php`. It now detects related properties with more confidence (even when multiple properties were change), and no longer considers unrelated properties as mapped (e.g. `mapped_type` and `deprecated` in 1.9->1.10).
+
+## API
+### `pocketmine\data\bedrock\block`
+- The following new API methods have been added:
+  - `public BlockStateData->toVanillaNbt() : CompoundTag` - returns the NBT for the blockstate without any PMMP extra metadata (`toNbt()` will normally include a `PMMPDataVersion` tag).
+
+### `pocketmine\data\runtime`
+- The following new API methods have been added:
+  - `public RuntimeDataDescriber->facingFlags(list<int> $faces) : void`
+
+### `pocketmine\scheduler`
+- `AsyncTask->onRun()` no longer tolerates uncaught exceptions.
+  - This means that any uncaught exceptions thrown from `AsyncTask->onRun()` will now crash the worker thread, and by extension, the server.
+  - This change makes it easier to debug errors by detecting them earlier.
+- The following API methods have been deprecated:
+  - `AsyncTask->onError()`
+
+## Internals
+- `AsyncTask->progressUpdates` is now lazily initialized when a task publishes a progress update.
+  - This was previously not possible due to technical limitations of the `ext-pmmpthread` extension.
+  - This change improves performance of `AsyncPool->submitTask()` and `AsyncPool->submitTaskToWorker()`, as well as reducing the amount of work needed to check for progress updates on tick.
+- Errors in `AsyncWorker` now cascade and crash the whole server.
+  - This makes it easier to debug errors by detecting them earlier.
+  - This includes all types of unexpected errors, such as OOM, uncaught exceptions, etc.
+  - This change is not expected to affect normal server operation, as worker threads are not expected to crash under normal circumstances.
+- `AsyncTask::$threadLocalStorage` now uses a plain `array` instead of `ArrayObject`. The `ArrayObject` was a workaround for `ext-pthreads` to prevent thread-locals getting copied to the worker thread, and is no longer necessary.
+- Regenerated `pocketmine\data\bedrock\item\ItemTypeNames` for Bedrock 1.20 (BC breaking, some item names have changed).
+- Fixed `build/generate-item-type-names.php` not including some newer blockitems, such as doors and hanging signs.
+
+# 5.2.1
+Released 11th July 2023.
+
+**This release includes changes from the following releases:**
+- [4.22.3](https://github.com/pmmp/PocketMine-MP/blob/4.22.3/changelogs/4.22.md#4223) - Fixes for some crash issues
+
+This release contains no other changes.

changelogs/5.3.md

@@ -0,0 +1,81 @@
+# 5.3.0
+Released 12th July 2023.
+
+**For Minecraft: Bedrock Edition 1.20.10**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.10.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## Interim releases
+If you're upgrading directly from 5.1.x to 5.3.x, please also read the following changelogs, as the interim releases contain important changes:
+- [5.2.0](https://github.com/pmmp/PocketMine-MP/blob/5.2.0/changelogs/5.2.md#520)
+
+## Included releases
+**This release includes changes from the following releases:**
+- [4.23.0](https://github.com/pmmp/PocketMine-MP/blob/4.23.0/changelogs/4.23.md#4230) - Support for Minecraft: Bedrock Edition 1.20.10
+
+## Internals
+- `BlockTypeNames`, `BlockStateNames`, `BlockStateStringValues` and `ItemTypeNames` in the `pocketmine\data\bedrock` package have BC-breaking changes to accommodate Bedrock 1.20.10.
+
+# 5.3.1
+Released 14th July 2023.
+
+## Included releases
+**This release includes changes from the following releases:**
+- [4.23.1](https://github.com/pmmp/PocketMine-MP/blob/4.23.1/changelogs/4.23.md#4231) - Security fixes
+
+## General
+- Updated `build/php` submodule to pmmp/PHP-Binaries@e0c918d1379465964acefd562d9e48f87cfc2c9e.
+
+# 5.3.2
+Released 18th July 2023.
+
+## Included releases
+**This release includes changes from the following releases:**
+- [4.23.2](https://github.com/pmmp/PocketMine-MP/blob/4.23.2/changelogs/4.23.md#4232) - Fix for `sandboxId`-related login errors
+
+## Documentation
+- Fixed documentation error in `StringToTParser`.
+
+## Fixes
+- Fixed turtle helmet not being able to be unequipped.
+
+## Internals
+- Armor pieces are no longer set back into the armor inventory if no change was made. This reduces the number of slot updates sent to clients, as well as avoiding unnecessary updates for armor pieces which have Unbreaking enchantments.
+
+# 5.3.3
+Released 24th July 2023.
+
+## Included releases
+**This release includes changes from the following releases:**
+- [4.23.3](https://github.com/pmmp/PocketMine-MP/blob/4.23.3/changelogs/4.23.md#4233) - Various bug fixes
+
+## Fixes
+- Added a workaround for PM4 worlds with chunks corrupted by [Refaltor77/CustomItemAPI](https://github.com/Refaltor77/CustomItemAPI).
+  - While this was not the fault of PocketMine-MP itself, a significant number of users were affected by this problem.
+  - This error was not detected by PM4 due to missing validation of certain data which should not have existed in 1.12.
+  - An error will now be logged when this corruption is detected, but the affected chunks should otherwise load normally.
+- Relaxed validation of expected 3D biome array counts per chunk in LevelDB worlds.
+  - Vanilla Bedrock currently saves 24 palettes (and only 24 are required), but it saved 25, 32, or 64 biome palettes per chunk in older versions.
+  - Core validation for these padding biomes was very strict, enforcing exact compliance with vanilla.
+  - Since only 24 palettes are actually required, the remaining palettes may now be omitted irrespective of the chunk version.
+  - An error will still be logged when this mistake is detected, but the affected chunks will otherwise load normally.
+- Fixed `/kill` not working on players who had (re)spawned in the 3 seconds immediately after (re)spawning (due to `noDamageTicks`).
+- Fixed `/kill` not working correctly for players with high levels of Health Boost or other health-altering effects.
+- Fixed netherite items being destroyed by lava.
+- Fireproof entities no longer display the burning animation when in fire or lava. This does not apply to creative players, who are immortal rather than being fireproof.
+- Fixed frosted ice melting in certain conditions which didn't match vanilla Bedrock.
+
+# 5.3.4
+Released 1st August 2023.
+
+## Included releases
+This release includes changes from the following releases:
+- [4.23.4](https://github.com/pmmp/PocketMine-MP/blob/4.23.4/changelogs/4.23.md#4234) - Item entity lag fix
+
+This release contains no other significant changes.

changelogs/5.4.md

@@ -0,0 +1,133 @@
+# 5.4.0
+Released 1st August 2023.
+
+**For Minecraft: Bedrock Edition 1.20.10**
+
+This is a minor feature update, including a handful of new gameplay features, new plugin APIs and improvements to error reporting.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Improved error reporting for async task and thread crashes.
+- Players may now have different creative inventories.
+
+## Gameplay
+### General
+- Added support for 1.5-block height sneaking.
+- Fixed missing player arm swing and sounds when punching the air.
+
+### Blocks
+- Implemented the following new blocks:
+  - Big Dripleaf Head
+  - Big Dripleaf Stem
+  - Small Dripleaf
+- Acacia saplings now grow into acacia trees.
+- Fixed melon and pumpkin stems not attaching to the correct block when growing.
+- Various blocks now drop more items when mined with a compatible tool enchanted with Fortune.
+
+### Items
+- Implemented Strong Slowness potion.
+- Implemented Fortune enchantment.
+
+## API
+### `pocketmine\block`
+- The following new classes have been added:
+  - `utils\FortuneDropHelper` - utility methods for calculating the drop counts for Fortune-affected blocks
+- The following new API methods have been added:
+  - `protected Block->getAdjacentSupportType(int $facing) : utils\SupportType` - returns the type of support provided by the block in the given direction on the adjacent face
+
+### `pocketmine\entity`
+- The following new API constants have been added:
+  - `Living::DEFAULT_KNOCKBACK_FORCE`
+  - `Living::DEFAULT_KNOCKBACK_VERTICAL_LIMIT`
+
+### `pocketmine\entity\animation`
+- `ConsumingItemAnimation` now accepts `Living` instances instead of just `Human`.
+
+### `pocketmine\event`
+- The following new classes have been added:
+  - `PlayerMissSwingEvent` - called when the player attempts the attack action (left click on desktop) without any target
+    - This is possible thanks to the introduction of new flags in `PlayerAuthInputPacket` in Bedrock 1.20.10
+- The following new API methods have been added:
+  - `public EntityDamageByEntityEvent->getVerticalKnockBackLimit() : float`
+  - `public EntityDamageByEntityEvent->setVerticalKnockBackLimit(float $verticalKnockBackLimit) : void` - sets the max vertical velocity that can result from the victim being knocked back
+
+### `pocketmine\player`
+- The following new API methods have been added:
+  - `public Player->getCreativeInventory() : pocketmine\inventory\CreativeInventory`
+  - `public Player->setCreativeInventory(pocketmine\inventory\CreativeInventory $inventory) : void`
+  - `public Player->missSwing() : void` - performs actions associated with the attack action when there is no target (see `PlayerMissSwingEvent`)
+
+### `pocketmine\scheduler`
+- Cancellation functionality has been removed from `AsyncTask`, as it didn't make any sense and wasn't used by anything for what it was intended for.
+  - It broke sequential task execution - later tasks might depend on state from earlier tasks
+  - It didn't actually cancel the task anyway - at best, it prevented it from running, but couldn't interrupt it (though interrupting a task does not make sense either)
+- The following API methods have been deprecated, and their functionality has been removed:
+  - `AsyncTask->hasCancelledRun()`
+  - `AsyncTask->cancelRun()`
+
+## Internals
+- Uncaught exceptions and fatal errors in `AsyncTask`, threads extending `pocketmine\thread\Thread`, and `pocketmine\thread\Worker` are now recorded in crashdumps, making it significantly easier to debug errors in these areas.
+- JWT signature DER <-> raw conversions are now handled in-house using code in `JwtUtils`
+  - Due to the simplicity of the conversion and only requiring a tiny subset of the ASN.1 spec, it didn't make much sense to introduce another dependency.
+  - `fgrosse/phpasn1` is no longer required. This package was abandoned by its author and only used by PocketMine-MP for this one purpose.
+- Various usages of `Closure::fromCallable()` have been replaced by PHP 8.1 first-class callable syntax.
+- Blocks requiring support shifted to a "can be supported at" model, rather than "can be supported by".
+  - This model reduces repeated logic when placing and performing nearby block updates (no need to hardcode facing everywhere).
+  - In addition, this change facilitates the use of the newly introduced `Block->getAdjacentSupportType()` API method, reducing boilerplate support-type checking code.
+- Bell block code has been simplified and cleaned up.
+- `TallGrass` and `DoubleTallGrass` now use a shared `TallGrassTrait` to reduce code duplication.
+
+# 5.4.1
+Released 8th August 2023.
+
+## General
+- Updated translation data to [pmmp/Language 2.19.6](https://github.com/pmmp/Language/releases/tag/2.19.6).
+- [`ext-pmmpthread` 6.0.7](https://github.com/pmmp/ext-pmmpthread/releases/tag/6.0.7) is now required (needed for bug fixes).
+
+## Fixes
+- Fixed Podzol not dropping itself when mined with Silk Touch.
+- Fixed `World->getSafeSpawn()` not accepting positions below `y=0` (world height limit change).
+- Fixed `pocketmine\thread\Thread` and `pocketmine\thread\Worker` instances not logging any information when they crash.
+- Fixed `CraftItemEvent` not cloning returned items.
+
+## Internals
+- Foreach by-reference is now disallowed via a custom PHPStan rule.
+
+# 5.4.2
+Released 9th August 2023.
+
+## Included releases
+- [4.23.5](https://github.com/pmmp/PocketMine-MP/blob/4.23.5/changelogs/4.23.md#4235) - Minor bug fixes
+
+## Fixes
+- Fixed cake accepting candle placement when slices have already been eaten.
+- Fixed fire charges not lighting candles.
+
+# 5.4.3
+Released 21st August 2023.
+
+## Included releases
+- [4.23.6](https://github.com/pmmp/PocketMine-MP/blob/4.23.6/changelogs/4.23.md#4236) - Armor inventory client bug workaround
+
+## Fixes
+- Fixed crashdumps not generating correctly on fatal errors.
+- Fixed `PotionCauldron::setPotionItem()` not validating the item type.
+- Fixed chorus fruit not considering teleport destinations below y=0.
+- Fixed cake dropping itself when mined.
+
+# 5.4.4
+Released 6th September 2023.
+
+## General
+- Crashdumps caused by non-phar plugins are now submitted to the Crash Archive, the same as other plugins. Previously, non-phar plugin crashes would not be submitted, causing maintainers to potentially miss important issues.
+
+## Fixes
+- Fixed player Y coordinates sometimes being slightly below the top of the block they were standing on (floating point error due to subtracting eye height).
+- Fixed template slot of smithing tables not accepting any items.
+- `tools/generate-bedrock-data-from-packets.php` is now significantly less spammy when warning about duplicated recipes.
+- Fixed empty stack traces in `lastError` data of crashdumps.

changelogs/5.5-beta.md

@@ -0,0 +1,156 @@
+# 5.5.0-BETA1
+Released 23rd August 2023.
+
+**For Minecraft: Bedrock Edition 1.20.10**
+
+This is a minor feature release, including performance improvements, new API methods, and new gameplay features.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## Dependencies
+- Updated `pocketmine/math` dependency to [`1.0.0`](https://github.com/pmmp/Math/releases/tag/1.0.0).
+- Updated `pocketmine/nbt` dependency to [`1.0.0`](https://github.com/pmmp/NBT/releases/tag/1.0.0).
+
+## Performance
+- Some events are now no longer fired if no handlers are registered.
+  - This improves performance by avoiding unnecessary object allocations and function calls.
+  - Events such as `DataPacketReceiveEvent`, `DataPacketSendEvent` and `PlayerMoveEvent` are optimized away almost completely by this change, offering some much-needed performance gains.
+- Significantly improved performance of small moving entities, such as dropped items.
+  - This was achieved by a combination of changes, which together improved observed performance with 2000 item entities moving in water by 30-40%.
+  - The benefit of this will be most noticeable in SkyBlock servers, where large cactus farms can generate thousands of dropped items.
+- `World->getCollisionBoxes()` now uses an improved search method, which reduces the work done by the function by almost 90% for small entities.
+  - This improves performance of collision detection for small entities, such as dropped items.
+
+## Gameplay
+### General
+- Implemented enchanting using an enchanting table (yes, finally!)
+  - Thanks to [@S3v3Nice](https://github.com/S3v3Nice) for investing lots of time and effort into developing this.
+  - Since this feature is quite complex, it's possible there may be bugs. Please be vigilant and report any issues you find.
+
+### Blocks
+- The following new blocks have been implemented:
+  - Pink Petals
+- Pressure plates are now functional, in the sense that they react when entities stand on them and perform the correct logic.
+  - Note that since redstone is not yet implemented, pressure plates do not activate any redstone devices, similar to buttons and levers.
+- Signs can now be edited by right-clicking them.
+- Signs can now be waxed using a honeycomb, which prevents them from being edited.
+
+### Items
+- The following new items have been implemented:
+  - Enchanted Book
+
+## API
+### `pocketmine\block`
+- The following new API methods have been added:
+  - `public Block->getEnchantmentTags() : list<string>` returns a list of strings indicating which types of enchantment can be applied to the block when in item form
+  - `public BlockTypeInfo->getEnchantmentTags() : list<string>`
+  - `protected PressurePlate->getActivationBox() : AxisAlignedBB` - returns the AABB entities must intersect with in order to activate the pressure plate (not the same as the visual shape)
+  - `protected PressurePlate->hasOutputSignal() : bool` - returns whether the pressure plate has an output signal - this should be implemented by subclasses
+  - `protected PressurePlate->calculatePlateState() : array{Block, ?bool}` - returns the state the pressure plate will change to if the given list of entities are standing on it, and a bool indicating whether the plate activated or deactivated this tick
+  - `protected PressurePlate->filterIrrelevantEntities(list<Entity> $entities) : list<Entity>` - returns the given list filtered of entities that don't affect the plate's state (e.g. dropped items don't affect stone pressure plates)
+  - `public BaseSign->isWaxed() : bool`
+  - `public BaseSign->setWaxed(bool $waxed) : $this`
+  - `public inventory\EnchantInventory->getInput() : Item`
+  - `public inventory\EnchantInventory->getLapis() : Item`
+  - `public inventory\EnchantInventory->getOutput(int $optionId) : ?Item` - returns the item that would be produced if the input item was enchanted with the selected option, or `null` if the option is invalid
+  - `public inventory\EnchantInventory->getOption(int $optionId) : EnchantOption` - returns the enchanting option at the given index
+- The following API methods have signature changes:
+  - `BlockTypeInfo->__construct()` now accepts an optional `list<string> $enchantmentTags` parameter
+  - `PressurePlate->__construct()` now accepts an optional `int $deactivationDelayTicks` parameter
+  - `WeightedPressurePlate->__construct()` now accepts optional `int $deactivationDelayTicks` and `float $signalStrengthFactor` parameters
+  - `SimplePressurePlate->__construct()` now accepts an optional `int $deactivationDelayTicks` parameter
+- The following new classes have been added:
+  - `PinkPetals`
+  - `utils\BlockEventHelper` - provides helper methods for calling block-related events
+- The following classes have been deprecated:
+  - `WeightedPressurePlateLight`
+  - `WeightedPressurePlateHeavy`
+
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Human->getEnchantmentSeed() : int` - returns the current seed used to randomize options shown on the enchanting table for this human
+  - `public Human->setEnchantmentSeed(int $seed) : void`
+  - `public Human->regenerateEnchantmentSeed() : void` - returns a new randomly generated seed which can be set with `setEnchantmentSeed()`
+
+### `pocketmine\event`
+- The following new classes have been added:
+  - `block\FarmlandHydrationChangeEvent` - called when farmland is hydrated or dehydrated
+  - `block\PressurePlateUpdateEvent` - called when a pressure plate is activated or changes its power output
+  - `player\PlayerEnchantingOptionsRequestEvent` - called when a player puts an item to be enchanted into an enchanting table, to allow plugins to modify the enchanting options shown
+  - `player\PlayerItemEnchantEvent` - called when a player enchants an item in an enchanting table
+  - `world\WorldDifficultyChangeEvent` - called when a world's difficulty is changed
+- The following new API methods have been added:
+  - `public static Event::hasHandlers() : bool` - returns whether the event class has any registered handlers - used like `SomeEvent::hasHandlers()`
+  - `public HandlerListManager->getHandlersFor(class-string<? extends Event> $event) : list<RegisteredListener>` - returns a list of all registered listeners for the given event class, using cache if available
+
+### `pocketmine\inventory\transaction`
+- The following new classes have been added:
+  - `EnchantingTransaction` - used when a player enchants an item in an enchanting table
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Armor->getMaterial() : ArmorMaterial` - returns an object containing properties shared by all items of the same armor material
+  - `public ArmorTypeInfo->getMaterial() : ArmorMaterial`
+  - `public Item->getEnchantability() : int` - returns the enchantability value of the item - higher values increase the chance of more powerful enchantments being offered by an enchanting table
+  - `public Item->getEnchantmentTags() : list<string>` - returns a list of strings indicating which types of enchantment can be applied to the item
+  - `public ToolTier->getEnchantability() : int`
+- The following API methods have signature changes:
+  - `Item->__construct()` now accepts an optional `list<string> $enchantmentTags` parameter
+  - `ArmorTypeInfo->__construct()` now accepts an optional `?ArmorMaterial $material` parameter
+- The following new classes have been added:
+  - `ArmorMaterial` - container for shared armor properties
+  - `VanillaArmorMaterials` - all vanilla armor materials
+  - `EnchantedBook` - represents an enchanted book item
+
+### `pocketmine\item\enchantment`
+- The following new classes have been added:
+  - `AvailableEnchantmentRegistry` - enchantments to be displayed on the enchanting table are selected from here - custom enchantments may be added
+  - `EnchantingHelper` - static class containing various helper methods for enchanting tables
+  - `EnchantingOption` - represents an option on the enchanting table menu
+  - `IncompatibleEnchantmentGroups` - list of constants naming groups of enchantments that are incompatible with each other - custom enchantments may be added using these group names to make them incompatible with existing enchantments in the same group
+  - `IncompatibleEnchantmentRegistry` - manages which enchantments are considered incompatible with each other - custom enchantments may be added using existing group names to make them incompatible with existing enchantments in the same group, or to entirely new groups
+  - `ItemEnchantmentTagRegistry` - manages item enchantment compatibility tags and which tags include which other tags
+  - `ItemEnchantmentTags` - list of constants naming item types for enchantment compatibility checks
+- The following classes have been deprecated
+  - `ItemFlags`
+- The following API methods have been added:
+  - `public Enchantment->isCompatibleWith(Enchantment $other) : bool`
+  - `public Enchantment->getMinEnchantingPower()` - returns the minimum enchanting power (derived from enchantability and number of bookshelves) needed to allow this enchantment to show on the enchanting table with a given level
+  - `public Enchantment->getMaxEnchantingPower()` - upper limit of enchanting power for this enchantment to be offered on the enchanting table with a given level
+- The following API methods have signature changes:
+  - `Enchantment->__construct()` now accepts optional `(\Closure(int $level) : int)|null $minEnchantingPower` and `int $enchantingPowerRange` parameters
+  - `Enchantment->__construct()` parameters `$primaryItemFlags` and `$secondaryItemFlags` are now deprecated and no longer used
+  - `ProtectionEnchantment->__construct()` has extra parameters to reflect `Enchantment->__construct()` changes
+- The following API methods have been deprecated:
+  - `Enchantment->getPrimaryItemFlags()` - use API methods provided by `AvailableEnchantmentRegistry` instead
+  - `Enchantment->getSecondaryItemFlags()` - use API methods provided by `AvailableEnchantmentRegistry` instead
+  - `Enchantment->hasPrimaryItemType()`
+  - `Enchantment->hasSecondaryItemType()`
+
+### `pocketmine\plugin`
+- The following new API methods have been added:
+  - `public PluginBase->getResourcePath(string $filename) : string` - returns a URI to an embedded resource file that can be used with `file_get_contents()` and similar functions
+  - `public PluginBase->getResourceFolder() : string` - returns a URI to the plugin's folder of embedded resources
+- The following API methods have been deprecated:
+  - `PluginBase->getResource()` - prefer using `getResourcePath()` with `file_get_contents()` or other PHP built-in functions instead
+
+### `pocketmine\resourcepacks`
+- The following new API methods have been added:
+  - `public ResourcePackManager->setResourcePacksRequired(bool $value) : void` - sets whether players must accept resource packs in order to join
+
+### `pocketmine\world\generator`
+- The following new API methods have been added:
+  - `public GeneratorManager->addAlias(string $name, string $alias) : void` - allows registering a generator alias without copying the generator registration parameters
+
+### `pocketmine\world\sound`
+- The following new classes have been added:
+- `PressurePlateActivateSound`
+- `PressurePlateDeactivateSound`
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+  - `public StringToTParser->registerAlias(string $existing, string $alias) : void` - allows registering a string alias without copying registration parameters

changelogs/5.5.md

@@ -0,0 +1,162 @@
+# 5.5.0
+Released 6th September 2023.
+
+**For Minecraft: Bedrock Edition 1.20.10**
+
+This is a minor feature release, including performance improvements, new API methods, and new gameplay features.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## Dependencies
+- Updated `pocketmine/math` dependency to [`1.0.0`](https://github.com/pmmp/Math/releases/tag/1.0.0).
+- Updated `pocketmine/nbt` dependency to [`1.0.0`](https://github.com/pmmp/NBT/releases/tag/1.0.0).
+
+## Performance
+- Some events are now no longer fired if no handlers are registered.
+  - This improves performance by avoiding unnecessary object allocations and function calls.
+  - Events such as `DataPacketReceiveEvent`, `DataPacketSendEvent` and `PlayerMoveEvent` are optimized away almost completely by this change, offering some much-needed performance gains.
+- Significantly improved performance of small moving entities, such as dropped items.
+  - This was achieved by a combination of changes, which together improved observed performance with 2000 item entities moving in water by 30-40%.
+  - The benefit of this will be most noticeable in SkyBlock servers, where large cactus farms can generate thousands of dropped items.
+- `World->getCollisionBoxes()` now uses an improved search method, which reduces the work done by the function by almost 90% for small entities.
+  - This improves performance of collision detection for small entities, such as dropped items.
+
+## Gameplay
+### General
+- Implemented enchanting using an enchanting table (yes, finally!)
+  - Thanks to [@S3v3Nice](https://github.com/S3v3Nice) for investing lots of time and effort into developing this.
+  - Since this feature is quite complex, it's possible there may be bugs. Please be vigilant and report any issues you find.
+
+### Blocks
+- The following new blocks have been implemented:
+  - Pink Petals
+- Pressure plates are now functional, in the sense that they react when entities stand on them and perform the correct logic.
+  - Note that since redstone is not yet implemented, pressure plates do not activate any redstone devices, similar to buttons and levers.
+- Signs can now be edited by right-clicking them.
+- Signs can now be waxed using a honeycomb, which prevents them from being edited.
+
+### Items
+- The following new items have been implemented:
+  - Enchanted Book
+
+## API
+### `pocketmine\block`
+- The following new API methods have been added:
+  - `public Block->getEnchantmentTags() : list<string>` returns a list of strings indicating which types of enchantment can be applied to the block when in item form
+  - `public BlockTypeInfo->getEnchantmentTags() : list<string>`
+  - `protected PressurePlate->getActivationBox() : AxisAlignedBB` - returns the AABB entities must intersect with in order to activate the pressure plate (not the same as the visual shape)
+  - `protected PressurePlate->hasOutputSignal() : bool` - returns whether the pressure plate has an output signal - this should be implemented by subclasses
+  - `protected PressurePlate->calculatePlateState() : array{Block, ?bool}` - returns the state the pressure plate will change to if the given list of entities are standing on it, and a bool indicating whether the plate activated or deactivated this tick
+  - `protected PressurePlate->filterIrrelevantEntities(list<Entity> $entities) : list<Entity>` - returns the given list filtered of entities that don't affect the plate's state (e.g. dropped items don't affect stone pressure plates)
+  - `public BaseSign->isWaxed() : bool`
+  - `public BaseSign->setWaxed(bool $waxed) : $this`
+  - `public inventory\EnchantInventory->getInput() : Item`
+  - `public inventory\EnchantInventory->getLapis() : Item`
+  - `public inventory\EnchantInventory->getOutput(int $optionId) : ?Item` - returns the item that would be produced if the input item was enchanted with the selected option, or `null` if the option is invalid
+  - `public inventory\EnchantInventory->getOption(int $optionId) : EnchantOption` - returns the enchanting option at the given index
+- The following API methods have signature changes:
+  - `BlockTypeInfo->__construct()` now accepts an optional `list<string> $enchantmentTags` parameter
+  - `PressurePlate->__construct()` now accepts an optional `int $deactivationDelayTicks` parameter
+  - `WeightedPressurePlate->__construct()` now accepts optional `int $deactivationDelayTicks` and `float $signalStrengthFactor` parameters
+  - `SimplePressurePlate->__construct()` now accepts an optional `int $deactivationDelayTicks` parameter
+- The following new classes have been added:
+  - `PinkPetals`
+  - `utils\BlockEventHelper` - provides helper methods for calling block-related events
+- The following classes have been deprecated:
+  - `WeightedPressurePlateLight`
+  - `WeightedPressurePlateHeavy`
+
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Human->getEnchantmentSeed() : int` - returns the current seed used to randomize options shown on the enchanting table for this human
+  - `public Human->setEnchantmentSeed(int $seed) : void`
+  - `public Human->regenerateEnchantmentSeed() : void` - returns a new randomly generated seed which can be set with `setEnchantmentSeed()`
+
+### `pocketmine\event`
+- The following new classes have been added:
+  - `block\FarmlandHydrationChangeEvent` - called when farmland is hydrated or dehydrated
+  - `block\PressurePlateUpdateEvent` - called when a pressure plate is activated or changes its power output
+  - `player\PlayerEnchantingOptionsRequestEvent` - called when a player puts an item to be enchanted into an enchanting table, to allow plugins to modify the enchanting options shown
+  - `player\PlayerItemEnchantEvent` - called when a player enchants an item in an enchanting table
+  - `world\WorldDifficultyChangeEvent` - called when a world's difficulty is changed
+- The following new API methods have been added:
+  - `public static Event::hasHandlers() : bool` - returns whether the event class has any registered handlers - used like `SomeEvent::hasHandlers()`
+  - `public HandlerListManager->getHandlersFor(class-string<? extends Event> $event) : list<RegisteredListener>` - returns a list of all registered listeners for the given event class, using cache if available
+
+### `pocketmine\inventory\transaction`
+- The following new classes have been added:
+  - `EnchantingTransaction` - used when a player enchants an item in an enchanting table
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Armor->getMaterial() : ArmorMaterial` - returns an object containing properties shared by all items of the same armor material
+  - `public ArmorTypeInfo->getMaterial() : ArmorMaterial`
+  - `public Item->getEnchantability() : int` - returns the enchantability value of the item - higher values increase the chance of more powerful enchantments being offered by an enchanting table
+  - `public Item->getEnchantmentTags() : list<string>` - returns a list of strings indicating which types of enchantment can be applied to the item
+  - `public ToolTier->getEnchantability() : int`
+- The following API methods have signature changes:
+  - `Item->__construct()` now accepts an optional `list<string> $enchantmentTags` parameter
+  - `ArmorTypeInfo->__construct()` now accepts an optional `?ArmorMaterial $material` parameter
+- The following new classes have been added:
+  - `ArmorMaterial` - container for shared armor properties
+  - `VanillaArmorMaterials` - all vanilla armor materials
+  - `EnchantedBook` - represents an enchanted book item
+
+### `pocketmine\item\enchantment`
+- The following new classes have been added:
+  - `AvailableEnchantmentRegistry` - enchantments to be displayed on the enchanting table are selected from here - custom enchantments may be added
+  - `EnchantingHelper` - static class containing various helper methods for enchanting tables
+  - `EnchantingOption` - represents an option on the enchanting table menu
+  - `IncompatibleEnchantmentGroups` - list of constants naming groups of enchantments that are incompatible with each other - custom enchantments may be added using these group names to make them incompatible with existing enchantments in the same group
+  - `IncompatibleEnchantmentRegistry` - manages which enchantments are considered incompatible with each other - custom enchantments may be added using existing group names to make them incompatible with existing enchantments in the same group, or to entirely new groups
+  - `ItemEnchantmentTagRegistry` - manages item enchantment compatibility tags and which tags include which other tags
+  - `ItemEnchantmentTags` - list of constants naming item types for enchantment compatibility checks
+- The following classes have been deprecated
+  - `ItemFlags`
+- The following API methods have been added:
+  - `public Enchantment->isCompatibleWith(Enchantment $other) : bool`
+  - `public Enchantment->getMinEnchantingPower()` - returns the minimum enchanting power (derived from enchantability and number of bookshelves) needed to allow this enchantment to show on the enchanting table with a given level
+  - `public Enchantment->getMaxEnchantingPower()` - upper limit of enchanting power for this enchantment to be offered on the enchanting table with a given level
+- The following API methods have signature changes:
+  - `Enchantment->__construct()` now accepts optional `(\Closure(int $level) : int)|null $minEnchantingPower` and `int $enchantingPowerRange` parameters
+  - `Enchantment->__construct()` parameters `$primaryItemFlags` and `$secondaryItemFlags` are now deprecated and no longer used
+  - `ProtectionEnchantment->__construct()` has extra parameters to reflect `Enchantment->__construct()` changes
+- The following API methods have been deprecated:
+  - `Enchantment->getPrimaryItemFlags()` - use API methods provided by `AvailableEnchantmentRegistry` instead
+  - `Enchantment->getSecondaryItemFlags()` - use API methods provided by `AvailableEnchantmentRegistry` instead
+  - `Enchantment->hasPrimaryItemType()`
+  - `Enchantment->hasSecondaryItemType()`
+
+### `pocketmine\plugin`
+- The following new API methods have been added:
+  - `public PluginBase->getResourcePath(string $filename) : string` - returns a URI to an embedded resource file that can be used with `file_get_contents()` and similar functions
+  - `public PluginBase->getResourceFolder() : string` - returns a URI to the plugin's folder of embedded resources
+- The following API methods have been deprecated:
+  - `PluginBase->getResource()` - prefer using `getResourcePath()` with `file_get_contents()` or other PHP built-in functions instead
+
+### `pocketmine\resourcepacks`
+- The following new API methods have been added:
+  - `public ResourcePackManager->setResourcePacksRequired(bool $value) : void` - sets whether players must accept resource packs in order to join
+
+### `pocketmine\world\generator`
+- The following new API methods have been added:
+  - `public GeneratorManager->addAlias(string $name, string $alias) : void` - allows registering a generator alias without copying the generator registration parameters
+
+### `pocketmine\world\sound`
+- The following new classes have been added:
+- `PressurePlateActivateSound`
+- `PressurePlateDeactivateSound`
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+  - `public StringToTParser->registerAlias(string $existing, string $alias) : void` - allows registering a string alias without copying registration parameters
+
+## Internals
+- Various `TypeIdMap` classes in the `pocketmine\data\bedrock` package now use the new `IntSaveIdMapTrait` to reduce code duplication.
+- Added a new `ServerProperties` class containing constants for all known `server.properties` keys.
+- Added a new `YmlServerProperties` class containing generated constants for all known `pocketmine.yml` keys. These keys can be used with `Config->getNested()`.
+

changelogs/5.6.md

@@ -0,0 +1,34 @@
+# 5.6.0
+Released 20th September 2023.
+
+**For Minecraft: Bedrock Edition 1.20.30**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.30.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.30.
+- Removed support for older versions.
+
+## Fixes
+- Fixed support conditions for hanging roots, cave vines and dead bushes.
+- Fixed connection conditions for fences, glass panes, iron bars, and walls.
+
+# 5.6.1
+Released 20th October 2023.
+
+## Performance
+- Improved performance of cactus growth by disabling neighbour updates when only the age property was updated. While this isn't a perfect solution, it provides significant performance gains for servers with large cactus farms.
+
+## Fixes
+- Fixed `tools/generate-bedrock-data-from-packets.php` incorrectly interpreting network meta as blockstates in some cases (broken crafting recipes).
+- Fixed crafting recipes involving beds, skulls and some other items not working correctly (incorrectly interpreted data).
+- Fixed crashes when flower pot or cauldron blockentities exist in places where they shouldn't (leftovers from upgraded PM3 worlds).
+- Fixed `Entity->broadcastSound()` not firing `WorldSoundEvent` (bypassing internal sound system).
+- Fixed wooden signs, buttons and doors not being able to be used as furnace fuel.
+- Fixed bone meal and tools only working when used on the top side of dirt and grass. Bone meal now works from any side, and tools work on any side except the bottom.

changelogs/5.7.md

@@ -0,0 +1,27 @@
+# 5.7.0
+Released 26th October 2023.
+
+**For Minecraft: Bedrock Edition 1.20.40**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.40.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.40.
+- Removed support for older versions.
+
+## Fixes
+- Fixed `cartography_table`, `smithing_table`, `stripped_cherry_log` and `stripped_cherry_wood` not working in `StringToItemParser`.
+- Fixed `Promise<null>::onCompletion()` always calling the reject handler if the promise was already completed.
+
+# 5.7.1
+Released 1st November 2023.
+
+## Fixes
+- Fixed non-reentrant-safe code in `PermissionManager` and various other subscriber subsystems.
+  - These issues caused server crashes when deleting a subscriber indirectly triggered the deletion of other subscribers (e.g. due to the GC activating in `unset()`).

changelogs/5.8.md

@@ -0,0 +1,138 @@
+# 5.8.0
+Released 1st November 2023.
+
+**Borked release, forgot to merge branches.**
+
+# 5.8.1
+Released 1st November 2023.
+
+**For Minecraft: Bedrock Edition 1.20.40**
+
+This is a minor feature release, including new gameplay features, various performance improvements to internal `World` and `Block` systems, and changes to the API.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Neighbour block updates now have a separate timer for timings. Previously, these were counted under `Scheduled Block Updates`, which was misleading.
+
+## Performance
+- `LightUpdate` now avoids attempting to propagate back in the same direction the light came from. This produces a small performance improvement of around 6% in light propagation.
+- Improved worst-case (non-cached) performance of `World::getCollisionBlocks()` (and its successor `World::getBlockCollisionBlocks()`).
+  - While 5.5.0 introduced caching at the `World` level for AABBs, the cache was rarely useful due to entity and player movement being too unpredictable. This meant that most users saw a performance degradation with lots of moving entities, except in specific situations.
+  - Performance for fetching non-cached AABBs for a cell is now improved by 2x. Overall performance benefit to a server depends on the number of entities and players.
+- Added cache for hydrated farmland blocks to remember the last known location of nearby water.
+  - If nearby water sources are not changed, this cache allows hydrated farmland to completely avoid checking up to 161 nearby blocks for water after the first check.
+  - Tests with large wheat farms showed a 25% performance improvement in overall server performance compared to previous 5.x versions.
+- Migrated various internal enums to native PHP 8.1 enums. Bypassing magic `__callStatic()` accessors improved performance in many areas, although it's hard to quantify the exact benefit.
+- Made use of `Facing::OFFSET` constant in various places to avoid unnecessary `Vector3` and `Position` object allocations. Many pathways benefit from this, including neighbour block updates (due to faster `Block::getSide()` and less useless objects).
+- Avoided clearing block AABB caches except when strictly necessary. Previously, the cache was wiped every time blocks were read from the world, making them mostly useless.
+- Avoided random updates on blocks which have reached their final state, such as fully-grown crops. This produces a minimal performance improvement.
+- Removed useless checks in some `World` hot paths.
+
+## API
+### General
+- All enums have been migrated to native PHP 8.1 enums.
+  - For now, the old APIs and accessors are still usable (via `LegacyEnumShimTrait`), but these will be removed in the next major release.
+  - `EnumTrait` has been deprecated, and will be removed in the next major release.
+  - Migration for most plugin developers will simply involve deleting `()` from the end of enum case usages, which is a trivial change and also improves performance.
+  - Plugin usages of `EnumTrait` are encouraged to move to native enums, optionally using `LegacyEnumShimTrait` to provide backwards compatibility.
+    - See [this code](https://github.com/pmmp/PocketMine-MP/blob/9832fe899f13a8ea47cc9d73de7088f7775a12f5/src/block/utils/DyeColor.php#L85-L107) for an example of how to associate properties with enum cases (since native enums don't support this directly).
+  - Thanks to improvements in `RuntimeDataDescriber`, any native enum can now be used as a custom block's state property.
+
+### `pocketmine\block`
+- The following classes have been added:
+  - `utils\AgeableTrait` - used by blocks which have an age property, such as crops
+  - `utils\StaticSupportTrait` - used by blocks which have the same support requirements regardless of their state, such as crops
+
+### `pocketmine\data\runtime`
+- The following API methods have been added:
+  - `public RuntimeDataDescriber->boundedIntAuto(int $min, int $max, int &$value) : void` - similar to `boundedInt()`, but automatically calculates the needed number of bits based on the given min/max
+  - `public RuntimeDataDescriber->enum(T extends \UnitEnum &$case) : void` - describes any native PHP 8.1 enum case
+  - `public RuntimeDataDescriber->enumSet(array<int, T extends \UnitEnum> &$set, array<int, T extends \UnitEnum> $allCases) : void` - describes a set of enum cases (similar to bitflags)
+- The following API methods have been deprecated:
+  - `RuntimeDataDescriber->bellAttachmentType()` - use `enum()` instead
+  - `RuntimeDataDescriber->boundedInt()` - use `boundedIntAuto()` instead
+  - `RuntimeDataDescriber->brewingStandSlots()` - use `enumSet()` instead
+  - `RuntimeDataDescriber->copperOxidation()` - use `enum()` instead
+  - `RuntimeDataDescriber->coralType()` - use `enum()` instead
+  - `RuntimeDataDescriber->dirtType()` - use `enum()` instead
+  - `RuntimeDataDescriber->dripleafState()` - use `enum()` instead
+  - `RuntimeDataDescriber->dyeColor()` - use `enum()` instead
+  - `RuntimeDataDescriber->froglightType()` - use `enum()` instead
+  - `RuntimeDataDescriber->leverFacing()` - use `enum()` instead
+  - `RuntimeDataDescriber->medicineType()` - use `enum()` instead
+  - `RuntimeDataDescriber->mobHeadType()` - use `enum()` instead
+  - `RuntimeDataDescriber->mushroomBlockType()` - use `enum()` instead
+  - `RuntimeDataDescriber->potionType()` - use `enum()` instead
+  - `RuntimeDataDescriber->slabType()` - use `enum()` instead
+  - `RuntimeDataDescriber->suspiciousStewType()` - use `enum()` instead
+
+### `pocketmine\player`
+- `TitleID` is now included in `PlayerInfo` metadata for plugin consumption.
+
+### `pocketmine\world`
+- The following API methods have been added:
+  - `public World->getBlockCollisionBoxes(AxisAlignedBB $bb) : list<AxisAlignedBB>` - similar to `getCollisionBoxes` but exclusively for blocks, avoiding the need for conditionally useless parameters
+- The following API methods have been deprecated:
+  - `World->getCollisionBoxes()` - use `getBlockCollisionBoxes()` instead (alongside `getCollidingEntities()` if entity collision boxes are also required)
+
+### `pocketmine\utils`
+- The following classes have been deprecated:
+  - `EnumTrait` - use native PHP 8.1 enums instead
+- The following classes have been added:
+  - `LegacyEnumShimTrait` - can be `use`d by native PHP 8.1 enums to provide the same API as `EnumTrait`
+
+## Gameplay
+### Blocks
+- Implemented the following blocks:
+  - Amethyst
+  - Amethyst Cluster
+  - Chiseled Bookshelf
+  - Crimson Roots
+  - Pitcher Crop
+  - Pitcher Plant
+  - Torchflower
+  - Torchflower Crop
+  - Warped Roots
+
+### Items
+- Implemented the following items:
+  - Pitcher Pod
+  - Torchflower Seeds
+
+## Internals
+- `Farmland` block now has an extra property (`waterPositionIndex`) stored in its blockstate ID to track the position of nearby water. This property is not saved to disk, and is only used for caching.
+- The format of internal blockstate ID has been updated.
+  - The lower `11` bits are now reserved for state data (previously `8` bits). This increase facilitates the new cache for `Farmland` blocks.
+  - The state data bits are now XOR'd with the `xxh3` of the block's type ID, instead of being directly XOR'd with the type ID.
+    - This XOR improves the distribution of the lower bits of the blockstate ID, which is important for hashtable indexing to minimize collisions.
+    - Previously, the lower bits were XOR'd with the type ID directly, but the effectiveness of this reduced as more state data bits were added.
+    - `xxh3` produces consistently good results for this purpose regardless of the number of state data bits allocated.
+    - Hash collisions with blockstate IDs are reduced by 50% with this change, which is a happy side effect.
+  - This is backwards-incompatible, so anyone saving internal blockstate IDs on disk or in a DB will be burned by this change (though they shouldn't have been doing that anyway).
+- Removed code generation step for `RuntimeDataDescriber` enum serialization. All described enums now use PHP 8.1 native enums, which can be described without codegen using `RuntimeDataDescriber->enum()`.
+- Added `DeprecatedLegacyEnumAccessRule` custom PHPStan rule to flag legacy `EnumTrait` case accessors.
+- Cleaned up remaining hardcoded `Config` keys in `SetupWizard`. These usages now use auto-generated constants like the rest of the codebase.
+
+# 5.8.2
+Released 9th November 2023.
+
+## Performance
+- Improved performance of small packet zero-compression (unintended use of slow zlib compressor instead of fast libdeflate one).
+  - This affected the majority of outbound packets, as most packets are below the 256-byte threshold for compression.
+  - This faster method is over 20x faster than the old method, producing noticeable performance gains for large servers.
+
+## Fixes
+- Fixed melons and pumpkins not growing.
+- Fixed melon and pumpkin stems not attaching to the grown melon/pumpkin.
+- Fixed iron and gold ores not being affected by the Fortune enchantment.
+- Fixed ancient debris burning in lava.
+- Fixed sign (front) text loading from vanilla world saves (back text is not yet supported).
+
+## Internals
+- Removed bogus optimization from `tools/generate-blockstate-upgrade-schema.php` that could cause incorrect `remappedStates` generation when some of the states stayed under the old ID.
+- Fixed possible crash in `BlockStateUpgrader` name flattening rule handling with invalid blockstate NBT data.

changelogs/5.9.md

@@ -0,0 +1,30 @@
+# 5.9.0
+Released 6th December 2023.
+
+**For Minecraft: Bedrock Edition 1.20.50**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.50.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe`  or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.50.
+- Removed support for older versions.
+
+## Fixes
+- Fixed `pitcher_plant` and `pitcher_pod` not being accepted by `StringToItemParser` (and therefore not being usable in commands).
+- Rotation of items in item frames in worlds from newer versions of Bedrock is now correctly loaded.
+- Fixed possible crash in block update sending if a chunk was unloaded during a previous chunk's block update syncing.
+- Fixed `AsyncTask::fetchLocal()` throwing an exception if `null` was stored in the local storage.
+
+## Documentation
+- `Server::prepareBatch()` is now correctly marked as `@internal`.
+- Updated documentation for `Server::prepareBatch()` to accurately reflect its behaviour.
+- Fixed incorrect path in doc comments of `EnumTrait` and `RegistryTrait`.
+
+## Internals
+- Added PHP 8.3 to the test matrix. This has not been thoroughly tested yet, so it should only be used for testing purposes.

composer.json

@@ -5,9 +5,9 @@
    "homepage": "https://pmmp.io",
    "license": "LGPL-3.0",
    "require": {
-      "php": "^8.0",
+      "php": "^8.1",
       "php-64bit": "*",
-      "ext-chunkutils2": "^0.3.0",
+      "ext-chunkutils2": "^0.3.1",
       "ext-crypto": "^0.3.1",
       "ext-ctype": "*",
       "ext-curl": "*",
@@ -22,7 +22,7 @@
       "ext-openssl": "*",
       "ext-pcre": "*",
       "ext-phar": "*",
-      "ext-pthreads": "~3.2.0",
+      "ext-pmmpthread": "^6.1.0",
       "ext-reflection": "*",
       "ext-simplexml": "*",
       "ext-sockets": "*",
@@ -31,32 +31,31 @@
       "ext-zip": "*",
       "ext-zlib": ">=1.2.11",
       "composer-runtime-api": "^2.0",
-      "adhocore/json-comment": "^1.1",
-      "fgrosse/phpasn1": "^2.3",
-      "netresearch/jsonmapper": "^4.0",
-      "pocketmine/bedrock-protocol": "1.0.0+bedrock1.17.10",
+      "adhocore/json-comment": "~1.2.0",
+      "pocketmine/netresearch-jsonmapper": "~v4.4.999",
+      "pocketmine/bedrock-block-upgrade-schema": "~4.2.0+bedrock-1.21.0",
+      "pocketmine/bedrock-data": "~2.11.0+bedrock-1.21.0",
+      "pocketmine/bedrock-item-upgrade-schema": "~1.10.0+bedrock-1.21.0",
+      "pocketmine/bedrock-protocol": "~32.1.0+bedrock-1.21.2",
       "pocketmine/binaryutils": "^0.2.1",
       "pocketmine/callback-validator": "^1.0.2",
-      "pocketmine/classloader": "dev-master",
-      "pocketmine/color": "^0.2.0",
-      "pocketmine/errorhandler": "^0.3.0",
-      "pocketmine/log": "^0.3.0",
-      "pocketmine/log-pthreads": "^0.2.0",
-      "pocketmine/math": "^0.3.0",
-      "pocketmine/nbt": "^0.3.0",
-      "pocketmine/raklib": "^0.13.1",
-      "pocketmine/raklib-ipc": "^0.1.0",
-      "pocketmine/snooze": "^0.3.0",
-      "pocketmine/spl": "dev-master",
-      "ramsey/uuid": "^4.1",
-      "respect/validation": "^2.0",
-      "webmozart/path-util": "^2.3"
+      "pocketmine/color": "^0.3.0",
+      "pocketmine/errorhandler": "^0.7.0",
+      "pocketmine/locale-data": "~2.19.0",
+      "pocketmine/log": "^0.4.0",
+      "pocketmine/math": "~1.0.0",
+      "pocketmine/nbt": "~1.0.0",
+      "pocketmine/raklib": "~1.1.0",
+      "pocketmine/raklib-ipc": "~1.0.0",
+      "pocketmine/snooze": "^0.5.0",
+      "ramsey/uuid": "~4.7.0",
+      "symfony/filesystem": "~6.4.0"
    },
    "require-dev": {
-      "phpstan/phpstan": "0.12.98",
-      "phpstan/phpstan-phpunit": "^0.12.6",
-      "phpstan/phpstan-strict-rules": "^0.12.2",
-      "phpunit/phpunit": "^9.2"
+      "phpstan/phpstan": "1.11.10",
+      "phpstan/phpstan-phpunit": "^1.1.0",
+      "phpstan/phpstan-strict-rules": "^1.2.0",
+      "phpunit/phpunit": "^10.5.24"
    },
    "autoload": {
       "psr-4": {
@@ -74,21 +73,24 @@
    },
    "config": {
       "platform": {
-         "php": "8.0.0"
+         "php": "8.1.0"
       },
       "sort-packages": true
    },
    "scripts": {
-      "make-devtools": "@php -dphar.readonly=0 tests/plugins/DevTools/src/DevTools/ConsoleScript.php --make tests/plugins/DevTools --out plugins/DevTools.phar",
+      "make-devtools": "@php -dphar.readonly=0 tests/plugins/DevTools/src/ConsoleScript.php --make ./ --relative tests/plugins/DevTools --out plugins/DevTools.phar",
       "make-server": [
          "@composer install --no-dev --classmap-authoritative --ignore-platform-reqs",
          "@php -dphar.readonly=0 build/server-phar.php"
       ],
-      "update-registry-annotations": [
+      "update-codegen": [
+         "@php build/generate-bedrockdata-path-consts.php",
+         "@php build/generate-biome-ids.php",
+         "@php build/generate-block-serializer-consts.php vendor/pocketmine/bedrock-data/canonical_block_states.nbt",
+         "@php build/generate-item-type-names.php vendor/pocketmine/bedrock-data/required_item_list.json",
+         "@php build/generate-known-translation-apis.php",
+         "@php build/generate-pocketmine-yml-property-consts.php",
          "@php build/generate-registry-annotations.php src"
-      ],
-      "update-translation-apis": [
-         "@php build/generate-known-translation-apis.php"
       ]
    }
 }

doxygen/doxygen.conf

@@ -1,4 +1,4 @@
-# Doxyfile 1.8.15
+# Doxyfile 1.9.3
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -93,14 +93,6 @@ ALLOW_UNICODE_NAMES    = NO
 
 OUTPUT_LANGUAGE        = English
 
-# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all generated output in the proper direction.
-# Possible values are: None, LTR, RTL and Context.
-# The default value is: None.
-
-OUTPUT_TEXT_DIRECTION  = None
-
 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
 # descriptions after the members that are listed in the file and class
 # documentation (similar to Javadoc). Set to NO to disable this.
@@ -197,6 +189,16 @@ SHORT_NAMES            = NO
 
 JAVADOC_AUTOBRIEF      = NO
 
+# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
+# such as
+# /***************
+# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
+# Javadoc-style will behave just like regular comments and it will not be
+# interpreted by doxygen.
+# The default value is: NO.
+
+JAVADOC_BANNER         = NO
+
 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
 # line (until the first dot) of a Qt-style comment as the brief description. If
 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
@@ -217,6 +219,14 @@ QT_AUTOBRIEF           = NO
 
 MULTILINE_CPP_IS_BRIEF = NO
 
+# By default Python docstrings are displayed as preformatted text and doxygen's
+# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
+# doxygen's special commands can be used and the contents of the docstring
+# documentation blocks is shown as doxygen documentation.
+# The default value is: YES.
+
+PYTHON_DOCSTRING       = YES
+
 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
 # documentation from any documented member that it re-implements.
 # The default value is: YES.
@@ -240,25 +250,19 @@ TAB_SIZE               = 4
 # the documentation. An alias has the form:
 # name=value
 # For example adding
-# "sideeffect=@par Side Effects:\n"
+# "sideeffect=@par Side Effects:^^"
 # will allow you to put the command \sideeffect (or @sideeffect) in the
 # documentation, which will result in a user-defined paragraph with heading
-# "Side Effects:". You can put \n's in the value part of an alias to insert
-# newlines (in the resulting output). You can put ^^ in the value part of an
-# alias to insert a newline as if a physical newline was in the original file.
-# When you need a literal { or } or , in the value part of an alias you have to
-# escape them by means of a backslash (\), this can lead to conflicts with the
-# commands \{ and \} for these it is advised to use the version @{ and @} or use
-# a double escape (\\{ and \\})
+# "Side Effects:". Note that you cannot put \n's in the value part of an alias
+# to insert newlines (in the resulting output). You can put ^^ in the value part
+# of an alias to insert a newline as if a physical newline was in the original
+# file. When you need a literal { or } or , in the value part of an alias you
+# have to escape them by means of a backslash (\), this can lead to conflicts
+# with the commands \{ and \} for these it is advised to use the version @{ and
+# @} or use a double escape (\\{ and \\})
 
 ALIASES                =
 
-# This tag can be used to specify a number of word-keyword mappings (TCL only).
-# A mapping has the form "name=value". For example adding "class=itcl::class"
-# will allow you to use the command class in the itcl::class meaning.
-
-TCL_SUBST              =
-
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
 # instance, some of the names that are used will be different. The list of all
@@ -299,19 +303,22 @@ OPTIMIZE_OUTPUT_SLICE  = NO
 # parses. With this tag you can assign which parser to use for a given
 # extension. Doxygen has a built-in mapping, but you can override or extend it
 # using this tag. The format is ext=language, where ext is a file extension, and
-# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
-# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
-# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
+# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
+# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
 # tries to guess whether the code is fixed or free formatted code, this is the
-# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
-# .inc files as Fortran files (default is PHP), and .f files as C (default is
-# Fortran), use: inc=Fortran f=C.
+# default for Fortran type files). For instance to make doxygen treat .inc files
+# as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# use: inc=Fortran f=C.
 #
 # Note: For files without extension you can use no_extension as a placeholder.
 #
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
-# the files are not read by doxygen.
+# the files are not read by doxygen. When specifying no_extension you should add
+# * to the FILE_PATTERNS.
+#
+# Note see also the list of default file extension mappings.
 
 EXTENSION_MAPPING      =
 
@@ -329,7 +336,7 @@ MARKDOWN_SUPPORT       = YES
 # to that level are automatically included in the table of contents, even if
 # they do not have an id attribute.
 # Note: This feature currently applies only to Markdown headings.
-# Minimum value: 0, maximum value: 99, default value: 0.
+# Minimum value: 0, maximum value: 99, default value: 5.
 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
 
 TOC_INCLUDE_HEADINGS   = 0
@@ -445,6 +452,19 @@ TYPEDEF_HIDES_STRUCT   = NO
 
 LOOKUP_CACHE_SIZE      = 0
 
+# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
+# during processing. When set to 0 doxygen will based this on the number of
+# cores available in the system. You can set it explicitly to a value larger
+# than 0 to get more control over the balance between CPU load and processing
+# speed. At this moment only the input processing can be done using multiple
+# threads. Since this is still an experimental feature the default is set to 1,
+# which effectively disables parallel processing. Please report any issues you
+# encounter. Generating dot graphs in parallel is controlled by the
+# DOT_NUM_THREADS setting.
+# Minimum value: 0, maximum value: 32, default value: 1.
+
+NUM_PROC_THREADS       = 1
+
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
@@ -465,6 +485,12 @@ EXTRACT_ALL            = NO
 
 EXTRACT_PRIVATE        = NO
 
+# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
+# methods of a class will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIV_VIRTUAL   = NO
+
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
 # The default value is: NO.
@@ -502,6 +528,13 @@ EXTRACT_LOCAL_METHODS  = YES
 
 EXTRACT_ANON_NSPACES   = YES
 
+# If this flag is set to YES, the name of an unnamed parameter in a declaration
+# will be determined by the corresponding definition. By default unnamed
+# parameters remain unnamed in the output.
+# The default value is: YES.
+
+RESOLVE_UNNAMED_PARAMS = YES
+
 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
 # undocumented members inside documented classes or files. If set to NO these
 # members will be included in the various overviews, but no documentation
@@ -519,8 +552,8 @@ HIDE_UNDOC_MEMBERS     = NO
 HIDE_UNDOC_CLASSES     = NO
 
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
-# (class|struct|union) declarations. If set to NO, these declarations will be
-# included in the documentation.
+# declarations. If set to NO, these declarations will be included in the
+# documentation.
 # The default value is: NO.
 
 HIDE_FRIEND_COMPOUNDS  = NO
@@ -539,11 +572,18 @@ HIDE_IN_BODY_DOCS      = YES
 
 INTERNAL_DOCS          = NO
 
-# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
-# names in lower-case letters. If set to YES, upper-case letters are also
-# allowed. This is useful if you have classes or files whose names only differ
-# in case and if your file system supports case sensitive file names. Windows
-# and Mac users are advised to set this option to NO.
+# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
+# able to match the capabilities of the underlying filesystem. In case the
+# filesystem is case sensitive (i.e. it supports files in the same directory
+# whose names only differ in casing), the option must be set to YES to properly
+# deal with such files in case they appear in the input. For filesystems that
+# are not case sensitive the option should be be set to NO to properly deal with
+# output files written for symbols that only differ in casing, such as for two
+# classes, one named CLASS and the other named Class, and to also support
+# references to files without having to specify the exact matching casing. On
+# Windows (including Cygwin) and MacOS, users should typically set this option
+# to NO, whereas on Linux or other Unix flavors it should typically be set to
+# YES.
 # The default value is: system dependent.
 
 CASE_SENSE_NAMES       = NO
@@ -562,6 +602,12 @@ HIDE_SCOPE_NAMES       = NO
 
 HIDE_COMPOUND_REFERENCE= NO
 
+# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
+# will show which file needs to be included to use the class.
+# The default value is: YES.
+
+SHOW_HEADERFILE        = YES
+
 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
@@ -719,7 +765,8 @@ FILE_VERSION_FILTER    =
 # output files in an output format independent way. To create the layout file
 # that represents doxygen's defaults, run doxygen with the -l option. You can
 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
-# will be used as the name of the layout file.
+# will be used as the name of the layout file. See also section "Changing the
+# layout of pages" for information.
 #
 # Note that if you run doxygen from a directory containing a file called
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
@@ -765,24 +812,35 @@ WARNINGS               = NO
 WARN_IF_UNDOCUMENTED   = NO
 
 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as not documenting some parameters
-# in a documented function, or documenting parameters that don't exist or using
-# markup commands wrongly.
+# potential errors in the documentation, such as documenting some parameters in
+# a documented function twice, or documenting parameters that don't exist or
+# using markup commands wrongly.
 # The default value is: YES.
 
 WARN_IF_DOC_ERROR      = YES
 
+# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
+# function parameter documentation. If set to NO, doxygen will accept that some
+# parameters have no documentation without warning.
+# The default value is: YES.
+
+WARN_IF_INCOMPLETE_DOC = YES
+
 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
 # are documented, but have no documentation for their parameters or return
-# value. If set to NO, doxygen will only warn about wrong or incomplete
-# parameter documentation, but not about the absence of documentation. If
-# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
+# value. If set to NO, doxygen will only warn about wrong parameter
+# documentation, but not about the absence of documentation. If EXTRACT_ALL is
+# set to YES then this flag will automatically be disabled. See also
+# WARN_IF_INCOMPLETE_DOC
 # The default value is: NO.
 
 WARN_NO_PARAMDOC       = NO
 
 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
-# a warning is encountered.
+# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
+# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
+# at the end of the doxygen process doxygen will return with a non-zero status.
+# Possible values are: NO, YES and FAIL_ON_WARNINGS.
 # The default value is: NO.
 
 WARN_AS_ERROR          = NO
@@ -799,7 +857,10 @@ WARN_FORMAT            = "$file:$line: $text"
 
 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
 # messages should be written. If left blank the output is written to standard
-# error (stderr).
+# error (stderr). In case the file specified cannot be opened for writing the
+# warning and error messages are written to standard error. When as file - is
+# specified the warning and error messages are written to standard output
+# (stdout).
 
 WARN_LOGFILE           =
 
@@ -820,8 +881,8 @@ INPUT                  = ../src \
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
-# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
-# possible encodings.
+# documentation (see:
+# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
 # The default value is: UTF-8.
 
 INPUT_ENCODING         = UTF-8
@@ -834,11 +895,15 @@ INPUT_ENCODING         = UTF-8
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # read by doxygen.
 #
+# Note the list of default checked file patterns might differ from the list of
+# default file extension mappings.
+#
 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
-# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
-# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
-# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
+# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
+# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
+# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
+# *.vhdl, *.ucf, *.qsf and *.ice.
 
 FILE_PATTERNS          = *.php
 
@@ -883,7 +948,7 @@ EXCLUDE_PATTERNS       = */bin/* \
 # (namespaces, classes, functions, etc.) that should be excluded from the
 # output. The symbol name can be a fully qualified name, a word, or if the
 # wildcard * is used, a substring. Examples: ANamespace, AClass,
-# AClass::ANamespace, ANamespace::*Test
+# ANamespace::AClass, ANamespace::*Test
 #
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories use the pattern */test/*
@@ -1059,16 +1124,24 @@ USE_HTAGS              = NO
 VERBATIM_HEADERS       = YES
 
 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
-# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
-# cost of reduced performance. This can be particularly helpful with template
-# rich C++ code for which doxygen's built-in parser lacks the necessary type
-# information.
+# clang parser (see:
+# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
+# performance. This can be particularly helpful with template rich C++ code for
+# which doxygen's built-in parser lacks the necessary type information.
 # Note: The availability of this option depends on whether or not doxygen was
 # generated with the -Duse_libclang=ON option for CMake.
 # The default value is: NO.
 
 CLANG_ASSISTED_PARSING = NO
 
+# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
+# tag is set to YES then doxygen will add the directory of each input to the
+# include path.
+# The default value is: YES.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_ADD_INC_PATHS    = YES
+
 # If clang assisted parsing is enabled you can provide the compiler with command
 # line options that you would normally use when invoking the compiler. Note that
 # the include paths will already be set by doxygen for the files and directories
@@ -1078,10 +1151,13 @@ CLANG_ASSISTED_PARSING = NO
 CLANG_OPTIONS          =
 
 # If clang assisted parsing is enabled you can provide the clang parser with the
-# path to the compilation database (see:
-# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
-# were built. This is equivalent to specifying the "-p" option to a clang tool,
-# such as clang-check. These options will then be passed to the parser.
+# path to the directory containing a file called compile_commands.json. This
+# file is the compilation database (see:
+# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
+# options used when the source files were built. This is equivalent to
+# specifying the -p option to a clang tool, such as clang-check. These options
+# will then be passed to the parser. Any options specified with CLANG_OPTIONS
+# will be added as well.
 # Note: The availability of this option depends on whether or not doxygen was
 # generated with the -Duse_libclang=ON option for CMake.
 
@@ -1098,13 +1174,6 @@ CLANG_DATABASE_PATH    =
 
 ALPHABETICAL_INDEX     = YES
 
-# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
-# which the alphabetical index list will be split.
-# Minimum value: 1, maximum value: 20, default value: 5.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
-COLS_IN_ALPHA_INDEX    = 5
-
 # In case all classes in a project start with a common prefix, all classes will
 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
 # can be used to specify a prefix (or a list of prefixes) that should be ignored
@@ -1204,7 +1273,7 @@ HTML_EXTRA_FILES       =
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to
-# this color. Hue is specified as an angle on a colorwheel, see
+# this color. Hue is specified as an angle on a color-wheel, see
 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
 # purple, and 360 is red again.
@@ -1214,7 +1283,7 @@ HTML_EXTRA_FILES       =
 HTML_COLORSTYLE_HUE    = 220
 
 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
-# in the HTML output. For a value of 0 the output will use grayscales only. A
+# in the HTML output. For a value of 0 the output will use gray-scales only. A
 # value of 255 will produce the most vivid colors.
 # Minimum value: 0, maximum value: 255, default value: 100.
 # This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1239,13 +1308,13 @@ HTML_COLORSTYLE_GAMMA  = 80
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_TIMESTAMP         = YES
+HTML_TIMESTAMP         = NO
 
 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
 # documentation will contain a main index with vertical navigation menus that
-# are dynamically created via Javascript. If disabled, the navigation index will
+# are dynamically created via JavaScript. If disabled, the navigation index will
 # consists of multiple levels of tabs that are statically embedded in every HTML
-# page. Disable this option to support browsers that do not have Javascript,
+# page. Disable this option to support browsers that do not have JavaScript,
 # like the Qt help browser.
 # The default value is: YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1275,10 +1344,11 @@ HTML_INDEX_NUM_ENTRIES = 100
 
 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
 # generated that can be used as input for Apple's Xcode 3 integrated development
-# environment (see: https://developer.apple.com/xcode/), introduced with OSX
-# 10.5 (Leopard). To create a documentation set, doxygen will generate a
-# Makefile in the HTML output directory. Running make will produce the docset in
-# that directory and running make install will install the docset in
+# environment (see:
+# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
+# create a documentation set, doxygen will generate a Makefile in the HTML
+# output directory. Running make will produce the docset in that directory and
+# running make install will install the docset in
 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
 # genXcode/_index.html for more information.
@@ -1295,6 +1365,13 @@ GENERATE_DOCSET        = NO
 
 DOCSET_FEEDNAME        = "Doxygen generated docs"
 
+# This tag determines the URL of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDURL         =
+
 # This tag specifies a string that should uniquely identify the documentation
 # set bundle. This should be a reverse domain-name style string, e.g.
 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
@@ -1320,8 +1397,12 @@ DOCSET_PUBLISHER_NAME  = Publisher
 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
-# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
-# Windows.
+# on Windows. In the beginning of 2021 Microsoft took the original page, with
+# a.o. the download links, offline the HTML help workshop was already many years
+# in maintenance mode). You can download the HTML help workshop from the web
+# archives at Installation executable (see:
+# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
+# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
 #
 # The HTML Help Workshop contains a compiler that can convert all HTML output
 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
@@ -1351,7 +1432,7 @@ CHM_FILE               =
 HHC_LOCATION           =
 
 # The GENERATE_CHI flag controls if a separate .chi index file is generated
-# (YES) or that it should be included in the master .chm file (NO).
+# (YES) or that it should be included in the main .chm file (NO).
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
@@ -1396,7 +1477,8 @@ QCH_FILE               =
 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
 # Project output. For more information please see Qt Help Project / Namespace
-# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
 # The default value is: org.doxygen.Project.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
@@ -1404,8 +1486,8 @@ QHP_NAMESPACE          = org.doxygen.Project
 
 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
 # Help Project output. For more information please see Qt Help Project / Virtual
-# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
-# folders).
+# Folders (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
 # The default value is: doc.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
@@ -1413,30 +1495,30 @@ QHP_VIRTUAL_FOLDER     = doc
 
 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
 # filter to add. For more information please see Qt Help Project / Custom
-# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
-# filters).
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_CUST_FILTER_NAME   =
 
 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
 # custom filter to add. For more information please see Qt Help Project / Custom
-# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
-# filters).
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_CUST_FILTER_ATTRS  =
 
 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
 # project's filter section matches. Qt Help Project / Filter Attributes (see:
-# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_SECT_FILTER_ATTRS  =
 
-# The QHG_LOCATION tag can be used to specify the location of Qt's
-# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
-# generated .qhp file.
+# The QHG_LOCATION tag can be used to specify the location (absolute path
+# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
+# run qhelpgenerator on the generated .qhp file.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHG_LOCATION           =
@@ -1479,16 +1561,28 @@ DISABLE_INDEX          = NO
 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
 # (i.e. any modern browser). Windows users are probably better off using the
 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
-# further fine-tune the look of the index. As an example, the default style
-# sheet generated by doxygen has an example that shows how to put an image at
-# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
-# the same information as the tab index, you could consider setting
-# DISABLE_INDEX to YES when enabling this option.
+# further fine tune the look of the index (see "Fine-tuning the output"). As an
+# example, the default style sheet generated by doxygen has an example that
+# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
+# Since the tree basically has the same information as the tab index, you could
+# consider setting DISABLE_INDEX to YES when enabling this option.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 GENERATE_TREEVIEW      = YES
 
+# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
+# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
+# area (value NO) or if it should extend to the full height of the window (value
+# YES). Setting this to YES gives a layout similar to
+# https://docs.readthedocs.io with more room for contents, but less room for the
+# project logo, title, and description. If either GENERATE_TREEVIEW or
+# DISABLE_INDEX is set to NO, this option has no effect.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FULL_SIDEBAR           = NO
+
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.
 #
@@ -1513,6 +1607,24 @@ TREEVIEW_WIDTH         = 250
 
 EXT_LINKS_IN_WINDOW    = NO
 
+# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
+# addresses.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+OBFUSCATE_EMAILS       = YES
+
+# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
+# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
+# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
+# the HTML output. These images will generally look nicer at scaled resolutions.
+# Possible values are: png (the default) and svg (looks nicer but requires the
+# pdf2svg or inkscape tool).
+# The default value is: png.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FORMULA_FORMAT    = png
+
 # Use this tag to change the font size of LaTeX formulas included as images in
 # the HTML documentation. When you change the font size after a successful
 # doxygen run you need to manually remove any form_*.png images from the HTML
@@ -1533,8 +1645,14 @@ FORMULA_FONTSIZE       = 10
 
 FORMULA_TRANSPARENT    = YES
 
+# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
+# to create new LaTeX commands to be used in formulas as building blocks. See
+# the section "Including formulas" for details.
+
+FORMULA_MACROFILE      =
+
 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
-# https://www.mathjax.org) which uses client side Javascript for the rendering
+# https://www.mathjax.org) which uses client side JavaScript for the rendering
 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
 # installed or if you want to formulas look prettier in the HTML output. When
 # enabled you may also need to install MathJax separately and configure the path
@@ -1544,11 +1662,29 @@ FORMULA_TRANSPARENT    = YES
 
 USE_MATHJAX            = YES
 
+# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
+# Note that the different versions of MathJax have different requirements with
+# regards to the different settings, so it is possible that also other MathJax
+# settings have to be changed when switching between the different MathJax
+# versions.
+# Possible values are: MathJax_2 and MathJax_3.
+# The default value is: MathJax_2.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_VERSION        = MathJax_2
+
 # When MathJax is enabled you can set the default output format to be used for
-# the MathJax output. See the MathJax site (see:
-# http://docs.mathjax.org/en/latest/output.html) for more details.
+# the MathJax output. For more details about the output format see MathJax
+# version 2 (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
+# (see:
+# http://docs.mathjax.org/en/latest/web/components/output.html).
 # Possible values are: HTML-CSS (which is slower, but has the best
-# compatibility), NativeMML (i.e. MathML) and SVG.
+# compatibility. This is the name for Mathjax version 2, for MathJax version 3
+# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
+# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
+# is the name for Mathjax version 3, for MathJax version 2 this will be
+# translated into HTML-CSS) and SVG.
 # The default value is: HTML-CSS.
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
@@ -1561,22 +1697,29 @@ MATHJAX_FORMAT         = HTML-CSS
 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
 # Content Delivery Network so you can quickly see the result without installing
 # MathJax. However, it is strongly recommended to install a local copy of
-# MathJax from https://www.mathjax.org before deployment.
-# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
+# MathJax from https://www.mathjax.org before deployment. The default value is:
+# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
+# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
 MATHJAX_RELPATH        = https://cdn.mathjax.org/mathjax/latest
 
 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
 # extension names that should be enabled during MathJax rendering. For example
+# for MathJax version 2 (see
+# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# For example for MathJax version 3 (see
+# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
+# MATHJAX_EXTENSIONS = ams
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
 MATHJAX_EXTENSIONS     =
 
 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
 # of code that will be used on startup of the MathJax code. See the MathJax site
-# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
 # example see the documentation.
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
@@ -1604,7 +1747,7 @@ MATHJAX_CODEFILE       =
 SEARCHENGINE           = YES
 
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
-# implemented using a web server instead of a web client using Javascript. There
+# implemented using a web server instead of a web client using JavaScript. There
 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
 # setting. When disabled, doxygen will generate a PHP script for searching and
 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
@@ -1623,7 +1766,8 @@ SERVER_BASED_SEARCH    = NO
 #
 # Doxygen ships with an example indexer (doxyindexer) and search engine
 # (doxysearch.cgi) which are based on the open source search engine library
-# Xapian (see: https://xapian.org/).
+# Xapian (see:
+# https://xapian.org/).
 #
 # See the section "External Indexing and Searching" for details.
 # The default value is: NO.
@@ -1636,8 +1780,9 @@ EXTERNAL_SEARCH        = NO
 #
 # Doxygen ships with an example indexer (doxyindexer) and search engine
 # (doxysearch.cgi) which are based on the open source search engine library
-# Xapian (see: https://xapian.org/). See the section "External Indexing and
-# Searching" for details.
+# Xapian (see:
+# https://xapian.org/). See the section "External Indexing and Searching" for
+# details.
 # This tag requires that the tag SEARCHENGINE is set to YES.
 
 SEARCHENGINE_URL       =
@@ -1708,10 +1853,11 @@ LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
 
 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
-# generate index for LaTeX.
+# generate index for LaTeX. In case there is no backslash (\) as first character
+# it will be automatically added in the LaTeX code.
 # Note: This tag is used in the generated output file (.tex).
 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
-# The default value is: \makeindex.
+# The default value is: makeindex.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_MAKEINDEX_CMD    = \makeindex
@@ -1745,29 +1891,31 @@ PAPER_TYPE             = a4
 
 EXTRA_PACKAGES         =
 
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
-# generated LaTeX document. The header should contain everything until the first
-# chapter. If it is left blank doxygen will generate a standard header. See
-# section "Doxygen usage" for information on how to let doxygen write the
-# default header to a separate file.
+# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
+# the generated LaTeX document. The header should contain everything until the
+# first chapter. If it is left blank doxygen will generate a standard header. It
+# is highly recommended to start with a default header using
+# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
+# and then modify the file new_header.tex. See also section "Doxygen usage" for
+# information on how to generate the default header that doxygen normally uses.
 #
-# Note: Only use a user-defined header if you know what you are doing! The
-# following commands have a special meaning inside the header: $title,
-# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
+# Note: Only use a user-defined header if you know what you are doing!
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. The following
+# commands have a special meaning inside the header (and footer): For a
+# description of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_HEADER           =
 
-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
-# generated LaTeX document. The footer should contain everything after the last
-# chapter. If it is left blank doxygen will generate a standard footer. See
+# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
+# the generated LaTeX document. The footer should contain everything after the
+# last chapter. If it is left blank doxygen will generate a standard footer. See
 # LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the footer.
-#
-# Note: Only use a user-defined footer if you know what you are doing!
+# special commands can be used inside the footer. See also section "Doxygen
+# usage" for information on how to generate the default footer that doxygen
+# normally uses. Note: Only use a user-defined footer if you know what you are
+# doing!
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_FOOTER           =
@@ -1800,9 +1948,11 @@ LATEX_EXTRA_FILES      =
 
 PDF_HYPERLINKS         = YES
 
-# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
-# the PDF file directly from the LaTeX files. Set this option to YES, to get a
-# higher quality PDF documentation.
+# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
+# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
+# files. Set this option to YES, to get a higher quality PDF documentation.
+#
+# See also section LATEX_CMD_NAME for selecting the engine.
 # The default value is: YES.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
@@ -1810,8 +1960,7 @@ USE_PDFLATEX           = YES
 
 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
 # command to the generated LaTeX files. This will instruct LaTeX to keep running
-# if errors occur, instead of asking the user for help. This option is also used
-# when generating formulas in HTML.
+# if errors occur, instead of asking the user for help.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
@@ -1824,16 +1973,6 @@ LATEX_BATCHMODE        = NO
 
 LATEX_HIDE_INDICES     = NO
 
-# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
-# code with syntax highlighting in the LaTeX output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_SOURCE_CODE      = NO
-
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
 # bibliography, e.g. plainnat, or ieeetr. See
 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
@@ -1914,16 +2053,6 @@ RTF_STYLESHEET_FILE    =
 
 RTF_EXTENSIONS_FILE    =
 
-# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
-# with syntax highlighting in the RTF output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_SOURCE_CODE        = NO
-
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
 #---------------------------------------------------------------------------
@@ -2020,15 +2149,6 @@ GENERATE_DOCBOOK       = NO
 
 DOCBOOK_OUTPUT         = docbook
 
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
@@ -2203,34 +2323,10 @@ EXTERNAL_GROUPS        = YES
 
 EXTERNAL_PAGES         = YES
 
-# The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of 'which perl').
-# The default file (with absolute path) is: /usr/bin/perl.
-
-PERL_PATH              = /usr/bin/perl
-
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
 
-# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
-# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
-# NO turns the diagrams off. Note that this option also works with HAVE_DOT
-# disabled, but it is recommended to install and use dot, since it yields more
-# powerful graphs.
-# The default value is: YES.
-
-CLASS_DIAGRAMS         = NO
-
-# You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see:
-# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
-# the mscgen tool resides. If left empty the tool is assumed to be found in the
-# default search path.
-
-MSCGEN_PATH            =
-
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The
 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
@@ -2287,11 +2383,14 @@ DOT_FONTSIZE           = 10
 
 DOT_FONTPATH           =
 
-# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
-# each documented class showing the direct and indirect inheritance relations.
-# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
+# graph for each documented class showing the direct and indirect inheritance
+# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
+# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
+# to TEXT the direct and indirect inheritance relations will be shown as texts /
+# links.
+# Possible values are: NO, YES, TEXT and GRAPH.
 # The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
 
 CLASS_GRAPH            = YES
 
@@ -2328,10 +2427,32 @@ UML_LOOK               = YES
 # but if the number exceeds 15, the total amount of fields shown is limited to
 # 10.
 # Minimum value: 0, maximum value: 100, default value: 10.
-# This tag requires that the tag HAVE_DOT is set to YES.
+# This tag requires that the tag UML_LOOK is set to YES.
 
 UML_LIMIT_NUM_FIELDS   = 10
 
+# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
+# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
+# tag is set to YES, doxygen will add type and arguments for attributes and
+# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
+# will not generate fields with class member information in the UML graphs. The
+# class diagrams will look similar to the default class diagrams but using UML
+# notation for the relationships.
+# Possible values are: NO, YES and NONE.
+# The default value is: NO.
+# This tag requires that the tag UML_LOOK is set to YES.
+
+DOT_UML_DETAILS        = NO
+
+# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
+# to display on a single line. If the actual line length exceeds this threshold
+# significantly it will wrapped across multiple lines. Some heuristics are apply
+# to avoid ugly line breaks.
+# Minimum value: 0, maximum value: 1000, default value: 17.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_WRAP_THRESHOLD     = 17
+
 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
 # collaboration graphs will show the relations between templates and their
 # instances.
@@ -2398,6 +2519,13 @@ GRAPHICAL_HIERARCHY    = YES
 
 DIRECTORY_GRAPH        = YES
 
+# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
+# of child directories generated in directory dependency graphs by dot.
+# Minimum value: 1, maximum value: 25, default value: 1.
+# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
+
+DIR_GRAPH_MAX_DEPTH    = 1
+
 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
 # generated by dot. For an explanation of the image formats see the section
 # output formats in the documentation of the dot tool (Graphviz (see:
@@ -2451,10 +2579,10 @@ MSCFILE_DIRS           =
 DIAFILE_DIRS           =
 
 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file. If left blank, it is assumed
-# PlantUML is not used or called during a preprocessing step. Doxygen will
-# generate a warning when it encounters a \startuml command in this case and
-# will not generate output for the diagram.
+# path where java can find the plantuml.jar file or to the filename of jar file
+# to be used. If left blank, it is assumed PlantUML is not used or called during
+# a preprocessing step. Doxygen will generate a warning when it encounters a
+# \startuml command in this case and will not generate output for the diagram.
 
 PLANTUML_JAR_PATH      =
 
@@ -2516,14 +2644,18 @@ DOT_MULTI_TARGETS      = YES
 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
 # explaining the meaning of the various boxes and arrows in the dot generated
 # graphs.
+# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
+# graphical representation for inheritance and collaboration diagrams is used.
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
 GENERATE_LEGEND        = YES
 
-# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
 # files that are used to generate the various graphs.
+#
+# Note: This setting is not only used for dot files but also for msc temporary
+# files.
 # The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_CLEANUP            = YES