Currencies

Configurable player currencies that power mastery, bounties, and the Token Shop

Overview

Currencies are configurable balances a player can earn and spend. The mod uses them to power mastery (mastery points, material currencies), bounties, and the Token Shop, but they are a general-purpose system; define your own and grant or charge them from rewards, quests, achievements, or commands.

Two flavors

Every currency is one of two kinds:

  • Counter-backed - a number stored on the player, with no inventory item. Set an iconItemId for the display icon and leave hytaleItemId unset. Mastery Points are counter-backed.
  • Item-backed - wraps a real Hytale item. Set hytaleItemId to the item id, and the balance is the count of that item the player holds. Life Essence is item-backed.
Counter-backed
{
  "nameKey": "currency.mastery_point.name",
  "iconItemId": "Ingredient_Crystal_Purple",
  "color": "#c08aff",
  "cap": 0,
  "showOnSidebar": true,
  "showOnMasteryPage": true
}
Item-backed
{
  "hytaleItemId": "Ingredient_Life_Essence",
  "color": "#a7e0a7",
  "cap": 0
}

nameKey is the localization key for a counter-backed currency's display name (convention currency.<id>.name). An item-backed currency needs no name key at all, it derives its name from the backing item's own native lang key. The deprecated raw displayName literal still parses as a fallback but should never be authored; it skips localization entirely.

A cap of 0 means uncapped. Currencies can optionally show on the sidebar and the mastery page.

The sidebar currency chips (or the Mastery page's currency header) showing live balances.
The sidebar currency chips (or the Mastery page's currency header) showing live balances.

Loss and decay

Two optional fields let a currency shrink over time instead of being permanent. Both are off (0) on every currency the mod and its packs ship, but a server owner can turn either on.

FieldTypeDefaultDescription
lossOnDeathPercentdouble [0,1]0Fraction of the balance lost on player death.
decayPerDayPercentdouble [0,1]0Fraction the balance decays per offline day, compounding.
visibilityobject (PrerequisiteGroup)none (always visible)A gate; the currency is hidden from the player entirely until met.
sources.xpConversionPercentdouble0Nested under a sources object. Passive XP-to-currency conversion rate.
* required

Earning & spending

  • Earn from command rewards at level milestones, from quest and achievement CURRENCY rewards, from an admin grant, or passively via sources.xpConversionPercent.
  • Spend on mastery nodes, on bounty rerolls, and at the Token Shop (including its XP Exchange).

Commands

CommandWhoDescription
/mmocurrency balance [--player=<name>] [--currency=<id>]PlayersShow your balances (or another player's, for admins).
/mmocurrency listPlayersList every defined currency.
/mmocurrency give --player=<name> --currency=<id> --amount=<n>AdminAdd to a balance.
/mmocurrency take --player=<name> --currency=<id> --amount=<n>AdminSubtract from a balance.
/mmocurrency set --player=<name> --currency=<id> --amount=<n>AdminSet a balance exactly.

Use the named-arg form (--player= --currency= --amount=). The legacy positional form (/mmocurrency give Steve mastery_point 1) is rejected by the live command. /currency is an alias for /mmocurrency.

For server owners & pack authors

Currencies are enabled in config and defined as content. Author your own (or retune the Mastery Pack's Mastery Points and Life Essence) through the pack system - see Currency content types for the full definition schema.