From e67d73809e7ecb16dea3e5e2df7ba4f9d0576c91 Mon Sep 17 00:00:00 2001
From: envizar <87126318+envizar@users.noreply.github.com>
Date: Fri, 8 Mar 2024 11:05:53 +0300
Subject: [PATCH] Redesign README.md (#28)
* Add new logo
* Delete Leaf.png
* Update README.md
* Update README.md
* new banner
* Update README.md
* update banner
* Delete leaf-banner.png
* update banner
* new banner
* Update README.md
* New readme design
* Delete leaf-banner.png
* add bStats
---
README.md | 76 +++++++++++++++++++++++-------------------------
leaf_banner.png | Bin 0 -> 554429 bytes
2 files changed, 36 insertions(+), 40 deletions(-)
create mode 100644 leaf_banner.png
diff --git a/README.md b/README.md
index 7f71c5d6..76d0e151 100644
--- a/README.md
+++ b/README.md
@@ -1,47 +1,46 @@
-
+
+
+[](https://github.com/Winds-Studio/Leaf/releases)โ
+[](https://github.com/Winds-Studio/Leaf/actions)โ
+[](https://discord.gg/gfgAwdSEuM)
-## Leaf
-
-[](https://github.com/Winds-Studio/Leaf/releases)
-[](https://discord.gg/gfgAwdSEuM)
-
-
Leaf is a drop-in replacement designed for removing some checks, customized, and high-performance built on top of Gale with optimization from other forks.
-
Logo designed by envizar
+**Leaf** is a drop-in replacement for [Paper](https://papermc.io/) servers designed to remove some checks, customized and high-performance, built on top of [Gale](https://github.com/GaleMC/Gale) with optimizations and fixes from other forks.
-## Features
- - **Fork of [Gale](https://github.com/GaleMC/Gale)** for better performance.
- - **Allows all characters as usernames**, including Chinese and other characters.
- - **Allows** players to connect the backend under proxy without enabling bunngecord mode.
- - **Allows tripwire dupe** by reverting tripwire bugfix patch of Paper.
- - **Configurable UseItem distance** for anarchy server.
- - **Latest dependencies**, keeping all dependencies in the newest version.
- - **More customized** relying on features of [Purpur](https://github.com/PurpurMC/Purpur).
- - **Maintenance friendly**, integrating with [Sentry](https://sentry.io/welcome/) of [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) to easy track all errors coming from your server in excruciating detail.
- - **Various optimization** blending from [other forks](https://github.com/Winds-Studio/Leaf#credits).
- - **Better Region Format** Support for the Linear region file format from [LinearPurpur](https://github.com/StupidCraft/LinearPurpur)
- - ...
+## ๐ Features
+ - **Fork of [Gale](https://github.com/GaleMC/Gale)** for better performance
+ - **Async** entity tracker, pathfinding and mob spawning
+ - **Linear region support** from [LinearPurpur](https://github.com/StupidCraft/LinearPurpur) to save disk space
+ - **Various optimizations** blending from [other forks](https://github.com/Winds-Studio/Leaf#-credits)
+ - **Fully compatible** with Bukkit, Spigot and Paper plugins
+ - **Latest dependencies**, keeping all dependencies in the newest version
+ - **Allows all characters in usernames**, including Chinese and other characters
+ - **Ability to disable** useless console messages
+ - **Fixes** some Minecraft bugs
+ - **Allows** to connect the backend via a proxy server without enabling the bungeecord mode
+ - **Allows tripwire dupe** by reverting tripwire bugfix patch of Paper
+ - **Configurable UseItem distance** for anarchy servers
+ - **Mod Protocols** support
+ - **More customized** relying on features of [Purpur](https://github.com/PurpurMC/Purpur)
+ - **Maintenance friendly**, integrating with [Sentry](https://sentry.io/welcome/) of [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) to easy track all errors coming from your server in excruciating detail
-## Contact
+## ๐ bStats
+[](https://bstats.org/plugin/server-implementation/Leaf)
-- ๐ซ Discord: `dreeam___` | QQ: `2682173972`
-
-## Downloads
-
-The Reobf JAR can be obtained in the [Releases](https://github.com/Winds-Studio/Leaf/releases)
-
-## Building
+## ๐ซ Contact
+- Discord: `dreeam___`
+- QQ: `2682173972`
+## ๐ฆ Building
Building a Paperclip JAR for distribution:
-
```bash
./gradlew applyPatches && ./gradlew createReobfPaperclipJar
```
-## API
+## ๐งช API
-Maven
+### Maven
```xml