Bedriox ExamplePlugin

This repository contains the first-party example plugin for Bedriox, a Minecraft: Bedrock Edition server written in modern PHP.

ExamplePlugin targets the experimental Bedriox API 0.4. It demonstrates a PHAR-ready manifest, lifecycle logging, attribute-based event registration, the default NORMAL priority, an explicit HIGH cancellable listener, read-only MONITOR observation, session-bound player messaging, class-based typed commands, PHP backed-enum arguments, typed command values, senders, and the high-level player display API, a runtime crafting recipe, and a persistent custom mob with typed entity events. It also demonstrates the authoritative effect manager and typed world-particle API without sending packets directly. Committed furnace and player-experience events are observed without mutating station state, items, experience, or protocol values.

Example behavior

• Players receive a welcome message after joining.
• resources/config.yml is copied into the plugin data directory once and controls the public join announcement without overwriting later edits.
• examplebroadcast <message> demonstrates the global server broadcast API.
• Sending the exact text cancel me demonstrates chat cancellation and an authoritative private response.
• Accepted and cancelled chat is observed at MONITOR priority.
• Successful block placement is logged through the plugin-bound logger.
• One dirt block can be crafted into one grass block through the plugin-owned exampleplugin:grass_block_from_dirt shapeless recipe.
• A cancellable pre-craft listener limits that example recipe to 16 repetitions per request, while a MONITOR listener observes committed crafts.
• examplesender reports whether its caller is the server console or a player.
• exampledisplay demonstrates messages, popups, jukebox popups, tips, titles, subtitles, action bars, toast notifications, and title clear/reset behavior.
• exampleeffect applies Speed for ten seconds and sends a heart particle only to the executing player through the containing world.
• examplespawn creates the plugin-owned exampleplugin:guide mob two blocks in front of the player. The example registers its appearance, dimensions, health, lifecycle behavior, and bounded persistent state through the entity registrar.
• The guide's AI hook submits bounded movement and look intents through its per-callback controller. Bedriox applies them together only after the hook returns successfully.
• Interacting with the guide demonstrates a cancellable typed entity event; committed guide spawns are observed through a post-event listener.
• Committed furnace smelts and player experience changes are observed at MONITOR priority through typed post-events. The listeners only write bounded debug summaries and do not modify processing or experience.

examplesender accepts either sender type and does not change player or world state. exampledisplay is player-only and declares its display modes through a PHP backed enum, which Bedriox uses for validation, usage, and client autocomplete. For example:

/exampledisplay title
/exampledisplay actionbar
/exampledisplay toast
/exampleeffect
/examplespawn
/examplebroadcast Server restart soon

exampleeffect uses Player::getEffects() and World::spawnParticle(). Effect duration is expressed in simulation ticks, and amplifier zero means level one. The EntityEffectAddedEvent listener observes the committed effect through typed values; it does not inspect numeric effect or packet IDs.

Run examplespawn while standing in a loaded area with clear space in front of the player. The custom type uses a cow as its current client appearance, but its canonical identity and lifecycle remain owned by ExamplePlugin. Its state codec stores only a bounded lifetime counter and does not serialize PHP objects. Its network appearance uses the current vanilla catalog identity; that appearance does not replace the plugin-owned canonical type.

Every lifecycle callback is transactional. Calls to the custom mob controller and other staged plugin APIs are committed only when the callback returns successfully. A callback exception discards the complete staged batch and follows the normal plugin failure path. Replacing an owned definition with replace: true affects later spawns; already-live mobs retain the immutable behavior factory and state codec generation with which they were created.

The API 0.4 examples keep actions on the object that owns their authority: player messages and displays use the event or command's Player, spawn positions retain the player's generation-bound World, and plugin-owned registrars come from PluginContext. A retained player snapshot cannot message a disconnected session, and Bedriox rejects the request by returning false.

Player inventory changes follow the same ownership rule. Main inventory and hotbar operations use getInventory(), equipment uses getArmorInventory(), and the single offhand slot uses getOffHandInventory():

use Bedriox\Api\Inventory\ItemStack;

$player->getInventory()->addItem(new ItemStack('minecraft:apple', 1));
$player->getArmorInventory()->clearAll();
$player->getOffHandInventory()->clear();

These are session-bound authoritative capabilities. Content arrays are snapshots, and a capability retained after the player disconnects cannot modify a later connection.

Packaged resources and PluginTools source resources use the same plugin data API. The example copies resources/config.yml only when it does not already exist, then reads it with $this->context()->data()->config(). YAML, YML, and JSON configuration files support typed getters, dot-separated keys, saving, and reloading. The plugin-bound logger identifies ExamplePlugin on every debug, info, notice, warning, error, and critical record.

Processing and experience listeners use FurnaceSmeltedEvent and PlayerExperienceChangedEvent, the non-deprecated committed event names. A plugin that needs policy enforcement should use the matching cancellable pre-event, while still respecting Bedriox's reach, ownership, capacity, revision, and atomic-commit checks.

Run the source plugin

Install PluginTools.phar, then copy or clone this project as a direct child of the server's plugins/ directory:

plugins/
|-- PluginTools.phar
`-- ExamplePlugin/
    |-- plugin.json
    `-- src/

Restart Bedriox. PluginTools automatically discovers and loads the source project; Bedriox itself continues to load only PHAR plugins. Restart again after changing PHP source because loaded classes cannot be safely replaced.

From the Bedriox console, verify the command example:

examplesender

With a player, place one dirt block in the personal or crafting-table grid and craft the advertised grass-block result. A request for more than 16 repetitions is cancelled as one transaction and receives the plugin's private explanation; smaller committed crafts are observed through the post-event listener.

Build the PHAR

With the source project loaded through PluginTools, run the primary build workflow from the Bedriox console:

makeplugin ExamplePlugin

The signed archive and checksum are written to:

plugin_data/PluginTools/ExamplePlugin.phar
plugin_data/PluginTools/ExamplePlugin.phar.sha256

An existing build is preserved. Replace it explicitly with:

makeplugin ExamplePlugin --overwrite

For CI, automation, or an offline server, the standalone CLI remains available:

php -d phar.readonly=0 ../PluginTools/bin/plugin-tools . dist/ExamplePlugin.phar

Copy the resulting PHAR into plugins/ and remove or move the source directory before restarting, because a source and PHAR plugin cannot share the same name. PluginTools is development tooling and should normally be removed from a production server.

Development

Requirements:

• 64-bit PHP 8.4 or later within the PHP 8 major line
• Composer 2

Install the development tools and run the repository gate:

composer install
composer check

See CONTRIBUTING.md before proposing a change and SECURITY.md for private vulnerability reporting.

License

Bedriox ExamplePlugin is free and open-source software licensed under the GNU General Public License v3.0 only.

Bedriox is an independent project and is not affiliated with or endorsed by Mojang Studios or Microsoft. Minecraft is a trademark of Microsoft Corporation.