💰 Economy System Tutorial

This comprehensive guide covers all aspects of EssentialsPlus's powerful economy system, from basic commands to advanced features like command costs and automated rewards.

Quick Overview

EssentialsPlus provides a complete economy system with:

Built-in currency system
VaultUnlocked integration (cross-mod compatibility)
Command costs (pay-per-use for any command)
AdminShop for buying/selling items
Automated rewards via announcements

Getting Started

What is the Economy System?

EssentialsPlus includes a full-featured economy system that allows:

Players to earn, spend, and transfer money
Admins to control the server's economy
Integration with other mods via VaultUnlocked
Command costs (players pay to use specific commands)
Item shops with buy/sell prices

First-Time Setup

Enable economy features in config.json
Set starting balance for new players
Configure command costs (optional)
Set up AdminShop (optional)
Create reward announcements (optional)

Basic Economy Commands

Full Command Reference

See Commands Reference for all economy commands and detailed usage examples.

Player Commands

Command	Description
`/money`	Check your balance
`/pay <player> <amount>`	Send money to another player

Aliases: /balance, /bal, /eco, /wallet for /money

Example: /pay Steve 100 - Send 100 coins to Steve

Admin Commands

Command	Description
`/money <player>`	View another player's balance
`/money add <player> <amount>`	Add money to a player
`/money remove <player> <amount>`	Remove money from a player
`/money set <player> <amount>`	Set exact balance
`/money top [page]`	View richest players

Configuration

Detailed Configuration

See Configuration Guide - Economy Section for complete economy configuration reference.

Basic Economy Settings

Open config.json and configure the economy section:

json

{
  "economy": {
    "enabled": true,
    "startBalance": 0.0,
    "minBalance": 0.0,
    "maxBalance": 1.0E8,
    "transactionLogging": true,
    "currencySymbol": "$",
    "currencyNameSingular": "Dollar",
    "currencyNamePlural": "Dollars"
  }
}

Configuration Options:

Option	Description	Default
`enabled`	Enable/disable the economy system	`true`
`startingBalance`	Money new players start with	`1000.0`
`currencySymbol`	Symbol displayed with amounts (e.g., `$`, `€`, `⛃`)	`$`
`currencyNameSingular`	Currency name (1 unit)	`Dollar`
`currencyNamePlural`	Currency name (multiple units)	`Dollars`
`maxBalance`	Maximum balance a player can have	`999999999.0`
`allowNegativeBalance`	Allow players to have negative balance	`false`

Currency Customization

You can use any symbol or name for your currency! Examples:

Medieval server: Gold / Gold Pieces
Space server: Credit / Credits
Fantasy server: Gem / Gems

VaultUnlocked Integration

VaultUnlocked Issues

If using VaultUnlocked with multiple economy mods, check which provider is active. EssentialsPlus respects VaultUnlocked's provider priority.

What is VaultUnlocked?

VaultUnlocked is a Hytale economy API that allows different mods to work together. EssentialsPlus supports VaultUnlocked in two ways:

EssentialsPlus → Other Mods: Other mods can use EssentialsPlus's economy
Other Mods → EssentialsPlus: EssentialsPlus can use another mod's economy

How It Works

EssentialsPlus automatically detects VaultUnlocked and connects to it. No additional configuration needed!

Scenario 1: EssentialsPlus as Main Economy

Server has: EssentialsPlus + VaultUnlocked + ShopMod

Result: ShopMod uses EssentialsPlus's economy system.
        Players use /balance from EssentialsPlus.
        ShopMod purchases deduct from EssentialsPlus balances.

Scenario 2: EssentialsPlus Uses Another Economy

Server has: EssentialsPlus + VaultUnlocked + BetterEconomy

Result: EssentialsPlus uses BetterEconomy's system.
        /pay and /balance use BetterEconomy.
        Command costs deduct from BetterEconomy balances.

Scenario 3: EssentialsPlus Standalone

Server has: EssentialsPlus (no VaultUnlocked)

Result: EssentialsPlus uses its own built-in economy.
        All features work normally.

Priority System

If multiple economy mods are installed, VaultUnlocked determines which one is used. EssentialsPlus respects this decision automatically.

Command Costs (Pay-Per-Use)

Detailed Configuration

See Configuration Guide - Command Interception for complete documentation on warmup, cooldown, and price settings.

One of the most powerful features: make any command cost money to use!

Quick Overview

The Command Interception System allows you to charge players for using commands. Configure this in the commandInterceptions.commands section of config.json:

json

{
  "commandInterceptions": {
    "commands": [
      {
        "command": "/warp",
        "price": 10.0,
        "cooldown": "0s",
        "warmup": "0s",
        "warmupMovementAllowed": true
      },
      {
        "command": "/rtp",
        "price": 50.0,
        "cooldown": "0s",
        "warmup": "0s",
        "warmupMovementAllowed": true
      }
    ]
  }
}

Free Commands

