mirror of
https://github.com/Winds-Studio/Leaf.git
synced 2025-12-19 15:09:25 +00:00
Redesign README.md (#28)
* Add new logo * Delete Leaf.png * Update README.md * Update README.md * new banner * Update README.md * update banner * Delete leaf-banner.png * update banner * new banner * Update README.md * New readme design * Delete leaf-banner.png * add bStats
This commit is contained in:
76
README.md
76
README.md
@@ -1,47 +1,46 @@
|
|||||||
<img src="leaf_logo.png" alt="Leaf logo" align="right" width="200">
|
<img src="leaf_banner.png" alt="Leaf">
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
|
[](https://github.com/Winds-Studio/Leaf/releases)⠀
|
||||||
|
[](https://github.com/Winds-Studio/Leaf/actions)⠀
|
||||||
|
[](https://discord.gg/gfgAwdSEuM)
|
||||||
|
|
||||||
## Leaf
|
**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/GaleMC/Gale) with optimizations and fixes from other forks.
|
||||||
|
|
||||||
[](https://github.com/Winds-Studio/Leaf/releases)
|
|
||||||
[](https://discord.gg/gfgAwdSEuM)
|
|
||||||
|
|
||||||
<h5>Leaf is a drop-in replacement designed for removing some checks, customized, and high-performance built on top of <a href="https://github.com/GaleMC/Gale">Gale</a> with optimization from other forks.</h5>
|
|
||||||
<h8>Logo designed by <a href="https://github.com/envizar">envizar</a></h8>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Features
|
## 🍃 Features
|
||||||
- **Fork of [Gale](https://github.com/GaleMC/Gale)** for better performance.
|
- **Fork of [Gale](https://github.com/GaleMC/Gale)** for better performance
|
||||||
- **Allows all characters as usernames**, including Chinese and other characters.
|
- **Async** entity tracker, pathfinding and mob spawning
|
||||||
- **Allows** players to connect the backend under proxy without enabling bunngecord mode.
|
- **Linear region support** from [LinearPurpur](https://github.com/StupidCraft/LinearPurpur) to save disk space
|
||||||
- **Allows tripwire dupe** by reverting tripwire bugfix patch of Paper.
|
- **Various optimizations** blending from [other forks](https://github.com/Winds-Studio/Leaf#-credits)
|
||||||
- **Configurable UseItem distance** for anarchy server.
|
- **Fully compatible** with Bukkit, Spigot and Paper plugins
|
||||||
- **Latest dependencies**, keeping all dependencies in the newest version.
|
- **Latest dependencies**, keeping all dependencies in the newest version
|
||||||
- **More customized** relying on features of [Purpur](https://github.com/PurpurMC/Purpur).
|
- **Allows all characters in usernames**, including Chinese and other characters
|
||||||
- **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.
|
- **Ability to disable** useless console messages
|
||||||
- **Various optimization** blending from [other forks](https://github.com/Winds-Studio/Leaf#credits).
|
- **Fixes** some Minecraft bugs
|
||||||
- **Better Region Format** Support for the Linear region file format from [LinearPurpur](https://github.com/StupidCraft/LinearPurpur)
|
- **Allows** to connect the backend via a proxy server without enabling the bungeecord mode
|
||||||
- ...
|
- **Allows tripwire dupe** by reverting tripwire bugfix patch of Paper
|
||||||
|
- **Configurable UseItem distance** for anarchy servers
|
||||||
|
- **Mod Protocols** support
|
||||||
|
- **More customized** relying on features of [Purpur](https://github.com/PurpurMC/Purpur)
|
||||||
|
- **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
|
||||||
|
|
||||||
## Contact
|
## 📈 bStats
|
||||||
|
[](https://bstats.org/plugin/server-implementation/Leaf)
|
||||||
|
|
||||||
- 📫 Discord: `dreeam___` | QQ: `2682173972`
|
## 📫 Contact
|
||||||
|
- Discord: `dreeam___`
|
||||||
## Downloads
|
- QQ: `2682173972`
|
||||||
|
|
||||||
The Reobf JAR can be obtained in the [Releases](https://github.com/Winds-Studio/Leaf/releases)
|
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
|
## 📦 Building
|
||||||
Building a Paperclip JAR for distribution:
|
Building a Paperclip JAR for distribution:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./gradlew applyPatches && ./gradlew createReobfPaperclipJar
|
./gradlew applyPatches && ./gradlew createReobfPaperclipJar
|
||||||
```
|
```
|
||||||
|
|
||||||
## API
|
## 🧪 API
|
||||||
|
|
||||||
Maven
|
### Maven
|
||||||
```xml
|
```xml
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.dreeam.leaf</groupId>
|
<groupId>org.dreeam.leaf</groupId>
|
||||||
@@ -50,25 +49,23 @@ Maven
|
|||||||
<scope>provided</scope>
|
<scope>provided</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
### Gradle
|
||||||
Gradle
|
|
||||||
```kotlin
|
```kotlin
|
||||||
dependencies {
|
dependencies {
|
||||||
compileOnly("org.dreeam.leaf.:leaf-api:1.20.4-R0.1-SNAPSHOT")
|
compileOnly("org.dreeam.leaf.:leaf-api:1.20.4-R0.1-SNAPSHOT")
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## ⚖️ License
|
||||||
|
|
||||||
Paperweight files are licensed under MIT.
|
Paperweight files are licensed under MIT.
|
||||||
Patches are licensed under MIT, unless indicated differently in their header.
|
Patches are licensed under MIT, unless indicated differently in their header.
|
||||||
Binaries are licensed under GPL-3.0.
|
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.
|
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:
|
## 📜 Credits
|
||||||
-------------
|
Thanks to these projects below. Leaf just mix some of their patches together.<br>
|
||||||
Thanks to these projects below. Leaf just mix some of their patches together. If these excellent projects haven't appeared, Leaf will not be great.
|
If these excellent projects hadn't appeared, Leaf wouldn't have become great.
|
||||||
|
|
||||||
- [Gale](https://github.com/GaleMC/Gale)
|
- [Gale](https://github.com/GaleMC/Gale)
|
||||||
- [Pufferfish](https://github.com/pufferfish-gg/Pufferfish)
|
- [Pufferfish](https://github.com/pufferfish-gg/Pufferfish)
|
||||||
@@ -88,8 +85,7 @@ Thanks to these projects below. Leaf just mix some of their patches together. If
|
|||||||
- [SparklyPaper](https://github.com/SparklyPower/SparklyPaper)
|
- [SparklyPaper](https://github.com/SparklyPower/SparklyPaper)
|
||||||
- [Polpot](https://github.com/HaHaWTH/Polpot)
|
- [Polpot](https://github.com/HaHaWTH/Polpot)
|
||||||
|
|
||||||
## Special Thanks To:
|
## 🔥 Special Thanks
|
||||||
|
|
||||||
<a href="https://cloud.swordsman.com.cn/"><img src="JiankeServer.jpg" alt="Jianke Cloud Host" align="left" hspace="8"></a>
|
<a href="https://cloud.swordsman.com.cn/"><img src="JiankeServer.jpg" alt="Jianke Cloud Host" align="left" hspace="8"></a>
|
||||||
cloud of swordsman | 剑客云
|
cloud of swordsman | 剑客云
|
||||||
|
|
||||||
|
|||||||
BIN
leaf_banner.png
Normal file
BIN
leaf_banner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 541 KiB |
Reference in New Issue
Block a user