Skip to main content

Rewards

Rewards are granted when players claim tier rewards or purchase shop items. The Season Pass supports multiple reward types that integrate with the Core mod's RewardGrantHelper.

Reward Types

TypeDescription
itemGrant an inventory item
commandExecute a server command
lootbagGrant a lootbag (random items from Core's lootbag system)
tokensGrant Season Tokens
titleGrant a title via command integration
boosterGrant a personal XP booster
noneEmpty reward (placeholder)

Common Fields

Every reward has these fields:

FieldTypeRequiredDescription
typestringYesReward type (item, command, lootbag, tokens, title, booster, none)
descriptionstringNoDisplay text in the UI
iconItemstringNoItem ID for the reward icon

Item Rewards

Grant specific items to the player's inventory.

FieldTypeDefaultDescription
itemIdstringItem ID to grant
amountint1Number of items
{
"type": "item",
"itemId": "Ingredient_Bar_Gold",
"amount": 100,
"description": "100 Gold Bars",
"iconItem": "Ingredient_Bar_Gold"
}

Command Rewards

Execute server commands on reward claim. Commands run as console with full permissions.

FieldTypeDescription
commandstringCommand to execute (without leading /)

Placeholder

PlaceholderReplaced With
{player}The claiming player's username

Examples

{
"type": "command",
"command": "emote_grant {player} dance_victory",
"description": "Emote: Victory Dance",
"iconItem": "Deco_FlowerBouquet"
}
{
"type": "command",
"command": "kstitles give {player} bronze_explorer",
"description": "Title: Bronze Explorer",
"iconItem": "Deco_Medal_Bronze"
}
{
"type": "command",
"command": "effect_give {player} glow 3600",
"description": "1h Glow Effect",
"iconItem": "Deco_Candle"
}
Command Rewards for Integration

Command rewards enable integration with any plugin that has commands. Grant titles, emotes, effects, currency, permissions, or anything else that can be triggered by a command. The commands are placeholders — adapt them to match the actual commands available on your server.

Lootbag Rewards

Grant a lootbag from the Lootbag System. Players receive random items from the configured lootbag pool.

FieldTypeDescription
lootbagIdstringLootbag ID from Core's lootbag config
{
"type": "lootbag",
"lootbagId": "explorer_premium",
"description": "Premium Explorer Lootbag",
"iconItem": "Deco_Scroll"
}

Token Rewards

Grant additional Season Tokens.

FieldTypeDescription
tokensintNumber of tokens to grant
{
"type": "tokens",
"tokens": 25,
"description": "25 Season Tokens"
}

Title Rewards

Grant a title to the player via the Titles system.

FieldTypeDescription
titleIdstringTitle ID to grant
{
"type": "title",
"titleId": "bronze_explorer",
"description": "Title: Bronze Explorer",
"iconItem": "Deco_Medal_Bronze"
}

Booster Rewards

Grant the player a personal XP booster for a limited duration.

FieldTypeDefaultDescription
boosterMultiplierdouble1.5XP multiplier during boost
boosterDurationMinutesint30Boost duration in minutes
{
"type": "booster",
"boosterMultiplier": 2.0,
"boosterDurationMinutes": 60,
"description": "2x XP Booster (1h)",
"iconItem": "Deco_Candle"
}
Booster Stacking

Boosters stack multiplicatively with the premium XP boost and prestige XP boost. A 2x booster + 1.5x premium + 5% prestige results in 2.0 * 1.5 * 1.05 = 3.15x total XP multiplier.

Empty Rewards

Use none for tiers that shouldn't have a reward on one track (e.g., no free reward on a premium-only tier).

{
"type": "none"
}

Tier Reward Example

A complete tier definition with both free and premium rewards:

{
"tier": 5,
"iconItem": "Weapon_Longsword_Iron",
"freeRewards": [
{
"type": "lootbag",
"lootbagId": "explorer_basic",
"description": "Explorer Lootbag",
"iconItem": "Deco_Scroll"
}
],
"premiumRewards": [
{
"type": "command",
"command": "emote_grant {player} dance_victory",
"description": "Emote: Victory Dance",
"iconItem": "Deco_FlowerBouquet"
}
]
}

Shop Item Reward Example

Shop items can contain multiple rewards per purchase:

{
"id": "shop_starter_bundle",
"name": "Starter Bundle",
"description": "A bundle of useful items",
"iconItem": "Deco_Chest",
"cost": 50,
"weight": 10,
"rewards": [
{ "type": "item", "itemId": "Food_Bread", "amount": 20, "description": "20x Bread" },
{ "type": "item", "itemId": "Tool_Pickaxe_Iron", "amount": 1, "description": "Iron Pickaxe" }
]
}