Skip to content
ClaimoClaimo

Quick start

This walkthrough creates a working code two ways — by hand, and with the in-game creator — then redeems it.

Create your first code

Section titled “Create your first code”
  1. Create plugins/Claimo/vouchers/welcome.yml:
    plugins/Claimo/vouchers/welcome.yml
    # Redeemed with /code welcome
    cmd: "give %player% diamond 5"
    console: true
  2. Reload Claimo: 
    /code reload
  3. As a player, redeem it: 
    /code welcome

Gate it behind a requirement

Section titled “Gate it behind a requirement”

Want players to earn the reward? Add a requirements: block. This code only redeems after the player has mined 100 blocks:

plugins/Claimo/vouchers/welcome.yml
cmd: "give %player% diamond 5"
console: true
requirements:
  - type: blocks_mined
    amount: 100

Run /code reload. Now a player who hasn’t mined enough sees a checklist instead of the reward. See Requirements for every built-in type.

Limit how often it’s redeemed

Section titled “Limit how often it’s redeemed”

Add a limit: block to cap redemptions:

One redeem per player
limit:
  mode: per-player
  amount: 1
A shared pool — first 50 players only
limit:
  mode: global
  amount: 50

Open the GUI

Section titled “Open the GUI”

Run the bare command with no argument to open a paginated GUI of every visible code — players click one to redeem it:

/code

Next steps

Section titled “Next steps”