pocketmine/pocketmine-mp

A server software for Minecraft: Bedrock Edition written in PHP

5.21.1 2024-11-12 11:48 UTC

Requires

• php: ^8.1
• php-64bit: *
• composer-runtime-api: ^2.0
• ext-chunkutils2: ^0.3.1
• ext-crypto: ^0.3.1
• ext-ctype: *
• ext-curl: *
• ext-date: *
• ext-gmp: *
• ext-hash: *
• ext-igbinary: ^3.0.1
• ext-json: *
• ext-leveldb: ^0.2.1 || ^0.3.0
• ext-mbstring: *
• ext-morton: ^0.1.0
• ext-openssl: *
• ext-pcre: *
• ext-phar: *
• ext-pmmpthread: ^6.1.0
• ext-reflection: *
• ext-simplexml: *
• ext-sockets: *
• ext-spl: *
• ext-yaml: >=2.0.0
• ext-zip: *
• ext-zlib: >=1.2.11
• adhocore/json-comment: ~1.2.0
• pocketmine/bedrock-block-upgrade-schema: ~5.0.0+bedrock-1.21.40
• pocketmine/bedrock-data: ~2.14.0+bedrock-1.21.40
• pocketmine/bedrock-item-upgrade-schema: ~1.13.0+bedrock-1.21.40
• pocketmine/bedrock-protocol: ~35.0.0+bedrock-1.21.40
• pocketmine/binaryutils: ^0.2.1
• pocketmine/callback-validator: ^1.0.2
• 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/netresearch-jsonmapper: ~v4.4.999
• 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

Requires (Dev)

• phpstan/phpstan: 1.11.11
• phpstan/phpstan-phpunit: ^1.1.0
• phpstan/phpstan-strict-rules: ^1.2.0
• phpunit/phpunit: ^10.5.24

LGPL-3.0

README

A highly customisable, open source server software for Minecraft: Bedrock Edition written in PHP

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

❌ 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 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, or write plugins to implement them yourself.

Getting Started

• Documentation
• Installation instructions
• Docker image
• Plugin repository

Community & Support

Join our Discord server to chat with other users and developers.

You can also post questions on StackOverflow 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.

• Developer documentation - General documentation for PocketMine-MP plugin developers
• Latest release API documentation - Doxygen API documentation generated for each release
• Latest bleeding-edge API documentation - Doxygen API documentation generated weekly from major-next branch
• DevTools - Development tools plugin for creating plugins
• 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
• Contributing Guidelines

Donate

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
• Bitcoin (BTC): 171u8K9e4FtU6j3e5sqNoxKUgEw9qWQdRV
• Stellar Lumens (XLM): GAAC5WZ33HCTE3BFJFZJXONMEIBNHFLBXM2HJVAZHXXPYA3HP5XPPS7T

Thanks for your support!

Licensing information

This project is licensed under LGPL-3.0. Please see the LICENSE file for details.

pmmp/PocketMine are not affiliated with Mojang. All brands and trademarks belong to their respective owners. PocketMine-MP is not a Mojang-approved software, nor is it associated with Mojang.