PlaceholderAPI

Claimo integrates with PlaceholderAPI in both directions — it consumes placeholders and provides its own.

Fully optional

PlaceholderAPI is a soft dependency. Everything below only activates when it’s installed; without it, Claimo runs fine and simply skips these features.

Claimo consumes placeholders

With PlaceholderAPI installed:

• In commands — any %placeholder% in a voucher’s cmd (beyond %player%) is resolved for the redeeming player, e.g. %player_uuid%, %vault_eco_balance%.
• In the custom requirement — compare any PAPI value to a target with an operator. See Requirements → custom.

Claimo provides the claimo expansion

Claimo registers a claimo expansion so other plugins — scoreboards, holograms, GUIs — can read voucher state. Replace <id> with a code name.

Placeholder	Value
%claimo_total_codes%	Number of loaded codes
%claimo_uses_<id>%	Total (global) redemptions of the code
%claimo_player_uses_<id>%	Redemptions by the viewing player
%claimo_redeemed_<id>%	true/false — whether the viewing player has redeemed the code
%claimo_remaining_<id>%	Redemptions left (per its limit mode), or unlimited
%claimo_limit_<id>%	The code’s limit amount, or unlimited
%claimo_can_redeem_<id>%	true/false — not expired and not exhausted for the player
%claimo_expired_<id>%	true/false

Example

Show a player how many times they can still redeem the welcome code on a scoreboard:

Welcome reward: %claimo_remaining_welcome% left

Custom true/false text

The boolean placeholders (redeemed, can_redeem, expired) return true/false by default, but you can change that text — e.g. to You already redeemed <voucher>! — via placeholders.true-value / placeholders.false-value in config.yml. The <voucher> token is replaced with the code id, and it applies to both PlaceholderAPI and MiniPlaceholders.

Deleted codes keep their history until purged

Deleting a code’s config does not immediately wipe its remembered redemptions from the database. Run /code purge (needs claimo.admin) to drop stored usage for every code that no longer has a config file. After purging, a code re-created with the same name starts fresh — %claimo_redeemed_<id>% reports false again until it’s redeemed anew.

Note

The expansion is registered at startup only when PlaceholderAPI is enabled, so its classes are never linked on servers that don’t have it.

The same placeholders in MiniPlaceholders

If MiniPlaceholders is installed, Claimo also registers a claimo expansion there, so the exact same values are available as MiniMessage tags — usable anywhere a plugin resolves MiniPlaceholders (chat, holograms, MiniMessage GUIs).

The per-code id is passed as a tag argument rather than a suffix, and everything else maps one-to-one:

PlaceholderAPI	MiniMessage tag
%claimo_total_codes%	<claimo_total_codes>
%claimo_uses_<id>%	<claimo_uses:'<id>'>
%claimo_player_uses_<id>%	<claimo_player_uses:'<id>'>
%claimo_redeemed_<id>%	<claimo_redeemed:'<id>'>
%claimo_remaining_<id>%	<claimo_remaining:'<id>'>
%claimo_limit_<id>%	<claimo_limit:'<id>'>
%claimo_can_redeem_<id>%	<claimo_can_redeem:'<id>'>
%claimo_expired_<id>%	<claimo_expired:'<id>'>

Welcome reward: <claimo_remaining:'welcome'> left

Note

MiniPlaceholders is a separate soft dependency from PlaceholderAPI — either, both, or neither can be installed. The MiniPlaceholders expansion is registered only when that plugin is present, and its classes are never linked otherwise. The per-player placeholders (player_uses, redeemed, can_redeem) resolve against the viewing player.