LuxEconomy

A simple, elegant economy plugin for Paper servers with MySQL support and Vault integration.

---

Overview

LuxEconomy provides a lightweight economy system for your server with beautiful formatted messages, complete customization, and seamless Vault integration. Players can check balances, send money to each other, and admins can manage the economy with powerful tools.

---

✨ Features

Player Economy

• Check your balance with /bal
• Send money to other players with /pay
• Beautiful formatted balance display
• Automatic starting balance for new players

Admin Management

• Set money for individual players
• Give/remove money from players
• Reset or set everyone's balance at once
• Complete economy control

Integration & Customization

• Full Vault economy support (works with other plugins)
• MySQL database for persistent storage
• Fully customizable messages using MiniMessage format
• Tab completion for all commands
• Configurable starting balance for new players

---

🚀 Installation

Requirements

• Paper 1.21+
• MySQL Server
• Vault plugin (optional, but recommended)

Setup Steps

1. Download & Place

   • Download LuxEconomy.jar
   • Place it in your plugins/ folder
   • Start your server (it will create default config files)

2. Configure Database

   • Open plugins/LuxEconomy/config.yml
   • Set your MySQL credentials:

   database:
     host: "localhost"
     port: 3306
     name: "luxeconomy"
     username: "root"
     password: ""
   

   • Save and restart the server

3. Done!

   • Plugin loads and creates tables automatically
   • Players get starting balance on first join

---

📋 Commands

Player Commands

Check Balance

/bal [player]

View your balance or another player's balance.

Send Money

/pay <player> <amount>

Send money to another player. Check balance first to ensure you have enough.

---

Admin Commands

Manage Player Balance

/eco give <player|self> <amount>

Give money to a player. Use self to give to yourself.

/eco set <player|self> <amount>

Set a player's balance to an exact amount.

/eco remove <player|self> <amount>

Remove money from a player's balance.

Bulk Operations

/econadmin setall <amount>

Set every player's balance to the same amount. Useful for economy resets.

/econadmin reset

Reset everyone's balance to $0.00. Use with caution.

---

🔐 Permissions

Grant these to players using your permission plugin (LuckPerms, etc):

luxeconomy.admin          # Access to /eco and /econadmin commands

By default, only OPs have access to admin commands.

---

⚙️ Configuration

config.yml - Database & Economy Settings

database:
  host: "localhost"
  port: 3306
  name: "luxeconomy"
  username: "root"
  password: ""

economy:
  starting-balance: 100.0  # Amount new players receive

messages.yml - Customize All Messages

All messages use MiniMessage format for colors and styling.

Color Codes:

• <#7FFF00> - Lime green (success)
• <#cc444c> - Dark red (errors)
• <#aaccee> - Light blue (amounts)
• <gray> - Gray text
• <white> - White text
• <bold> - Bold text

Example Custom Message:

pay:
  success_sender: "<#7FFF00><bold>Sent <reset><#aaccee>$%amount% <gray>to %player%"

Available Placeholders:

• %amount% - Money amount
• %player% - Player name
• %count% - Number of players

---

💾 Database

LuxEconomy automatically creates and manages the MySQL database.

Table: player_balance

• uuid - Player's unique identifier
• username - Player's name
• balance - Current money amount

No manual database setup required.

---

🔗 Vault Integration

LuxEconomy registers automatically with Vault. Other plugins like jobs, shops, and minions can use your economy system.

For Plugin Developers:

RoyalEconomy economy = (RoyalEconomy) Bukkit.getServer()
    .getServicesManager()
    .getRegistration(net.milkbowl.vault.economy.Economy.class)
    .getProvider();

economy.getBalance(player);
economy.withdrawPlayer(player, 100);
economy.depositPlayer(player, 50);

---

🎨 Customization Examples

Change Starting Balance

Edit config.yml:

economy:
  starting-balance: 500.0

Change Success Color

Edit messages.yml:

pay:
  success_sender: "<#FF6B00><bold>Sent <reset><white>$%amount% to %player%"

Add Currency Symbol

Edit messages.yml:

balance:
  self: "<gray>💰 Balance: <white>%amount%"

---

📊 Usage Tips

Check Before Sending Always check your balance before using /pay:

/bal          # Check your balance
/pay User 50  # Send them $50

Bulk Reset Economy Reset everyone's balance (careful!):

/econadmin reset

Set Everyone to Same Amount Give everyone $1000:

/econadmin setall 1000

Give New Players Money Change starting balance in config.yml:

starting-balance: 250.0  # New players get $250

---

❓ FAQ

Q: Can I use this with other economy plugins? A: No, only one economy provider can be active. Choose one economy plugin.

Q: How do I backup player data? A: Backup your MySQL database. Contact your host for backup procedures.

Q: Can players see other players' balances? A: Yes, with /bal <player>. You can remove this by editing permissions.

Q: Does this work on older Paper versions? A: Requires Paper 1.21+. Update your server for compatibility.

Q: How do I migrate from another economy plugin? A: Set starting balance, then use /econadmin setall to distribute money equally to everyone.

---

🐛 Troubleshooting

Plugin won't start

• Check MySQL connection in config.yml
• Verify MySQL server is running
• Check firewall/port access

"No registered Vault provider" error

• Vault plugin must be installed
• LuxEconomy must load after Vault
• Restart server completely

Players don't receive starting balance

• Check economy.starting-balance in config.yml
• Starting balance only applies to new players
• Use /econadmin setall for existing players

Database connection refused

• Verify MySQL credentials are correct
• Ensure MySQL server is accessible
• Check host/port settings

---

📝 License

LuxEconomy is provided as-is for your server.

---

Support

Issues with the plugin? Check the following:

1. Configuration - Verify config.yml and messages.yml
2. Database - Test MySQL connection
3. Permissions - Check permission node assignments
4. Updates - Ensure you're running the latest version

---

Simple. Clean. Reliable.