Documentation
ExyliaEconomy
As many currencies as you want, kept in the database and edited in game, one published to Vault, payments with taxes and confirmations, banknotes a copy cannot redeem twice, interest, leaderboards, a ledger with rollback, and balances shared across every server. Free and open source.
- Version
- v1.1.0
- Minecraft
- 1.21+
- Category
- Survival
- Pages
- 19
Getting started03
IntroductionWhat ExyliaEconomy is, what it solves, and how this documentation is organised.InstallationDownloading the plugin, how ExyliaLib installs itself, the database, the files the first start writes, and how updates arrive.First stepsWhat a fresh server starts with, which currency answers /balance, and a first currency of your own.
Configuring05
CurrenciesStored, item, experience and display-only currencies, every field a currency has, the economy settings, and the per-currency commands.PaymentsWhat /pay checks and in which order, the transfer tax, the confirmation above an amount, the one-second throttle, /paytoggle, offline notices, exchanges and giveall.Banknotes/withdraw and /deposit, which currencies print notes, what a note is, why a copied note pays once, and the guards that keep notes out of crafting and trading.InterestA percentage of a balance paid at every interval: the four settings, when a payout happens, who earns it, and why nobody is paid twice.Leaderboards/baltop and every currency's top, how the board is read and cached, the money supply, and leaving players off with exyliaeconomy.top.exempt.
Systems05
VaultPublishing one stored currency as the server's Vault economy, sitting beneath EssentialsX or CMI or on top of them, and how the bridge answers what Vault plugins ask.NetworkSharing balances across servers: who writes a balance, what happens to a change for a player somewhere else, shared and per-server currencies, server ids and Redis.Ledger and rollbackWhat the ledger writes and keeps, every reason it records, the history screen, /economyadmin log and export, and how a rollback reverts movements once.MigrationComing from the economy module of ExyliaSurvivalCore, the currencies.yml import of a first start, and moving balances in from Vault, EssentialsX, CMI or PlayerPoints.IntegrationsHow other Exylia plugins pay in these currencies, Vault plugins, PlaceholderAPI, ExyliaAnalytics, the plugins it loads before, and Folia.
Reference06
CommandsEvery player command, /economy, the per-currency commands and /economyadmin, with their aliases, permissions and what each optional argument defaults to.PermissionsEvery node the plugin declares, what each one gates, their defaults and children, the ExyliaSurvivalCore names that still work, and a currency's own permission.PlaceholdersEvery placeholder the plugin answers, in the PlaceholderAPI form and the short form Exylia files read, and what each returns.Configurationconfig.yml key by key, what messages.yml holds, the menu files and their values, and every database table the plugin keeps.APIPaying and charging these currencies through ExyliaLib, reacting to every balance change, and cancelling payments and exchanges with ExyliaEconomy's own events.FAQThe questions that come up: price, coming from ExyliaSurvivalCore, Vault plugins, balances that look wrong across servers, and where to get help.