Leaf/README.md

⠀ ⠀

Leaf is a drop-in replacement for Paper servers designed to remove some checks, customized and high-performance, built on top of Gale with optimizations and fixes from other forks.

🍃 Features

• Fork of Gale for better performance
• Async entity tracker, pathfinding and mob spawning
• Linear region support from LinearPurpur to save disk space
• Various optimizations blending from other forks
• 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
• Configurable tripwire dupe
• Configurable UseItem distance for anarchy servers
• Mod Protocols support
• More customized relying on features of Purpur
• Maintenance friendly, integrating with Sentry of Pufferfish to easy track all errors coming from your server in excruciating detail
• And more...

📈 bStats

📫 Contact

• Discord: https://discord.gg/gfgAwdSEuM
• QQ: 2682173972

📥 Download

You can find latest successful build in GitHub Action or Releases

Please note Java >= 17 is required, Java >= 21 is recommended.

📦 Building

Building a Paperclip JAR for distribution:

./gradlew applyPatches && ./gradlew createReobfPaperclipJar

🧪 API (WIP)

Maven

<dependency>
    <groupId>org.dreeam.leaf</groupId>
    <artifactId>leaf-api</artifactId>
    <version>1.20.4-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Gradle

dependencies {
    compileOnly("org.dreeam.leaf:leaf-api:1.20.4-R0.1-SNAPSHOT")
}

⚖️ License

Paperweight files are licensed under MIT. Patches are licensed under MIT, unless indicated differently in their header. Binaries are licensed under GPL-3.0.

Also see PaperMC/Paper and PaperMC/Paperweight for the license of some material used by this project.

📜 Credits

Thanks to these projects below. Leaf just mix some of their patches together.
If these excellent projects hadn't appeared, Leaf wouldn't have become great.

• Gale
• Pufferfish
• Purpur
• KeYi (R.I.P.) (Backup)
• KTP
• Mirai
• Petal
• Carpet Fixes
• Akarin
• Slice
• Parchment
• Leaves
• Kaiiju
• PandaSpigot
• Plazma
• SparklyPaper
• Polpot
• Matter

🔥 Special Thanks

cloud of swordsman | 剑客云

If you want to find a cheaper, high performance, stable with lower latency, then cloud of swordsman is a good choice! Registers and purchases in here.

如果你想找一个低价高性能, 低延迟的云服务商，剑客云是个不错的选择! 你可以在这里注册.