Leaf/README.md

⠀ ⠀

Leaf is a Paper 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 | 中文

🍃 Features

• Based on Paper for generic performance and flexible API
• Async pathfinding, mob spawning and entity tracker
• Various optimizations blending from other forks 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
• Linear region file format, to save disk space
• Maintenance friendly, integrating with Sentry of Pufferfish to easily track all errors coming from your server in extreme detail
• And more...

📈 bStats

📫 Contact

• Discord: https://discord.com/invite/gfgAwdSEuM
• QQ Group: 619278377

📫 Donation

If you love our work, feel free to donate via our Open Collective or Dreeam's AFDIAN :)

📥 Download

Download Leaf from our website or get latest build in GitHub Action

Please note Java >= 21 is required.

📄 Documentation

Documentation about how to use/configure Leaf: www.leafmc.one/docs

📦 Building

Building a Paperclip JAR for distribution:

./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar

🧪 API

Maven

<repository>
    <id>leafmc</id>
    <url>https://maven.nostal.ink/repository/maven-snapshots/</url>
</repository>

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

Gradle

repositories {
  maven {
    url = uri("https://maven.nostal.ink/repository/maven-snapshots/")
  }
}

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

java {
  toolchain.languageVersion.set(JavaLanguageVersion.of(21))
}

⚖️ License

Leaf is licensed under multiple open source licenses depending on upstream projects and other materials,

see LICENSE.md for full license information.

📜 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 (Original Repo)
• Pufferfish
• 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.