diff --git a/README.md b/README.md index 347f3b1..d5ca7f1 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ -Logo +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

+ +**English** | [中文](https://github.com/LuminolMC/Luminol/blob/master/README_CN.md) + [![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) -

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

- ## Features - Configurable vanilla features - Tpsbar support @@ -28,7 +31,7 @@ To build a paperclip jar, you need to run the following command. You can find th For gradle: ```kotlin dependencies { - compileOnly("me.earthme.luminol:luminol-api:1.20.4-R0.1-SNAPSHOT") + compileOnly("me.earthme.luminol:luminol-api:1.20.2-R0.1-SNAPSHOT") } ``` For maven @@ -36,7 +39,7 @@ For maven me.earthme.luminol luminol-api - 1.20.4-R0.1-SNAPSHOT + 1.20.2-R0.1-SNAPSHOT ``` diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..5f19c87 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,47 @@ +Logo + +# Luminol + +

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

+ +[English](https://github.com/LuminolMC/Luminol/blob/master/README.md) | **中文** + +[![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) + +## 特性 +- 可配置的原版特性 +- Tpsbar 支持 +- 线性区域文件格式 (from kaiiju) +- 对单线程区域性能的优化 +- 更多的插件开发API支持(进行中) + +## 下载 +任何版本都可以在 [release](https://github.com/LuminolMC/Luminol/releases), 中找到,您也可以通过以下步骤自己构建。 + +## 构建 +要构建一个paperclip jar,你需要运行以下命令。你可以在build/libs中找到jar(注意:需要JDK17) + ```shell + ./gradlew applyPatches && ./gradlew createReobfPaperclipJar +``` +## 使用API +使用 Gradle: +```kotlin +dependencies { + compileOnly("me.earthme.luminol:luminol-api:1.20.2-R0.1-SNAPSHOT") +} + ``` +使用 Maven +```xml + + me.earthme.luminol + luminol-api + 1.20.2-R0.1-SNAPSHOT + +``` + +## BStats +![bStats](https://bstats.org/signatures/server-implementation/Luminol.svg "bStats") \ No newline at end of file diff --git a/public/image/Luminol_1.png b/public/image/Luminol_1.png new file mode 100644 index 0000000..bb7acf7 Binary files /dev/null and b/public/image/Luminol_1.png differ diff --git a/public/image/Luminol_2.png b/public/image/Luminol_2.png new file mode 100644 index 0000000..c85b3ae Binary files /dev/null and b/public/image/Luminol_2.png differ diff --git a/public/image/Luminol_3.png b/public/image/Luminol_3.png new file mode 100644 index 0000000..558ec24 Binary files /dev/null and b/public/image/Luminol_3.png differ diff --git a/public/image/Luminol_4.png b/public/image/Luminol_4.png new file mode 100644 index 0000000..0135c10 Binary files /dev/null and b/public/image/Luminol_4.png differ diff --git a/public/image/Luminol_5.png b/public/image/Luminol_5.png new file mode 100644 index 0000000..96730e2 Binary files /dev/null and b/public/image/Luminol_5.png differ diff --git a/public/image/Luminol_6.png b/public/image/Luminol_6.png new file mode 100644 index 0000000..1262b89 Binary files /dev/null and b/public/image/Luminol_6.png differ