minecraft-pi-reborn/README.md

38 lines
1.2 KiB
Markdown

<center>
![Start Screen](images/start.png)
</center>
# Minecraft: Pi Edition: Reborn
Minecraft: Pi Edition Modding Project
## Installation
### Option A: Pi-Apps (Raspberry Pi Only)
[![Pi-Apps](https://github.com/Botspot/pi-apps/blob/master/icons/badge.png?raw=true)](https://github.com/Botspot/pi-apps)
### Option B: Manual Installation
[View Manual Installation](docs/INSTALL.md)
## Troubleshooting
[View Troubleshooting](docs/TROUBLESHOOTING.md)
## Dedicated Server
The dedicated server is a version of Minecraft: Pi Edition modified to run in a headless environment. It loads settings from a ``server.properties`` file.
To use, install the ``minecraft-pi-reborn-server`` package and run ``minecraft-pi-reborn-server``. It will generate the world and ``server.properties`` in the current directory.
This server is also compatible with MCPE Alpha v0.6.1.
### Limitations
- Player data is not saved because of limitations with MCPE LAN worlds
- An easy workaround is to place your inventory in a chest before logging off
- Survival Mode servers are only compatible with ``minecraft-pi-reborn`` clients
## Modding
[View Modding](docs/MODDING.md)
## Credits
[View Credits](docs/CREDITS.md)