Commands & permissions
Claimo registers a single root command whose name you choose. Everything — redeeming, the GUI, and admin management — hangs off it.
Command reference
Section titled “Command reference”| Command | Description | Permission |
|---|---|---|
/<command> |
Open the paginated voucher GUI (players); print usage (console) | claimo.use |
/<command> <voucher> |
Redeem a voucher | claimo.use |
/<command> create |
Open the in-game code creator dialog 1.21.7+ | claimo.admin |
/<command> edit <voucher> |
Edit an existing code in the dialog wizard 1.21.7+ | claimo.admin |
/<command> delete <voucher> |
Delete a code (with a confirm dialog) 1.21.7+ | claimo.admin |
/<command> give <players> <voucher> [amount] |
Give a voucher’s item form (supports selectors like @a) |
claimo.admin |
/<command> giveoffline <player> <voucher> [amount] |
Give a voucher item to an offline player — queued and delivered on their next join | claimo.admin |
/<command> info <voucher> |
Print a code’s full configuration and its global use count | claimo.admin |
/<command> generate <voucher> <amount> |
Generate hidden one-time copies of a code (max 500 per run) | claimo.admin |
/<command> campaign create <voucher> <amount> |
Same as generate — the batch becomes a campaign named after the template |
claimo.admin |
/<command> campaign info <campaign> |
Show a campaign’s code counts: total, redeemed, disabled, remaining | claimo.admin |
/<command> campaign disable <campaign> |
Invalidate all remaining codes in a campaign | claimo.admin |
/<command> campaign export <campaign> |
Save the still-unused codes to a text file | claimo.admin |
/<command> campaign delete <campaign> |
Delete all of a campaign’s codes and purge their usage | claimo.admin |
/<command> stats <voucher> |
Uses, unique players, revenue and last redeem of a code | claimo.admin |
/<command> history <code | player> |
Last 10 redeems of a code or by a player | claimo.admin |
/<command> reload |
Reload config and voucher files | claimo.admin |
/<command> purge |
Drop stored usage for codes whose config was deleted | claimo.admin |
Permissions
Section titled “Permissions”| Node | Grants | Default |
|---|---|---|
claimo.use |
Redeem codes and open the GUI | everyone |
claimo.admin |
Create, edit, delete, reload and purge | op |
claimo.update |
Get notified on join when a new Claimo release is out | op |
The command name
Section titled “The command name”<command> defaults to code and is set by the command: key in config.yml. There’s
also a permanent /claimo alias.
# Players redeem with /kod <voucher> instead of /code <voucher>command: kodBehaviour notes
Section titled “Behaviour notes”-
Voucher names tab-complete on the redeem argument.
-
Running the command with no argument opens the paginated GUI listing available codes; clicking one redeems it. (Set
gui-list-enabled: falseto disable.) -
Vouchers with
hide: trueare excluded from both the GUI and tab-completion — they stay redeemable by typing the exact code. -
/<command> purgeremoves stored redemption counts (global and per-player) for every code that no longer has a config file, and clears the deleted codes’ cooldowns for online players. Deleting a code alone leaves its history in the database; purge is the explicit, one-off cleanup, and it lets a re-created code start fresh. -
/<command> giveofflinequeues the items inplugins/Claimo/pending-gives.ymlwhen the target is offline (an online target is handed the items immediately). A player can have several queued entries — winning three giveaways while offline delivers all three on the next join. Entries whose code (or itsitemsection) was deleted in the meantime are skipped and noted inlogs/admin.log. -
/<command> generate <voucher> <amount>clones an existing code into hidden, one-time (limit: global 1) copies named<voucher>-x7k2q9and saves the full list toplugins/Claimo/generated/<voucher>-<timestamp>.txt— hand those out on Discord, in a store, etc. Expiry (expires) is re-counted from the moment of generation. -
Every generated code carries a
campaign:key named after its template, which thecampaignsubcommands operate on: run a 500-code giveaway, watchcampaign infofor progress, thencampaign disableto void whatever leaked orcampaign deleteto clean up entirely. Disabled codes answer with thecode-disabledmessage and disappear from the GUI. Generating from the same template twice extends the same campaign. -
/<command> historyand/<command> statsread the redeem history that Claimo records in its storage backend (who, when, at what price). The argument tohistoryis tried as a code id first and as a player name second.