Currency File

On this page, you will find the format of a currency file, for editing it by hand.

Everything on this page can be set from the in-game editor. The files are only worth opening for a bulk change, or to copy currencies between servers. Run /pcur reload after saving them.

#Where the Files Are

Each currency is one file in the currencies folder, named after its id. A new file dropped in the folder is a new currency after a reload. Balances are not in these files, they are in the database.

#Example

display-name: '&bGems'
symbol: Gems
format:
  pattern: '%amount% %symbol%'
  decimals: 0
  grouping: true
  compact-in-messages: false
starting-balance: 0.0
max-balance: -1.0
pay:
  enabled: true
  minimum: 1.0
  tax:
    percent: 5.0
    flat: 0.0
    paid-by: sender
    account: server
  limits:
    daily-send: -1.0
    daily-receive: -1.0
  cooldown-seconds: 0
permission-required: false
leaderboard: true
commands:
  label: gems
  aliases: []
  pay-aliases: []
  top-aliases: []
exchange-rates:
  money: 100.0

#Keys

Key	Description
display-name, symbol, format	How the currency is named and written. `decimals` goes from 0 to 4. See Edit Currency.
starting-balance, max-balance	-1 for no maximum.
pay	Whether players can pay, the minimum, the fee (`paid-by` is `sender` or `receiver`, `account` is a bank id or empty), the daily limits and the cooldown. See Payments.
permission-required, leaderboard	See Edit Currency.
commands	The command, its aliases and the pay and top shortcuts, without slashes.
icon	The item shown in menus.
exchange-rates	One rate per currency id it can be exchanged into. See Exchange.
banknotes	See Banknotes.
interest, rewards	See Interest and Rewards.
restrictions	The `worlds` and `servers` lists. See Worlds and Servers.
discord	The `threshold` of the Discord webhook.

Anything left out of the file takes its default, and the plugin writes every key back the next time the currency is saved.

Last updated about 2 hours ago