minecraft-pi-reborn/README.md

<center>

![Start Screen](images/start.png)

</center>

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

## Installation

### Option A: Pi-Apps (Raspberry Pi Only)
[![Pi-Apps](https://github.com/Botspot/pi-apps/blob/master/icons/badge.png?raw=true)](https://github.com/Botspot/pi-apps)  

### Option B: Manual Installation
[View Manual Installation](docs/INSTALL.md)

## Troubleshooting
[View Troubleshooting](docs/TROUBLESHOOTING.md)

## 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 v0.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](docs/MODDING.md)

## Credits
[View Credits](docs/CREDITS.md)
Improve Documentation 2021-02-18 14:04:59 -05:00			`<center>`
Improve Modding 2020-10-03 16:18:53 -04:00
Improve Documentation 2021-02-18 14:04:59 -05:00			`![Start Screen](images/start.png)`
Simplify README 2021-01-27 18:51:31 -05:00
Improve Documentation 2021-02-18 14:04:59 -05:00			`</center>`
Simplify README 2021-01-27 18:51:31 -05:00
Improve Documentation 2021-02-18 14:04:59 -05:00			`# Minecraft: Pi Edition: Reborn`
			`Minecraft: Pi Edition Modding Project`
Add Docker Troubleshooting Info 2021-01-30 21:45:26 -05:00
Improve Documentation 2021-02-18 14:04:59 -05:00			`## Installation`
Update Capitalization 2021-02-02 12:04:39 -05:00
Improve Documentation 2021-02-18 14:04:59 -05:00			`### Option A: Pi-Apps (Raspberry Pi Only)`
			`[![Pi-Apps](https://github.com/Botspot/pi-apps/blob/master/icons/badge.png?raw=true)](https://github.com/Botspot/pi-apps)`
Show Dialog On Crash + Add Troubleshooting Information To README 2020-12-10 17:16:44 -05:00
Improve Documentation 2021-02-18 14:04:59 -05:00			`### Option B: Manual Installation`
			`[View Manual Installation](docs/INSTALL.md)`
Show Dialog On Crash + Add Troubleshooting Information To README 2020-12-10 17:16:44 -05:00
Improve Documentation 2021-02-18 14:04:59 -05:00			`## Troubleshooting`
			`[View Troubleshooting](docs/TROUBLESHOOTING.md)`
No Longer Run MCPI As Root 2021-01-30 21:32:20 -05:00
Document Server 2020-10-27 14:37:29 -04: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 18:08:55 -05: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 14:37:29 -04:00
Update Capitalization 2021-02-02 12:04:39 -05:00			`This server is also compatible with MCPE Alpha v0.6.1.`
Document Server 2020-10-27 14:37:29 -04: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 14:17:04 -05:00			`- Player data is not saved because of limitations with MCPE LAN worlds`
Document Server 2020-10-27 14:37:29 -04:00			`- An easy workaround is to place your inventory in a chest before logging off`
Update Capitalization 2021-02-02 12:04:39 -05:00			- Survival Mode servers are only compatible with ``minecraft-pi-reborn`` clients
Document Server 2020-10-27 14:37:29 -04:00
Improve Modding 2020-10-03 16:18:53 -04:00			`## Modding`
Improve Documentation 2021-02-18 14:04:59 -05:00			`[View Modding](docs/MODDING.md)`
Link To Credits 2020-11-20 16:39:05 -05:00
			`## Credits`
Improve Documentation 2021-02-18 14:04:59 -05:00			`[View Credits](docs/CREDITS.md)`