minecraft-pi-reborn/README.md

80 lines
3.2 KiB
Markdown
Raw Normal View History

2021-01-27 16:13:06 +00:00
# Minecraft: Pi Edition: Reborn
Minecraft: Pi Edition Modding Project
2020-09-25 16:43:53 +00:00
2021-01-27 21:26:19 +00:00
## Getting Started
2020-10-03 20:18:53 +00:00
2021-01-27 23:51:31 +00:00
### Debian/Raspbian Buster Users
1. Install Newer ``libseccomp2``
```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
```
2. Install Official Docker Build
```sh
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
```
2021-02-02 17:04:39 +00:00
3. Remove Vanilla Minecraft: Pi Edition Package If Installed (``sudo apt remove minecraft-pi``)
4. Transfer Vanilla Minecraft: Pi Edition Worlds (``mv ~/.minecraft ~/.minecraft-pi``)
2021-01-27 23:51:31 +00:00
### Installation Instructions
1. Download Appropriate Package From [Here](https://jenkins.thebrokenrail.com/job/minecraft-pi-reborn/job/master/lastSuccessfulBuild/artifact/out/deb/) (See Table Below)
2. Install With ``sudo apt install ./<Path To File>``
3. Have Fun!
#### Package Table
2020-10-26 19:58:28 +00:00
| Package | Description |
| --- | --- |
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)) |
2020-10-26 19:58:28 +00:00
2021-01-31 02:32:20 +00:00
## Troubleshooting
Game logs are located in ``/tmp/minecraft-pi``.
2021-01-31 02:45:26 +00:00
### ``Couldn't connect to Docker daemon at http+docker://localhost - is it running?``
2021-02-02 17:04:39 +00:00
Start Docker if it isn't running:
2021-01-31 20:33:31 +00:00
```sh
sudo service docker start
```
2021-01-31 02:45:26 +00:00
### ``Error response from daemon: error gathering device information while adding custom device "/dev/dri": no such file or directory``
2021-02-02 17:04:39 +00:00
Make sure you are using the correct GPU drivers for your system.
If you are using a Raspberry Pi, make sure your GPU driver is set to ``Full KMS`` or ``Fake KMS`` in ``raspi-config``.
2021-01-31 02:32:20 +00:00
### ``Segmentation Fault`` (Exit Code: ``139``)
2021-02-02 17:04:39 +00:00
Report an issue with reproduction instructions and system details.
2021-01-31 02:32:20 +00:00
### ``[ERR]: Invalid ~/.minecraft-pi Permissions``
2021-02-02 17:04:39 +00:00
Update ``~/.minecraft-pi`` permissions:
2021-01-31 02:32:20 +00:00
```sh
sudo chown -R "$(id -u):$(id -g)" ~/.minecraft-pi
chmod -R u+rw ~/.minecraft-pi
```
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.
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.
2020-10-27 18:37:29 +00:00
2021-02-02 17:04:39 +00:00
This server is also compatible with MCPE Alpha v0.6.1.
2020-10-27 18:37:29 +00:00
### Limitations
- Player data is 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
2021-02-02 17:04:39 +00:00
- Survival Mode servers are only compatible with ``minecraft-pi-reborn`` clients
2020-10-27 18:37:29 +00:00
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)