minecraft-pi-docker/README.md

45 lines
2.3 KiB
Markdown
Raw Normal View History

2020-09-25 16:43:53 +00:00
# Minecraft: Pi Edition For Docker
2020-09-27 03:35:13 +00:00
This is a project allowing Minecraft: Pi Edition to be run without a Raspberry Pi using Docker.
2020-09-25 16:43:53 +00:00
2020-09-27 03:35:13 +00:00
## Setup
[View Binaries](https://jenkins.thebrokenrail.com/job/minecraft-pi-docker/job/master/lastSuccessfulBuild/artifact/out/)
2020-10-03 20:18:53 +00:00
2020-10-26 19:58:28 +00:00
### Packages
| Package | Description |
| --- | --- |
| ``minecraft-pi-server`` | Dedicated Server |
| ``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) |
2020-12-05 02:45:53 +00:00
### General Notes
#### Docker Versions
While the distribution-provided version of Docker works fine on most systems, in rare cases it can be outdated and cause bugs. Before reporting a bug, try using the official builds of Docker. These can be installed by following your distribution's instructions at https://docs.docker.com/engine/install.
### Distribution-Specific Notes
#### Raspbian Buster
By default Raspbian Buster ships an older version of the package ``libseccomp2``. This package is used to block certain dangerous system calls from running inside Docker containers. The included version accidentally blocks the system call ``clock_gettime64``, this causes bugs inside Minecraft: Pi Edition. However, the Debian ``buster-backports`` repo includes an updated version. You can enable the ``buster-backports`` repo and update ``libseccomp2`` by running:
```sh
echo 'deb http://deb.debian.org/debian buster-backports main' | sudo tee /etc/apt/sources.list
sudo apt update && sudo apt install libseccomp2
```
2020-10-27 18:37:29 +00:00
## 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
2020-11-06 04:05:37 +00:00
- Player inventories are not saved because of limitations with MCPE LAN worlds
2020-10-27 18:37:29 +00:00
- 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
2020-10-03 20:18:53 +00:00
## Modding
[View Modding](MODDING.md)
2020-11-20 21:39:05 +00:00
## Credits
[View Credits](CREDITS.md)