Getting started

Introduction

What ExyliaEconomy is, what it solves, and how this documentation is organised.

ExyliaEconomy is the economy of an Exylia server: currencies the server keeps itself, in its own database, edited in game and shared across every server that points at the same database. It is free and open source, published under the GNU General Public License v3.0 on GitHub.

A server can run as many currencies as it wants — dollars, shards, gems — each with its own name, symbol, decimals, format, starting balance, ceiling and rules. One of them can be published as the server's Vault economy, so every shop, jobs or auction plugin that only speaks Vault runs on it without EssentialsX or CMI underneath. Every Exylia plugin reaches the same currencies through ExyliaLib, by id.

It used to be the economy module of ExyliaSurvivalCore. It is its own plugin now, and a server that ran the module keeps its balances, its currencies and its permissions on the first start — see Migration.

What is included

Currencies

Stored balances, item currencies and experience, created and edited from /economyadmin. No currency file to maintain.

Payments

/pay with a minimum, a tax, a confirmation above an amount, a per-player toggle and a notice for whoever was paid while away.

Banknotes

/withdraw prints money as paper. Each note is a row in the database, so a copied note pays once.

Interest

A percentage of a balance paid at every interval, once per player across the network.

Network

One balance across every server, or one per server. Only the server a player is on writes it.

Ledger and rollback

Every movement written down with its reason, exported to CSV, and reverted line by line.

Requirements

Requirement	Detail
Server	Paper 1.21 or newer. Folia supported.
Java	21
Required dependency	`ExyliaLib` 1.236.0 or newer — installed automatically when missing
Optional dependencies	`Vault`, `PlaceholderAPI`, `ExyliaAnalytics`

About ExyliaLib

Typed configuration, the YAML menus, the database and Redis, placeholders, the in-game editors and the economy facade every Exylia plugin pays through all come from ExyliaLib. ExyliaEconomy is one of the economies that facade serves: its currencies register there, and any plugin that asks ExyliaLib for money by id reaches them.

How to read this documentation

Getting started

Installation, what the first start creates, and a first currency of your own.

Configuring

Currencies, payments, banknotes, interest and leaderboards: what a player sees.

Systems

Vault, the network, the ledger, imports from other economies and how the rest of the ecosystem reads the money.

Reference

Commands, permissions, placeholders, every configuration key and message, and the developer API.

Conventions

Values marked as default are what the plugin writes the first time it starts. If the file already exists, your value is kept.
Identifiers between < and > are variables. /pay <player> <amount> means /pay Steve 100.
Amounts are typed the way players type them everywhere: 100, 2.5k, 1m, 3b. Commas are ignored, exponents are refused.
A currency is named by its id, the lowercase key it was created with: dollars, shards.
Colours use ExyliaLib palette tokens ({primary}, {success}, {highlight}); MiniMessage tags such as <click> and <hover> work too, as the confirmation buttons show.

Something missing on this page? Tell us on Discord