Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
booky10 committed Jul 22, 2023
1 parent cf781cb commit 256cde5
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`.

0 comments on commit 256cde5

Please sign in to comment.