Plugin Repository • Forums • Discord • Source Code

PocketMine-MP is a custom server software for the Minecraft: Bedrock family of Minecraft editions (includes Android, iOS, W10 and others).

What features does it have?

A powerful plugin API, which allows you to extend and customize your server far more easily and extensively than any competing server implementations, including the official vanilla server.
Multi-world support, allowing you to offer a more varied game experience to players without transferring them to other server nodes.
Performance fit to hold 100+ players (depends on hardware, see the Setup requirements section).
Continuously updated to support latest Minecraft versions. PocketMine-MP has the longest and best track record of any custom server for compatibility with new Minecraft versions.

Note

PocketMine-MP is NOT a complete vanilla server, and it doesn’t have some features you would find in the vanilla game.

If you just want to play survival multiplayer and don’t care about plugins, you should consider using the official Minecraft: Bedrock server software instead of using PocketMine-MP.

Installation & Updating

Setup requirements

A computer or device with the following is required:

64-bit CPU
64-bit operating system
1GB RAM or better

The following are not requirements, but recommended:

Dual-core or better CPU

Note

PocketMine-MP is notoriously bad at multi-core usage. If purchasing a machine to run PocketMine-MP on, prefer higher CPU frequency instead of lots of cores.

We officially try to support Windows, Linux and MacOS platforms. However, in general any platform which will run 64-bit PHP with the required extensions will work.

Using the official installer (Linux/MacOS only)

Warning

Only works on Linux or MacOS.

If you’re creating a new server, create a directory which you want to install PocketMine-MP into, and cd into it.

Otherwise, just cd straight into your existing server folder.

Installing/updating to the latest version

Then use curl to install/update PocketMine-MP using the following command:

curl -sL https://get.pmmp.io | bash -s -

or, if you don’t have curl, try wget:

wget -q -O - https://get.pmmp.io | bash -s -

[*] Found PocketMine-MP Final_1.5dev (build 1254) using API 1.12.0
[*] This development build was released on Sat Jun 20 09:45:04 CEST 2015
[*] Installing/updating PocketMine-MP on directory ./
[1/3] Cleaning...
[2/3] Downloading PocketMine-MP Final_1.5dev-1254 phar... done!
[3/3] Obtaining PHP: detecting if build is available...
[3/3] MacOS 64-bit PHP build available, downloading PHP_5.6.10_x86-64_MacOS.tar.gz... checking... regenerating php.ini... done
[*] Everything done! Run ./start.sh to start PocketMine-MP

Error

It is recommended to run it as a normal user as it doesn’t need further permissions.

Do not run the installer as root, this is discouraged.

Note

If the installer doesn’t work for you, try installing manually.

Installing a specific version

If you don’t want to run the latest version, you may be able to run an older version by giving the -v option to the installer.

Examples:

Version	Command
Latest 4.x stable	`curl -sL https://get.pmmp.io \| bash -s - -v 4`
Latest 5.x beta	`curl -sL https://get.pmmp.io \| bash -s - -v 5-beta`
Latest 5.1 stable	`curl -sL https://get.pmmp.io \| bash -s - -v 5.1`

You can see a list of available options for -v by clicking here.

Using Docker (Linux only)

Using Docker is a relatively easy and secure way to run PocketMine-MP.

Click here for instructions on using Docker to run PocketMine-MP.

Installing/updating manually

Warning

Installing manually is complicated. Don’t attempt it unless you have no other option.

Windows

Make a folder for your server. If you’re updating an existing server, delete PocketMine-MP.phar, any file called start, and the bin folder from the folder.
Download the custom PHP binary for Windows here. Make sure you get the right version for your chosen version of PocketMine-MP (see below).
Right-click -> click Extract All, pick your server folder and click Extract. Now you should have a folder called bin.
In the bin folder, double-click the fole vc_redist.x64.exe, accept the terms and conditions, and install. This will install Microsoft Visual C++ Redistributable, which is needed by the PHP binary.
Download your chosen version of PocketMine-MP.phar and start.cmd from here and save them in your server folder.

