minecraft-pi-reborn/minecraft-pi-reborn
3
7
Fork 10
Code Issues 5 Pull Requests 1 Actions 1 Releases 3 Activity

Document Overrides Folder
All checks were successful
minecraft-pi-reborn/pipeline/head This commit looks good
Details

Browse Source
This commit is contained in:
TheBrokenRail 2021-02-18 15:01:59 -05:00
parent 71fadf1645
commit c1b52370dd
3 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -15,23 +15,9 @@ Minecraft: Pi Edition Modding Project
### 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)
## Documentation
- [View Overriding Assets](docs/OVERRIDING_ASSETS.md)
- [View Troubleshooting](docs/TROUBLESHOOTING.md)
- [View Dedicated Server](docs/DEDICATED_SERVER.md)
- [View Modding](docs/MODDING.md)
- [View Credits](docs/CREDITS.md)

11
docs/DEDICATED_SERVER.md Normal file
View File

@ -0,0 +1,11 @@
# 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.
## Server 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

6
docs/OVERRIDING_ASSETS.md Normal file
View File

@ -0,0 +1,6 @@
# Overriding Assets
Normally, Minecraft: Pi Edition assets can be easily overridden by physically replacing the file, however ``minecraft-pi-=reborn`` uses a Docker image making this much harder to do. To make overriding assets easier, ``minecraft-pi-reborn`` provides an overrides folder. Any file located in Minecraft: Pi Edition's ``data`` folder can be overridden by placing a file with the same name and path in the overrides folder. The overrides folder is located at ``~/.minecraft-pi/overrides``.
## Examples
- ``data/images/terrain.png`` -> ``~/.minecraft-pi/overrides/images/terrain.png``
- ``data/lang/en_US.lang`` -> ``~/.minecraft-pi/overrides/lang/en_US.lang``