RelishEconomy

---

🌟 Why Choose RelishEconomy?

RelishEconomy provides a solid economy foundation with multi-currency support, database flexibility, and seamless plugin integrations. Built for modern Minecraft servers with performance and reliability in mind.

✨ Key Highlights

🏦 Multi-Language - Support for multiple custom currencies 🚀 Multi-Language - Advanced caching with Caffeine for fast operations 🔧 Multi-Language - Vault and PlaceholderAPI support 🗄️ Multi-Language - SQLite and MySQL support 🌍 Multi-Language - Built-in English, Arabic, and Portuguese translations

---

📋 Requirements

| Component | Requirement | |-----------|-------------| | Soft Dependencies | 1.21+ | | Soft Dependencies | Paper, Purpur, or Paper-based forks | | Soft Dependencies | 21+ | | Soft Dependencies | Vault (recommended), PlaceholderAPI (optional) |

---

🚀 Features Overview

🆓 Free Version

- ✅ Basic economy commands (`/balance`, `/pay`, `/baltop`, `/eco`) - ✅ Currency exchange with custom properties - ✅ Per-currency formatting, permissions, and decimal control - ✅ Currency exchange with per-currency exchange rates - ✅ Command-based selling (`/sellhand`, `/sellhotbar`, `/sellall`) - ✅ Sold-item hover breakdowns for sell commands - ✅ Baltop leaderboard placeholders and balance placeholders - ✅ Data migration from other plugins - ✅ Player username storage alongside UUID balances - ✅ Towny and Vault economy compatibility - ✅ Vault and PlaceholderAPI support - ✅ SQLite and MySQL support - ✅ Config validation, backup, and auto-recovery for bundled files

⭐ Premium Version

- ⭐ Composter selling with category browsing - ⭐ Composter selling for item selling - ⭐ Composter selling for sell history navigation - ⭐ Composter selling (shop/sell blocks) - ⭐ Composter selling and interactions - ⭐ Composter selling - ⭐ Composter selling for physical currency deposit and withdraw - ⭐ Composter selling - ⭐ Composter selling support for physical currencies - ⭐ Composter selling for configured item sources - ⭐ Composter selling - throw items on composter to sell them

---

📦 Installation

1. Reload the plugin JAR file 2. Reload it in your server's `plugins` folder 3. Reload your server 4. Reload For premium features, buy a license key from Reload 5. Reload in `config.yml` 6. Reload the plugin

```bash

Quick setup commands

/re help # View all commands /re version # Check plugin status /re reload # Reload configuration ```

---

🎮 Commands & Usage

👤 Player Commands

| Command | Description | Example | |---------|-------------|---------| | `/balance [player] [currency]` | Check balance | `/bal coins` | | `/pay <player> <amount>` | Send money | `/pay Steve 100` | | `/baltop [currency] [page]` | View leaderboard | `/baltop dollars 2` | | `/currency <list|info>` | View currencies | `/currency list` | | `/exchange <from> <to> <amount>` | Convert currencies | `/exchange dollars coins 500` | | `/shop` ⭐ | Open shop GUI | `/shop` | | `/shop help` ⭐ | Show shop help | `/shop help` | | `/sell [subcommands]` ⭐ | Open sell GUI | `/sell price` | | `/re atm` ⭐ | Open ATM GUI | `/re atm` | | `/sellhand` | Sell item in hand | `/sellhand` | | `/sellhotbar` | Sell hotbar items | `/sellhotbar` | | `/sellall` | Sell all items | `/sellall confirm` | | `/withdraw <currency> <amount>` ⭐ | Get physical currency | `/withdraw coins 10` |

👑 Admin Commands

| Command | Description | Example | |---------|-------------|---------| | `/eco <give|take|set> <player> <amount>` | Manage balances | `/eco give Steve 1000` | | `/re reload` | Reload configuration | `/re reload` | | `/re migrate <plugin> <currency>` | Import from other plugins | `/re migrate essentials dollars` |

💡 Amount Shortcuts

- `k` = thousand (e.g., `5k` = 5,000) - `m` = million (e.g., `2m` = 2,000,000) - `b` = billion (e.g., `1b` = 1,000,000,000)

---

🔧 Configuration

