# YLEconomy

YLEconomy is a powerful Vault-compatible economy plugin for Minecraft servers that provides a comprehensive financial system with multi-currency support, intuitive commands, and extensive customization options. Developed by YoungLion and designed to offer both performance and flexibility, it's suitable for servers of any size.


## Overview

YLEconomy provides a complete economic solution for your Minecraft server with advanced features including banking, jobs, transactions, and multi-currency support. The plugin is built with performance in mind while offering extensive customization options to fit your server's unique requirements.

## Key Features

* **Multi-currency System**: Support for multiple currencies with independent balances
* **Banking System**:
- Interest rates with configurable intervals
- Multiple account types with upgradable tiers
- Automatic interest payments
* **Jobs System**:
- Players can join multiple jobs
- Experience and leveling system
- Configurable rewards and cooldowns
- Progress tracking
* **Transaction Management**:
- Full transaction history
- In-game GUI for viewing transactions
- Secure player-to-player transfers
* **Vault Integration**: Fully compatible with all Vault-dependent plugins
* **Intuitive UI**:
- Player-friendly commands
- Scoreboard display
- Action bar balance display
* **Statistics Tracking**:
- Track player earnings and spending
- Economy leaderboards
* **Multi-language Support**:
- Available in 7 languages (English, Polish, Turkish, German, French, Spanish, Russian)
* **Advanced Admin Tools**: Comprehensive economy management for server administrators
* **Robust Data Storage**: Secure and reliable data storage with auto-save capabilities
* **Developer API**: Clean API for developers to extend functionality

## Installation

