EssentialsPay

# EssentialsPay

EssentialsPay is a modern, lightweight, and feature-rich payment add-on designed to enhance the economy system on your Minecraft server! Built with **MiniMessage** support, it allows you to bring beautiful hex gradients, custom sound effects, and advanced payment controls to your players.

> ⚠️ **REQUIREMENT / DEPENDENCY**
> This plugin is an **add-on** for EssentialsX. You **MUST** have **[EssentialsX]( https://essentialsx.net/)** and a compatible Economy Provider (like **Vault**) installed on your server for this plugin to work.

---

## ✨ Features

* **Modern MiniMessage Formatting:** Full support for Hex Colors, Gradients, and Bold formatting across all messages and actionbars.
* **Advanced Pay Controls:**
* `/paytoggle`, `/payon`, `/payoff` — Players can toggle whether they want to receive payments from others.
* `/payconfirm` — Players can enable a confirmation check before sending transactions to prevent accidental payments.
* **Broadcast Payments:**
* Send payments to individual players.
* Send payments to all online players using `/pay * <amount>`.
* Send payments to all registered server players using `/pay ** <amount>`.
* **Interactive Notifications:** Custom sound effects and Actionbar / Hotbar alerts for sent and received payments.
* ⚙️ **Fully Configurable (`config.yml`):**
* Set minimum payment limits (e.g., `$10,000`).
* Block self-payments (`allow-self-pay: false`).
* Customize every single message, prefix, sound, and actionbar text.
* ⚡ **High Performance:** Uses Spigot's `PersistentDataContainer` (PDC) for lightweight and fast player data storage without bloat.

---

## Commands & Permissions

| Command | Permission | Description |
| :--- | :--- | :--- |
| `/pay <player> <amount>` | `essentialspay.pay` | Pay money to a specific player. |
| `/pay * <amount>` | `essentialspay.pay.all` | Pay money to all online players. |
| `/pay ** <amount>` | `essentialspay.pay.allserver` | Pay money to all registered players on the server. |
| `/paytoggle [on\|off]` | `essentialspay.paytoggle` | Toggle receiving payments on or off. |
| `/payconfirm [on\|off]` | `essentialspay.payconfirm` | Toggle payment confirmation mode. |
| `/balance [player]` | `essentialspay.balance` | Check your balance or another player's balance. |
| `/eco <give\|take\|set> ...` | `essentialspay.admin` | Admin economy management commands. |
| `/pay reload` | `essentialspay.admin` | Reload the plugin configuration. |

---

## ⚙️ Installation

1. Download and install **EssentialsX** and **Vault** on your server.
2. Download `EssentialsPay.jar` and place it into your server's `/plugins/` directory.
3. Start or restart your server to generate the default `config.yml`.
4. Customize messages and settings in `config.yml`, then run `/pay reload` to apply changes!

---

## Default Configuration (`config.yml`)

```yaml
min-pay-amount: 10000.0
allow-self-pay: false

messages:
reload-success: "<gradient:#55FF55:#00AA00><bold>EssentialsPay configuration reloaded successfully.</bold></gradient>"
no-permission: "<gradient:#FF5555:#AA0000>I'm sorry, but you do not have permission to perform this command.</gradient>"
self-pay-disabled: "<gradient:#FF5555:#AA0000>You cannot pay money to yourself!</gradient>"
min-pay-limit: "<#FF5555>The minimum payment amount is <#FFD700>$<min_amount></#FFD700>!</#FF5555>"
pay-toggle-off: "<#FF5555>Payment reception has been <bold>DISABLED</bold>.</#FF5555>"
pay-toggle-on: "<#55FF55>Payment reception has been <bold>ENABLED</bold>.</#55FF55>"

hotbar:
enabled: true
pay-sent: "<actionbar><#AAAAAA>Sent <#FFD700>$<amount></#FFD700> to <#FFA500><target></#FFA500></#AAAAAA></actionbar>"
pay-received: "<actionbar><#AAAAAA>Received <#FFD700>$<amount></#FFD700> from <#FFA500><sender></#FFA500></#AAAAAA></actionbar>"