TheEconomy

✅ EconomySystem — Hytale Economy Plugin

EconomySystem is a complete economy plugin for Hytale servers, featuring persistent player balances, money commands, admin tools, reward systems, a full Shop GUI, player-to-player shops, Secondary currency named Cash, multi-language support, MySQL database support, and a public API for easy integration with other mods.

✅ Compatibility tested with: LuckPerms, MyPermissions, and PermissionsPlus.
✅ Compatible with: VaultUnlocked and Cassaforte

---

⚠️ Warning — Custom HUD

This plugin includes a Custom HUD. Hytale currently allows only one custom HUD at a time. If you already use another plugin that enhances the screen (such as EyeSpy or any other HUD plugin), you must either:

• Disable EconomySystem HUD in mods/Economy_Economy/SystemEconomySystem.json by setting "EnableHud" to false
• Or install MultipleHUD to support more than one Custom HUD

---

✅ Main Features

• Persistent Balances (JSON / MySQL) saved automatically every 30 seconds
• MySQL Support: Full MySQL integration for scalable server deployments
• Starter Money: New players receive a configurable starting balance
• Safe & Stable: Thread-safe balance handling with secure saving
• Shop System: Server shop with GUI, buy/sell support, and dynamic item loading
• Player Shop System: Player-to-player shops with GUI, tabs, stock management, and persistence
• Rewards System: Earn money from breaking blocks (ores/wood) and killing monsters
• Advanced Currency Formatting: custom symbol, locale formatting, and short values (1k, 1kk, 1kkk)
• Plugin Scoreboard
• Minecraft-like Color Codes for messages, GUI, and HUD
• Multi-language Support: EN / PT / ES / RU / PL / DE / HU / FR
• Console Support: Admin commands work from the server console
• Plugin's own scoreboard
• The plugin has now been adapted to a color-coding system for messages similar to that of Minecraft.
• Custom Hud (Lines and position)
• Secondary currency named Cash
• Addition of NPCs with individual shops for each NPC.
• Ability to sell multiples commands on the console.
  • Example of a console command: money give {playername} {quantity}
  • Example of a multiple console commands: money give {playername} {quantity},kick {playername},kick {playername}

---

💰 Player Commands

• /money → Shows your balance in a stylish on-screen title.
  Aliases: /eco /balance /bal
  Permission: theeconomy.player.money
• /cash → Shows your balance of cash in a stylish on-screen title.
  Aliases: /cashbalance /cb
  Permission: theeconomy.player.cash
• /hud <on/off> → Activate / deactivate your HUD
  Aliases: /ehud /economyhud
  Permission: theeconomy.player.hud
• /money <player> → View another player’s balance
  Permission: theeconomy.player.money
• /money pay <player> <amount> → Send money to another player
  Permission: theeconomy.player.money.pay
• /money top → Displays the Top 10 richest players (special colors for Top 3)
  Aliases: /money ranking /money leaderboard
  Permission: theeconomy.player.money.top
• /iteminfo → Shows information about the item in hand
  Aliases: /ii /item
  Permission: theeconomy.player.iteminfo

---

🛠 Admin Commands

• /money set <player> <amount> → Set a player’s balance
  Permission: theeconomy.admin.money.set
• /money give <player> <amount> → Add money to a player
  Permission: theeconomy.admin.money.give
• /cash give <player> <amount> → Add cash to a player
  Permission: theeconomy.admin.cash.give
  ✅ Works from console!

---

🛒 Server Shop Commands & System

• /shop → Opens the Shop GUI
  Aliases: /loja
  Permission: theeconomy.player.shop
• Browse available items using a clean interface
• Buy and sell items with a confirmation dialog
• Quantity input field in the confirmation GUI
• Shop supports translated item names, tooltips, and messages
• Buy/Sell options are automatically disabled if the item price is set to 0
• Displays an empty shop message when no items are available
• Dynamic translated titles based on configured language

🛠 Server Shop Admin Commands

• /shop npc add → Adds an NPC with an interactive feature to open a shop exclusively for that NPC.
  Permission: theeconomy.admin.shop.add
• /shop npc movehere → Move a NPC to player Location.
  Permission: theeconomy.admin.shop.add
