Skip to main content

Config: Economy

Configuration reference for economy.json — treasury, fees, and upkeep settings.

Economy Configuration

File Location

mods/com.hyperfactions_HyperFactions/config/economy.json

Controls faction economy integration, treasury settings, fees, and upkeep.

Requires VaultUnlocked

Economy features require the VaultUnlocked mod to be installed. Without it, this module is automatically disabled.

Reload Required

Changes require /f admin reload or a server restart to take effect.

Currency Settings

KeyTypeDefaultDescription
currencyNamestring"dollar"Singular currency name
currencyNamePluralstring"dollars"Plural currency name
currencySymbolstring"$"Currency symbol for display
startingBalancedouble0.0Starting treasury balance for new factions
disbandRefundToLeaderbooltrueRefund treasury to leader on disband

Treasury Limits

KeyTypeDefaultDescription
defaultMaxWithdrawAmountdouble0.0Max single withdrawal (0 = unlimited)
defaultMaxWithdrawPerPerioddouble0.0Max withdrawals per period (0 = unlimited)
defaultMaxTransferAmountdouble0.0Max single transfer (0 = unlimited)
defaultMaxTransferPerPerioddouble0.0Max transfers per period (0 = unlimited)
defaultLimitPeriodHoursint24Period duration for withdrawal/transfer limits

Fees

KeyTypeDefaultDescription
depositFeePercentdouble0.0Percentage fee on deposits (0-100)
withdrawFeePercentdouble0.0Percentage fee on withdrawals (0-100)
transferFeePercentdouble0.0Percentage fee on inter-faction transfers (0-100)

Upkeep

KeyTypeDefaultDescription
upkeepEnabledboolfalseEnable territory upkeep costs
upkeepCostPerChunkdouble10.0Cost per claimed chunk per interval
upkeepIntervalHoursint24Hours between upkeep charges
upkeepGracePeriodHoursint48Grace period before claims decay from missed upkeep
upkeepAutoPayDefaultbooltrueAuto-pay upkeep from treasury by default

Default Configuration

{
  "enabled": true,
  "currencyName": "dollar",
  "currencyNamePlural": "dollars",
  "currencySymbol": "$",
  "startingBalance": 0.0,
  "disbandRefundToLeader": true,
  "defaultMaxWithdrawAmount": 0.0,
  "defaultMaxWithdrawPerPeriod": 0.0,
  "defaultMaxTransferAmount": 0.0,
  "defaultMaxTransferPerPeriod": 0.0,
  "defaultLimitPeriodHours": 24,
  "depositFeePercent": 0.0,
  "withdrawFeePercent": 0.0,
  "transferFeePercent": 0.0,
  "upkeepEnabled": false,
  "upkeepCostPerChunk": 10.0,
  "upkeepIntervalHours": 24,
  "upkeepGracePeriodHours": 48,
  "upkeepAutoPayDefault": true
}