Content generated with AI — it may contain mistakes.

ExyliaEconomy/GuidesUpdated in v1.4.0

Choose what Vault sees

Publish one stored currency as the server's Vault economy so shop, jobs and auction plugins run on it, with or without EssentialsX or CMI.

Page 9 of 254 min read

Most shop, jobs, auction and rank plugins only speak Vault. After this page one of your currencies is the server's Vault economy, so all of them run on it with no EssentialsX or CMI underneath.

Before you start#

Vault must be installed. Without it nothing is published and the console says so. You need a stored currency, see Create a currency. If EssentialsX or CMI is installed, read "Beneath or on top" below first.

Steps#

Open the currency

Run /economyadmin, left-click the stored currency, then click Integrations.

Publish it

Click Vault economy. Choosing another currency replaces it; clicking the published one again unpublishes it, and deleting it does too.

See which one is published

Go back to the currency list and open Economy settings: Vault economy shows the published currency.

A fresh server publishes dollars. Should the chosen currency no longer exist while Vault is installed and no other economy plugin is, the first stored currency serves instead, with a console warning; a server whose default currency is vault would otherwise have no money at all. Unpublished on purpose, it stays unpublished.

Check that it works#

Read the log

With Debug on in Economy settings, the console says "Economy: 'dollars' is the server's Vault economy." (or, with another economy plugin on top, "Economy: EssentialsX provides the Vault economy; 'dollars' is registered beneath it"). Debug is off by default and prints nothing otherwise.

Use it from another plugin

Buy something in a shop plugin, or check a balance with a plugin that reads Vault. /balance in game shows the same number.

Going further#

Beneath or on top#

Vault on topAnother economy plugin installedWho serves Vault
on (default)eitherYour currency.
offnoYour currency.
offEssentialsX, CMI...The other plugin. Your currency is registered beneath it and serves only without it.

Vault on top is in Economy settings and is on until an admin turns it off. When an economy plugin is installed or removed while the server runs, who serves is worked out again.

Two economies, two sets of balances

Running EssentialsX's economy and this plugin side by side means two places where money lives. Pick one for Vault and import the other, see Migration.

Plugins that load first#

Vault is published while the plugin enables, before its currencies are even read, so a plugin that looks for an economy in its own enable finds one. Until the currencies arrive a moment later, the bridge answers an empty balance and refuses payments with "The economy is still loading.", and every plugin that kept the bridge keeps working through every reload after that.

To be sure ExyliaEconomy enables first, plugin.yml lists these under loadbefore: ExyliaSurvivalCore, ExyliaMines, ShopGUIPlus, EconomyShopGUI, ChestShop, QuickShop, Jobs, zAuctionHouseV3 and AuctionHouse.

The vault currency id#

ExyliaLib knows the Vault economy as the currency id vault, and its default currency ships as vault. While one of your currencies serves Vault, vault is a second name for it everywhere: a price in vault, a leaderboard of vault and the history of vault all mean that currency. While another plugin serves Vault, vault is that plugin's money. See Your first currency and the shared economy page.

What Vault plugins get
Vault callWhat the bridge does
NameExyliaEconomy:<currency>.
Balance, hasMemory for a player on this server. For anybody else the row is read from the database, waiting up to two seconds off the main thread; on the main thread it never waits and answers the last balance read, or zero for somebody never read, fetching the row for the next call.
DepositAny player: on this server at once, queued for anybody elsewhere. Refused whole at the ceiling.
WithdrawOnly from a player on this server. Charging somebody offline or elsewhere is refused: "Only the balance of a player on this server can be charged."
AmountsVault's double, rounded half up to the currency's decimals, so 2.3 x 3 is 6.90, never 6.89.
Players by nameLooked up among the names ExyliaLib knows. An unknown name is refused.
BanksNot supported. Every bank call answers not implemented.
Format, names, decimalsThe currency's own.

Every Vault movement is a ledger line with the reason vault:<plugin>, naming the plugin that called Vault (vault:jobs, vault:chestshop), or plain vault when no plugin can be found.

Something missing on this page? Tell us on Discord