Based on Fairy Framework, it runs as a plugin, aiming to encapsulate various existing libraries to simplify the development of plugins.

Overview

A comprehensive library built on Fairy Framework, providing essential tools and utilities for modern Minecraft plugin development. It is cross-platform and supports Spigot Paper and Folia.

Core Modules

• annotation - Powerful annotation processing framework with flexible scanning options and lifecycle management.

• commons - Essential utilities including VarHandle injection, task scheduling, and JSON operations.

• configuration - Flexible configuration framework built on SimplixStorage with serialization support.

• mongodb - Streamlined MongoDB integration with Morphia for efficient data persistence.

• cache - Multi-tier caching system integrating Caffeine and Redis, providing comprehensive lock management and a generic framework for thread-safe resource access.

• player - High-performance player data management with multi-tier caching and real-time synchronization.

• script - Powerful, flexible, extensible, and high-performance script execution engine wrapper that supports Rhino, Nashorn and V8 JavaScript engines.

• experimental - Some experimental modules that can significantly improve performance, but may be too complex to use or temporarily unstable.

• security - Coming soon.

Usage

Although the version number is currently still a SNAPSHOT, this does not mean it is unsuitable for production use. In fact, we plan to extensively utilize this version in a large-scale plugin development project, and will release the first official version once we have thoroughly validated its stability and functionality.

Distribution Packages

Download from Actions:

• -javadoc: Generated API documentation
• -plugin: Compiled plugin for direct server use
• -sources: Source code with compiled classes (recommended for development)

Detailed documentation in each module's README

Maven Repository

Configure GitHub authentication first (Learn More)

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/LegacyLands/legacy-lands-library")
        credentials {
            username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
            password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
        }
    }
}

dependencies {
    implementation("net.legacy.library:module-name:version")
}

Jenkins

Link

Community

• 中文文档
• QQ Group
• Github Issues
• Bilibili (Chinese tutorials)

We will release more development tutorials and experience sharing about this module or Fairy Framework in the Bilibili channel!

Sponsors

Fully sponsored and maintained by LegacyLands.

Luminol is a Folia fork with many useful optimizations, configurable vanilla features, and more API supports.

Star History