Currency Setup

```yaml currencies: dollars: name: "dollars" symbol: "$" display-name: "Dollars" color: "<green>" default: true starting-balance: 100.0 payments-enabled: true permission: "" decimals-enabled: true exchange-rates: coins: 0.01 physical-item: material: PAPER deposit-enabled: true withdraw-enabled: true name: "<green><bold>Dollar Bill" lore: - "<gray>Value: {formatted_amount}" - "<gray>Owner: <white>{owner}" - "" - "<yellow>Shift + Right-Click to deposit" crafting: enabled: false value: 100.0 amount: 1

coins: name: "coins" symbol: "◎" display-name: "Coins" color: "<gold>" default: false starting-balance: 50.0 payments-enabled: true permission: "" decimals-enabled: false exchange-rates: dollars: 100.0 physical-item: material: GOLD_NUGGET deposit-enabled: true withdraw-enabled: true name: "<gold><bold>Gold Coin" lore: - "<gray>Value: {formatted_amount}" - "<gray>Owner: <white>{owner}" - "" - "<yellow>Shift + Right-Click to deposit" custom-model-data: 2001 natural-source: enabled: true value-per-item: 1.0 match-any-meta: false crafting: enabled: false value: 1.0 amount: 1 ```

🗄️ Database Options

```yaml database: type: sqlite # or mysql for networks

mysql: host: localhost port: 3306 database: relisheconomy username: root password: password ```

⭐ Physical currency notes and coins keep the owner name in their item metadata. `/withdraw` sets the owner to the player, crafted physical currency is rewritten to the crafting player, and custom model data can be applied per currency item.

⭐ Natural-source currency conversion can also turn configured gameplay item sources into the physical currency item itself. This is configured per currency.

⭐ ATM menu for physical currencies. Players can deposit supported currency items directly into the tray, switch between currencies, choose withdraw amounts, and confirm the action from a single GUI.

Shop-style layout - Shop-style layout - Queue supported physical currency items for deposit - Shop-style layout - Select currency, adjust amount, and withdraw as physical items - Shop-style layout - Open the ATM from a configured block interaction - Shop-style layout - Uses the same focused quantity workflow as the purchase GUI

ATM Config ```yaml atm: enabled: true block: material: LOOM require-sneak: true ```

🔄 Currency Exchange

```yaml exchange-fee-percentage: 2.5

currencies: dollars: exchange-rates: coins: 0.01 # 1 dollar = 0.01 coins coins: exchange-rates: dollars: 100.0 # 1 coin = 100 dollars ```

🔄 Data Migration

RelishEconomy can import data from other economy plugins:

GemsEconomy - GemsEconomy - Import from userdata files - GemsEconomy - Import from SQLite database - GemsEconomy - Import token balances - GemsEconomy - Import point balances - GemsEconomy - Import coin balances - GemsEconomy - Import gem balances

Async processing - ✅ Async processing of source plugin data - ✅ Async processing for modern Minecraft - ✅ Async processing - migrates all accounts - ✅ Async processing with detailed reports - ✅ Async processing - no server lag

---

⭐ Shop System

📦 Shop Features

RelishEconomy's premium shop system provides a comprehensive item marketplace with intuitive GUI interfaces and flexible configuration options.

Optional disabled display - Optional disabled display - Default layout follows the creative inventory tab order (operator utilities disabled by default) - Optional disabled display - Favorite items, browse a dedicated favorites view, and optionally render favorites with a glow highlight (`favorites.yml`) - Optional disabled display - Click an item to open a buy menu with quantity +/- controls, confirm/cancel, and back-to-category paging - Optional disabled display - Buy prices can be calculated from sell prices using a configurable multiplier - Optional disabled display - Enable/disable categories, set icons, and control slots with `page:slot` - Optional disabled display - Search across categories and navigate pages - Optional disabled display - Show items with no buy price as disabled instead of hiding them (`show-unpriced-items`)

Search functionality - Search functionality - Navigate creative-style category tabs - Search functionality - See item details and buy prices - Search functionality - Live balance display in the GUI - Search functionality - Audio feedback for purchases and navigation (configured in `gui.yml`) - Search functionality - Navigate through multiple pages of items - Search functionality - Find items across all categories

