69 lines
2.6 KiB
Markdown
69 lines
2.6 KiB
Markdown
<img src="./public/image/Luminol_5.png" alt="Logo" align="right" width="250">
|
|
|
|
# Luminol
|
|
<h4>Luminol is a Folia fork with many useful optimizations, configurable vanilla features, and more API supports, and it was designed for survival and anarchy servers</h4>
|
|
|
|
[](LICENSE)
|
|
[](https://github.com/LuminolMC/Luminol/issues)
|
|
|
|
|
|
|
|
|
|
**English** | [中文](./README_CN.md)
|
|
|
|
## Features
|
|
- Configurable vanilla features
|
|
- Tpsbar support
|
|
- Linear region file format(from kaiiju)
|
|
- Useful optimizations to improve the performance of single threaded region
|
|
- More API support for plugin development (W.I.P)
|
|
|
|
## Download
|
|
Any versions are available in the [release](https://github.com/LuminolMC/Luminol/releases), also you can build it by yourself through [the following steps](https://github.com/LuminolMC/Luminol#build).
|
|
|
|
## Build
|
|
To build a paperclip jar, you need to run the following command. You can find the jar in build/libs(Note: JDK17 is needed)
|
|
|
|
```shell
|
|
./gradlew applyPatches && ./gradlew createReobfPaperclipJar
|
|
```
|
|
|
|
## Using API
|
|
For gradle:
|
|
|
|
```kotlin
|
|
dependencies {
|
|
compileOnly("me.earthme.luminol:luminol-api:1.20.4-R0.1-SNAPSHOT")
|
|
}
|
|
```
|
|
|
|
For maven
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>me.earthme.luminol</groupId>
|
|
<artifactId>luminol-api</artifactId>
|
|
<version>1.20.4-R0.1-SNAPSHOT</version>
|
|
</dependency>
|
|
```
|
|
|
|
## Contact
|
|
> If you are interested in this project or have any issue, feel free to ask us.
|
|
|
|
QQ Group: `368632360` | QQ Channel: [Click To Join](https://pd.qq.com/s/eq9krf9j)
|
|
|
|
## Notice
|
|
**This project is not related to Leaves.Do not report any bugs about protocol support to leaves because the protocol supports are already refactored.**
|
|
|
|
## About Issue
|
|
When you meet any problems, just ask us, we will do our best to solve it, but remember to state your problem clear and provide enough logs etc.</br>
|
|
|
|
## Pull Requests
|
|
See [Contributing](./docs/CONTRIBUTING.md)
|
|
|
|
## BStats
|
|
|
|
|
|
## Please ⭐star us!
|
|
[](https://star-history.com/#LuminolMC/Luminol&LuminolMC/LightingLuminol&Date)
|