
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.
25 pages, read in order
- Version
- v1.4.0
- Minecraft
- 1.21.4+
- Category
- Survival
Start in three steps
From the jar to the first match, in this order.
- 1IntroductionWhat ExyliaEconomy is, what it solves, and how this documentation is organised.
- 2InstallationDownloading the plugin, the ExyliaLib it needs, the database, the files the first start writes, and how updates arrive.
- 3Your first currencyCheck what a fresh server starts with, make /balance read the right currency, then create a currency of your own in the editor.
New in v1.4.0
- IntroductionWhat ExyliaEconomy is, what it solves, and how this documentation is organised.
- InstallationDownloading the plugin, the ExyliaLib it needs, the database, the files the first start writes, and how updates arrive.
- Your first currencyCheck what a fresh server starts with, make /balance read the right currency, then create a currency of your own in the editor.
- Create a currencyCreate stored, item, experience and display-only currencies in game, set their rules, tax and exchange rates, and give each its own command.
- Set up paymentsLet players pay each other with /pay, add a transfer tax, ask for confirmation on big amounts, and let players turn payments off.
- Print banknotesLet players turn money into a paper item with /withdraw and cash it back with right-click or /deposit, safe against copies.
- Pay interestPay players a percentage of their balance every hour, day or any interval you choose, with a cap, and decide whether offline players earn it too.
- Show a leaderboardLet players see the richest of each currency with /baltop, the money in circulation, and keep staff off the board.
- Choose what Vault seesPublish one stored currency as the server's Vault economy so shop, jobs and auction plugins run on it, with or without EssentialsX or CMI.
- Move from another economyBring balances into ExyliaEconomy from Vault, EssentialsX, CMI or PlayerPoints, or move over from the ExyliaSurvivalCore economy module and an old config.yml.
- NetworkSharing balances across servers: who writes a balance, what happens to a change for a player somewhere else, global, group 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.
- IntegrationsHow other Exylia plugins pay in these currencies, Vault plugins, PlaceholderAPI, ExyliaAnalytics, the plugins it loads before, and Folia.
- CommandsEvery ExyliaEconomy command: the player shortcuts, /economy, the per-currency commands and /economyadmin, with the permission each one needs.
- PermissionsEvery ExyliaEconomy permission, how to cut a transfer tax per rank, and how to lock a currency behind a rank.
- PlaceholdersEvery ExyliaEconomy placeholder for balances, currency names and leaderboards, to use in scoreboards, tab lists and holograms.
- ConfigurationWhere each setting lives, what messages.yml holds, the menu and screen 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.
- Common problemsFixes for the problems server owners hit with ExyliaEconomy: the wrong default currency, a balance that is still loading, balances that differ between servers and menus that reset.
- FAQQuestions people ask: price, coming from ExyliaSurvivalCore, Vault plugins, rollbacks and where to get help.
Straight to the reference
Chapter 01
Getting started
- 1IntroductionWhat ExyliaEconomy is, what it solves, and how this documentation is organised.
- 2InstallationDownloading the plugin, the ExyliaLib it needs, the database, the files the first start writes, and how updates arrive.
- 3Your first currencyguideCheck what a fresh server starts with, make /balance read the right currency, then create a currency of your own in the editor.
Chapter 02
Guides
- 4Create a currencyCreate stored, item, experience and display-only currencies in game, set their rules, tax and exchange rates, and give each its own command.
- 5Set up paymentsLet players pay each other with /pay, add a transfer tax, ask for confirmation on big amounts, and let players turn payments off.
- 6Print banknotesLet players turn money into a paper item with /withdraw and cash it back with right-click or /deposit, safe against copies.
- 7Pay interestPay players a percentage of their balance every hour, day or any interval you choose, with a cap, and decide whether offline players earn it too.
- 8Show a leaderboardLet players see the richest of each currency with /baltop, the money in circulation, and keep staff off the board.
- 9Choose what Vault seesPublish one stored currency as the server's Vault economy so shop, jobs and auction plugins run on it, with or without EssentialsX or CMI.
- 10Move from another economyBring balances into ExyliaEconomy from Vault, EssentialsX, CMI or PlayerPoints, or move over from the ExyliaSurvivalCore economy module and an old config.yml.
Chapter 03
How it works
- 11NetworkSharing balances across servers: who writes a balance, what happens to a change for a player somewhere else, global, group and per-server currencies, server ids and Redis.
- 12Ledger 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.
- 13IntegrationsHow other Exylia plugins pay in these currencies, Vault plugins, PlaceholderAPI, ExyliaAnalytics, the plugins it loads before, and Folia.
Chapter 04
Reference
- 14CommandsreferenceEvery ExyliaEconomy command: the player shortcuts, /economy, the per-currency commands and /economyadmin, with the permission each one needs.
- 15PermissionsreferenceEvery ExyliaEconomy permission, how to cut a transfer tax per rank, and how to lock a currency behind a rank.
- 16PlaceholdersreferenceEvery ExyliaEconomy placeholder for balances, currency names and leaderboards, to use in scoreboards, tab lists and holograms.
- 17ConfigurationWhere each setting lives, what messages.yml holds, the menu and screen files and their values, and every database table the plugin keeps.
- 18APIdevPaying and charging these currencies through ExyliaLib, reacting to every balance change, and cancelling payments and exchanges with ExyliaEconomy's own events.
Chapter 05
Help
- 19Common problemsreferenceFixes for the problems server owners hit with ExyliaEconomy: the wrong default currency, a balance that is still loading, balances that differ between servers and menus that reset.
- 20FAQQuestions people ask: price, coming from ExyliaSurvivalCore, Vault plugins, rollbacks and where to get help.
Chapter 06
Customise (all Exylia plugins)
- 21Change the colours of your Exylia pluginsRecolour every Exylia plugin at once from one file, colors.yml: the palette, the theme colour, hex values, gradients and how to use the colours in your own messages.
- 22Change messages and the languagePick the language of your Exylia plugins, find and edit any message, use colours, hex, gradients and click-able text, change the prefix and reload.
- 23Edit the menus of your Exylia pluginsMenus are plain files: change a title, an item name, an icon, a slot or a sound, hide a button, and reload.
- 24Set up the economy for your Exylia pluginsChoose which money your Exylia plugins charge and pay in: Vault, PlayerPoints or an ExyliaEconomy currency, with one file, economy.yml.
- 25Set up the database of your Exylia pluginsWhere Exylia plugins keep their data by default, how to move to MySQL, MariaDB or PostgreSQL step by step, and how to share data between servers.