🏪 Shop Configuration

```yaml

shop.yml

shop: enabled: true buy-currency: "dollars" buy-multiplier: 2.0 items-per-page: 28 show-unpriced-items: false

categories: building_blocks: display-name: "Building Blocks" icon: STONE enabled: true slot: "1:0" items: - STONE - COBBLESTONE - BRICKS

... more items

```

Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities - Operator Utilities (disabled by default)

🎯 Shop Commands

```bash /shop # Open main shop interface /shop help # Show shop help ```

---

💰 Sell System

📤 Sell Features

The sell system provides multiple ways for players to convert their items into currency, from quick command-based selling to an interactive GUI interface.

Logs view - Logs view - Quick `/sellhand`, `/sellhotbar`, and `/sellall` commands (Free) - ⭐ Logs view - Drag-and-drop interface for selective selling - Logs view - Automatically collect sellable items from inventory - Logs view - Real-time value calculation with currency conversion - Logs view - Prevent accidental sales with confirmation prompts - ⭐ Logs view - Open sell history from the sell GUI

Sold-items hover summary - Sold-items hover summary - Receive payment in configured target currency - Sold-items hover summary - Sell entire stacks or inventory contents at once - Sold-items hover summary - Comprehensive item price database - ⭐ Sold-items hover summary - Throw items on composter for instant selling - Sold-items hover summary - Track all sell transactions for auditing - Sold-items hover summary - Hover chat output to view sold item breakdown

🎮 Sell Commands (Free)

```bash /sellhand # Sell the item in your hand /sellhotbar # Sell all sellable items in your hotbar /sellall # Sell all sellable items in inventory /sellall confirm # Confirm bulk selling with safety check ```

These commands work without a premium license. Only the sell GUI, composter selling, and sell block interactions are premium.

⭐ Sell GUI Interface

The premium Sell GUI provides an intuitive drag-and-drop interface for item selling:

Sound effects - Sound effects - Simply drag items to sell them - Sound effects - Auto-collect all sellable items from inventory - Sound effects - See total sale value update as you add items - Sound effects - View total sale value before confirming - Sound effects - Confirm sale with total summary - Sound effects - Audio feedback for all interactions

⚙️ Sell Configuration

```yaml

prices.yml

sell: enabled: true

target-currency: "dollars"

prices:

Basic format

STONE: 0.5 COBBLESTONE: 0.3 OAK_LOG: 1.5

Multi-currency format (if needed)

DIAMOND: { price: 100, currency: "gems" } EMERALD: { price: 150, currency: "tokens" } ```

Food items - Food items - Stone, cobblestone, bricks, deepslate - Food items - All logs, planks, stripped variants - Food items - Dirt, sand, gravel, clay - Food items - Diamonds, emeralds, gold, iron - Food items - Netherrack, soul sand, nether bricks - Food items - End stone, purpur blocks - Food items - Bones, string, gunpowder, leather - Food items - Wheat, carrots, potatoes, meat

⭐ Sell Block Interactions

Premium users can use physical blocks for convenient item selling:

Visual/audio feedback - Visual/audio feedback - Opens sell GUI interface - Visual/audio feedback - Throw items on composter to sell instantly - Visual/audio feedback - Prevents spam (500ms default) - Visual/audio feedback - Confirmation messages and sounds

```yaml

config.yml

composter-selling: enabled: true cooldown: 500

sell-gui-block: COMPOSTER shop-gui-block: EMERALD_BLOCK ```

⭐ Physical Currency

Players can withdraw supported currencies into physical items, trade them, then deposit them back with `Shift + Right-Click`.

Each currency can control this separately: - `currencies.<name>.physical-item.withdraw-enabled` - `currencies.<name>.physical-item.deposit-enabled` - `currencies.<name>.crafting.enabled` - `currencies.<name>.physical-item.custom-model-data` - `currencies.<name>.physical-item.natural-source.enabled`

Crafted physical currency also stores the crafting player as the owner, matching withdrawn notes and coins.

---

⭐ GUI Features

⭐ Shop Interface

The premium shop GUI provides an elegant and user-friendly shopping experience with full customization options.

