diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d10b114 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d55f5d7 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +Logo + +# Luminol +

Luminol 是一个基于Folia的分支,具有许多有用的优化、可配置的原版特性和更多的API支持,它专为生存和无政府服务器设计

+ +[![MIT License](https://img.shields.io/github/license/LuminolMC/Luminol?style=flat-square)](LICENSE) +[![Issues](https://img.shields.io/github/issues/LuminolMC/Luminol?style=flat-square)](https://github.com/LuminolMC/Luminol/issues) +![Commit Activity](https://img.shields.io/github/commit-activity/w/LuminolMC/Luminol?style=flat-square) +![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/LuminolMC/Luminol?style=flat-square) +![GitHub all releases](https://img.shields.io/github/downloads/LuminolMC/Luminol/total?style=flat-square) + +[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 + + + moliatopia + https://maven.moliatopia.icu/repository/maven-snapshots/ + + + + + + me.earthme.luminol + luminol-api + 1.21.3-R0.1-20241201.004037-1 + + +``` + +## 联系方式 +> 如果您对这个项目感兴趣或有任何问题,请随时向我们提问。 + +**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 +![bStats](https://bstats.org/signatures/server-implementation/Luminol.svg "bStats") + +## 请给我们一个 ⭐Star! +> 你的每一个免费的 ⭐Star 就是我们每一个前进的动力。 + + + + + + Star历史表 + + diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..3d427f5 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,86 @@ +Logo + +# Luminol +

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

+ +[![MIT License](https://img.shields.io/github/license/LuminolMC/Luminol?style=flat-square)](LICENSE) +[![Issues](https://img.shields.io/github/issues/LuminolMC/Luminol?style=flat-square)](https://github.com/LuminolMC/Luminol/issues) +![Commit Activity](https://img.shields.io/github/commit-activity/w/LuminolMC/Luminol?style=flat-square) +![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/LuminolMC/Luminol?style=flat-square) +![GitHub all releases](https://img.shields.io/github/downloads/LuminolMC/Luminol/total?style=flat-square) + +**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 + + + moliatopia + https://maven.moliatopia.icu/repository/maven-snapshots/ + + + + + + me.earthme.luminol + luminol-api + 1.21.3-R0.1-20241201.004037-1 + + +``` + +## 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.
+ +## Pull Requests +See [Contributing](./docs/CONTRIBUTING_EN.md) + +## BStats +![bStats](https://bstats.org/signatures/server-implementation/Luminol.svg "bStats") + +## Please ⭐star us! + + + + + Star History Chart + +