ke.ric:heirloom-api:2.11.0 Java 21 Paper 1.21.11+ Compile-Only SDK + Javadocs

Heirloom Maven Repository

Public developer SDK for Heirloom addons and integrations, including bytecode stubs, -sources.jar, and -javadoc.jar for full IDE autocomplete and hover documentation.

Browse Online Javadoc Developer API Guide

Repository URL

https://heirloom-maven.pages.dev

Group / Artifact

ke.ric:heirloom-api

Latest Version

2.11.0

Metadata Updated

2026-11-15 12:38 UTC

Build Configuration

repositories {
    mavenCentral()
    maven("https://repo.papermc.io/repository/maven-public/")
    maven("https://heirloom-maven.pages.dev")
}

dependencies {
    compileOnly("io.papermc.paper:paper-api:1.21.11-R0.1-SNAPSHOT")
    compileOnly("ke.ric:heirloom-api:2.11.0")
}

repositories {
    mavenCentral()
    maven { url 'https://repo.papermc.io/repository/maven-public/' }
    maven { url 'https://heirloom-maven.pages.dev' }
}

dependencies {
    compileOnly 'io.papermc.paper:paper-api:1.21.11-R0.1-SNAPSHOT'
    compileOnly 'ke.ric:heirloom-api:2.11.0'
}

<repositories>
    <repository>
        <id>papermc</id>
        <url>https://repo.papermc.io/repository/maven-public/</url>
    </repository>
    <repository>
        <id>heirloom-maven</id>
        <url>https://heirloom-maven.pages.dev</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>ke.ric</groupId>
        <artifactId>heirloom-api</artifactId>
        <version>2.11.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

# Require Heirloom at server startup:
depend: [Heirloom]

# Or load optionally and guard calls with HeirloomAPI.getInstance().isReady():
softdepend: [Heirloom]

IDE Hover Docs & Parameter Names
Both -javadoc.jar and -sources.jar are published alongside the SDK, and .class files include Java -parameters metadata. IntelliJ IDEA, VS Code, and Eclipse display full Javadocs, parameter names, and code snippets automatically after Gradle/Maven sync.

Compile-Only — Never Shade!
heirloom-api contains compile-time API stubs that throw UnsupportedOperationException if executed directly. Always keep compileOnly / provided scope and let the Heirloom plugin supply the runtime classes on the server.

Quick Example

HeirloomAPI api = HeirloomAPI.getInstance();
if (api != null && api.isReady()) {
    FoodFactsV2 facts = api.foodFactsV2(itemStack);
    FoodFactsV2.Truth vegan = facts.dietaryFacts().getOrDefault("VEGAN", FoodFactsV2.Truth.UNKNOWN);

    api.registerAddon("my_addon", "1.0.0", this, heirloom -> {
        heirloom.items().register(ItemRegistration.builder()
            .id("HONEY_GLAZED_BERRY")
            .name("Honey Glazed Berry")
            .edible(true)
            .foodValue(4)
            .saturation(0.6f));
    });
}

Repository Artifacts (2.11.0)

Artifact	Purpose	SHA-256
heirloom-api-2.11.0.jar	Compile-only bytecode SDK	5068090abe2b6011acd596daaa4786ec2a2b34aa9bdc0707f61b289713bad367
heirloom-api-2.11.0-javadoc.jar	IDE Javadoc archive	b256b2390455e5dc9cb017c5ede3b22cc9fd41e8c67dc3dee93e49d072f83969
heirloom-api-2.11.0-sources.jar	IDE stub source attachment	99af9cab8530b5b507ce0d3f239ed3711d3f11b336afade4a6f31409ac862f76
heirloom-api-2.11.0.pom	Maven POM metadata	97bf6b531de38917b36a165fa4de01b5cfcd84872ccf17c2dacfc4cd4e5d6c0c
maven-metadata.xml	Version catalog metadata	.sha256