minecraft-pi-reborn/README.md

# Minecraft: Pi Edition For Docker
This is a project allowing Minecraft: Pi Edition to be run without a Raspberry Pi using Docker.

## Setup
1. Download Appropriate Package (See Table Below) From [Here](https://jenkins.thebrokenrail.com/job/minecraft-pi-docker/job/master/lastSuccessfulBuild/artifact/out/deb/)
2. Install With ``sudo apt install ./<Path To File>``

### Packages
| Package | Description |
| --- | --- |
| ``minecraft-pi-server`` | Minecraft Pi Edition Modded Into A 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) |

### 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
# Install Backports Key
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 04EE7237B7D453EC
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 648ACFD622F3D138
# Install Backports Repository
echo 'deb http://deb.debian.org/debian buster-backports main' | sudo tee -a /etc/apt/sources.list
# Update APT Index
sudo apt update
# Install Updated libseccomp2
sudo apt install -t buster-backports libseccomp2
```

## Troubleshooting Crashes
Game logs are located in ``/tmp/minecraft-pi``.

### ``Error response from daemon: error gathering device information while adding custom device "/dev/dri": no such file or directory``
Make sure you are using the correct GPU drivers for your system. If you are using a Raspberry Pi, make sure you have set your GPU driver to ``Full KMS`` or ``Fake KMS`` in ``raspi-config``.

### ``Segmentation Fault``
1. Attempt To Reproduce Issue And Record Instructions
2. Report On Issue Tracker Including The Instructions To Reproduce

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

## Credits
[View Credits](CREDITS.md)
Initial Commit 2020-09-25 16:43:53 +00:00			`# Minecraft: Pi Edition For Docker`
Fix DEB And Update README 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.`
Initial Commit 2020-09-25 16:43:53 +00:00
Fix DEB And Update README 2020-09-27 03:35:13 +00:00			`## Setup`
Update README 2020-12-10 19:55:45 +00:00			`1. Download Appropriate Package (See Table Below) From [Here](https://jenkins.thebrokenrail.com/job/minecraft-pi-docker/job/master/lastSuccessfulBuild/artifact/out/deb/)`
			2. Install With ``sudo apt install ./<Path To File>``
Improve Modding 2020-10-03 20:18:53 +00:00
Improve Comments 2020-10-26 19:58:28 +00:00			`### Packages`
			`\| Package \| Description \|`
			`\| --- \| --- \|`
Update README 2020-12-10 19:55:45 +00:00			\| ``minecraft-pi-server`` \| Minecraft Pi Edition Modded Into A Dedicated Server \|
Improve Comments 2020-10-26 19:58:28 +00:00			\| ``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) \|

Add Raspbian Note 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:
Update README 2020-12-10 19:55:45 +00:00
Add Raspbian Note 2020-12-05 02:45:53 +00:00			```sh
Update README 2020-12-10 19:55:45 +00:00			`# Install Backports Key`
			`sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 04EE7237B7D453EC`
			`sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 648ACFD622F3D138`
			`# Install Backports Repository`
Fix Raspbian Buster Script 2020-12-05 18:35:14 +00:00			`echo 'deb http://deb.debian.org/debian buster-backports main' \| sudo tee -a /etc/apt/sources.list`
Update README 2020-12-10 19:55:45 +00:00			`# Update APT Index`
			`sudo apt update`
			`# Install Updated libseccomp2`
			`sudo apt install -t buster-backports libseccomp2`
Add Raspbian Note 2020-12-05 02:45:53 +00:00			```

Show Dialog On Crash + Add Troubleshooting Information To README 2020-12-10 22:16:44 +00:00			`## Troubleshooting Crashes`
			Game logs are located in ``/tmp/minecraft-pi``.

			### ``Error response from daemon: error gathering device information while adding custom device "/dev/dri": no such file or directory``
			Make sure you are using the correct GPU drivers for your system. If you are using a Raspberry Pi, make sure you have set your GPU driver to ``Full KMS`` or ``Fake KMS`` in ``raspi-config``.

			### ``Segmentation Fault``
			`1. Attempt To Reproduce Issue And Record Instructions`
			`2. Report On Issue Tracker Including The Instructions To Reproduce`

Document Server 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`
Remove Player Data Storage From Dedicated Server Mod It was very complicated and because it lacked proper authentication and inventory saving, it was basically useless. 2020-12-15 19:17:04 +00:00			`- Player data is not saved because of limitations with MCPE LAN worlds`
Document Server 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

Improve Modding 2020-10-03 20:18:53 +00:00			`## Modding`
			`[View Modding](MODDING.md)`
Link To Credits 2020-11-20 21:39:05 +00:00
			`## Credits`
			`[View Credits](CREDITS.md)`