PocketMine-MP Documentation

PocketMine-MP Documentation

Release 4.0.0 PocketMine Team

Jun 13, 2023

1 Installation & Updating 2 Basic usage 3 Configuration 4 Plugins 5 Resource Packs & Behaviour Packs 6 Permissions 7 Contact and Support 8 Useful Links 9 Installation 10 Connecting 11 Playing 12 Plugins 13 About PocketMine-MP 14 Crashes 15 Using the GitHub Issue Tracker 16 Developer Reference 17 External development resources

GETTING STARTED

3 7 9 11 13 15 23 25 27 29 35 37 39 41 43 45 59

i

ii

PocketMine-MP Documentation, Release 4.0.0

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).

? 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.

GETTING STARTED

1

PocketMine-MP Documentation, Release 4.0.0

2

GETTING STARTED

CHAPTER

ONE

INSTALLATION & UPDATING

1.1 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.

1.2 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.

1.2.1 Installing/updating to the latest version

Then use curl to install/update PocketMine-MP using the following command: curl -sL | bash -s or, if you don't have curl, try wget: wget -q -O - | bash -s -

3

PocketMine-MP Documentation, Release 4.0.0

[*] 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.

1.2.2 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 Latest 4.x stable Latest 5.x beta Latest 5.1 stable

Command curl -sL | bash -s - -v 4 curl -sL | bash -s - -v 5-beta curl -sL | bash -s - -v 5.1

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

1.3 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.

1.4 Installing/updating manually

Warning: Installing manually is complicated. Don't attempt it unless you have no other option.

1.4.1 Windows

1. 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.

4

Chapter 1. Installation & Updating

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download