Package ke.ric.api

package ke.ric.api

Public entry point and addon lifecycle contracts for integrating with Heirloom.

Obtain the API instance via HeirloomAPI.getInstance() after checking HeirloomAPI.isReady(), register addons via registerAddon(...), create or identify Heirloom items, and inspect dietary provenance via HeirloomAPI.foodFactsV2(org.bukkit.inventory.ItemStack).

This SDK JAR contains compile-only stubs. Declare Heirloom in depend or softdepend inside plugin.yml, depend on ke.ric:heirloom-api with provided / compileOnly scope, and never shade it into your plugin JAR.

Related Packages

Package	Description
ke.ric.api.advancement	Addon advancement definition contracts registered via AdvancementRegistration.
ke.ric.api.affinity	Deterministic candidate affinity aggregation and ranking utilities shared by addons.
ke.ric.api.aging	Staged aging definitions, climate/environment probes, exposure histories, and dynamic outcome hooks.
ke.ric.api.events	Bukkit/Paper events fired by Heirloom during food consumption, placed-food eating, station crafting, crop harvesting, and admin item grants.
ke.ric.api.food	Immutable food provenance and dietary evidence models (FoodFactsV2 and legacy FoodFacts).
ke.ric.api.guide	Immutable guide page, navigation action, and production-destination models for addon guides.
ke.ric.api.item	Shared beverage, alcohol strength/serving, quality tier, and tooltip formatting helpers.
ke.ric.api.registration	Owner-scoped registration facades for custom items, recipes, crops, dietary properties, seed acquisition rules, advancements, and staged aging definitions.

Class	Description
GuideRegistration	Owner-scoped registration facade for immutable addon guide definitions.
GuideRegistration.OwnedGuideDefinition
GuideRegistration.OwnedItemUse
GuideRegistration.OwnedProductionDestination
HeirloomAddon	Interface that all Heirloom addons must implement.
HeirloomAPI	Main API entry point for Heirloom addons.
HeirloomAPI.ReloadRollbackScope