EzEconomy

EzEconomy – Modern, fast, and flexible Vault economy provider for Minecraft servers. Supports YML, MySQL, SQLite, MongoDB, and custom storage. Multi-currency, async caching, and robust permissions for any server size.

Available in: English, Español, Nederlands, 中国人, Français

---

★ Key Features

EzEconomy is built for performance, flexibility, and ease of use. Highlights include:

• Vault API compatible: Works with any Vault-based plugin
• YML, MySQL, SQLite, MongoDB, or custom storage: Flexible, production-ready storage options
• Thread-safe: Robust error handling and concurrency
• Multi-currency support: Optional, per-player, fully configurable
• Async caching: Optimized for large servers
• Comprehensive commands: /balance, /eco, /baltop, /bank, /pay, /currency
• Granular permissions: Per-command and per-bank action

---

⚡ Commands

• /balance: View your balance
• /balance <player>: View another player's balance (ezeconomy.balance.others)
• /eco <give|take|set> <player> <amount>: Admin control (ezeconomy.eco)
• /baltop [amount]: Show top balances
• /bank <create|delete|balance|deposit|withdraw|addmember|removemember|info> ...: Bank management (ezeconomy.bank)
• /tax [reset]: View tax statistics or reset totals (admin only)
  • Shows total tax collected (transaction, interest, exchange)
  • Use /tax reset to clear all tax totals (requires permission)
• A transaction tax is deducted from deposits and withdrawals if enabled.
• Interest tax applies to bank interest payouts if enabled.
• /pay <player> <amount>: Pay another player (ezeconomy.pay)
  • A transaction tax is deducted from the sender if enabled.
• /currency [currency]: Set or view your preferred currency

---

🛡️ Permissions

• ezeconomy.balance.others: View other players' balances
• ezeconomy.eco: Use /eco admin command
• ezeconomy.pay: Use /pay command
• ezeconomy.currency: Use /currency command
• ezeconomy.tax.exempt: Exempt from all economy taxes (admin/trusted players)
• ezeconomy.tax.admin: Use /tax and /tax reset commands (view/reset tax totals)
• Bank Permissions:
  • ezeconomy.bank.create: Create a new bank
  • ezeconomy.bank.delete: Delete a bank
  • ezeconomy.bank.balance: View bank balance
  • ezeconomy.bank.deposit: Deposit to a bank
  • ezeconomy.bank.withdraw: Withdraw from a bank
  • ezeconomy.bank.addmember: Add a member to a bank
  • ezeconomy.bank.removemember: Remove a member from a bank
  • ezeconomy.bank.info: View bank info
  • ezeconomy.bank.admin: All bank admin actions

---

⚙️ Configuration Example

config.yml (Only global settings):

storage: yml
multi-currency:
  enabled: false
  default: "dollar"
  currencies:
    dollar:
      display: "Dollar"
      symbol: "$"
      decimals: 2
    euro:
      display: "Euro"
      symbol: "€"
      decimals: 2
  tax:
    transaction:
      enabled: true
      rate: 0.05 # 5% tax on /pay, bank deposit/withdraw
      exempt-permission: ezeconomy.tax.exempt
    interest:
      enabled: true
      rate: 0.10 # 10% tax on bank interest
    exchange:
      enabled: true
      rate: 0.02 # 2% tax on currency conversion
    gem:
      display: "Gem"
      symbol: "♦"
      decimals: 0
  conversion:
    dollar:
      euro: 0.95
      gem: 0.01
    euro:
      dollar: 1.05
      gem: 0.012
    gem:
      dollar: 100
      euro: 80

config-yml.yml (YML storage settings):

yml:
  file: balances.yml
  per-player-file-naming: uuid
  data-folder: data

config-mysql.yml (MySQL storage settings):

mysql:
  host: localhost
  port: 3306
  database: ezeconomy
  username: root
  password: password
  table: balances

config-sqlite.yml (SQLite storage settings):

sqlite:
  file: ezeconomy.db
  table: balances
  banksTable: banks

config-mongodb.yml (MongoDB storage settings):

mongodb:
  uri: mongodb://localhost:27017
  database: ezeconomy
  collection: balances
  banksCollection: banks

---

⬇️ Installation

1. Place EzEconomy.jar in your plugins folder
2. Configure config.yml and the appropriate config-*.yml file for your storage type
3. Restart your server

---

🔗 Integration

• EzEconomy automatically registers as a Vault provider
• No extra setup required for Vault-compatible plugins
• PlaceholderAPI support:
  • Use placeholders in chat, scoreboard, and other plugins:
    • %ezeconomy_balance% – Your balance
    • %ezeconomy_balance_<currency>% – Your balance in a specific currency (e.g., %ezeconomy_balance_euro%)
    • %ezeconomy_bank_<bank>% – Balance of a specific bank
    • %ezeconomy_top_1% – Top 1 player balance (replace 1 with rank)
    • %ezeconomy_currency% – Your preferred currency
  • Works with all PlaceholderAPI-compatible plugins

---

🛠️ Developer: Custom Storage Providers

EzEconomy supports custom storage backends (YML, MySQL, SQLite, MongoDB, or your own)! You can implement your own provider for any database or storage system.

How to add a custom provider:

1. Implement the StorageProvider interface in your plugin or module.
2. Register your provider before EzEconomy loads:

   EzEconomy.registerStorageProvider(new YourProvider(...));
   

3. Only one provider can be registered. If set, EzEconomy will use it instead of YML/MySQL.
4. See the JavaDoc in StorageProvider.java for required methods.

This allows you to use SQLite, MongoDB, Redis, or any other system for player balances and banks!

---

💸 Tax System

EzEconomy now supports a configurable tax system for server admins to control the flow of currency and add realism to your economy.

Configurable Taxes

• Transaction Tax: Deducts a percentage from player-to-player payments (e.g., /pay), bank deposits, and withdrawals.
• Interest Tax: Applies a tax to interest earned in banks.
• Currency Exchange Tax: Deducts a fee when converting between currencies.

Tax Settings Example

tax:
  transaction:
    enabled: true
    rate: 0.05 # 5% tax on /pay, bank deposit/withdraw
    exempt-permission: ezeconomy.tax.exempt
  interest:
    enabled: true
    rate: 0.10 # 10% tax on bank interest
  exchange:
    enabled: true
    rate: 0.02 # 2% tax on currency conversion

How Taxes Work

• Taxes are deducted from the sender for payments and deposits, and from the receiver for withdrawals and interest.
• Tax rates are configurable globally; future updates may allow per-currency or per-bank rates.
• Players or banks with the ezeconomy.tax.exempt permission are not taxed.

Admin Commands

• Admins can view total tax collected and adjust rates via config.
• Tax-exempt permissions can be granted to trusted players or groups.

Example Scenario

• Player A pays Player B $100 with a 5% transaction tax. Player B receives $95, and $5 is collected as tax.
• A bank deposit of $200 with a 5% tax results in $190 deposited, $10 taxed.
• Interest earned of $50 with a 10% tax results in $45 credited, $5 taxed.

---

❓ Support

• For help, join our community Discord

---

🔗 Related Plugins

• ⭐ EzAuction: Buy Orders, Advanced GUI, Show Shop Price
• ⚠️ EzShops: Dynamic Shops GUI, Player Shops, Sell Hand/Inv