config.yml

config.yml holds Claimo’s core settings. Here it is in full, annotated:

plugins/Claimo/config.yml

# Command players type to redeem. Set to "kod" for /kod <voucher>.
# Changing this requires a server restart.
command: code
# Open the paginated voucher GUI when the bare command is run with no argument.
gui-list-enabled: true

# Text the boolean placeholders (redeemed, can_redeem, expired) return, in both
# PlaceholderAPI and MiniPlaceholders. Set custom messages instead of true/false.
placeholders:
  true-value: "true"
  false-value: "false"

# Sound played to the player on a successful redeem.
# key accepts any sound id, including custom resourcepack sounds (namespace:path).
# source: master|music|record|weather|block|hostile|neutral|player|ambient|voice
redeem-sound:
  enabled: true
  key: "minecraft:entity.player.levelup"
  source: master
  volume: 1.0
  pitch: 1.0

# Append plugin activity to plugins/Claimo/logs/.
logging:
  redeems: true
  admin: true

# Checks https://github.com/Naimadx123/Claimo/releases for a newer version.
update-checker:
  enabled: true
  notify-admins: true # players with claimo.update get a message on join
  interval-hours: 6 # how often to re-check (minimum 1)

# Where redemption counts (global pools and per-player usage) are stored.
storage:
  type: yaml
  uri: ""
  host: localhost
  port: 3306
  database: claimo
  username: root
  password: ""
  table-prefix: claimo_
  pool-size: 10

Keys

command

restart required The command players type to redeem. Defaults to code; there’s also a permanent /claimo alias. See Commands & permissions.

gui-list-enabled

When true (default), running the bare command with no argument opens the paginated voucher GUI. Set false to disable it.

placeholders

The text the boolean placeholders — redeemed, can_redeem and expired — return, in both PlaceholderAPI and MiniPlaceholders. Use it to show a friendly message instead of true/false. The token <voucher> is replaced with the code id.

Key	Meaning
true-value	Returned when the check is true (default true).
false-value	Returned when the check is false (default false).

placeholders:
  true-value: "You already redeemed <voucher>!"
  false-value: "&cNot claimed"

redeem-sound

A sound played to the player on a successful redeem.

Key	Meaning
enabled	Turn the sound on or off.
key	Any sound id, including custom resourcepack sounds (namespace:path).
source	master, music, record, weather, block, hostile, neutral, player, ambient or voice.
volume	Playback volume.
pitch	Playback pitch.

Resourcepack sounds work

Because key accepts any raw sound id, a namespace:path from your resourcepack plays fine — not just vanilla sounds.

logging.redeems

When true, every successful redeem is appended to plugins/Claimo/logs/redeems.log — including the price paid, for codes with a price.

logging.admin

When true, admin actions — /code give, /code generate, /code purge and the creator’s create/edit/delete — are appended to plugins/Claimo/logs/admin.log.

update-checker

Asks the GitHub releases API whether a newer Claimo build exists. The check runs off the main thread (Folia-safe) and never downloads anything — it only tells you a release is out.

Key	Meaning
enabled	Turn the check on or off (default true).
notify-admins	Message players holding claimo.update shortly after they join (default true).
interval-hours	How often to re-check, minimum 1 (default 6).

The result is also logged to the console once per new version. Customise the in-game text with the update-available key in messages.yml — it accepts <latest>, <current> and <url>.

storage

Where redemption counts — global pools and per-player usage — are persisted. This is a big topic with several backends; it has its own page.

Restart required

Changing storage.type requires a server restart.

→ Storage backends