NexoriaEconomy

NexoriaEconomy Documentation

NexoriaEconomy is a high-throughput, multi-currency economy engine with native Vault provider support for Paper and Folia servers.

---

1. Requirements & Installation

• Dependencies: Requires NexoriaCore to be installed on the server.
• Compatibility: Paper, Purpur, Folia (Java 25+).

Installation Steps

1. Install NexoriaCore.jar in your server's plugins/ directory.
2. Download and place NexoriaEconomy.jar into the plugins/ directory.
3. If using external plugins that require Vault economy hook, ensure Vault.jar is also present.
4. Restart the server.

---

2. Configuration (config.yml)

The configuration file is generated at plugins/NexoriaEconomy/config.yml:

general:
  enabled: true
  debug-mode: false
  prefix: "<gradient:#10B981:#059669>[NexoriaEconomy]</gradient> "

storage:
  cache-timeout-seconds: 300
  async-batch-size: 64

messages:
  no-permission: "<red>You lack the required permissions to run this command.</red>"
  reloaded: "<green>Configuration and data modules have been reloaded.</green>"

---

3. Commands & Permissions

Command	Description	Permission	Default
/balance	Displays the player's current account balance	nexoria.economy.use	Everyone
/pay <player> <amount>	Transfers funds securely to another player	nexoria.economy.use	Everyone
/balance status	Shows system status and active transaction handlers	nexoria.economy.admin	OP
/balance reload	Reloads configuration files and caches	nexoria.economy.admin	OP

---

4. Vault Provider Integration

NexoriaEconomy automatically registers itself as the active net.milkbowl.vault.economy.Economy service provider on server startup. Any plugin supporting Vault will interface with NexoriaEconomy without additional setup.

---

5. Developer API Usage

import dev.nexoria.economy.NexoriaEconomyPlugin;
import dev.nexoria.economy.EconomyAPI;

public class EconomyHook {

    public void checkStatus() {
        EconomyAPI api = NexoriaEconomyPlugin.getInstance().getApi();
        
        if (api.isActive()) {
            var status = api.getStatus();
            System.out.println("NexoriaEconomy active sessions: " + status.activeSessions());
        }
    }
}