minecraft-pi-reborn/README.md

# Minecraft: Pi Edition: Reborn
Minecraft: Pi Edition Modding Project

## Getting Started
1. Remove Old Minecraft: Pi Edition Package If Installed (``sudo apt remove minecraft-pi``)
2. Download Appropriate Package From [Here](https://jenkins.thebrokenrail.com/job/minecraft-pi-reborn/job/master/lastSuccessfulBuild/artifact/out/deb/) (See Table Below)
3. Install With ``sudo apt install ./<Path To File>``
4. Have Fun!

### Packages
| Package | Description |
| --- | --- |
| ``minecraft-pi-reborn-server`` | Minecraft Pi Edition Modded Into A Dedicated Server |
| ``minecraft-pi-reborn-virgl`` | Minecraft Pi Edition Using VirGL For Hardware Acceleration (Recommended For Desktop) |
| ``minecraft-pi-reborn-native`` | Minecraft: Pi Edition Using Docker Device Mounting For GPU Acceleration (Recommended For ARM Devices (ie. Raspberry Pi, PinePhone, etc)) |

## General Notes

### Docker Versions
While the distribution-provided version of Docker is fine for 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.

### Debian/Raspbian Buster And ``libseccomp2``
By default Debian/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. Buster's version accidentally blocks the system call ``clock_gettime64``, this causes bugs inside of 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-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 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-reborn`` clients

## Modding
[View Modding](MODDING.md)

## Credits
[View Credits](CREDITS.md)
Project Rename 2021-01-27 16:13:06 +00:00			`# Minecraft: Pi Edition: Reborn`
			`Minecraft: Pi Edition Modding Project`
Initial Commit 2020-09-25 16:43:53 +00:00
Fixes 2021-01-27 21:26:19 +00:00			`## Getting Started`
Update README 2020-12-25 18:27:00 +00:00			1. Remove Old Minecraft: Pi Edition Package If Installed (``sudo apt remove minecraft-pi``)
Fixes 2021-01-27 21:26:19 +00:00			`2. Download Appropriate Package From [Here](https://jenkins.thebrokenrail.com/job/minecraft-pi-reborn/job/master/lastSuccessfulBuild/artifact/out/deb/) (See Table Below)`
Update README 2020-12-25 18:27:00 +00:00			3. Install With ``sudo apt install ./<Path To File>``
Fixes 2021-01-27 21:26:19 +00:00			`4. Have Fun!`
Improve Modding 2020-10-03 20:18:53 +00:00
Improve Comments 2020-10-26 19:58:28 +00:00			`### Packages`
			`\| Package \| Description \|`
			`\| --- \| --- \|`
Project Rename 2021-01-27 16:13:06 +00:00			\| ``minecraft-pi-reborn-server`` \| Minecraft Pi Edition Modded Into A Dedicated Server \|
			\| ``minecraft-pi-reborn-virgl`` \| Minecraft Pi Edition Using VirGL For Hardware Acceleration (Recommended For Desktop) \|
			\| ``minecraft-pi-reborn-native`` \| Minecraft: Pi Edition Using Docker Device Mounting For GPU Acceleration (Recommended For ARM Devices (ie. Raspberry Pi, PinePhone, etc)) \|
Improve Comments 2020-10-26 19:58:28 +00:00
Tweak README 2021-01-27 23:08:55 +00:00			`## General Notes`
Add Raspbian Note 2020-12-05 02:45:53 +00:00
Tweak README 2021-01-27 23:08:55 +00:00			`### Docker Versions`
Project Rename 2021-01-27 16:13:06 +00:00			`While the distribution-provided version of Docker is fine for 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.`
Add Raspbian Note 2020-12-05 02:45:53 +00:00
Tweak README 2021-01-27 23:08:55 +00:00			### Debian/Raspbian Buster And ``libseccomp2``
			By default Debian/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. Buster's version accidentally blocks the system call ``clock_gettime64``, this causes bugs inside of 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.

Tweak README 2021-01-27 23:08:55 +00:00			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.
Document Server 2020-10-27 18:37:29 +00:00
Tweak README 2021-01-27 23:08:55 +00:00			`This server is also compatible with MCPE Alpha 0.6.1.`
Document Server 2020-10-27 18:37:29 +00:00
			`### 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`
Project Rename 2021-01-27 16:13:06 +00:00			- Survival mode servers are only compatible with ``minecraft-pi-reborn`` clients
Document Server 2020-10-27 18:37:29 +00:00
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)`