[ci skip]docs: refactor format

This commit is contained in:
Helvetica Volubi
2025-07-30 16:18:31 +08:00
parent cfb1ad88f4
commit e71b36e331
7 changed files with 134 additions and 103 deletions
+12
View File
@@ -13,6 +13,7 @@
[English](./README_EN.md) | **中文** [English](./README_EN.md) | **中文**
## 特性 ## 特性
- 支持部分Bukkit插件 - 支持部分Bukkit插件
- 可配置的原版特性 - 可配置的原版特性
- Tpsbar 支持 - Tpsbar 支持
@@ -20,14 +21,19 @@
- 更多有用的功能 - 更多有用的功能
## 下载 ## 下载
任何版本都可以在 [Release](https://github.com/LuminolMC/Lophine/releases), 中找到,你也可以通过[以下步骤](./README.md#构建)自己构建。 任何版本都可以在 [Release](https://github.com/LuminolMC/Lophine/releases), 中找到,你也可以通过[以下步骤](./README.md#构建)自己构建。
## 构建 ## 构建
要构建一个paperclip jar,你需要运行以下命令。你可以在lophine-server/build/libs中找到jar(注意:需要`JDK21` 要构建一个paperclip jar,你需要运行以下命令。你可以在lophine-server/build/libs中找到jar(注意:需要`JDK21`
```shell ```shell
./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar ./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar
``` ```
## 使用API ## 使用API
使用 Gradle: 使用 Gradle:
```kotlin ```kotlin
@@ -62,26 +68,32 @@ dependencies {
``` ```
## 联系方式 ## 联系方式
> 如果您对这个项目感兴趣或有任何问题,请随时向我们提问。 > 如果您对这个项目感兴趣或有任何问题,请随时向我们提问。
**QQ群: [1015048616](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=QML5kIVsniPi1PlZvnjHQT_02EHsZ5Jc&authKey=%2FTCJsZC7JFQ9sxAroPCKuYnlV57Z5fyqp36ewXZk3Sn4iJ9p4MB1JKdc%2FFcX3HOM&noverify=0&group_code=1015048616)** | QQ频道: [点击加入](https://pd.qq.com/s/eq9krf9j) | Telegram: [点击加入](https://t.me/LuminolMinecraft) | Discord: [点击加入](https://discord.gg/Qd7m3V6eDx) **QQ群: [1015048616](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=QML5kIVsniPi1PlZvnjHQT_02EHsZ5Jc&authKey=%2FTCJsZC7JFQ9sxAroPCKuYnlV57Z5fyqp36ewXZk3Sn4iJ9p4MB1JKdc%2FFcX3HOM&noverify=0&group_code=1015048616)** | QQ频道: [点击加入](https://pd.qq.com/s/eq9krf9j) | Telegram: [点击加入](https://t.me/LuminolMinecraft) | Discord: [点击加入](https://discord.gg/Qd7m3V6eDx)
## 关于 Issue ## 关于 Issue
当您遇到任何问题时,请向我们提问,我们将尽力解决,但请记得清楚地描述您的问题并提供足够的日志等信息。 当您遇到任何问题时,请向我们提问,我们将尽力解决,但请记得清楚地描述您的问题并提供足够的日志等信息。
## 贡献代码 ## 贡献代码
可查看 [Contributing](./docs/CONTRIBUTING.md) 可查看 [Contributing](./docs/CONTRIBUTING.md)
## BStats ## BStats
![bStats](https://bstats.org/signatures/server-implementation/Lophine.svg "bStats") ![bStats](https://bstats.org/signatures/server-implementation/Lophine.svg "bStats")
## 特别感谢 ## 特别感谢
<b>感谢[LegacyLands](https://github.com/LegacyLands)对本项目的赞助,如果你想开发一些跨folia/非folia平台的插件,[legacy-lands-library](https://github.com/LegacyLands/legacy-lands-library/)将会是个不错的lib</b> <b>感谢[LegacyLands](https://github.com/LegacyLands)对本项目的赞助,如果你想开发一些跨folia/非folia平台的插件,[legacy-lands-library](https://github.com/LegacyLands/legacy-lands-library/)将会是个不错的lib</b>
![legacy-lands-logo](public/image/legacy-lands-logo.png) ![legacy-lands-logo](public/image/legacy-lands-logo.png)
## 请给我们一个 ⭐Star ## 请给我们一个 ⭐Star
> 你的每一个免费的 ⭐Star 就是我们每一个前进的动力。 > 你的每一个免费的 ⭐Star 就是我们每一个前进的动力。
<a href="https://star-history.com/#LuminolMC/Luminol&LuminolMC/LightingLuminol&LuminolMC/Lophine&Date"> <a href="https://star-history.com/#LuminolMC/Luminol&LuminolMC/LightingLuminol&LuminolMC/Lophine&Date">
+14 -1
View File
@@ -2,7 +2,8 @@
# Lophine # Lophine
<h4>LightingLuminol is a Luminol fork with many useful optimizations and configurable vanilla features, aims to provide more function for survival-usable circuit on folia</h4> <h4>LightingLuminol is a Luminol fork with many useful optimizations and configurable vanilla features, aims to provide
more function for survival-usable circuit on folia</h4>
[![License](https://img.shields.io/github/license/LuminolMC/Lophine?style=flat-square)](LICENSE.md) [![License](https://img.shields.io/github/license/LuminolMC/Lophine?style=flat-square)](LICENSE.md)
[![Issues](https://img.shields.io/github/issues/LuminolMC/Lophine?style=flat-square)](https://github.com/LuminolMC/Lophine/issues) [![Issues](https://img.shields.io/github/issues/LuminolMC/Lophine?style=flat-square)](https://github.com/LuminolMC/Lophine/issues)
@@ -13,6 +14,7 @@
**English** | [中文](./README.md) **English** | [中文](./README.md)
## Features ## Features
- Supported some Bukkit plugin - Supported some Bukkit plugin
- Configurable vanilla features - Configurable vanilla features
- Tpsbar support - Tpsbar support
@@ -20,14 +22,19 @@
- More functions - More functions
## Download ## Download
Any versions are available in the [release](https://github.com/LuminolMC/Lophine/releases), also you can build it by yourself through [the following steps](./README_EN.md#Build). Any versions are available in the [release](https://github.com/LuminolMC/Lophine/releases), also you can build it by yourself through [the following steps](./README_EN.md#Build).
## Build ## Build
To build a paperclip jar, you need to run the following command. You can find the jar in lophine-server/build/libs(Note: `JDK21` is needed) To build a paperclip jar, you need to run the following command. You can find the jar in lophine-server/build/libs(Note: `JDK21` is needed)
```shell ```shell
./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar ./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar
``` ```
## Using API ## Using API
For gradle: For gradle:
```kotlin ```kotlin
@@ -62,25 +69,31 @@ For maven
``` ```
## Contact ## Contact
> If you are interested in this project or have any issue, feel free to ask us. > If you are interested in this project or have any issue, feel free to ask us.
**QQ Group: [1015048616](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=hTPlI5j6XB8pgk4sdx6RkjhBPGG1r4IR&authKey=pnu6uCKQP7Sja2CJWC15Qi3BeI%2FAsh8tU4m5muufMBjbB3zz%2BwHBZCTRRdSNKhld&noverify=0&group_code=1015048616)** | QQ Channel: [Click To Join](https://pd.qq.com/s/eq9krf9j) | Telegram: [Click To Join](https://t.me/LuminolMinecraft) | Discord: [Click To Join](https://discord.gg/Qd7m3V6eDx) **QQ Group: [1015048616](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=hTPlI5j6XB8pgk4sdx6RkjhBPGG1r4IR&authKey=pnu6uCKQP7Sja2CJWC15Qi3BeI%2FAsh8tU4m5muufMBjbB3zz%2BwHBZCTRRdSNKhld&noverify=0&group_code=1015048616)** | QQ Channel: [Click To Join](https://pd.qq.com/s/eq9krf9j) | Telegram: [Click To Join](https://t.me/LuminolMinecraft) | Discord: [Click To Join](https://discord.gg/Qd7m3V6eDx)
## About Issue ## 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> 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 ## Pull Requests
See [Contributing](./docs/CONTRIBUTING_EN.md) See [Contributing](./docs/CONTRIBUTING_EN.md)
## BStats ## BStats
![bStats](https://bstats.org/signatures/server-implementation/Lophine.svg "bStats") ![bStats](https://bstats.org/signatures/server-implementation/Lophine.svg "bStats")
## Special Thanks ## Special Thanks
Thanks [LegacyLands](https://github.com/LegacyLands) for sponsoring this project.If you want to develop some crossing folia/non-folia platform plugins, [legacy-lands-library](https://github.com/LegacyLands/legacy-lands-library/) will be a nice choice for you Thanks [LegacyLands](https://github.com/LegacyLands) for sponsoring this project.If you want to develop some crossing folia/non-folia platform plugins, [legacy-lands-library](https://github.com/LegacyLands/legacy-lands-library/) will be a nice choice for you
![legacy-lands-logo](public/image/legacy-lands-logo.png) ![legacy-lands-logo](public/image/legacy-lands-logo.png)
## Please ⭐star us! ## Please ⭐star us!
<a href="https://star-history.com/#LuminolMC/Luminol&LuminolMC/LightingLuminol&LuminolMC/Lophine&Date"> <a href="https://star-history.com/#LuminolMC/Luminol&LuminolMC/LightingLuminol&LuminolMC/Lophine&Date">
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol%2CLuminolMC/Lophine&type=Date&theme=dark" /> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=LuminolMC/Luminol%2CLuminolMC/LightingLuminol%2CLuminolMC/Lophine&type=Date&theme=dark" />
+4 -1
View File
@@ -1,5 +1,5 @@
为Lophine贡献代码 为Lophine贡献代码
=========== ===============
[English](./CONTRIBUTING_EN.md) | **中文** [English](./CONTRIBUTING_EN.md) | **中文**
@@ -45,13 +45,16 @@ Lophine 使用和 Folia 一样的补丁系统,并为了针对不同部分的
4. 进入 仓库根目录下的 `*-api``*-server` 文件夹进行修改。 4. 进入 仓库根目录下的 `*-api``*-server` 文件夹进行修改。
以下为对上述各个文件夹的简单描述,详细描述可以参考[这里](https://github.com/Toffikk/paperweight-examples/blob/18241979c88068d5b061d95ad69c98ecb201c246/README.md) 以下为对上述各个文件夹的简单描述,详细描述可以参考[这里](https://github.com/Toffikk/paperweight-examples/blob/18241979c88068d5b061d95ad69c98ecb201c246/README.md)
1. API部分 1. API部分
- `lophine-api` :对新增API的修改 - `lophine-api` :对新增API的修改
- `luminol-api` :对luminol-API的修改应当在此文件夹下进行 - `luminol-api` :对luminol-API的修改应当在此文件夹下进行
- `folia-api` :对folia-API的修改应当在此文件夹下进行 - `folia-api` :对folia-API的修改应当在此文件夹下进行
- `paper-api` :对paper-API/spigot-API/bukkit-API的修改应该在此文件夹下进行 - `paper-api` :对paper-API/spigot-API/bukkit-API的修改应该在此文件夹下进行
2. Server部分 2. Server部分
- `lophine-server` :对Minecraft原版服务器的修改和新增文件应当在此文件夹下进行 - `lophine-server` :对Minecraft原版服务器的修改和新增文件应当在此文件夹下进行
- `luminol-server` :对luminol-server的修改应当在此文件夹下进行 - `luminol-server` :对luminol-server的修改应当在此文件夹下进行
- `folia-server` :对folia-Server的修改应当在此文件夹下进行 - `folia-server` :对folia-Server的修改应当在此文件夹下进行
+3 -1
View File
@@ -1,5 +1,5 @@
Contributing to Lophine Contributing to Lophine
=========== =======================
**English** | [中文](./CONTRIBUTING.md) **English** | [中文](./CONTRIBUTING.md)
@@ -50,12 +50,14 @@ If you have forked the main repository, then you should follow the steps below:
The following is the simple description of the aforementioned folders, detailed description can be referred to [here](https://github.com/Toffikk/paperweight-examples/blob/18241979c88068d5b061d95ad69c98ecb201c246/README.md): The following is the simple description of the aforementioned folders, detailed description can be referred to [here](https://github.com/Toffikk/paperweight-examples/blob/18241979c88068d5b061d95ad69c98ecb201c246/README.md):
1. API part 1. API part
- `lophine-api` : Modifications to the new API - `lophine-api` : Modifications to the new API
- `luminol-api` : Modifications to Luminol API should be carried out in this folder - `luminol-api` : Modifications to Luminol API should be carried out in this folder
- `folia-api` : Modifications to Folia API should be carried out in this folder - `folia-api` : Modifications to Folia API should be carried out in this folder
- `paper-api` : Modifications to Paper API/Spigot API/Bukkit API should be carried out in this folder - `paper-api` : Modifications to Paper API/Spigot API/Bukkit API should be carried out in this folder
2. Server part 2. Server part
- `lophine-server` : Changes and new files to the Minecraft vanilla server should be made in this folder - `lophine-server` : Changes and new files to the Minecraft vanilla server should be made in this folder
- `luminol-server` : Changes to luminol-server should be made in this folder - `luminol-server` : Changes to luminol-server should be made in this folder
- `folia-server` : Changes to folia-server should be made in this folder - `folia-server` : Changes to folia-server should be made in this folder
+2 -1
View File
@@ -1,4 +1,5 @@
### GNU GENERAL PUBLIC LICENSE ### GNU GENERAL PUBLIC LICENSE
==============================
Version 3, 29 June 2007 Version 3, 29 June 2007
@@ -286,7 +287,7 @@ ways:
available for as long as needed to satisfy these requirements. available for as long as needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission, - e) Convey the object code using peer-to-peer transmission,
provided you inform other peers where the object code and provided you inform other peers where the object code and
Corresponding Source of the work are being offered to the general Corresponding Source of the work are being offered to the
public at no charge under subsection 6d. public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded A separable portion of the object code, whose source code is excluded
+2 -2
View File
@@ -1,5 +1,5 @@
The MIT License (MIT) ### The MIT License (MIT)
===================== =========================
Permission is hereby granted, free of charge, to any person Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation obtaining a copy of this software and associated documentation