Content generated with AI — it may contain mistakes.

Reference

Placeholders

Every placeholder the plugin answers, in the PlaceholderAPI form and the short form Exylia files read, and what each returns.

Every placeholder below is written in full, and clicking one copies it.

How the name is written

The placeholders are registered through ExyliaLib as one group, economy. PlaceholderAPI reaches them by putting the plugin in front, so a scoreboard, a hologram or a tab plugin asks for:

%exyliaeconomy_economy_balance_dollars%

That is the form this page documents. Inside an Exylia plugin's own files — menus, messages, another Exylia plugin's scoreboard — the registered name also stands on its own, %economy_balance_dollars%.

No expansion needs downloading. Without PlaceholderAPI installed only the Exylia form works.

Coming from ExyliaSurvivalCore

%exyliasurvivalcore_economy_…% belonged to the old module and no longer answers. Replace exyliasurvivalcore_ with exyliaeconomy_; the rest of each name is the same.

The currency argument

Most placeholders end with a currency id. Leave it off for the default currency: %exyliaeconomy_economy_balance% is the viewer's balance in whatever /balance reads. vault works too, meaning the currency that serves Vault.

Ids with an underscore cannot be named

Arguments are split at underscores, and the plugin reads only the first piece as the currency. An id that contains one — netherite_ingots, xp_points, xp_levels, or any my_coins of your own — cannot be named in a placeholder: %exyliaeconomy_economy_balance_xp_points% asks for a currency called xp. Give a currency you want on a scoreboard an id without underscores, such as gems or xppoints.

Balances

PlaceholderReturns
%exyliaeconomy_economy_balance_<currency>%The viewer's balance, formatted: $1,250.00.
%exyliaeconomy_economy_compact_<currency>%The same, short, with the compact format: $1.2k.
%exyliaeconomy_economy_raw_<currency>%The number alone, at the currency's decimals: 1250.00.

These read memory: the balance of a player on this server, or the last one read for somebody else. They never ask the database on the thread that renders them.

The currency itself

PlaceholderReturns
%exyliaeconomy_economy_name_<currency>%The plural name: Dollars.
%exyliaeconomy_economy_name_singular_<currency>%One unit's name: Dollar.
%exyliaeconomy_economy_name_plural_<currency>%The plural name, as name.
%exyliaeconomy_economy_symbol_<currency>%The symbol: $, or nothing.

Leaderboards

Only stored currencies with Leaderboard on are ranked. The board is cached for a minute and holds the first 100 places; see Leaderboards.

PlaceholderReturns
%exyliaeconomy_economy_top_name_<position>_<currency>%Who is at that place, or —.
%exyliaeconomy_economy_top_amount_<position>_<currency>%What they hold, formatted; the formatted zero when the place is empty.
%exyliaeconomy_economy_rank_<currency>%The viewer's place, or — past the first 100 or when they are exempt.
%exyliaeconomy_economy_total_<currency>%Every balance added up, the money supply, formatted.

Written out, with a position and a currency in place:

%exyliaeconomy_economy_top_name_1_dollars%
%exyliaeconomy_economy_top_amount_1_dollars%
%exyliaeconomy_economy_top_name_3%
%exyliaeconomy_economy_rank_shards%

The third has no currency, so it is the default one. Until a board has been read once after a start, names answer —, amounts zero and the total zero, while the read is kicked off.

Formatting

The amounts are already written the way the currency writes them, so most lines need nothing else. The library's own suffixes still apply — a format after :, a fallback after | — and are described on the library's text page. Note that top_name and rank answer — rather than nothing, so a fallback never replaces them.

Inside the plugin's own screens

The menus under menus/user/ and menus/admin/ have values of their own, such as %currency_balance% or %top_player%. They are listed on Configuration.

Something missing on this page? Tell us on Discord