Developer API overview

Addons extend Claimo by registering new requirement types. A type is just a key (used in a voucher file) bound to a factory that builds a Requirement. This means you can add checks Claimo doesn’t ship — a social-media follow, a web-API lookup, a Discord role — without forking the plugin.

The API is a separate artifact

The public API lives in its own zone.vao:claimo-api module, published to repo.vao.zone, so you compile against just the API — not the whole plugin.

Depend on Claimo

Gradle (Kotlin)

build.gradle.kts

repositories {
    maven("https://repo.vao.zone/releases")   // or /snapshots for -SNAPSHOT versions
}
dependencies {
    compileOnly("zone.vao:claimo-api:1.0-SNAPSHOT")
}

plugin.yml

plugin.yml

depend: [Claimo]     # or softdepend: [Claimo]

Load order

Depending on Claimo guarantees your plugin enables after it, so the API is ready by the time your onEnable runs.

The three steps

1. Implement a Requirement — an async check that returns satisfied / unsatisfied.
2. Register the type from your onEnable, optionally declaring input fields so it shows up in the in-game creator.
3. Use it in a voucher by its type key.

Each step has its own page:

Custom requirementsImplement and register a requirement type.

EventsReact to redemptions — cancel or observe them.

API referenceThe full ClaimoApi surface.