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

Overview

A Modular Plugin Toolkit built on Fairy Framework, featuring modular design and leveraging modern Java 21 features. It provides essential tools and utilities for modern Minecraft plugin development with cross-platform support for Spigot, Paper, and Folia.

Core Modules

• foundation - Core foundation module providing essential testing infrastructure, utilities, and base abstractions for all library modules.

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

• aop - Enterprise-grade Aspect-Oriented Programming framework with ClassLoader isolation, providing performance monitoring, thread safety, logging, and exception handling aspects.

• commons - Essential utilities including VarHandle injection, task scheduling, virtual thread scheduling, JSON operations, and random object generation.

• 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 - Enterprise-grade distributed data management framework building high-performance entity-relationship data layers. Capable of seamlessly handling thousands of inter-entity relationship networks and state 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.

  • third-party-schedulers - Achieves distributed task processing via gRPC external task schedulers (currently implemented in Rust), enabling large plugin decoupling and performance improvements (for backends that cannot directly access the Bukkit API). Ideal for machine learning, anti-cheat large data computation, mathematics, and similar applications.

• 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 {
    compileOnly("net.legacy.library:module-name:version")
}

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.

PromptX is an AI application-native professional capability enhancement system developed by Deepractice, playing a key role in this project.

Contributing

We warmly welcome more developers to join our open source project and contribute their strength. Whether it's sharing ideas, creating Issues, or submitting Pull Requests, every contribution is significant!

We are very liberal with our use of AI. You can use any AI you want to write and contribute code, as long as it all works and meets the requirements in CLAUDE.md (this is a Chinese document).

Star History

---