Document Overrides Folder

README.md

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

docs/DEDICATED_SERVER.md

@@ -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

docs/OVERRIDING_ASSETS.md

@@ -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``