Economy

ExyliaLib talks to economies — Vault, PlayerPoints, anything a plugin registers — and keeps none of its own. The economy module is where the server's own currencies live: their balances, their history, their leaderboards, the currency handed to Vault, and every command a player types about money. Turning it off leaves the server with whatever other economy it runs.

Currencies

A currency is a row in sc_currencies, created and edited in game with /economyadmin. There is no currency file to edit.

There are three kinds:

Experience is a fourth source, switched on in the economy settings rather than created: xp_levels and xp_points become currency ids a shop can price in.

An item or experience currency only has a balance while the player is on this server. Paying an absent player queues the payment for the next server that holds them; taking from an absent player fails.

An item currency is the whole item — name, lore, model and enchantments — and only a stack exactly like it counts.

What a currency has

A currency behind a permission is left out of the wallet, the balance lines on shop screens, and command suggestions for anyone without it, and its commands refuse them.

What a fresh server starts with

The first time the tables are empty, the module imports modules/economy/currencies.yml and renames it currencies.yml.imported. A server without that file but with the one ExyliaLib kept before 1.159.0, plugins/ExyliaLib/currencies.yml, has that one copied over first, edits and all. A server with neither imports the defaults:

Both stored currencies start at 0, have no ceiling, allow transfers from 1 with no tax, and have exchange off. Experience points are a currency, experience levels are not, and the ledger is on.

After the import the file is never read again. If a currencies.yml is still there on a later start, the console says so and ignores it.

The default currency

A command that names no currency — /balance, /pay, /baltop — uses ExyliaLib's default, set as default-currency in plugins/ExyliaLib/economy.yml. It ships as vault: whatever Vault serves, which on a server with no other economy plugin is dollars through the bridge below.

The Vault bridge

One stored currency can be published as the server's Vault economy, so every plugin that only speaks Vault runs on it. Pick it with Vault economy on that currency's screen; choosing another replaces it, and deleting the published currency unpublishes it.

It is registered beneath any economy plugin the owner installed — EssentialsX, CMI — and serves only while none does. Vault on top in the economy settings registers it above them instead. The console says which of the two happened.

The bridge has no bank accounts: every bank call answers not implemented. A player named by text rather than by UUID is looked up among the players ExyliaLib has seen, and an unknown name is refused. Without Vault installed nothing is published and the console warns.

Balances, offline players and other servers

A player's stored balances are loaded when they join, and the server they are on is the only one that writes them. Every other server — or the same server, for somebody who is away — leaves the change in a queue and tells the network. The owner folds it in at once; otherwise it waits for their next join. A sweep every minute picks up anything a lost message missed.

The admin commands say "Queued … They are away; it lands when they are next seen" instead of showing a balance they do not hold.

A deposit that would pass the ceiling pays only up to it, and one at the ceiling already fails.

Currency edits made on one server are registered there at once and read by every other server on the network, which reinstalls the currency commands too.

The ledger

With the ledger on (the default), every operation on a stored currency writes a line to exylia_ledger: what moved, what the balance read after, the reason, who caused it and which server applied it — including changes that arrived from another server. Nothing prunes it.

Other plugins write their own reasons.

Player commands

Anything about another player — a balance, a wallet, a history — also needs exyliasurvivalcore.economy.others. Every one of these works on a player who is offline or on another server. Amounts are typed as 100, 2.5k or 1m.

A payment checks the currency's transfer switch and minimum, refuses paying yourself, takes the tax from the sender on top of the amount, then moves the amount. The receiver is told if they are online.

An exchange needs Exchange on the source currency and a rate from it to the target, which may be any currency that exists. The source is taken first; a failed deposit gives it back.

A command per currency

Every stored currency with Commands enabled and at least one command name gets its own command, installed the moment it is saved:

/shards                       your balance
/shards <player>              somebody else's (needs .others)
/shards pay <player> <amount>
/shards top [page]
/shards history [player]
/shards exchange <amount> <to>
/shards give|take|set <player> <amount>   administrators
/shards reset <player>                    administrators

It needs exyliasurvivalcore.economy. A name another plugin already holds still answers as /exyliasurvivalcore:<name>, and the console says so.

The screens

Three screens under modules/economy/menus/, written once and yours to edit:

The history and the board both go 90 deep. The board is read from the database at most once a minute, so the first look after a start can be empty until that read lands. Only stored currencies with the leaderboard on are ranked, and only they keep a history; any other currency opens an empty screen.

The actions behind them — survivalcore:economy_wallet [uuid], survivalcore:economy_history <currency> [uuid] and survivalcore:economy_top <currency> — can be bound to any menu.

/economyadmin

/economyadmin — /ecoadmin, /eadmin — needs exyliasurvivalcore.economy.admin.

import walks every player the server has ever seen and adds their balance in from to into. Run it once.

The old spellings — /eco give, /eco take, /eco set, /eco reset, /eco import — still work with the same permission, because reward and crate files on live servers are written with them.