Now you should be able to double-click start.cmd to start the server.

Linux/MacOS

The following steps require you to use the Terminal.

cd to wherever you want to put the server (e.g. cd /home/dylan).
Make a folder for your server using mkdir (e.g. mkdir pocketmine). If you’re updating an existing server, cd directly to your server’s folder instead.
Run rm -rf ./bin ./PocketMine-MP.phar ./start.sh. This deletes any outdated server files (don’t worry, your data won’t be harmed).
Find the download link for the right PHP version for your OS. You can see a list of available ones here.
Run curl -L <link to your chosen PHP binary> | tar -xz. Now you should have a folder called bin. Make sure you get the right version for your chosen version of PocketMine-MP (see below).
Find the download link for your chosen version of PocketMine-MP.phar and start.sh here.
Run curl -LO <link to PocketMine-MP.phar>.
Run curl -LO <link to start.sh>.
Run chmod +x ./start.sh.`

Now you should be able to run the server by running ./start.sh.

Warning

Make sure you know which binary to use for your chosen version of PocketMine-MP. Different versions need different binaries. You can get some information about this from the update.pmmp.io API.

Binaries have a suffix that tells you which PocketMine-MP version they are for. PM4 is for 4.x, and PM5 is for 5.x.

There are also different downloads different operating systems, different CPU architectures and different versions of PHP itself.

If you use the wrong binary, the server might not work.

Basic usage

Starting the server

Linux/MacOS: run ./start.sh
Windows: Double-click start.cmd, or open PowerShell in the server directory and run .\start.ps1.

Setup Wizard

The first time PocketMine-MP starts, it launches a setup wizard.

The setup wizard will allow you to choose a language, and guide you through setting up basic information about your new server, like its name, the server port, etc.

Note

You’ll be asked to accept the terms of PocketMine-MP’s license. You can read the full text of the license on GitHub.

Tip

You can skip the setup wizard by passing --no-wizard to start.sh, start.cmd or start.ps1.

Stopping the server

To stop the server, simply type stop in the console and press enter.

Error

Do NOT click the X to stop the server. You could lose data or your data might get corrupted.

Configuration

Server behaviour

PocketMine-MP’s behaviour is controlled by several configuration files. You can edit them to change the behaviour of your server.

server.properties contains basic settings like the server name, port, maximum view distance, etc. These settings are all safe to change.
pocketmine.yml contains more advanced settings settings like memory usage, max thread count, etc. It also contains settings for loading multiple worlds.

Warning

It’s best to leave a setting alone if you don’t understand what it’s for. Many settings in pocketmine.yml can break your server if configured incorrectly.

Note

To edit configs on Windows, right-click on the file → Open With → Choose another app → Notepad.

Resource packs

resource_packs.yml is found in the resource_packs folder.

Player permissions

There are several files that allow you to control player permissions on your server:

ops.txt is a simple list of player names that have “op” permissions on your server. Ops can do more things than regular players, like giving items, teleporting, stopping the server and more.
banned-players.txt lists names of players that are banned from your server.
banned-ips.txt lists IPs that are not allowed to connect to your server. This is useful for troublesome players who change accounts and keep coming back to hassle you.

Note

You can modify these by using slash commands instead of editing the files directly. See /op, /deop, /ban, /unban, /ban-ip and /unban-ip.

Plugins

PocketMine-MP can be extended and customized with plugins.

A plugin is an external module which can be “plugged in” to your server to add custom features, change default behaviours and more.

Downloading plugins

You can find a wide range of premade plugins on the Poggit Release plugin platform.

Installing/updating a plugin

Plugin developers usually distribute plugins as phar files. These files can be easily loaded by placing them in your plugins folder in the server data folder.

Be sure to delete old versions of the plugin, and restart the server to see changes.

Writing your own plugins

You can find resources for plugin development at the DeveloperDocs site.

Resource Packs & Behaviour Packs

PocketMine-MP has some support for resource packs.

Any number of valid resource packs may be loaded. However, per-world resource packs are not currently supported at the time of writing.

Error

Behaviour packs are not supported.

Warning

Resource packs which depend on behaviour packs may not work correctly. While PocketMine-MP will not prevent you loading such packs, it makes no attempt to validate dependencies and your game may experience errors or crashes when attempting to use them.

Installing resource packs

Resource packs to be loaded should be placed in the resource_packs folder of your server data.

Then, you will need to add them to the stack in the resource_packs.yml file (also located in the resource_packs folder).

Resource stack

This is a list of resource packs in resource_packs.yml that will used by your server. It should contain a list of valid resource pack file names found in the resource_packs folder, including the file extension.

Resource packs are applied from bottom to top, similar to how they work in Minecraft itself. This means that resources at the top of the list will override resources lower down the list.

Supported pack formats

At the time of writing, the following types of resource pack are supported:

.zip
.mcpack

Error

Unpacked (folder) resource packs are not currently supported.

Permissions

PocketMine-MP includes a powerful permission system, similar in functionality to the one found in Bukkit. It allows fine-grained control of access to various parts of the server functionality, such as:

Ability to use individual commands
Whether or not the user can see administrative broadcasts when a command is used (e.g. when someone uses /op)

In addition, plugins can offer permissions to allow customising access to behaviours that they offer.

PocketMine-MP doesn’t directly offer any way to use permissions at the time of writing (August 2022), but you can find permission management plugins in the “Admin Tools” section on Poggit.

Built-in permissions

List of PocketMine-MP core permissions

Generated from PocketMine-MP 4.13.1+dev

Name	Description	Implied permissions
`pocketmine.broadcast.admin`	Allows the user to receive administrative broadcasts	N/A
`pocketmine.broadcast.user`	Allows the user to receive user broadcasts	N/A
`pocketmine.command.ban.ip`	Allows the user to ban IP addresses	N/A
`pocketmine.command.ban.list`	Allows the user to list banned players	N/A
`pocketmine.command.ban.player`	Allows the user to ban players	N/A
`pocketmine.command.clear.other`	Allows the user to clear inventory of other players	N/A
`pocketmine.command.clear.self`	Allows the user to clear their own inventory	N/A
`pocketmine.command.defaultgamemode`	Allows the user to change the default gamemode	N/A
`pocketmine.command.difficulty`	Allows the user to change the game difficulty	N/A
`pocketmine.command.dumpmemory`	Allows the user to dump memory contents	N/A
`pocketmine.command.effect`	Deprecated, kept for backwards compatibility only	Jump
`pocketmine.command.effect.other`	Allows the user to modify effects of other players	N/A
`pocketmine.command.effect.self`	Allows the user to modify their own effects	N/A
`pocketmine.command.enchant`	Deprecated, kept for backwards compatibility only	Jump
`pocketmine.command.enchant.other`	Allows the user to enchant the held items of other players	N/A
`pocketmine.command.enchant.self`	Allows the user to enchant their own held item	N/A
`pocketmine.command.gamemode`	Deprecated, kept for backwards compatibility only	Jump
`pocketmine.command.gamemode.other`	Allows the user to change the game mode of other players	N/A
`pocketmine.command.gamemode.self`	Allows the user to change their own game mode	N/A
`pocketmine.command.gc`	Allows the user to fire garbage collection tasks	N/A
`pocketmine.command.give`	Deprecated, kept for backwards compatibility only	Jump
`pocketmine.command.give.other`	Allows the user to give items to other players	N/A
`pocketmine.command.give.self`	Allows the user to give items to themselves	N/A
`pocketmine.command.help`	Allows the user to view the help menu	N/A
`pocketmine.command.kick`	Allows the user to kick players	N/A
`pocketmine.command.kill.other`	Allows the user to kill other players	N/A
`pocketmine.command.kill.self`	Allows the user to commit suicide	N/A
`pocketmine.command.list`	Allows the user to list all online players	N/A
`pocketmine.command.me`	Allows the user to perform a chat action	N/A
`pocketmine.command.op.give`	Allows the user to give a player operator status	N/A
`pocketmine.command.op.take`	Allows the user to take a player’s operator status	N/A
`pocketmine.command.particle`	Allows the user to create particle effects	N/A
`pocketmine.command.plugins`	Allows the user to view the list of plugins	N/A
`pocketmine.command.save.disable`	Allows the user to disable automatic saving	N/A
`pocketmine.command.save.enable`	Allows the user to enable automatic saving	N/A
`pocketmine.command.save.perform`	Allows the user to perform a manual save	N/A
`pocketmine.command.say`	Allows the user to talk as the console	N/A
`pocketmine.command.seed`	Allows the user to view the seed of the world	N/A
`pocketmine.command.setworldspawn`	Allows the user to change the world spawn	N/A
`pocketmine.command.spawnpoint`	Deprecated, kept for backwards compatibility only	Jump
`pocketmine.command.spawnpoint.other`	Allows the user to change the respawn point of other players	N/A
`pocketmine.command.spawnpoint.self`	Allows the user to change their own respawn point	N/A
`pocketmine.command.status`	Allows the user to view the server performance	N/A
`pocketmine.command.stop`	Allows the user to stop the server	N/A
`pocketmine.command.teleport`	Deprecated, kept for backwards compatibility only	Jump
`pocketmine.command.teleport.other`	Allows the user to teleport other players	N/A
`pocketmine.command.teleport.self`	Allows the user to teleport themselves	N/A
`pocketmine.command.tell`	Allows the user to privately message another player	N/A
`pocketmine.command.time.add`	Allows the user to fast-forward time	N/A
`pocketmine.command.time.query`	Allows the user query the time	N/A
`pocketmine.command.time.set`	Allows the user to change the time	N/A
`pocketmine.command.time.start`	Allows the user to restart the time	N/A
`pocketmine.command.time.stop`	Allows the user to stop the time	N/A
`pocketmine.command.timings`	Allows the user to record timings to analyse server performance	N/A
`pocketmine.command.title`	Deprecated, kept for backwards compatibility only	Jump
`pocketmine.command.title.other`	Allows the user to send a title to the specified player	N/A
`pocketmine.command.title.self`	Allows the user to send a title to themselves	N/A
`pocketmine.command.transferserver`	Allows the user to transfer self to another server	N/A
`pocketmine.command.unban.ip`	Allows the user to unban IP addresses	N/A
`pocketmine.command.unban.player`	Allows the user to unban players	N/A
`pocketmine.command.version`	Allows the user to view the version of the server	N/A
`pocketmine.command.whitelist.add`	Allows the user to add a player to the server whitelist	N/A
`pocketmine.command.whitelist.disable`	Allows the user to disable the server whitelist	N/A
`pocketmine.command.whitelist.enable`	Allows the user to enable the server whitelist	N/A
`pocketmine.command.whitelist.list`	Allows the user to list all players on the server whitelist	N/A
`pocketmine.command.whitelist.reload`	Allows the user to reload the server whitelist	N/A
`pocketmine.command.whitelist.remove`	Allows the user to remove a player from the server whitelist	N/A
`pocketmine.group.console`	Grants all console permissions	Jump
`pocketmine.group.operator`	Grants all operator permissions	Jump
`pocketmine.group.user`	Grants all non-sensitive permissions that everyone gets by default	Jump

Implied permissions

Some permissions automatically grant (or deny) other permissions by default when granted. These are referred to as implied permissions.

Permissions may imply permissions which in turn imply other permissions (e.g. pocketmine.group.operator implies pocketmine.group.user, which in turn implies pocketmine.command.help).

Implied permissions can be overridden by explicit permissions from elsewhere.

Note: When explicitly denied, implied permissions are inverted. This means that “granted” becomes “denied” and vice versa.