From 256cde5464584f25510d81fb6b5e240a4aa3a1e6 Mon Sep 17 00:00:00 2001 From: booky10 Date: Sat, 22 Jul 2023 02:39:15 +0200 Subject: [PATCH] Add readme --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c71f91e --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# CloudPlane + +A Minecraft server fork of [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) with some more patches. +This fork is mainly designed to fit the CloudCraft Minecraft network. + +## Features + +- `allowPvP` gamerule +- Translate custom item names and their lore +- Instantly refresh various things on player locale change +- Add version info to brand in F3 screen +- Add option for changing Pufferfish config location +- Various other fixes + +## Download + +https://nightly.link/CloudCraftProjects/CloudPlane/workflows/build/master/CloudPlane-Artifacts.zip + +## Building + +_Building on Windows is untested and not recommended!_ +After installing the dependencies, clone this repository, don't download the ZIP. + +After downloading, apply the patches using `./gradlew applyPatches`. Then the reobfuscated paperclip jar can be compiled +using `./gradlew createReobfPaperclipJar`.