Getting Started

This guide walks you through installing and configuring EzEconomy for the first time.

Prerequisites

Before installing, make sure you have:

  • Java 8 or higher — required by your server jar.
  • Paper or Spigot 1.7.10 – 1.21.1 — EzEconomy supports the full version range.
  • Vault — required. EzEconomy registers itself as the Vault economy provider so that shop, job, and reward plugins work automatically.
  • (Optional) PlaceholderAPI — needed for balance placeholders in chat, scoreboards, and other plugins.

Installation

  1. Download EzEconomy.jar from the releases page.
  2. Place EzEconomy.jar (and Vault.jar if not already present) in your server’s plugins/ folder.
  3. Start the server once to generate the default configuration files.
  4. Stop the server and edit plugins/EzEconomy/config.yml to choose your storage backend and any optional features.
  5. Start the server again — EzEconomy will connect to the configured backend and register with Vault.

Choosing a Storage Backend

Pick the backend that fits your server’s scale and infrastructure:

Backend Best For Requirements
YML (default) Small servers, testing None — data is written to flat files
SQLite Single server, larger player counts None — embedded database, no server needed
MySQL Networks, high traffic, shared hosting Requires a MySQL or MariaDB server
MongoDB Existing MongoDB infrastructure Requires a MongoDB server

Set the storage key in config.yml, then fill in the matching storage config file (e.g., config-mysql.yml):

storage: yml   # options: yml, sqlite, mysql, mongodb

See Storage Backends for full setup instructions and schema details.

First-Start Checklist

After the first successful start, verify the following:

  1. The server console shows [EzEconomy] Economy service registered with Vault.
  2. The folder plugins/EzEconomy/ contains config.yml and the matching storage config file.
  3. Other Vault-dependent plugins (shops, jobs, rewards) recognise EzEconomy as the active economy.

Quick Verification

Run these commands in-game as a server operator:

/balance              # Shows your balance (default: 0)
/eco give <you> 100   # Credit yourself 100
/balance              # Should now show 100

If /balance returns an error, check that Vault is installed and that the console shows the registration message above.

Next Steps

I want to… Go here
Configure storage, currencies, banking, and caching Configuration
See all player and admin commands Commands
Set up permissions for staff and players Permissions
Monitor and adjust player economies Moderation Guide
Show balances in chat or scoreboards Placeholders
Enable multi-currency or the bank system Features