mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-05-16 02:38:54 +00:00
54 lines
3.4 KiB
Markdown
54 lines
3.4 KiB
Markdown
<p align="center">
|
|
<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://github.com/pmmp/PocketMine-MP/raw/stable/.github/readme/pocketmine-dark.png" media="(prefers-color-scheme: dark)">
|
|
<img src="https://github.com/pmmp/PocketMine-MP/raw/stable/.github/readme/pocketmine.png" 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">
|
|
<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://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://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
|
|
- [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)
|
|
- [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)
|
|
|
|
## For developers
|
|
* [Building and running from source](BUILDING.md)
|
|
* [Developer documentation](https://devdoc.pmmp.io) - General documentation for PocketMine-MP plugin developers
|
|
* [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 `next-major` 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 Guidelines](CONTRIBUTING.md)
|
|
|
|
## Donate
|
|
- Bitcoin Cash (BCH): `qq3r46hn6ljnhnqnfwxt5pg3g447eq9jhvw5ddfear`
|
|
- Bitcoin (BTC): `171u8K9e4FtU6j3e5sqNoxKUgEw9qWQdRV`
|
|
- Stellar Lumens (XLM): `GAAC5WZ33HCTE3BFJFZJXONMEIBNHFLBXM2HJVAZHXXPYA3HP5XPPS7T`
|
|
- [Patreon](https://www.patreon.com/pocketminemp)
|
|
|
|
## Licensing information
|
|
This project is licensed under LGPL-3.0. Please see the [LICENSE](/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.
|