License and README.md
This commit is contained in:
MrHua269
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 LuminolMC
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
88
README.md
Normal file
88
README.md
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
<img src="./public/image/Luminol_5.png" alt="Logo" align="right" width="250">
|
||||||
|
|
||||||
|
# Luminol
|
||||||
|
<h4>Luminol 是一个基于Folia的分支，具有许多有用的优化、可配置的原版特性和更多的API支持，它专为生存和无政府服务器设计</h4>
|
||||||
|
|
||||||
|
[](LICENSE)
|
||||||
|
[](https://github.com/LuminolMC/Luminol/issues)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[English](./README_EN.md) | **中文**
|
||||||
|
|
||||||
|
## 特性
|
||||||
|
- 可配置的原版特性
|
||||||
|
- Tpsbar 支持
|
||||||
|
- 对单线程区域性能的优化
|
||||||
|
- 更多的插件开发API支持（进行中）
|
||||||
|
|
||||||
|
## 下载
|
||||||
|
任何版本都可以在 [Release](https://github.com/LuminolMC/Luminol/releases) 中找到，你也可以通过[以下步骤](./README.md#构建)自己构建。
|
||||||
|
|
||||||
|
## 构建
|
||||||
|
要构建一个paperclip jar，你需要运行以下命令。你可以在build/libs中找到jar（注意：需要`JDK21`）
|
||||||
|
|
||||||
|
```shell
|
||||||
|
./gradlew applyPatches && ./gradlew createMojmapPaperclipJar
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用API
|
||||||
|
使用 Gradle:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
url = "https://maven.moliatopia.icu/repository/maven-snapshots/"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
compileOnly("me.earthme.luminol:luminol-api:1.21.3-R0.1-20241201.004037-1")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
使用 Maven
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>moliatopia</id>
|
||||||
|
<url>https://maven.moliatopia.icu/repository/maven-snapshots/</url>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>me.earthme.luminol</groupId>
|
||||||
|
<artifactId>luminol-api</artifactId>
|
||||||
|
<version>1.21.3-R0.1-20241201.004037-1</version>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 联系方式
|
||||||
|
> 如果您对这个项目感兴趣或有任何问题，请随时向我们提问。
|
||||||
|
|
||||||
|
**QQ群: [368632360](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=MfosKhcDd8Fdxn1MREuZ8Krbf9T6jiBC&authKey=3cm6qdHohON3gHnuD63FK4k07fIbrWnY4hdyq8OmELsfjMVP1kbFTJY9mRyM2Rkj&noverify=0&group_code=368632360)** | QQ频道: [点击加入](https://pd.qq.com/s/eq9krf9j) | Telegram: [点击加入](https://t.me/LuminolMC) | Discord: [点击加入](https://discord.gg/Qd7m3V6eDx)
|
||||||
|
|
||||||
|
|
||||||
|
## 关于 Issue
|
||||||
|
当您遇到任何问题时，请向我们提问，我们将尽力解决，但请记得清楚地描述您的问题并提供足够的日志等信息。
|
||||||
|
|
||||||
|
## 贡献代码
|
||||||
|
可[查看 Contributing](./docs/CONTRIBUTING.md)
|
||||||
|
|
||||||
|
## BStats
|
||||||
|
|
||||||
|
|
||||||
|
## 请给我们一个 ⭐Star！
|
||||||
|
> 你的每一个免费的 ⭐Star 就是我们每一个前进的动力。
|
||||||
|
|
||||||
|
<a href="https://star-history.com/#LuminolMC/Luminol&LuminolMC/LightingLuminol&Date">
|
||||||
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol&type=Date&theme=dark" />
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol&type=Date" />
|
||||||
|
<img alt="Star历史表" src="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol&type=Date" />
|
||||||
|
</picture>
|
||||||
|
</a>
|
||||||
86
README_EN.md
Normal file
86
README_EN.md
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
<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.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](./README_EN.md#build).
|
||||||
|
|
||||||
|
## Build
|
||||||
|
To build a paperclip jar, you need to run the following command. You can find the jar in build/libs(Note: JDK21 is needed)
|
||||||
|
|
||||||
|
```shell
|
||||||
|
./gradlew applyPatches && ./gradlew createMojmapPaperclipJar
|
||||||
|
```
|
||||||
|
|
||||||
|
## Using API
|
||||||
|
For gradle:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
url = "https://maven.moliatopia.icu/repository/maven-snapshots/"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
compileOnly("me.earthme.luminol:luminol-api:1.21.3-R0.1-20241201.004037-1")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
For maven
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>moliatopia</id>
|
||||||
|
<url>https://maven.moliatopia.icu/repository/maven-snapshots/</url>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>me.earthme.luminol</groupId>
|
||||||
|
<artifactId>luminol-api</artifactId>
|
||||||
|
<version>1.21.3-R0.1-20241201.004037-1</version>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
> If you are interested in this project or have any issue, feel free to ask us.
|
||||||
|
|
||||||
|
**QQ Group: [368632360](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=MfosKhcDd8Fdxn1MREuZ8Krbf9T6jiBC&authKey=3cm6qdHohON3gHnuD63FK4k07fIbrWnY4hdyq8OmELsfjMVP1kbFTJY9mRyM2Rkj&noverify=0&group_code=368632360)** | QQ Channel: [Click To Join](https://pd.qq.com/s/eq9krf9j) | Telegram: [Click To Join](https://t.me/LuminolMC) | Discord: [Click To Join](https://discord.gg/Qd7m3V6eDx)
|
||||||
|
|
||||||
|
## 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_EN.md)
|
||||||
|
|
||||||
|
## BStats
|
||||||
|
|
||||||
|
|
||||||
|
## Please ⭐star us!
|
||||||
|
<a href="https://star-history.com/#LuminolMC/Luminol&LuminolMC/LightingLuminol&Date">
|
||||||
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol&type=Date&theme=dark" />
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol&type=Date" />
|
||||||
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol&type=Date" />
|
||||||
|
</picture>
|
||||||
|
</a>
|
||||||
Reference in New Issue
Block a user