9
0
mirror of https://github.com/LeavesMC/Leaves.git synced 2025-12-29 03:49:10 +00:00
Files
LeavesMC/README.md
2022-03-27 12:56:25 +08:00

49 lines
1.5 KiB
Markdown

Leaves [![Leaves CI](https://github.com/LeavesMC/Leaves/actions/workflows/leaves.yml/badge.svg)](https://github.com/LeavesMC/Leaves/actions/workflows/leaves.yml)
===========
**English** | [中文](https://github.com/LeavesMC/Leaves/blob/master/README_cn.md)
> Fork of [Paper](https://github.com/PaperMC/Paper) aimed at repairing broken vanilla properties.
> You can see what we modify and fix in [this](https://github.com/LeavesMC/Leaves/blob/master/docs/MODIFICATION.md)
> Waring: This fork will have low mspt as Paper
## How To (Server Admins)
Leaves use the same paperclip jar system that Paper uses.
You can download the latest build (1.18.x) of Leaves by going [here](https://github.com/LeavesMC/Leaves/actions/workflows/leaves.yml)
You can also [build it yourself](https://github.com/LeavesMC/Leaves#building).
## How To (Plugin developers)
In order to use Leaves as a dependency you must [build it yourself](https://github.com/LeavesMC/Leaves#building).
Each time you want to update your dependency you must re-build Leaves.
Leaves-API maven dependency:
```xml
<dependency>
<groupId>top.leavesmc.leaves</groupId>
<artifactId>leaves-api</artifactId>
<version>1.18.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
Leaves-Server maven dependency:
```xml
<dependency>
<groupId>top.leavesmc.leaves</groupId>
<artifactId>leaves</artifactId>
<version>1.18.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
## Building
Java17+
`./gradlew applyPatches`
`./gradlew createReobfBundlerJar`