9
0
mirror of https://github.com/LeavesMC/Leaves.git synced 2025-12-26 18:39:08 +00:00
Files
LeavesMC/README.md
2023-05-18 23:22:22 +08:00

60 lines
2.4 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)
[![Discord](https://badgen.net/discord/online-members/5hgtU72w33?icon=discord&label=Discord&list=what)](https://discord.gg/5hgtU72w33)
[![QQ](https://img.shields.io/badge/QQ-603461533-blue)](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=YZCUmBIMQIoKIdoSohMN4nVI4SHuwwJC&authKey=0GotlXL9HYCYQk3oPARGPS920kJL8xQ3radhaAGj4A9z6OgSnKQRK5U6ManMrMuK&noverify=0&group_code=603461533)
**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)
## How To (Server Admins)
Leaves use the same paperclip jar system that Paper uses.
You can download the latest build (1.19.x) of Leaves by going [here](https://github.com/LeavesMC/Leaves/releases)
You can also [build it yourself](https://github.com/LeavesMC/Leaves#building).
You can visit our [documentation](https://docs.leavesmc.top/leaves) for more information.
## 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:
```kotlin
dependencies {
compileOnly("top.leavesmc.leaves:leaves-api:1.19.4-R0.1-SNAPSHOT")
}
```
Leaves-Server maven dependency:
```kotlin
dependencies {
compileOnly("top.leavesmc.leaves:leaves:1.19.4-R0.1-SNAPSHOT")
}
```
## Building
You need JDK 17 and good internet connection
Clone this repo, run `./gradlew applyPatches`, then `./gradlew createReobfBundlerJar` form your terminal.
You can find jar in `build/libs` directory.
## Pull Request
See [Contributing](https://github.com/LeavesMC/Leaves/blob/master/docs/CONTRIBUTING.md)
## Special Thanks To:
[<img src="https://user-images.githubusercontent.com/21148213/121807008-8ffc6700-cc52-11eb-96a7-2f6f260f8fda.png" alt="" width="150">](https://www.jetbrains.com)
[JetBrains](https://www.jetbrains.com/), creators of the IntelliJ IDEA, supports We with one of their [Open Source Licenses](https://www.jetbrains.com/opensource/). We recommend using IntelliJ IDEA as your IDE.