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

Overview

A comprehensive library built on Fairy Framework, providing essential tools and utilities for modern Minecraft plugin development. While optimized for Folia, it's fully compatible with Spigot and Paper platforms.

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-level caching system integrating Caffeine and Redis with comprehensive lock mechanisms

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

• security - Coming soon

Usage

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")
}

Community

• 中文文档
• QQ Group: 1022665227
• 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. We will use this for our main development work.

Star History