Content generated with AI — it may contain mistakes.

Getting startedguide

First steps

What a fresh server starts with, which currency answers /balance, and a first currency of your own.

What a fresh server starts with

The first start imports a set of currencies into the database. Without a currencies.yml of your own or one left by ExyliaSurvivalCore, these are the ones:

IdKindLookNotes
dollarsstoredDollar, $, 2 decimals, %symbol%%amount%Commands /dollars and /dollar. Published to Vault
shardsstoredShard, ✦, 0 decimals, %amount% %symbol%Commands /shards and /shard
netherite_ingotsitemNETHERITE_INGOT, %amount% %name%The item in the player's inventory
vaultdisplay onlyDollar, $, 2 decimalsHow the Vault economy is written
pointsdisplay onlyPoint, 0 decimalsHow PlayerPoints is written

Both stored currencies start at 0, have no ceiling, allow payments from 1 with no tax, and have exchange off. Experience points are a currency (xp_points); experience levels are not. The ledger is on and keeps 90 days.

Which currency /balance reads

Every command that names no currency — /balance, /pay, /baltop, /withdraw — uses ExyliaLib's default currency, set as default-currency in plugins/ExyliaLib/economy.yml. It ships as vault.

vault is a second name for the stored currency that serves Vault. On a server with Vault and no other economy plugin, that is dollars, so the defaults work as they are: /balance reads dollars, /baltop ranks dollars, /pay follows the rules of dollars.

Without Vault, or with another economy plugin

When Vault is not installed, nothing serves vault, and a command that names no currency has no stored currency behind it. The same happens when EssentialsX or CMI keeps serving Vault: vault is then their money, not one of yours. In both cases set the default to one of your own currencies:

plugins/ExyliaLib/economy.yml
default-currency: dollars

then run /exylialib reload.

A first look

Check a balance

/balance shows yours in the default currency. /wallet opens a screen with every currency you may use; left-click one for its history, right-click for its leaderboard.

Give yourself some

/economyadmin give <you> 500 deposits 500 in the default currency. /economyadmin give <you> 20 shards names another one.

Pay somebody

/pay <player> 100 sends 100 dollars. The receiver is told if they are on this server; a player who was offline hears about it when they next join.

A currency of your own

Everything happens in /economyadmin. The only thing typed is the id.

Create it

/economyadmin → Create currency. Type an id such as gems: lowercase letters, digits and underscores, up to 32. The id is the key balances are stored under, so it never changes.

Pick the kind

Stored for a balance kept in the database, Item for an exact item the player carries, Display only for how another plugin's currency looks. An item currency then asks for the item.

Give it a look

On the currency's screen, Appearance asks for the name, plural, symbol, decimals, format and compact format. The preview lines show 12345.67 written the new way.

Set the rules

Rules sets the starting balance, ceiling, permission, least amount a player may send and the transfer tax. The switches below turn payments, exchange, the leaderboard, the network and the command on or off.

Use it

The command names default to the id: /gems shows the balance, /gems pay <player> <amount> pays in gems, /gems top opens its leaderboard. Commands renames them.

Every change is written at once, registered on this server, and announced to the others on the same database. See Currencies for every field.

Where to go next

  • Payments — confirmations, taxes, /paytoggle and offline notices.
  • Vault — choosing which currency the other plugins see.
  • Network — several servers on one set of balances.

Something missing on this page? Tell us on Discord