Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

The Reward Definition creates a reusable template for a reward. It defines what the reward looks like in the menu and what happens when it is claimed.

​
Configuration

​
rewardId
String
required
Unique ID referenced by GiveRewardAction.
​
displayItem
Item
The icon shown in the GUI.
​
requiredInventorySlots
Int
default:"0"
Number of empty inventory slots required to claim.
​
onClaimActions
List<Ref<Triggerable>>
Actions executed to deliver the reward (e.g. give_item, add_money).
​
onClaimFailActions
List<Ref<Triggerable>>
Actions executed if claim fails (e.g. inventory full).
manifest:
  type: btc_reward_definition
  id: "daily_gold"
  rewardId: "daily_gold"
  requiredInventorySlots: 0
  onClaimActions:
    - action: add_money
      amount: 100