# Lophine
*Lophine is a Luminol fork with many useful optimizations and configurable vanilla features, aims to provide more function for survival-usable circuit on folia (Please note that Fabric should be used for complete survival-usable)*
[](LICENSE.md)
[](https://github.com/LuminolMC/Lophine/issues)
**English** | [ไธญๆ](./README.md)
---
## โจ Core Features
- ๐ง **Configurable Vanilla Features** - Flexibly adjust game mechanics to suit different server needs
- ๐ **Tpsbar Support** - Real-time TPS status display
- ๐ **Folia Bug Fixes** - Targeted fixes for known Folia issues
- ๐พ **Multiple World Format Support** - Support for linear and b_linear (linear reimplementation) world formats
- ๐ฌ **Redstone Enhancement** - More redstone functionality on Folia (use Fabric for complete redstone features)
- ๐ ๏ธ **More Useful Functions** - Continuously adding useful server features
## ๐ฅ Download
### Stable Releases
All release versions can be found on the [Releases](https://github.com/LuminolMC/Lophine/releases) page.
### Development Builds
If you want to experience the latest features, you can build it yourself following the steps below.
### Build Steps
```bash
# Clone the project
git clone https://github.com/LuminolMC/Lophine.git
cd Lophine
# Apply patches and build Paperclip JAR
./gradlew applyAllPatches && ./gradlew createPaperclipJar
```
After building, you can find the generated JAR file in the `lophine-server/build/libs` directory.
## ๐ API Usage
### Gradle Configuration
```kotlin
repositories {
maven {
url = "https://repo.bacteriawa.com/repository/maven-public/"
}
}
dependencies {
compileOnly("fun.bm.lophine:lophine-api:$VERSION")
}
```
### Maven Configuration
```xml
repositoryhttps://repo.bacteriawa.com/repository/maven-public/fun.bm.lophineluminol-api$VERSIONprovided
```
## ๐ฌ Community & Support
> If you're interested in this project or have any questions, feel free to ask us.
### Join Our Community
- **QQ Group**: [1015048616](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=QML5kIVsniPi1PlZvnjHQT_02EHsZ5Jc&authKey=%2FTCJsZC7JFQ9sxAroPCKuYnlV57Z5fyqp36ewXZk3Sn4iJ9p4MB1JKdc%2FFcX3HOM&noverify=0&group_code=1015048616)
- **QQ Channel**: [Join Here](https://pd.qq.com/s/eq9krf9j)
- **Telegram**: [Join Here](https://t.me/LuminolMinecraft)
- **Discord**: [Join Here](https://discord.gg/Qd7m3V6eDx)
### Get Help
- ๐ [Submit Issues](https://github.com/LuminolMC/Lophine/issues)
- ๐ฌ [GitHub Discussions](https://github.com/LuminolMC/Lophine/discussions)
- ๐ [Project Documentation](./docs/)
## ๐ Bug Reports
When you encounter any issues, please ask us and we'll do our best to resolve them. Please remember to:
- ๐ **Describe the problem clearly** - Provide detailed information about the specific issue
- ๐ **Provide complete logs** - Include error logs and relevant configuration information
- ๐ **Environment details** - Specify server version, plugin list, and other environment details
- ๐ **Reproduction steps** - If possible, provide specific steps to reproduce the issue
## ๐ค Contributing
We welcome community contributions! For detailed contribution guidelines, please see:
- ๐ [Contributing Guide (English)](./docs/CONTRIBUTING_EN.md)
- ๐ [่ดก็ฎๆๅ (ไธญๆ)](./docs/CONTRIBUTING.md)
## ๐ Project Statistics
### BStats Data
## ๐ Special Thanks
### Project Sponsors
Thanks to LegacyLands for sponsoring this project If you want to develop cross-Folia/non-Folia platform plugins, legacy-lands-library would be a great choice
---
## โญ Give Us a Star!
> Every free โญStar you give is the motivation for our every step forward.
### Star History
If this project helps you, please don't forget to give us a โญStar!
# Lophine
*Lophine is a Luminol fork with many useful optimizations and configurable vanilla features, aims to provide more function for survival-usable circuit on folia (Please note that Fabric should be used for complete survival-usable)*
[](LICENSE.md)
[](https://github.com/LuminolMC/Lophine/issues)
**English** | [ไธญๆ](./README.md)
