BTC Reward Definition

Defines a reward type that can be given and claimed by players

ManifiestoProporcionado por Rewards

Campos

Campo	Tipo	Predeterminado	Descripción
rewardId	String	—	Unique identifier for this reward type (used to reference this reward)
source	String	—	Origin of this reward, free-form (e.g. event, vote, daily_login). Used to group and filter rewards in menus and placeholders. Empty = uncategorised
displayItem	Item	—	Display item shown in the rewards menu
requiredInventorySlots	Int	0	Required free inventory slots to claim this reward (0 = no requirement)
onClaimActions	List<Ref<TriggerableEntry>>	empty	Actions triggered when this reward is successfully claimed
onClaimFailActions	List<Ref<TriggerableEntry>>	empty	Actions triggered if claim fails (inventory full)
additionalLore	List<String>	empty	Description lines shown at the top of the reward lore (supports MiniMessage)
displayNameOverride	String	—	Display name override for the menu (empty = use item name, supports MiniMessage)

How to use it

rewardId is the key the queue stores, so keep it unique and stable: changing it orphans rewards already granted. source is only a label used in the lore and in the <rewards_source:...> placeholder.

Put what the player actually receives in onClaimActions (give item, money, command action...). requiredInventorySlots should match the number of item stacks those actions give. onClaimFailActions is not read in the current version.

displayItem is the icon in the menu. If it is empty, a chest is shown. displayNameOverride and additionalLore are MiniMessage; the source, slot requirement and tip lines are added after them from the Rewards Config layout.