• /shop npc list → List all NPC Shops
  Permission: theeconomy.admin.shop.add
• /shop npc remove → Remove an NPC with an interactive feature to open a shop exclusively for that NPC.
  Permission: theeconomy.admin.shop.add
• /shop manager → It allows you to manage Adminshop through the interface without using the commands below.
  Permission: theeconomy.admin.shop.manager
• /shop add <itemid> <quantity> <pricesell> <pricebuy> → Adds an item to the shop
  Permission: theeconomy.admin.shop.add
• /shop tab add <tabname> → Adds an tab to the shop
  Permission: theeconomy.admin.shop.add
• /shop tab remove <tabname> → Removes an tab to the shop
  Permission: theeconomy.admin.shop.remove
• /shop remove <uniqueid> → Removes an item from the shop
  Permission: theeconomy.admin.shop.remove
• /shop rpshop <playername> <new name> → Rename player Shop
  Permission: theeconomy.admin.shop.rename.player

---

🧑‍🤝‍🧑 Player Shop System (Player-to-Player Shops)

Players can create their own personal shops and trade with others.

Player Shop Commands

• /myshop →
  Aliases: /mshop /minhaloja
  Permission: theeconomy.player.myshop.manager
• /myshop manager → It allows you to manage Playershop through the interface without using the commands below.
  Permission: theeconomy.player.myshop.manager
• /myshop open → Opens your shop.
  Permission: theeconomy.player.myshop
• /myshop close → Closes your shop
  Permission: theeconomy.player.myshop
• /myshop add <priceBuy> <priceSell> → Adds the item in hand to your shop
  Permission: theeconomy.player.myshop
• /myshop remove <uniqueid> → Removes an item from your shop
  Permission: theeconomy.player.myshop
• /myshop tab add <name> → Adds a tab to the player's store.
  Permission: theeconomy.player.myshop
• /myshop rename <name> → Rename the store.
  Permission: theeconomy.player.myshop
• /playershop <nick> → Opens another player’s shop
  Aliases: /pshop /lojajogador
  Permission: theeconomy.player.playershop
• /shops → Lists all open player shops
  Aliases: /lojas /shopslist
  Permission: theeconomy.player.shops

---

⛏ Block Break Rewards

Earn money automatically by breaking blocks:

• Ore Rewards
  • Fully configurable per ore type
  • Can be enabled/disabled in config
• Wood Rewards
  • Reward values can be configured per wood type
  • Can be enabled/disabled in config

---

🐲 Monster Kill Rewards

Players can earn money by defeating monsters:

• Individual configuration system per monster
• Each monster can have its own reward set.
• Configurable via MonsterReward in EconomyConfig
• Optional debug logs

---

⚙ Configuration Options

