btc_rewards_config
Global configuration for the rewards system (sounds, toasts, messages) — manifest entry.
Entry Information
| Property | Value |
|---|---|
| Entry ID | btc_rewards_config |
| Type | Manifest |
| Color | Orange |
| Icon | mdi:cog |
Fields
| Field | Type | Description |
|---|---|---|
toastsEnabled | Boolean | Enable toast notifications when claiming rewards |
claimSuccessToast | ToastConfig | Toast configuration for successful claim |
claimSuccessSound | Sound | Sound played on successful claim (configure in TypeWriter) |
claimErrorSound | Sound | Sound played when claim fails (inventory full) |
bulkClaimSound | Sound | Sound played when bulk claiming rewards |
inventoryFullMessage | String | Message when inventory is full (supports MiniMessage) |
claimSuccessMessage | String | Message when successfully claiming (supports MiniMessage) |
noRewardsMessage | String | Message when no rewards to claim (supports MiniMessage) |
bulkClaimSuccessMessage | String | Message when bulk claim is successful (supports MiniMessage) |
bulkClaimFailMessage | String | Message when bulk claim fails - no space (supports MiniMessage) |
Reward item lore
These drive the lore layout of every reward item (see btc_reward_definition). Leaving one empty hides the corresponding line.
| Field | Type | Description |
|---|---|---|
rewardLoreSeparator | String | Separator line between lore sections (supports MiniMessage) |
rewardLoreSourceLabel | String | Source line. {source} is replaced by the reward's source. Empty = hide |
rewardLoreRequirementLabel | String | Required free slots line. {slots} is replaced by the count. Empty = hide |
rewardLoreTip | String | Closing tip line (supports MiniMessage). Empty = hide |
Usage Example
- entry: btc_rewards_config
name: "Global configuration for the rewards system (sounds, toasts, messages)"
toastsEnabled: false
claimSuccessToast: ""
claimSuccessSound: ""
claimErrorSound: ""
bulkClaimSound: ""
inventoryFullMessage: ""
claimSuccessMessage: ""
noRewardsMessage: ""
bulkClaimSuccessMessage: ""
bulkClaimFailMessage: ""
rewardLoreSeparator: "<dark_gray><strikethrough> "
rewardLoreSourceLabel: "<gray>Source: <white>{source}"
rewardLoreRequirementLabel: "<gray>Free slots required: <white>{slots}"
rewardLoreTip: "<yellow>Click to claim!"