Authoring Shops & Currencies

The Token Shop is the bounty-token sink: players spend currency at a storefront for XP, boosts, and conversions. Four raw-Payload asset types cooperate, all lowerCamelCase in the body, PascalCase envelope keys - see the Content Types & Merging casing rule.

content-packs/bounty-contracts-pack/Server/MMOSkillTree/
├── Shops/            # storefront groupings (ShopBoard) - referenced by an entry/pool's "shop" field
├── ShopPools/        # rotating offer pools (RotationSpec/SelectionSpec/PoolSlot/RerollCost)
├── ShopEntries/      # individual purchasable offers - the only type that requires a cost object
├── ShopTemplates/    # extends/params skeletons shared by ShopEntry AND ShopPool
└── Currencies/       # item-backed or counter-backed balances

Shop (storefront)

Folder Shops/*.json. Filename (lowercased) is the runtime shop id, referenced by an entry or pool's shop field. Parsed via TokenShopConfig.parseShopBoard.

{
  "Name": "XpExchange",
  "Payload": {
    "titleKey": "shop.xpexchange.title",
    "descriptionKey": "shop.xpexchange.desc",
    "icon": "Tool_Pickaxe_Crude",
    "order": 1,
    "enabled": true
  }
}

ShopPool

Folder ShopPools/*.json. Filename (lowercased) is the runtime pool id. Same rotating-pool shape as a Bounty Board's rotation schedule, plus a shop field to group the pool under a storefront.

rotation / selection / slots / rerollCost

This shape is shared with the Bounty Board rotation engine (rotation/) - the same fields work the same way for both offer pools and bounty pools.

ShopEntry

Folder ShopEntries/*.json. Filename does not drive the id - the runtime id is the inner Payload.id (falls back to the asset key, lowercased, if id is absent). Parsed via TokenShopConfig.parseEntry.

ShopTemplate

Folder ShopTemplates/*.json. One store serves both ShopEntry and ShopPool - a concrete entry or pool extends a template id from this shared registry. The only reserved keys the resolver strips are extends/params; everything else (including forEachSkill, read after template resolution) overlays through. Full DSL mechanics on Template Extension.

forEachSkill: true fans the resolved template out to one ShopEntry per active skill, substituting {{SKILL}} (skill id) and {{SKILL_NAME}} (display name) into every string value, never a key. That is why requireSelfLevel exists as a special scalar the fan-out converts into requirements.requiresSkills.<skill>=N in Java, instead of a templated map key. The id pattern (containing {{SKILL}}) is what the generated per-skill entries key off, so several tiers can fan out to distinct ids without colliding. An explicitly authored entry with the same generated id always wins over the fan-out.

{
  "Name": "Xp_Packet_Base",
  "Payload": {
    "forEachSkill": true,
    "category": "conversion", "shop": "xpexchange", "pool": "xpexchange",
    "groupKey": "{{SKILL}}", "displayName": "{{SKILL_NAME}} {{TIER_NAME}}",
    "cost": { "currencies": { "bounty_token": "{{TOKENS}}", "life_essence": "{{ESSENCE}}" } },
    "rewards": [ { "type": "XP", "skill": "{{SKILL}}", "amount": "{{XP}}" } ]
  }
}

{
  "Name": "XP_Packet_Greater",
  "Payload": {
    "extends": "xp_packet_base",
    "params": { "TIER_NAME": "Training", "TOKENS": "165", "ESSENCE": "65", "XP": "7500" },
    "id": "shop_xp_greater_{{SKILL}}", "tier": "greater", "order": 42,
    "requireSelfLevel": 30, "limitPerDay": 3
  }
}

Minimal ShopEntry example

{
  "Name": "Simple_Offer",
  "Payload": {
    "id": "shop_simple",
    "cost": { "currencies": { "bounty_token": 50 } },
    "rewards": [ { "type": "XP", "skill": "MINING", "amount": 500 } ]
  }
}

Exhaustive ShopEntry example

{
  "Name": "Boost_Mining",
  "Payload": {
    "id": "shop_boost_mining",
    "titleKey": "shop.boost_mining.title",
    "descriptionKey": "shop.boost_mining.desc",
    "cost": { "currencies": { "bounty_token": 150 } },
    "icon": "Tool_Pickaxe_Crude",
    "category": "boosts",
    "order": 20,
    "shop": "general",
    "limitPerDay": 3,
    "requirements": { "requiresSkills": { "MINING": 1 } },
    "rewards": [
      { "type": "BOOST_TOKEN", "skill": "MINING", "multiplier": 3.0, "durationMinutes": 20 }
    ]
  }
}

Currency authoring

Folder Currencies/*.json. Filename (lowercased) is the runtime currency id. Parsed via CurrencyConfig's override-merge logic, shared by both the pack and owner layers.

Minimal example (item-backed)

{ "Name": "Life_Essence", "Payload": { "hytaleItemId": "Ingredient_Life_Essence" } }

Exhaustive example (counter-backed)

{
  "Name": "Mastery_Point",
  "Payload": {
    "iconItemId": "Ingredient_Crystal_Purple",
    "color": "#c08aff",
    "cap": 0,
    "lossOnDeathPercent": 0,
    "decayPerDayPercent": 0,
    "showOnSidebar": true,
    "showOnMasteryPage": true,
    "sources": { "xpConversionPercent": 0 }
  }
}

The Token Shop is gated launch: a MMO_Token_Trader block, the mmo_token_shop_open interaction, and /mmoshopui open it in-game; /mmoshop is the admin command; /mmoshop validate runs the ShopValidator content audit. Shop and currency content ship in the standalone MMO Skill Bounty Pack; the engine, UI, and Java stay in the jar.