• Enable/disable Ore Rewards
• Enable/disable Wood Rewards
• Enable/disable Player Shop system (EnablePlayerShop
• Enable/disable Admin Shop system (EnableShop)
• Enable/disable hud system (EnableHud)
• Set default Language (EN / PT / ES / RU / DE)
• Customize Currency Symbol
• Configure Ore rewards per type
• Configure Wood rewards per type
• Configure Monster rewards per type

---

🗄️ MySQL Database Support

EconomySystem includes full MySQL database support for scalable server deployments.

MySQL Configuration (EconomySystem.json)

• EnableMySQL (default: false)
• MySQLHost (default: localhost)
• MySQLPort (default: 3306)
• MySQLUser (default: root)
• MySQLPassword (default: empty)
• MySQLDatabaseName (default: theeconomy)
• MySQLTableName (default: bank)
• MySQLAdminShopTableName (default: adminshop)
• MySQLPlayerShopTableName (default: playershop)

• ✅ Automatic table creation on first connection
• ✅ Seamless migration between JSON and MySQL
• ✅ Thread-safe database operations
• ✅ Supports all plugin features (balances + shops + rewards)

---

🌍 Localization / Translation

• Language_EN.json — English
• Language_PT.json — Portuguese
• Language_ES.json — Spanish
• Language_RU.json — Russian
• Language_PL.json — Polish
• Language_DE.json — German
• Language_HU.json — Hungarian
• Language_FR.json — French

✅ All messages, GUIs, tooltips, and shop titles are fully translatable
✅ Supports placeholders and dynamic values
✅ Item names are translated in all messages and GUIs

---

🔌 Public API (EconomyAPI)

EconomySystem includes a public API available at: com.economy.api.EconomyAPI

• Balance queries, management, and checks
• Formatted balance retrieval
• Player name/UUID helpers
• Shop opening method for integrations

---

🔗 Placeholder API

EconomySystem includes a Placeholder API: com.economy.util.PlaceholderAPI

• %balance% — Player balance (numeric)
• %balance_formated% — Player balance (formatted)

---

🔌 Public API (EconomyAPI)

EconomySystem includes a public API located at:
com.economy.api.EconomyAPI

Available API Methods

Balance Queries

• getBalance(UUID playerUUID)
• getBalance(String playerName)

Balance Management

• setBalance(UUID playerUUID, double value)
• setBalance(String playerName, double value) (returns boolean)
• addBalance(UUID playerUUID, double value)
• addBalance(String playerName, double value) (returns boolean)
• removeBalance(UUID playerUUID, double value) (returns boolean)
• removeBalance(String playerName, double value) (returns boolean)

Balance Checks

• hasBalance(UUID playerUUID, double value)
• hasBalance(String playerName, double value)

Player Info Helpers

• getPlayerName(UUID playerUUID)
• getPlayerUUID(String playerName)

Formatted Balance

• getFormattedBalance(UUID playerUUID)
• getFormattedBalance(String playerName)

Shop Management

• openShop(Player player) (returns boolean)
  • Opens the shop for a player
  • Automatically checks if shop is enabled in configuration
  • Returns true if shop was opened successfully, false otherwise

API Example

import com.economy.api.EconomyAPI;
import com.hypixel.hytale.server.core.entity.entities.Player;
import java.util.UUID;

// Get API instance
EconomyAPI api = EconomyAPI.getInstance();

// Balance queries
double balance = api.getBalance(playerUUID);
double balanceByName = api.getBalance("PlayerName");

// Balance management
api.setBalance(playerUUID, 1000.0);
api.addBalance(playerUUID, 100.0);
boolean success = api.removeBalance(playerUUID, 50.0);

// Balance checks
boolean hasEnough = api.hasBalance(playerUUID, 200.0);

// Formatted balance
String formatted = api.getFormattedBalance(playerUUID);

// Player info
String name = api.getPlayerName(playerUUID);
UUID uuid = api.getPlayerUUID("PlayerName");

// Open shop (in an event or command)
public void onPlayerCommand(Player player) {
    EconomyAPI api = EconomyAPI.getInstance();
    
    // Check balance
    double balance = api.getBalance(player.getUuid());
    
    // Add money
    api.addBalance(player.getUuid(), 100.0);
    
    // Open administrative shop
    if (api.openShop(player)) {
        // Shop opened successfully
    } else {
        // Failed to open shop (may be disabled or player offline)
    }
}

---

🔗 Placeholder API

EconomySystem includes a public Placeholder API for other plugins:

com.economy.util.PlaceholderAPI

Available Placeholders

• %balance% - Player balance (numeric value)
• %balance_formated% - Player balance (formatted with currency symbol)

Placeholder API Methods

• PlaceholderAPI.getInstance().replacePlaceholders(UUID playerUUID, String text)
• PlaceholderAPI.getInstance().replacePlaceholders(String playerName, String text)
• PlaceholderAPI.getInstance().containsPlaceholders(String text)

Placeholder Example

PlaceholderAPI placeholderAPI = PlaceholderAPI.getInstance();

String text = "Your balance is %balance_formated%";
String result = placeholderAPI.replacePlaceholders(playerUUID, text);
// Result: "Your balance is $1,234.56"

---

🔐 Permissions

All permissions are registered and visible in LuckPerms:

Player Permissions

• theeconomy.player.hud - Access to /hud command
• theeconomy.player.money - Access to /money command
• theeconomy.player.cash - Access to /cash command
• theeconomy.player.money.pay - Access to /money pay command
• theeconomy.player.money.top - Access to /money top command
• theeconomy.player.shop - Access to /shop or /loja command
• theeconomy.player.iteminfo - Access to /iteminfo command
• theeconomy.player.myshop - Access to /myshop commands
• theeconomy.player.myshop.manager - Access to /myshop manager
• theeconomy.player.playershop - Access to /playershop or /pshop command
• theeconomy.player.shops - Access to /shops command

Admin Permissions

• theeconomy.admin.money.set - Access to /money set command
• theeconomy.admin.cash.give - Access to /cash give command
• theeconomy.admin.money.give - Access to /money give command
• theeconomy.admin.shop.add - Access to /shop add command
• theeconomy.admin.shop.add - Access to /shop add command
• theeconomy.admin.shop.manager - Access to /shop manager command

Permission Groups

• theeconomy.player.* - Grants all player permissions
• theeconomy.admin.* - Grants all admin permissions
• theeconomy.* - Grants all permissions

---

🎨 Color Code System

✨ New Feature: EconomySystem includes a Minecraft-like color code system for customizing messages in chat, GUIs, and HUD!

Color Codes

Use & or § followed by a code to apply colors and formatting:

Basic Colors

• &0 - Black
• &1 - Dark Blue
• &2 - Dark Green
• &3 - Dark Cyan
• &4 - Dark Red
• &5 - Dark Purple
• &6 - Gold
• &7 - Gray
• &8 - Dark Gray
• &9 - Blue
• &a - Green
• &b - Cyan
• &c - Red
• &d - Pink
• &e - Yellow
• &f - White

Formatting Codes

• &l - Bold
• &o - Italic
• &r - Reset (removes all formatting and colors)

Where It Works

• ✅ Chat Messages: All command messages, errors, success notifications
• ✅ GUI Text: Window titles, labels, button text, tooltips, confirmations
• ✅ HUD Text: All HUD labels, shop status, temporary notifications

Usage Examples

In Translation Files (JSON)

{
  "chat_welcome": "&aWelcome to the server!",
  "chat_error": "&cError: &fSomething went wrong!",
  "chat_info": "&bInfo: &fYour shop is open"
}

Combining Colors and Formatting

&l&6Gold Bold Text
&c&lRed Bold Text
&a&oGreen Italic Text
&l&6&oGold Bold Italic Text

Default HUD Colors

The plugin uses default colors in the HUD that can be customized in translation files:

• &l&6 - Bold Gold (for main labels: Nick, Money, Top Rank, Shop)
• &a - Green (for positive status: Shop Open, Gains)
• &c - Red (for negative status: Shop Closed)
• &r - Reset (returns to default after label)

Recommended Color Usage

• Success: &a (Green) - &aOperation successful!
• Error: &c (Red) - &cError processing command!
• Warning: &e (Yellow) - &eWarning: Insufficient balance!
• Info: &b (Cyan) - &bInfo: Your shop is open
• Highlight: &6 (Gold) - &6Top Rank: #1
• Title: &l&6 (Bold Gold) - &l&6Administrative Shop

Quick Reference

Code	Color	Example
&0	Black	&0Black Text
&1	Dark Blue	&1Dark Blue Text
&2	Dark Green	&2Dark Green Text
&3	Dark Cyan	&3Dark Cyan Text
&4	Dark Red	&4Dark Red Text
&5	Dark Purple	&5Dark Purple Text
&6	Gold	&6Gold Text
&7	Gray	&7Gray Text
&8	Dark Gray	&8Dark Gray Text
&9	Blue	&9Blue Text
&a	Green	&aGreen Text
&b	Cyan	&bCyan Text
&c	Red	&cRed Text
&d	Pink	&dPink Text
&e	Yellow	&eYellow Text
&f	White	&fWhite Text
&l	Bold	&lBold Text
&o	Italic	&oItalic Text
&r	Reset	&rNormal Text

Note: You can also use § instead of & (e.g., §a = &a)

---

• EconomySystem developed by Agmar Martins
• Russian Translation: Lylex — Thank you for your contribution! 🙏
• German Translation: SalimoSB - HyHero — Thank you for your contribution! 🙏
• Hungarian Translation: Marvar — Thank you for your contribution! 🙏

Version: 1.0.8-beta