YLEconomy

# YLEconomy
## Overview

YLEconomy is a powerful Vault-compatible economy plugin for Minecraft servers that provides a complete 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.

## Key Features

- **Multi-currency System**: Support for multiple currencies with independent balances
- **Vault Integration**: Fully compatible with all Vault-dependent plugins
- **Intuitive UI**: Player-friendly commands and scoreboard display
- **Advanced Admin Tools**: Comprehensive economy management for server administrators
- **Extensive Customization**: Highly configurable to fit your server's needs
- **Multi-language Support**: Available in 7 languages (English, Polish, Turkish, German, French, Spanish, Russian)
- **Robust Data Storage**: Secure and reliable data storage with auto-save capabilities
- **Optimized Performance**: Lightweight with minimal server impact
- **Developer API**: Clean API for developers to extend functionality

## Getting Started

### Prerequisites

- Minecraft server running Paper/Spigot 1.19+
- Java 21 or higher
- [Vault]( https://www.spigotmc.org/resources/vault.34315/) plugin installed

## Usage

### Player Commands

| Command | Description | Permission |
|---------|-------------|------------|
| `/economy` or `/eco` | Shows main economy commands | - |
| `/eco balance` | View your current balance | yleconomy.balance |
| `/eco balance [player]` | View another player's balance | yleconomy.balance |
| `/eco pay <player> <amount>` | Send money to another player | yleconomy.pay |
| `/eco help` | Display help menu | - |

### 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 |

## Configuration

YLEconomy offers extensive configuration options through the `config.yml` file.

### Basic Configuration

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

# Currency Settings
currency:
name: Young Lion Minecoin
singular: YLM
plural: YLMs
starting-balance: 100.0
max-balance: -1 # -1 for unlimited

# Scoreboard Settings
scoreboard:
enabled: true
title: "§6YoungLion Economy"
format: "§eYLM: §9%balance%"
update-interval: 20 # ticks (20 ticks = 1 second)
```

## Languages

YLEconomy comes with built-in translations for:

- English (en)
- Polish (pl)
- Turkish (tr)
- German (de)
- French (fr)
- Spanish (es)
- Russian (ru)

You can easily change the language in the config.yml file:

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

## API

Developers can integrate with YLEconomy through our API. Below is a simple example:

```java
// Get the economy provider
YLEconomyProvider economy = YLEconomy.getInstance().getEconomy();

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

## Credits

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