⠀ ⠀

Leaf is a Paper fork designed to customized and high-performance, built on top of Gale with optimizations and fixes from other forks.

Warning

Leaf is a performance-oriented fork. Make sure to take backups before switching to it. Everyone is welcome to contribute by optimizing or reporting issues.

🍃 Features

• Based on Gale for better performance
• Async pathfinding, mob spawning and entity tracker
• 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
• Fixes some Minecraft bugs
• Configurable UseItem distance for anarchy servers
• Mod Protocols support
• More customized relying on features of Purpur
• Support for Linear region file format
• 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.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

You can find the latest successful build in GitHub Action or Releases

Please note Java >= 21 is required.

📄 Documentation

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

📦 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.4-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.4-R0.1-SNAPSHOT")
}

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

⚖️ 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 includes some patches taken from them.
If these excellent projects hadn't appeared, 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
  

🔥 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.

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

---

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.