Collectable Codex API

The Collectable Codex API is a lightweight public library for integrating with the Collections / Discoverables system.

It provides a generic, extensible framework for managing collectables in Minecraft servers, such as lore notes, recipes, rare fish, music, or hidden easter eggs

This API is designed for plugin developers who want to register new collectable types, repositories, or custom unlock triggers

Features

• Generic and modular system - supports any type of collectable
• Configuration-driven repositories and entries
• Simple commands and API hooks for triggering discoveries
• Per-player unlock tracking with replay support
• Extendable with custom CollectableType implementations

📦 Getting Started

Gradle (Kotlin DSL)

repositories {
    maven {
        name = "GitHubPackages"
        url = uri("<https://maven.pkg.github.com/Glance-Studios/CollectableCodexAPI>")
        credentials {
            username = project.findProperty("gpr.user") as String? ?: System.getenv("GPR_USER")
            password = project.findProperty("gpr.key") as String? ?: System.getenv("GPR_TOKEN")
        }
    }
}

dependencies {
    compileOnly("com.glance.codex:codex-api:1.0.0")
}

Core Concepts

Collectable

Represents a single unlockable entry (e.g. a note, recipe, or artifact)

• Has display name, icons (locked/unlocked), and metadata