Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Winds-Studio/Leaf

A Paper fork aim to find balance between performance, vanilla and stability
https://github.com/Winds-Studio/Leaf

gale keyi minecraft minecraft-server-software mirai paper

Last synced: about 1 month ago
JSON representation

A Paper fork aim to find balance between performance, vanilla and stability

Host: GitHub
URL: https://github.com/Winds-Studio/Leaf
Owner: Winds-Studio
License: other
Created: 2022-06-02T15:06:59.000Z (over 2 years ago)
Default Branch: ver/1.21.1
Last Pushed: 2024-10-29T09:45:10.000Z (about 2 months ago)
Last Synced: 2024-10-29T11:44:46.815Z (about 2 months ago)
Topics: gale, keyi, minecraft, minecraft-server-software, mirai, paper
Language: Shell
Homepage:
Size: 8.04 MB
Stars: 321
Watchers: 12
Forks: 38
Open Issues: 10
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-minecraft - Leaf

README

        



 

[![Github Releases](https://img.shields.io/badge/Download-Releases-blue?&style=for-the-badge&colorA=19201a&colorB=298046)](https://github.com/Winds-Studio/Leaf/releases)⠀

[![Github Actions Build](https://img.shields.io/github/actions/workflow/status/Winds-Studio/Leaf/build-1211.yml?&style=for-the-badge&colorA=19201a&colorB=298046)](https://github.com/Winds-Studio/Leaf/actions)⠀

[![Discord](https://img.shields.io/discord/1145991395388162119?label=discord&style=for-the-badge&colorA=19201a&colorB=298046)](https://discord.gg/gfgAwdSEuM)

**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/Dreeam-qwq/Gale) with optimizations and fixes from other forks.



## 🍃 Features

 - **Fork of [Gale](https://github.com/Dreeam-qwq/Gale)** for better performance

 - **Async** pathfinding, mob spawning and entity tracker

 - **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

 - **Fixes** some Minecraft bugs

 - **Configurable UseItem distance** for anarchy servers

 - **Mod Protocols** support

 - **More customized** relying on features of [Purpur](https://github.com/PurpurMC/Purpur)

 - Support for **Linear region file format**

 - **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

 - And more...

## 📈 bStats

[![bStats Graph Data](https://bstats.org/signatures/server-implementation/Leaf.svg)](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 my work, feel free to donate :)

- afdian: https://afdian.com/a/Dreeam

## 📥 Download

You can find latest successful build in [GitHub Action](https://github.com/Winds-Studio/Leaf/actions) or [Releases](https://github.com/Winds-Studio/Leaf/releases)

**Please note Java >= 21 is required.**

## 📦 Building

Building a Paperclip JAR for distribution:

```bash

./gradlew applyPatches && ./gradlew createMojmapPaperclipJar

```

## 🧪 API

### Maven

```xml

    leafmc

    https://maven.nostal.ink/repository/maven-snapshots/

```

```xml

    cn.dreeam.leaf

    leaf-api

    1.21.1-R0.1-SNAPSHOT

    provided

```

### Gradle

```kotlin

repositories {

  maven {

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

  }

}

dependencies {

    compileOnly("cn.dreeam.leaf:leaf-api:1.21.1-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](https://github.com/PaperMC/Paper) and [PaperMC/Paperweight](https://github.com/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](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


      • PandaSpigot


      • 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](https://cloud.swordsman.com.cn/?i8ab42c).

如果你想找一个低价高性能, 低延迟的云服务商，剑客云是个不错的选择! 你可以在[这里](https://cloud.swordsman.com.cn/?i8ab42c)注册.

---

![YourKit](https://www.yourkit.com/images/yklogo.png)

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](https://www.yourkit.com/java/profiler/),

[YourKit .NET Profiler](https://www.yourkit.com/dotnet-profiler/),

and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/).