Content generated with AI — it may contain mistakes.

ExyliaEconomy/Getting startedguideUpdated in v1.4.0

Your first currency

Check what a fresh server starts with, make /balance read the right currency, then create a currency of your own in the editor.

Page 3 of 253 min read

A fresh server already has two working currencies. This page checks them, then makes a third of your own, all inside /economyadmin with no file to edit.

Before you start#

You need ExyliaEconomy and ExyliaLib installed (see Installation) and exyliaeconomy.admin, which operators have. Vault is optional but makes other plugins see your money.

What a fresh server starts with#

The first start fills the database with these:

IdKindLookNotes
dollarsstoredDollar, $, 2 decimalsCommands /dollars and /dollar. Published to Vault
shardsstoredShard, ✦, 0 decimalsCommands /shards and /shard
netherite_ingotsitemNETHERITE_INGOTThe item in the player's inventory
vaultdisplay onlyDollar, $How the Vault economy is written
pointsdisplay onlyPointHow PlayerPoints is written

Stored currencies start at 0, with no ceiling, payments from 1, no tax and exchange off. 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, which ships as vault: whichever stored currency serves Vault. With Vault and no other economy that is dollars. See Choose what Vault sees and the shared economy page.

Without Vault, or with EssentialsX or CMI

Nothing of yours serves vault then. Set the default to one of your own currencies in plugins/ExyliaLib/economy.yml, then run /exylialib reload:

yaml
default-currency: dollars

Create a currency#

Open the editor

Run /economyadmin. The list shows every currency; Create currency starts a new one.

Name it

Type an id such as gems: lowercase letters and digits, up to 32. Leave out underscores if you want it in a placeholder. The id never changes later.

Pick the kind

Stored keeps a balance in the database, Item counts an exact item the player carries, Display only is how another plugin's currency looks.

Give it a look

In the currency's screen open Appearance (name, symbol, decimals, format). The preview shows 12345.67 written your way.

Set the rules

Open Rules for the starting balance, ceiling, permission and transfer tax. The switches turn payments, exchange, the leaderboard, the network and the command on or off.

Every change is saved at once and sent to the other servers on the same database. See Create a currency for every field.

Check that it works#

Give yourself some

/economyadmin give <you> 500 gems deposits 500 gems.

Read it

/gems shows your balance. /wallet opens every currency you may use; left-click one for its history, right-click for its leaderboard.

Pay somebody

/gems pay <player> 100 sends 100. Somebody offline hears about it when they next join.

Good first values#

  • Keep Decimals at 0 for a currency of whole things (gems, shards) and 2 for money.
  • Leave the transfer tax at 0 until players have used the currency for a while.
  • Turn Leaderboard on only for currencies you want ranked.
The wallet screen

The wallet, the leaderboard and the history are one native screen when PacketEvents is installed and the player uses Java 1.20.2 or newer. Otherwise the chest menus open instead. See ExyliaLib screens.

Something missing on this page? Tell us on Discord