1. Download the YLEconomy.jar file from [Hangar]( https://hangar.papermc.io/YoungLion/YLEconomy)
2. Place it in your server's `plugins/` folder
3. Install [Vault]( https://www.spigotmc.org/resources/vault.34315/) as a dependency
4. Restart your server
5. Configure the plugin in the `plugins/YLEconomy/config.yml` file

## Commands

### Player Commands

| Command | Description | Permission |
| -------------------------- | ----------------------------- | ----------------- |
| `/economy` or `/eco` | Shows main economy commands | `yleconomy.use` |
| `/eco balance` | View your current balance | `yleconomy.use` |
| `/eco balance [player]` | View another player's balance | `yleconomy.use` |
| `/eco pay <player> <amount>` | Send money to another player | `yleconomy.use` |
| `/eco bank` | Access bank commands | `yleconomy.bank` |
| `/eco bank info` | Display bank account information | `yleconomy.bank` |
| `/eco bank deposit <amount>` | Deposit money to your bank account | `yleconomy.bank` |
| `/eco bank withdraw <amount>` | Withdraw money from your bank account | `yleconomy.bank` |
| `/eco bank upgrade` | Upgrade your bank account | `yleconomy.bank` |
| `/eco top [page]` | View economy leaderboard | `yleconomy.use` |
| `/eco help` | Display help menu | `yleconomy.use` |

### Jobs Commands

| Command | Description | Permission |
| ------------------------ | ---------------------------------- | ---------------- |
| `/jobs` or `/job` | Main jobs command | `yleconomy.jobs` |
| `/jobs list` | Show available jobs | `yleconomy.jobs` |
| `/jobs info <job_name>` | Display info about a job | `yleconomy.jobs` |
| `/jobs join <job_name>` | Join a job | `yleconomy.jobs` |
| `/jobs leave <job_name>` | Leave a job | `yleconomy.jobs` |
| `/jobs my` | View your current jobs and progress | `yleconomy.jobs` |

### Admin Commands

| Command | Description | Permission |
| ----------------------------- | -------------------------- | ----------------- |
| `/ecoadmin` or `/ecoa` | Shows admin command menu | `yleconomy.admin` |
| `/ecoa set <player> <amount>` | Set a player's balance | `yleconomy.admin` |
| `/ecoa give <player> <amount>`| Give money to a player | `yleconomy.admin` |
| `/ecoa take <player> <amount>`| Take money from a player | `yleconomy.admin` |
| `/ecoa reset <player>` | Reset a player's balance | `yleconomy.admin` |
| `/ecoa help` | Show admin help | `yleconomy.admin` |

### Other Commands

| Command | Description | Permission |
| ------------------------ | -------------------------- | ------------------------ |
| `/transactions [player]` | View transaction history | `yleconomy.transactions` |
| `/stats` or `/ecostats` | View economic statistics | `yleconomy.statistics` |
| `/ecodebug` | Debug commands for admins | `yleconomy.debug` |

## Permissions

- `yleconomy.use` - Access to basic economy commands (default: true)
- `yleconomy.admin` - Access to admin commands (default: op)
- `yleconomy.debug` - Access to debug commands (default: op)
- `yleconomy.statistics` - Access to statistics (default: true)
- `yleconomy.scoreboard` - Permission to see economy scoreboard (default: true)
- `yleconomy.scoreboard.bank` - Permission to see bank info on scoreboard (default: true)
- `yleconomy.scoreboard.transactions` - Permission to see transactions on scoreboard (default: true)
- `yleconomy.bank` - Access to banking system (default: true)
- `yleconomy.jobs` - Access to jobs system (default: true)
- `yleconomy.cheque` - Access to cheque system (default: true)
- `yleconomy.bulkpay` - Access to bulk payment system (default: true)
- `yleconomy.exchange` - Access to currency exchange (default: true)
- `yleconomy.transactions` - View transaction history (default: true)

## Configuration

YLEconomy offers extensive configuration options through several YAML files:

### config.yml

```yaml
# Language Settings (Available: en, pl, tr, de, fr, es, ru, az, it, vi, ar)
language: en

# Currency Settings
currency:
name: "Young Lion Minecoin"
starting-balance: 100.0
# Enable multiple currencies
multi-currency: false
# If multi-currency is enabled, list them here
currencies:
USD:
name: "US Dollar"
rate: 1.0
symbol: "$"
EUR:
name: "Euro"
rate: 0.85
symbol: "€"
GBP:
name: "British Pound"
rate: 0.73
symbol: "£"

# Bank System
bank:
enabled: true
interest:
enabled: true
rate: 0.5 # 0.5% interest rate
interval: 1440 # In minutes (1440 = 24 hours)

# Jobs System
jobs:
enabled: true
cooldown: 60 # Base cooldown in seconds

# Scoreboard Settings
scoreboard:
enabled: true
title: "&6YoungLion Economy"
format: "&eYLM: &9%balance%"
bank-format: "&eBanka: &9%balance% &7(%account_type%)"
job-format: "&eİş: &9%job_name% &7(Seviye %job_level%)"
group-format: "&eGrup: &9%group%"
show-all-currencies: false
update-interval: 20 # ticks
```

### jobs.yml

Configure available jobs, rewards, and requirements:

```yaml
settings:
enabled: true
cooldown: 60 # in seconds
max-jobs: 3 # Maximum number of jobs a player can join
disable-in-creative: true
debug-mode: false
transaction-logging: true

jobs:
miner:
name: "Miner"
description: "Break blocks to earn money"
rewards:
minecraft:diamond_ore:
amount: 5.0
currency: default
quantity: 1
message: "&aYou earned %amount% %currency% for mining diamond ore!"
farmer:
name: "Farmer"
description: "Grow and harvest crops to earn money"
rewards:
minecraft:wheat:
amount: 0.5
currency: default
quantity: 1
message: "&aYou earned %amount% %currency% for harvesting wheat!"
```

### Languages

YLEconomy comes with built-in translations for multiple languages. You can easily change the language in the config.yml file:

```yaml
language: en # Change to your preferred language code
```

Available languages:
- English (en)
- Polish (pl)
- Turkish (tr)
- German (de)
- French (fr)
- Spanish (es)
- Russian (ru)
- Azerbaijani (az)
- Italian (it)
- Arabic (ar)

## Developer API

YLEconomy provides a comprehensive API for developers who want to integrate with the economy system:

```java
// Get the plugin instance
YLEconomy economy = YLEconomy.getInstance();

// Access the economy provider
YLEconomyProvider provider = economy.getEconomy();

// Basic operations
double balance = provider.getBalance(player);
provider.depositPlayerSimple(player, amount);
provider.withdrawPlayerSimple(player, amount);

// Work with the bank system
Bank bank = Bank.getInstance();
BankAccount account = bank.getAccount(player.getUniqueId());
bank.deposit(player, "default", amount);

// Access the jobs system
JobManager jobManager = economy.getJobManager();
jobManager.joinJob(player, jobId);

// Work with transactions
TransactionManager transactionManager = economy.getTransactionManager();
transactionManager.createTransaction(player, amount, "default", Transaction.TransactionType.DEPOSIT, "Deposit");
```

## Server Integration

YLEconomy is proudly used on the [YoungLion Minecraft Server]( https://minecraft.younglionofficial.com/), where it powers the entire economic system. Connect to `playmc.younglionofficial.com` to see the plugin in action!

## Support

For issues, feature requests, or questions:
- Check out our [Hangar page]( https://hangar.papermc.io/YoungLion/YLEconomy)
- Visit our [website]( https://minecraft.younglionofficial.com/plugins/YLEconomy)
- Join our server at `playmc.younglionofficial.com`

## Credits

- **Creator & Lead Developer**: cavanshirpro
- **Organization**: YoungLion

## License

YLEconomy is distributed under the License included with the plugin.

---

This plugin is not affiliated with Mojang Studios or Microsoft. Minecraft is a trademark of Mojang Studios.