diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d776be --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +Gale logo +
+

Gale

+

A Minecraft server fork of Paper

+

Under active development

+ +[![Discord](https://img.shields.io/discord/1045402468416233592?color=5865F2&label=discord&style=for-the-badge)](https://discord.com/invite/pbsPkpUjG4) +
+ +## About + +Gale is a [Paper](https://github.com/PaperMC/Paper) fork. +The current state of the project is stable, but in the initial phase of setup. +While you can run it on your server right now, we do not claim any specific performance increase. + +## Building + +You can clone this repository and build it yourself. +If you are interested in making a Paperweight fork, check out [the example template](https://github.com/PaperMC/paperweight-examples)! + +In order to distribute and use this server software, you need a Paperclip file: + +```bash +./gradlew applyPatches && ./gradlew createReobfPaperclipJar +``` + +## Acknowledgements + +This fork would not exist without the years-long work of all the contributors to the [Paper](https://github.com/PaperMC/Paper) and [Spigot](https://www.spigotmc.org/) projects, +including the dedication of their community to stability and trust among all users. +Over the years, many forks of Paper have appeared, including some that contain changes that are too minor to be worth inclusion and maintaining by the Paper project. +We gratefully include various tested and carefully individually reviewed changes from Paper forks, including [Airplane](https://github.com/TECHNOVE/Airplane), [Mirai](https://github.com/etil2jz/Mirai), [JettPack](https://gitlab.com/Titaniumtown/JettPack), [Patina](https://github.com/PatinaMC/Patina) and [EmpireCraft](https://github.com/starlis/empirecraft). +We would also like to thank our friends at [MultiPaper](https://github.com/MultiPaper/MultiPaper) and MCMT ([Fabric](https://github.com/himekifee/MCMTFabric), [Forge](https://github.com/jediminer543/JMT-MCMT)) for their shared knowledge and hard work towards a common goal. + +## License +Paperweight files are licensed under MIT. Patches are licensed under GPL-3.0, unless indicated differently in their header. \ No newline at end of file diff --git a/logo.png b/logo.png new file mode 100644 index 0000000..935cad5 Binary files /dev/null and b/logo.png differ