Azrova's Economy - This project is no longer managed by Azrova, you can fork but please make sure to give us credits!

A robust and feature-rich economy plugin for PaperMC/Bukkit servers, designed to provide essential economic functionalities with support for Vault and optional PlaceholderAPI integration.

---

Features

• Core Economy via Vault: Leverages Vault for broad compatibility with other economy-related plugins.
• Player Account Management: Complete user account creation, removal, and access control system.
• User Access Control: Administrators can remove users from the economy system, preventing access to all economy commands.
• Configurable Starting Balance: Set a starting amount for new players.
• Daily Rewards: Allow players to claim a configurable daily reward.
• Player-to-Player Payments: /pay command for transferring money.
• Banknotes: /withdraw command to create physical banknotes that can be redeemed.
• Balance Checking: /balance command for players to check their own or others' balances (permission-based).
• Richest Players List: /money top command to display the top N richest players.
• Organized Admin Commands: Separate command sets for balance management and user management.
• Comprehensive Help System: In-game help via /eco help [topic] for economy, admin, and user management commands.
• PlaceholderAPI Support (Optional): Display player balances via %azrovaseconomy_balance%.
• Configurable Currency Symbol: Customize the currency symbol (e.g., $, €, etc.) in config.yml.
• SQLite Data Storage: Player data is saved locally using SQLite, requiring no external database setup.

---

Dependencies

• Vault (Required): Azrova's Economy relies on Vault to provide the economy API. This plugin will not function without Vault installed.
• PlaceholderAPI (Optional): If you wish to use placeholders like %azrovaseconomy_balance% in other plugins (e.g., scoreboards, chat), PlaceholderAPI must be installed. The plugin will function normally without it, but placeholders will not be available.

---

Installation

1. Ensure your server is running PaperMC 1.21.x or a compatible version.
2. Install Vault if you haven't already. Download it from SpigotMC and place the JAR file in your server's plugins folder.
3. (Optional) Install PlaceholderAPI if you intend to use placeholders. Download it from SpigotMC and place the JAR file in your server's plugins folder.
4. Download the latest release of AzrovasEconomy.jar from the Releases Page.
5. Place the AzrovasEconomy.jar file into your server's plugins folder.
6. Restart or reload your server.

---

Configuration

The plugin will generate a config.yml file in its plugin folder (plugins/AzrovasEconomy/config.yml) upon first run. You can modify these settings:

starting-balance: 100.0
daily-reward-amount: 100.0
currency-symbol: "$"
daily-enabled: true

• starting-balance: The amount of money a player receives when they join the server for the first time and an account is created for them.
• daily-reward-amount: The amount of money a player receives when they use the /daily command.
• currency-symbol: The symbol used before amounts in messages (e.g., "$100.00").
• daily-enabled: Whether the daily reward system is enabled. Set to false to disable the /daily command entirely.

---

Commands & Permissions

Below is a list of commands and their associated permissions. Permissions set to true under default are enabled for all users by default. Permissions set to op are enabled for server operators by default.

Player Commands

Command	Description	Permission	Default
/pay [user] [amount]	Pay a user an amount of money.	azrova.economy.pay	true
/withdraw [amount]	Withdraw money as a physical banknote.	azrova.economy.withdraw	true
/balance or /bal	Shows your current balance.	azrova.economy.balance	true
/balance [user]	Shows another user's balance.	azrova.economy.balance.others	op
/money top	Shows the top richest players.	azrova.economy.money.top	true
/daily	Claim your daily reward.	azrova.economy.daily	true

Admin Commands

Help System

Command	Description	Permission	Default
/eco help	Shows available help topics.	azrova.admin	op
/eco help economy	Shows general economy commands help.	azrova.admin	op
/eco help admin	Shows admin balance commands help.	azrova.admin	op
/eco help user	Shows user management commands help.	azrova.admin	op

Balance Management (Legacy /eco commands)

Command	Description	Permission	Default
/eco set [user] [amount]	Set a user's balance.	azrova.admin.set	op
/eco remove [user] [amount]	Remove money from a user.	azrova.admin.remove	op
/eco delete [user]	Delete a user's economy account.	azrova.admin.delete	op

Balance Management (New /eco admin commands)

Command	Description	Permission	Default
/eco admin set [user] [amount]	Set a user's balance.	azrova.admin.set	op
/eco admin add [user] [amount]	Add money to a user's balance.	azrova.admin.add	op
/eco admin remove [user] [amount]	Remove money from a user.	azrova.admin.remove	op
/eco admin delete [user]	Delete a user's economy account.	azrova.admin.delete	op

User Management

Command	Description	Permission	Default
/eco user create [username]	Create an economy account for a user.	eco.admin.user.create	op
/eco user remove [username]	Remove a user's economy account.	eco.admin.user.remove	op

Base Admin Permission

Permission	Description	Default
azrova.admin	Base permission for all admin commands.	op

---

User Access Control

Azrova's Economy includes a comprehensive user access control system:

Account Management

• Account Creation: Administrators can create economy accounts for users with /eco user create [username]
• Account Removal: Administrators can remove users from the economy system with /eco user remove [username]
• Access Prevention: Removed users cannot use any economy commands until their account is recreated

Removed User Behavior

When a user's economy account is removed:

• All economy commands (/balance, /pay, /withdraw, /daily) will fail with a clear error message
• The user receives the message: "You do not have an economy account. Contact an administrator."
• No automatic account recreation occurs - accounts must be manually recreated by administrators
• Other players cannot pay money to removed users

Account Recreation

• Removed users can have their accounts recreated using /eco user create [username]
• New accounts start with the configured starting balance
• All economy functionality is restored upon account recreation

---

Help System

The plugin features a comprehensive in-game help system accessible through /eco help:

• /eco help - Shows all available help topics
• /eco help economy - Lists all player economy commands
• /eco help admin - Lists all admin balance management commands
• /eco help user - Lists all user management commands with usage notes

---

Placeholders (PlaceholderAPI)

If PlaceholderAPI is installed, the following placeholder is available:

• %azrovaseconomy_balance%: Displays the player's current balance, formatted with the configured currency symbol.
  • Example: You have: %azrovaseconomy_balance% might display as You have: $150.50
  • Returns $0.00 for users without economy accounts

---

Building from Source

If you wish to build the plugin from source:

1. Clone the repository: git clone https://github.com/Azrova/AzrovasEconomy.git
2. Navigate to the project directory: cd AzrovasEconomy
3. Ensure you have Java 21 (or the version specified in build.gradle.kts) installed and configured.
4. Run the Gradle build command:
   • On Windows: .\gradlew build
   • On Linux/macOS: ./gradlew build
5. The compiled JAR file will be located in build/libs/.

---

Authors & Support

• Authors: CNethuka, Sobble
• Support & Bug Reports: Please use the Issues Page on GitHub.
• Project Repository: https://github.com/Azrova/AzrovasEconomy

---

Made with ❤ by CNethuka and Sobble