EconomyAPI

EconomyAPI

A lightweight, developer-friendly economy backbone for Hytale servers.

EconomyAPI is a core utility designed to handle the "heavy lifting" of currency management. It provides a centralized system for storing, retrieving, and modifying player balances, allowing other mods to focus on features like shops, auctions, or land claims without worrying about a centeralized money system. But it also acts like a bridge so that mods made using this API can also work with other economy systems.

🎮 For Players

By itself, this mod is a Library/Dependency. It doesn't add items or blocks to the game world. You likely need this because another mod you enjoy (like a Shop or Trading mod) uses it to manage money.

Available Commands:

Command Description Permission

/balance (player) /bal Check someones balance economyapi.user.command.balance

/pay Pay someone economyapi.user.command.pay

/baltop Check the 5 richest players on your server economyapi.user.command.baltop

/economyapi /economy /eco

Check the credits for this mod economyapi.user.command.economy

/setbalance <player> <amount> /setbal Sets a player's balance to a specific value. economyapi.admin.command.setbalance

You can gain money by killing mobs.

📦 Installation

Download the EconomyAPI.jar.

Place it into your server's mods folder.

Restart the server.

⚙️Configuration

{ "currencyPrefix": "$", "logRetentionDays": 7, "startingBalance": 500.0, "bridgeMode": "none" // See Bridge Modes }

Bridge Modes:

TheEconomy

EcoTale

💿Mods using this API

SimpleGambler - Adds gambling games

SimpleBanker - Adds physical coins and bills

Get your mod on here! Just send me a message.

👨&zwj;💻 For Developers

Stop reinventing the wheel! Use EconomyAPI as your server's single source of truth for currency.

Why use this API?

Persistent Storage: Automatically saves to a balances.json file in the plugin data folder.

Namechange-Safe: Uses Hytale's UUID system to ensure data persists even if players change names.

Easy Access: Simple integration via our api

Implementation Example:

import com.sennecoolgames.economyapi.EconomyAPI;

EconomyAPI eco = EconomyAPI.getAPI();

// get balance double wallet = eco.getBalance(player.getUuid()); playerRef.sendMessage(Message.raw("Balance: " + eco.getEcoPrefix() + wallet);

// set balance eco.setBalance(player.getUuid(), amount, optionalReason);

// deposit (add money) eco.deposit(player.getUuid(), amount, optionalReason);

// withdraw (remove money) (Outputs false if the user doesn't have enough money) if (eco.withdraw(playerRef.getUuid(), amount, optionalReason)) { commandContext.sendMessage(Message.raw("You withdrew " + eco.formatShort(amount) + "(" + eco.format(amount) + ")" )); } else { commandContext.sendMessage(Message.raw("You don't have enough money!")); }

eco.format(amount); // 1k, 1m, 1t eco.formatShort(amount); // 1.000,00 or 1,000.00

// Get a players username from their uuid (useful for offline players) eco.getCacheUsername(uuid);

// Get economy prefix (default: $) eco.getEcoPrefix();

// Get other config values eco.getConfig(configKey);

Coming Soon

Shop