Permission-based category access - Permission-based category access with configurable icons and colors - Permission-based category access with multiple quantity options (1, 32, 64) - Permission-based category access with live updates - Permission-based category access for all interactions - Permission-based category access and layout options - Permission-based category access

⭐ Sell Interface

The premium sell GUI offers an intuitive drag-and-drop experience for item selling.

Multi-currency - Multi-currency item selling with visual feedback - Multi-currency button to auto-collect sellable items - Multi-currency calculation and display - Multi-currency with total sale summary - Multi-currency and particle animations - Multi-currency payout options

⭐ GUI Customization

Premium users have full control over GUI appearance and behavior:

Layout templates - Layout templates - Choose from 9, 18, 27, 36, 45, or 54 slot layouts - Layout templates - Set personalized GUI titles with color codes - Layout templates - Use any material as category or button icons - Layout templates - Configure custom sounds for different actions - Layout templates - Pre-designed layouts or create your own ---

🔌 Integrations

🏛️ Vault API

Full economy provider implementation: - `getBalance()`, `depositPlayer()`, `withdrawPlayer()` - Compatible with any plugin using Vault - Multi-currency support through Vault - Towny bank deposits are supported (including `/t deposit <amount>` flow)

📊 PlaceholderAPI Integration

Balance Placeholders: ``` %relisheconomy_balance_[currency]% # Raw balance (e.g. 1000.50) %relisheconomy_balance_[currency][type][style]% # Formatting options (e.g. 1,250.00 via full_plain) %relisheconomy_formatted_[currency]% # Formatted balance (e.g. $1,000.50) ```

Leaderboard Placeholders: ``` %relisheconomy_baltop_[position]_[currency]_name% # Player name at position %relisheconomy_baltop_[position]_[currency]_balance% # Formatted balance at position %relisheconomy_baltop_[position]_[currency]_raw% # Raw balance at position %relisheconomy_rank_[currency]% # Player's rank ```

Currency Information: ``` %relisheconomy_currency_[currency]_symbol% # Currency symbol %relisheconomy_currency_[currency]_display% # Display name %relisheconomy_currency_[currency]_starting% # Starting balance %relisheconomy_currency_[currency]_default% # Is default currency ```

Utility Placeholders: ``` %relisheconomy_hasenough_[amount]_[currency]% # true/false if player has enough %relisheconomy_exchangerate_[from]_[to]% # Exchange rate between currencies ```

Server Statistics: ``` %relisheconomy_stats_currencies% # Number of currencies %relisheconomy_stats_accounts% # Number of cached accounts %relisheconomy_stats_dbtype% # Database type (sqlite/mysql) %relisheconomy_stats_dbhealthy% # Database health status ```

---

🌍 Multi-Language Support

🗣️ Built-in Languages

- 🇺🇸 Portuguese (en) - Complete - 🇸🇦 Portuguese (ar) - Complete - 🇵🇹 Portuguese (pt) - Complete

🌐 Custom Languages

Create `lang/[code].yml` files for any language: ```yaml

Example: lang/es.yml for Spanish

balance: current: "<green>Tu saldo: {balance}" other: "<green>Saldo de {player}: {balance}" ```

---

📈 Performance & Scalability

⚡ Optimization Features

- Auto-cleanup for instant data access - Auto-cleanup with HikariCP (MySQL) - Auto-cleanup for database queries - Auto-cleanup with configurable duration - Auto-cleanup of stale cache data

📊 Scalability Options

- Database health monitoring for small-medium servers (0-500 players) - Database health monitoring for large networks (500+ players) - Database health monitoring for external integrations - Database health monitoring

---

📄 License

RelishEconomy is proprietary software. All rights reserved.

License Types

🆓 Free Version

- Available without license key - Includes multi-currency, exchange, baltop, migration, and command-based selling - May be used on unlimited servers - NOT open source - modification and redistribution prohibited

⭐ Premium Version

- Requires valid license key from M5LB - Includes premium-only features such as Shop GUI, Sell GUI, ATM GUI, transaction logs GUI, physical currency, and premium block interactions - License key tied to purchaser and server count - NOT open source - modification and redistribution prohibited

For full license terms, see LICENSE file.

Obtain Premium License

To get a premium license key: - 🛒 Buy a key from M5LB Store

---