Market Square: Currencies, Wallets and Shops Kit
- ..
- .metadata246 B
- README.md1.1 KB
- schema.yaml619 B
README.md
currency (economyKit contract)
One currency a game's players can hold: gold, gems, a premium token, anything. Add a .data asset bound to economyKit.currency anywhere in a world and economyKit finds it by itself; no code changes.
| Field | Meaning |
|---|---|
id | The name code uses ("coins"). Letters, digits, _ and -. |
nameKey | Translation key for the name players read (economy.currency_coins, or one in the game's own locales/<lang>/<ns>.json). |
name | Fallback name when no nameKey is given or the key has no translation. |
icon | One of the twelve icon styles: coins, gems, tokens, scrap, souls, energy, tickets, banknotes, stars, wood, stone, food. |
color | Accent colour for counters and popups. |
start | What a new player's wallet starts with. |
max | The most one wallet can hold; anything above is refused. |
persist | Kept between sessions (true) or reset each session (false, e.g. per-match cash). |
order | Sort order in wallet displays (lower first). |