From bd57e4b004d62fc240f4c8cb3046d3215359ea0e Mon Sep 17 00:00:00 2001 From: TheBrokenRail Date: Tue, 27 Oct 2020 14:37:29 -0400 Subject: [PATCH] Document Server --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 674057eb0..753f39bdf 100644 --- a/README.md +++ b/README.md @@ -11,5 +11,17 @@ This is a project allowing Minecraft: Pi Edition to be run without a Raspberry P | ``minecraft-pi-virgl`` | Minecraft Pi Edition Using VirGL For Hardware Acceleration (Recommended For Desktop) | | ``minecraft-pi-native`` | Minecraft: Pi Edition Using Docker Device Mounting For GPU Acceleration (Recommended For Raspberry Pi) | +## 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-server`` package and run ``minecraft-pi-server``. It will generate the world and ``server.properties`` in the current directory. + +This is also compatible with MCPE 0.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-docker`` clients + ## Modding [View Modding](MODDING.md)