https://github.com/winds-studio/leaf
A Paper fork, focused on finding balance between performance, vanilla behavior and stability
https://github.com/winds-studio/leaf
gale java keyi minecraft minecraft-performance minecraft-server-software mirai paper
Last synced: 1 day ago
JSON representation
A Paper fork, focused on finding balance between performance, vanilla behavior and stability
- Host: GitHub
- URL: https://github.com/winds-studio/leaf
- Owner: Winds-Studio
- License: other
- Created: 2022-06-02T15:06:59.000Z (over 3 years ago)
- Default Branch: ver/1.21.11
- Last Pushed: 2026-01-27T16:39:09.000Z (5 days ago)
- Last Synced: 2026-01-28T02:24:48.261Z (5 days ago)
- Topics: gale, java, keyi, minecraft, minecraft-performance, minecraft-server-software, mirai, paper
- Language: Java
- Homepage: https://www.leafmc.one
- Size: 20.4 MB
- Stars: 910
- Watchers: 16
- Forks: 134
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://www.leafmc.one/download)⠀
[](https://github.com/Winds-Studio/Leaf/actions)⠀
[](https://discord.gg/gfgAwdSEuM)
[](https://www.leafmc.one/docs/getting-started)
**Leaf** is a [Paper](https://papermc.io/) fork designed to be customizable and high-performance.
> [!WARNING]
> Leaf is a performance-oriented fork. Make sure to take backups **before** switching to it. Everyone is welcome to contribute optimizations or report issues to help us improve.
**English** | [中文](public/readme/README_CN.md)
## 🍃 Features
- **Based on [Paper](https://papermc.io/)** for generic performance and flexible API
- **Async** pathfinding, mob spawning and entity tracker
- **Various optimizations** blending from [other forks](#-credits) and our own
- **Fully compatible** with Spigot and Paper plugins
- **Latest dependencies**, keeping all dependencies up-to-date
- **Allows all characters in usernames**, including Chinese and other characters
- **Fixes** some Minecraft bugs
- **Mod Protocols** support
- **More customized** relying on features of [Purpur](https://github.com/PurpurMC/Purpur)
- **Linear region file format**, to save disk space
- **Maintenance friendly**, integrating with [Sentry](https://sentry.io/welcome/) of [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) to easily track all errors coming from your server in extreme detail
- And more...
## 📈 bStats
[](https://bstats.org/plugin/server-implementation/Leaf)
## 📫 Contact
- Discord: [`https://discord.com/invite/gfgAwdSEuM`](https://discord.com/invite/gfgAwdSEuM)
- QQ Group: `619278377`
## 📫 Donation
If you love our work, feel free to donate via our [Open Collective](https://opencollective.com/Winds-Studio) or [Dreeam's AFDIAN](https://afdian.com/a/Dreeam) :)
## 📥 Download
Download Leaf from our [Website](https://www.leafmc.one/download) or get latest build in [GitHub Releases](https://github.com/Winds-Studio/Leaf/releases)
## 📄 Documentation
Documentation about how to use/configure Leaf: [Leaf Docs](https://www.leafmc.one/docs/getting-started)
## 📦 Building
Building a Paperclip JAR for distribution:
```bash
./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar
```
## 📦 API
Click to expand
### Maven
```xml
leafmc
https://maven.leafmc.one/snapshots/
```
```xml
cn.dreeam.leaf
leaf-api
1.21.11-R0.1-SNAPSHOT
provided
```
### Gradle
```kotlin
repositories {
maven {
url = uri("https://maven.leafmc.one/snapshots/")
}
}
dependencies {
compileOnly("cn.dreeam.leaf:leaf-api:1.21.11-R0.1-SNAPSHOT")
}
java {
toolchain.languageVersion.set(JavaLanguageVersion.of(21))
}
```
## ⚖️ License
Leaf is licensed under various open source licenses from its upstream projects. See [LICENSE.md](LICENSE.md) for full details.
## 📜 Credits
Thanks to these projects below. Leaf includes some patches taken from them.
If these excellent projects hadn't existed, Leaf wouldn't have become great.
- [Gale](https://github.com/Dreeam-qwq/Gale) ([Original Repo](https://github.com/GaleMC/Gale))
- [Pufferfish](https://github.com/pufferfish-gg/Pufferfish)
- [Purpur](https://github.com/PurpurMC/Purpur)
-
🍴 Expand to see forks that Leaf takes patches from.
• KeYi (R.I.P.)
(Backup)
• Mirai
• Petal
• Carpet Fixes
• Akarin
• Slice
• Parchment
• Leaves
• Kaiiju
• Plazma
• SparklyPaper
• Polpot
• Matter
• Luminol
• Nitori
• Moonrise (during 1.21.1)
• Sakura
## 🔥 Special Thanks
cloud of swordsman | 剑客云
If you want to find a cheaper, high performance, stable, lower latency host, then cloud of swordsman is a good choice! Registers and purchases in here.
如果你想找一个低价高性能、低延迟的云服务商，剑客云是个不错的选择！你可以在 这里 注册。
RainYun | 雨云
Global multi-line routing with cloud storage. Refund available within 7 days. Reliable uptime and expert support. RainYun — stable, cost-effective, and ready for fast cloud deployment. Visit RainYun.
国际多线路选择，配套云存储 — 购买服务后七天内不满意可以申请退订，强大的技术支持团队和高在线率客服。雨云云服务器，用稳定和性价比，助力您快速上云。点击前往 雨云。
YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.