EconomyAPI - PMMPCore Plugin

EconomyAPI Plugin (Click for More)

EconomyAPI is a virtual currency system for PMMPCore Framework that brings full economic management to Minecraft Bedrock. Manage wallets, bank accounts, debt, transactions, and interest systems with complete PlaceholderAPI integration.

What Does This Plugin Do?

EconomyAPI extends PMMPCore Framework with a complete virtual economy system, allowing server owners to manage player wallets, bank deposits, debt with interest, transaction logging, and top-money leaderboards. Fully integrated with PlaceholderAPI for scoreboards and chat display.

⚠️ Requirements

Requirement	Status	Details
❌ PMMPCore Framework	Required	This plugin cannot work without PMMPCore Framework installed.
❌ PurePerms	Required	Permission system for economy command access control.
✅ Server Owner	Recommended	Designed for server administrators, not casual players.

Key Features

• ✅ Player Wallets: Each player has a personal wallet with default starting money (configurable).
• ✅ Bank System: Deposit and withdraw money to/from a secure bank account with interest accumulation.
• ✅ Debt Management: Players can borrow money with configurable interest rates and limits.
• ✅ Transaction System: Complete transaction history with WAL-based persistence for data safety.
• ✅ Top Money Leaderboard: Paginated leaderboard showing wealthiest players.
• ✅ Interest System: Automatic debt and bank interest applied on configurable intervals.
• ✅ PlaceholderAPI Integration: Expansions for displaying economy data in chat and scoreboards.
• ✅ Permission System: Granular permission nodes for every economy command.

🛠️ Available Commands

EconomyAPI provides comprehensive commands for economy management:

Command	Syntax	Description
mymoney	/mymoney	Shows your current wallet balance
mydebt	/mydebt	Shows your current debt amount
mystatus	/mystatus	Shows full financial status (wallet, debt, bank, net worth)
takedebt	/takedebt <money>	Borrow money as debt
returndebt	/returndebt <money>	Return borrowed debt
topmoney	/topmoney [page]	Show wealthiest players leaderboard
pay	/pay <player> <money>	Pay money to another player
seemoney	/seemoney <player>	View another player's money
bank	/bank <deposit|withdraw|mymoney> [money]	Bank account operations
economys	/economys	List plugins using EconomyAPI
setmoney	/setmoney <player> <money>	Set player's money (admin)
givemoney	/givemoney <player> <money>	Give money to player (admin)
takemoney	/takemoney <player> <money>	Take money from player (admin)
bankadmin	/bankadmin <takemoney|givemoney> <player> <money>	Bank admin operations
moneysave	/moneysave	Flush economy data to storage
moneyload	/moneyload	Replay WAL and refresh economy state

Example Usage

# Check your balance
/mymoney

# Pay another player
/pay Notch 500

# Deposit into bank
/bank deposit 1000

# Check your full status
/mystatus

# View top money leaderboard
/topmoney

Configuration Options

Configure EconomyAPI behavior in the plugin config:

const ECONOMY_DEFAULTS = {
  defaultMoney: 1000,
  defaultDebt: 0,
  defaultBankMoney: 0,
  debtLimit: 500,
  onceDebtLimit: 100,
  timeForIncreaseDebt: 10,       // Minutes between debt interest
  percentOfIncreaseDebt: 5,       // Debt interest percentage
  timeForIncreaseMoney: 10,       // Minutes between bank interest
  bankIncreaseMoneyRate: 5,       // Bank interest percentage
  allowPayOffline: true,
  topPageSize: 5
};

PlaceholderAPI Integration

EconomyAPI registers these placeholders for use in chat and scoreboards:

Placeholder	Description
%economy_money%	Player's wallet balance
%economy_wallet%	Player's wallet balance (alias)
%economy_bank%	Player's bank balance
%economy_debt%	Player's current debt
%economy_formatted%	Formatted economy display string

Permission System

EconomyAPI integrates with PurePerms for granular command permissions:

Permission Node	Command	Default Group
economy.command.mymoney	/mymoney	Guest
economy.command.mydebt	/mydebt	Guest
economy.command.mystatus	/mystatus	Guest
economy.command.takedebt	/takedebt	Guest
economy.command.returndebt	/returndebt	Guest
economy.command.topmoney	/topmoney	Guest
economy.command.pay	/pay	Guest
economy.command.seemoney	/seemoney	Mod
economy.command.bank	/bank	Guest
economy.command.economys	/economys	Admin
economy.admin.setmoney	/setmoney	Admin
economy.admin.givemoney	/givemoney	Admin
economy.admin.takemoney	/takemoney	Admin
economy.admin.bank	/bankadmin	Admin
economy.admin.save	/moneysave	Admin
economy.admin.load	/moneyload	Admin

Integration with Other Plugins

• PlaceholderAPI: Economy data placeholders for chat, scoreboards, and custom displays.
• PurePerms: Permission-based command access control.
• ScoreHud: Display player money, bank, and debt on scoreboards.
• EssentialsTP: Economy-enabled teleport costs (when enabled).

Compatibility & Requirements

• ⚠️ Requires PMMPCore Framework: This plugin is part of the PMMPCore ecosystem and cannot function independently.
• ⚠️ Requires PurePerms: Permission system is required for economy command access control.
• ✅ Version: Optimized for Minecraft Bedrock 1.21.70+ (Release).
• ✅ Multiplayer: Fully tested on Realms and Dedicated Servers.
• ✅ License: GPL-3.0 - Free to use, modify, and distribute under the same terms.

Installation

1. Download EconomyAPI from CurseForge (comes as .mcpack file)
2. Change file extension: Rename EconomyAPI.mcpack to EconomyAPI.zip
3. Extract the archive: Unzip the file to access the contents
4. Locate PMMPCore: Find your PMMPCore Framework installation folder
5. Copy plugin files: From the extracted folder, copy the EconomyAPI folder from scripts/plugins/
6. Paste to plugins: Paste the folder into scripts/plugins/ within PMMPCore
7. Register plugins: Open scripts/plugins.js and add the import:

// Add this line to your plugins.js file
import "./plugins/EconomyAPI/main.js";

1. Restart server: Restart Minecraft Bedrock to load the plugin
2. Verify installation: Use /plugins to confirm plugin is loaded

Performance Features

• WAL-Based Persistence: Write-ahead logging ensures data integrity even during crashes.
• Automatic Flushing: Data is periodically flushed to storage to prevent loss.
• Interest Scheduling: Debt and bank interest calculated on efficient intervals.
• Transaction History: Complete audit trail with indexed queries.

Getting Started

1. Install PMMPCore Framework first (required dependency)
2. Install PurePerms (required for permissions)
3. Follow the installation steps above to add EconomyAPI
4. Restart your server to initialize the plugin
5. Configure economy settings in the plugin config
6. Use /mymoney to verify it's working

Need help with your server economy? Join our Discord Server for support!

---

⚠️ Important Notice: This plugin requires PMMPCore Framework and PurePerms, and is designed for server administrators with technical knowledge of server management.