EconomySS — Economy API for SimpleScripting

Add economy features to your JavaScript server mods.

EconomySS is a SimpleScripting extension that brings a complete economy API to your server — letting you build shops, manage player balances, and create economy-based gameplay with just a few lines of JavaScript. It automatically detects and integrates with popular economy plugins like VaultUnlocked, so setup is effortless.

SimpleScripting required. Download SimpleScripting first.

Full documentation, guides, and tutorials: wiki.hosttale.com

Join to our discord if any issue or help needed: Discord

---

Why EconomySS?

Works with your economy plugin	Automatically detects VaultUnlocked, EliteEssentials, and other providers — no extra configuration needed.
Simple JavaScript API	Query balances, deposit, withdraw, and check funds with a clean, intuitive interface.
No threading headaches	Handles all the threading complexity behind the scenes — your JavaScript code works like it's synchronous.
Multi-vendor support	Built on the VaultUnlocked bridge, so you can support dozens of economy plugins without changing your mod code.
Player Shops example	Ships with a complete shop system mod — ready to deploy or customize for your server.
Type definitions included	Get autocomplete and inline documentation for the economy API in your editor.

---

How It Works

1. Install EconomySS alongside SimpleScripting and your economy plugin (e.g., VaultUnlocked + EconTale).
2. EconomySS automatically detects your economy provider on startup.
3. The economy global becomes available to all JavaScript mods.
4. Use simple API calls to manage player balances, build shops, and create economy-driven gameplay.

---

What Can You Build?

The economy API unlocks unlimited possibilities:

• Player Shops — Let players buy and sell items for currency
• Tipping & Donations — Players can pay other players or support the server
• Taxes & Fees — Charge for access to regions, commands, or services
• Bounties & Rewards — Pay players for completing tasks or winning events
• Auctions & Trading Houses — Players can sell items to each other
• Server Resources — Charge currency for special abilities, cosmetics, or ranks
• Economy Events — Organise competitions or challenges with prize pools
• Banking Systems — Let players manage accounts and set interest rates
• Lottery & Gambling — Host games of chance with currency stakes
• Custom Shops — Integrate your mod's economy with server-wide balance tracking

---

Economy Providers

EconomySS automatically detects and uses the most suitable economy provider available on your server, in this priority order:

1. VaultUnlocked (Recommended)

A universal economy API that bridges many economy plugins. Installing VaultUnlocked with any compatible economy backend gives you maximum flexibility.

Compatible economy plugins:

• EconTale
• TheEconomy
• DynastyEconomy
• Coins
• Maiconomy
• EcoTale
• EasyEcon

2. EliteEssentials

Direct integration with EliteEssentials' built-in economy system.

Setup:

1. Install VaultUnlocked plugin (recommended) + your chosen economy plugin, or
2. Install EliteEssentials
3. Install EconomySS — it will auto-detect your provider

Check server startup logs to confirm detection:

[EconomySS] Economy provider: VaultUnlocked
[EconomySS] Connected to economy service

---

For JavaScript Mod Developers

Once EconomySS is installed, the economy global is automatically available in all your mods with methods to check balances, deposit, withdraw, and verify player funds.

The bundled Player Shops example mod demonstrates a complete, ready-to-use shop system with multiple items, price configuration, and balance checking.

For detailed API documentation, code examples, and development guides, visit the SimpleScripting wiki.

Bundled Example

EconomySS ships with a ready-to-use Player Shops example mod that you can enable or customize for your server.

---

Installation Requirements

• Hytale dedicated server with SimpleScripting plugin installed
• Economy provider: one of the following:
  • VaultUnlocked plugin + any compatible economy plugin (recommended)
  • EliteEssentials
• Java 25+ JDK (for building from source)

---

Features at a Glance

• ✅ Automatic provider detection — no manual configuration required
• ✅ Multi-provider support — works with dozens of economy plugins via VaultUnlocked
• ✅ Thread-safe operations — EconomySS handles threading; your mods just use the API
• ✅ TypeScript definitions — full editor autocomplete and inline documentation
• ✅ Example mods — ready-to-use shops and complete implementations
• ✅ Action logging — clear error messages and provider status in server logs
• ✅ Hot reload compatible — update your economy mods without restarting

---

Dependency

EconomySS is a SimpleScripting extension. It requires SimpleScripting to be installed and loaded before it initializes. If you haven't set up SimpleScripting yet, download it from CurseForge first.

---

Troubleshooting

Economy not available?

• Ensure VaultUnlocked (or EliteEssentials) is installed and running
• Check server log for provider detection messages
• Verify EconomySS is in the plugins folder

Cannot find player balance?

• Confirm the player UUID is correct in your code
• Some economy plugins may need additional configuration

For more help:

• Check the SimpleScripting wiki
• Review the bundled player-shops example for best practices

---

SimpleScripting Wiki · Report Issues · Built on SimpleScripting for the Hytale modding community.