The admin screens

Create asks for an id, then the kind, then — for an item currency — the item itself. The buttons a currency shows depend on its kind: a stored currency has rules and switches, an item currency its item, a display-only one only its look.

Delete asks first. A stored currency's balances stay in the database, unused until a currency with that id exists again.

Every change is written, registered on this server at once and announced to the others. These three files are regenerated from the plugin on every start, so edits to them do not survive.

The currency picker

menus/currency_select.yml is the one screen every flow uses to ask which currency: listing on the market, starting an auction, placing a buy order, and choosing the currency a shop product is priced in. Each currency shows its icon and what the player holds of it. A server with a single currency never sees it — the flow carries on with the only one there is.

%purpose% is the line the asking screen writes; each currency draws with %currency%, %currency_icon% and %currency_balance%. The file is written once and yours to edit.

The balance lines on the shop, market and auction screens follow the same rule: every currency the viewer may use, one per line.

Placeholders

The balances and the leaderboards are both this module's; the balances work for any currency, stored here or not.

Leaving the currency off reads the default currency. Left at vault, the leaderboard ranked is the stored currency published to Vault. The %exylialib_economy_…% forms no longer answer; see Placeholders.

Low-economy defaults

The shipped prices and payouts are scaled for a low economy, where a cheap block is worth one unit and nothing is priced in the thousands. A fresh install writes these; a server that already has the files keeps its own numbers.

The shop catalogue follows two rules that keep it from printing money: a product sells back for about a third of what it costs, and where one product crafts into another — logs into planks, wheat into hay — the output never sells for more than its inputs. Gear is sold but never bought back.

Boosters

A booster multiplies money or experience, for one player or for everybody, for a time.

Missions, kill rewards, farming and votes pay their money in the default currency, rounded down to its decimals. Money handed out by a command — eco give — is not boosted.

An experience booster applies to every experience gain the game reports, orbs included, whatever its source.

The source is free text: a booster given for a source that does not exist multiplies nothing.

Personal and global

A personal booster waits in /boosters until its owner starts it, so it can be given to somebody who is offline or on another server — which is what a web store needs. The player is told when one arrives.

A global booster is announced on every server when it starts and when it ends, to everyone who has booster announcements on in /settings. /boostersadmin clear ends every running global booster without announcing it.

The multiplier must be above 1 and at most 100. The duration is 30m, 2h, 1d; a bare number is seconds, and s and h work too. No source means *.

Stacking

Every running booster of a type that applies to a payout counts — the player's own and the global ones together.

settings:
  stacking: ADD
  max-multiplier: 5.0
  one-per-type: true
bossbar:
  config:
    text: "{highlight}⚡ {primary}&lBOOSTERS {letters_black}» {success}Money x%money% {letters_black}· {info}XP x%xp% {letters_black}» {letters}%left%"
    colour: PURPLE
    overlay: PROGRESS

Anything else reads as ADD. The result is never below x1, and never above max-multiplier; 0 removes the cap.

one-per-type stops a player starting a second personal booster of a type while one is running. Global boosters do not count against it.

The boss bar shows while any booster applies to the player, filling with the time left on the one that ends last. %money%, %xp%, %left% and %count% work in its text; an empty text hides it.

Commands, permissions and placeholders

/boosters lists the global boosters running, then the player's own — running first, then waiting. Its screen is modules/boosters/menus/boosters.yml.

Sell wands

The sell-wands module needs the shop: both of its features sell at shop prices, so the player's exyliasurvivalcore.shop.sell.<multiplier> bonus, shop-sell money boosters, product and category permissions, and the shop's sell limits all apply. See Shop.

The wand

A wand carries a multiplier and a number of uses on the item, and an id of its own so two wands never stack.

/sellwandadmin give <player> <multiplier> <uses>

/sellwanda for short, needing exyliasurvivalcore.sellwands.admin. The player must be online. The multiplier goes from 0.1 to 10; uses are -1 for unlimited or anything above 0.

Right-clicking a container with a wand in the main hand sells what the shop buys out of it, at the shop price times the wand's multiplier. Everything else, and the remainder of a unit, stays where it is. It needs exyliasurvivalcore.sellwands.use, and a click a protection plugin has already refused is left alone, so a wand never reaches into a chest its holder could not open.

A use is spent only when something sold; the last one breaks the wand.

Autosell

With exyliasurvivalcore.sellwands.autosell, what a player breaks is sold for them: blocks broken by hand, and both the block drops and the loot of mines. Only drops the shop buys are taken; everything else drops as usual.

Drops wait a few seconds and are sold together, at the plain shop price. Whatever the shop refuses by then — a sell limit reached — goes back to the player. Leaving the server sells what is waiting first. Every so often the player is told what it came to.

/autosell switches it, the same switch as in /settings. It is on by default for everyone holding the permission.

Configuration

modules/sell-wands/config.yml:

Both autosell timers are scheduled once, when the plugin starts: a change to them needs a restart.