Set price to 0.0 to make a command free (but still respect cooldowns/warmups if configured).

Permission-Based Discounts

Give VIP players discounts using permissions:

essentialsplus.[command].reduce.price.[amount]

Examples:

essentialsplus.interception.home.reduce.price.5 → 5$ discount on /home
essentialsplus.interception.fly.price.infinite → /fly is always free (bypass)

Quick Setup Example (LuckPerms):

bash

# VIP gets 5$ off teleports
/lp group vip permission set essentialsplus.interception.home.reduce.price.5 true

# VIP+ gets free teleports  
/lp group vip_plus permission set essentialsplus.interception.home.price.infinite true

AdminShop System

Detailed Documentation

See AdminShop Configuration for complete setup guide, item matching details, and more examples.

The AdminShop allows players to buy and sell items at fixed prices you set.

How It Works

Buy: Players purchase items from the server (infinite stock)
Sell: Players sell items to the server
Admin-controlled: You set all prices

Basic Usage

Add an item to the shop:

/adminshop add --buyprice=<price> --sellprice=<price>

Hold the item you want to add, then run the command.

Examples:

/adminshop add --buyprice=100 --sellprice=50 - Buy for $100, sell for $50
/adminshop add --buyprice=500 --sellprice=0 - Buy-only (can't sell back)
/adminshop add --buyprice=0 --sellprice=25 - Sell-only (can't buy)

Automated Rewards via Announcements

Detailed Configuration

See Announcements Configuration for full documentation on titles, sounds, random order, and advanced features.

You can use the announcement system to give players automatic rewards (daily bonuses, hourly income, etc.).

How It Works

Edit announcements.json and add commands to your announcements:

json

{
  "version": "1.0",
  "enabled": true,
  "interval": "15m",
  "randomOrder": false,
  "announcements": [
    {
      "name": "daily_bonus",
      "enabled": true,
      "chatMessage": [
        "<gradient:#4ade80:#22c55e>Daily Bonus received!</gradient>",
        "<gray>You received <green><bold>10 coins</bold></green> as a login bonus!</gray>"
      ],
      "titleMessage": {
        "primary": "Daily Bonus",
        "secondary": "+10 Coins",
        "isMajor": false,
        "duration": "3s",
        "fadeIn": "1s",
        "fadeOut": "2s"
      },
      "sound": {
        "soundEventIndex": 15,
        "category": "UI",
        "volume": 0.8,
        "pitch": 1.2
      },
      "runCommandAsServer": [
        "/money add {player} 10"
      ],
      "runCommandAsPlayer": []
    }
  ]
}

Money Rewards

The money is given through the runCommandAsServer field, which executes commands as the server. Use {player} as a placeholder for the player's name. The command /money add {player} 10 adds 10 coins to each player when the announcement triggers.

For Developers: Economy API

If you're developing your own mod or plugin and want to integrate with EssentialsPlus's economy system, we provide a comprehensive Economy API. This allows you to:

Query player balances
Add/remove money programmatically
Listen to economy events
Full async support with CompletableFuture

API Documentation

See Economy API Reference for complete developer documentation with code examples.

Configuration Guide - Economy Section - Detailed config options
Commands Reference - All economy commands
Permissions Guide - Economy permissions
Announcements Configuration - Reward automation setup
AdminShop Configuration - Shop setup details

⚙️ Configuration

🎓 Tutorials

💰 Economy System Tutorial

Getting Started

What is the Economy System?

First-Time Setup

Basic Economy Commands

Player Commands

Admin Commands

Configuration

Basic Economy Settings

VaultUnlocked Integration

What is VaultUnlocked?

How It Works

Command Costs (Pay-Per-Use)

Quick Overview

Permission-Based Discounts

AdminShop System

How It Works

Basic Usage

Automated Rewards via Announcements

How It Works

For Developers: Economy API

💰 Economy System Tutorial ​

Getting Started ​

What is the Economy System? ​

First-Time Setup ​

Basic Economy Commands ​

Player Commands ​

Admin Commands ​

Configuration ​

Basic Economy Settings ​

VaultUnlocked Integration ​

What is VaultUnlocked? ​

How It Works ​

Command Costs (Pay-Per-Use) ​

Quick Overview ​

Permission-Based Discounts ​

AdminShop System ​

How It Works ​

Basic Usage ​

Automated Rewards via Announcements ​

How It Works ​

For Developers: Economy API ​

Related Resources ​

💰 Economy System Tutorial

Getting Started

What is the Economy System?

First-Time Setup

Basic Economy Commands

Player Commands

Admin Commands

Configuration

Basic Economy Settings

VaultUnlocked Integration

What is VaultUnlocked?

How It Works

Command Costs (Pay-Per-Use)

Quick Overview

Permission-Based Discounts

AdminShop System

How It Works

Basic Usage

Automated Rewards via Announcements

How It Works

For Developers: Economy API

Related Resources