README_EN.md

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 | 中文

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, also you can build it by yourself through the following steps.

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)

./gradlew applyPatches && ./gradlew createMojmapPaperclipJar

Using API

For gradle:

repositories {
    maven {
        url = "https://maven.nostal.ink/repository/maven-snapshots/"
    }
}

dependencies {
    compileOnly("me.earthme.luminol:luminol-api:1.20.6-R0.1-20241001.135131-1")
}

For maven

<repositories>
    <repository>
        <id>nostal</id>
        <url>http://maven.nostal.ink/repository/maven-snapshots/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>me.earthme.luminol</groupId>
        <artifactId>luminol-api</artifactId>
        <version>1.20.6-R0.1-20241001.135131-1</version>
    </dependency>
</dependencies>

Contact

If you are interested in this project or have any issue, feel free to ask us.

QQ Group: 368632360 | QQ Channel: Click To Join | Telegram: Click To Join | Discord: Click To Join

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

BStats

Please ⭐star us!