Configuration

The configuration file for Nexal Taxes. Located at plugins/Nexal Taxes/config.yml.

config.yml

# Nexal Taxes Configuration
# Most settings can also be changed in-game with /tax admin > Configuration.

# Storage configuration
storage:
  type: json  # json or sql
  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: ""

# Timezone the collection schedule runs in and times are shown in
# (e.g., UTC, America/New_York, Europe/London)
timezone: "UTC"

# Cron expression for tax collection schedule, in the timezone above
# Format: minute hour day-of-month month day-of-week
# Examples:
#   "0 0 * * *"     - Daily at midnight
#   "0 */6 * * *"   - Every 6 hours
#   "0 0 * * 0"     - Weekly on Sunday at midnight
#   "0 0 1 * *"     - Monthly on the 1st at midnight
collection-schedule: "0 0 * * *"

# Government treasury settings
treasury:
  enabled: true
  starting-balance: 0.0

# Debt handling configuration
debt-handling:
  # Mode: "debt" = track unpaid as debt, "collect" = take whatever balance is available
  mode: debt
  # Maximum debt before consequences are applied
  max-debt: 100000.0
  # Daily interest rate on debt (percentage, 0 = disabled). Added at each collection
  # for the time since the player's previous collection. No interest while exempt.
  debt-interest: 0.0
  # At each collection, pay older debt from whatever balance is left after this cycle's taxes.
  auto-deduct: true
  # Actions when player reaches max debt
  max-debt-actions:
    warn: true
    # Block the transfer-commands below (e.g. /pay) for players at the max debt
    block-economy: false
    # Commands to run when max debt is reached
    # Placeholders: %player%, %debt%, %uuid%
    commands: []
    # Example: commands: ["mail send %player% You have reached maximum tax debt!"]

# Whether to collect taxes from offline players.
# Players with nexaltaxes.exempt are recognised while offline by the permission they had when
# they last left the server.
collect-offline: true

# Commands that send money to another player as /<command> <player> <amount>.
# Evasion detection watches them, and block-economy blocks them.
transfer-commands:
  - pay
  - epay

# How long history is kept. Old entries are removed at startup and after each collection.
retention:
  # Days to keep tax records (the payment history). 0 keeps everything.
  tax-records-days: 0
  # Days to keep resolved evasion alerts. Unresolved alerts are always kept. 0 keeps everything.
  resolved-alerts-days: 0

# Tax configurations
taxes:
  # Land ownership tax (requires GriefPrevention)
  land:
    enabled: true
    # Cost per claimed block per collection cycle
    cost-per-block: 0.01
    # Number of free blocks before taxing begins
    grace-blocks: 100

  # Wealth tax on player balance
  wealth:
    enabled: true
    # Only tax balance above this threshold
    threshold: 10000.0
    # Progressive tax brackets
    # Each bracket taxes wealth between previous max and current max at the given rate
    # max: -1 means unlimited (applies to all remaining wealth)
    brackets:
      - max: 50000
        rate: 1.0
      - max: 100000
        rate: 2.0
      - max: -1
        rate: 3.0

# Tax evasion detection: watches the transfer-commands above
evasion-detection:
  enabled: true
  # Alert online admins with the nexaltaxes.alerts permission
  alert-admins: true
  # Number of transfers within time window to trigger alert
  rapid-transfer-threshold: 5
  # Time window in seconds
  rapid-transfer-window: 60
  # Alert on transfers above this amount
  large-transfer-alert: 50000.0

Configuration Options

Below is a reference of the main configuration sections:

storage

Nexal Taxes Configuration Most settings can also be changed in-game with /tax admin > Configuration.

Storage configuration

timezone

Timezone the collection schedule runs in and times are shown in (e.g., UTC, America/New_York, Europe/London)

collection-schedule

Cron expression for tax collection schedule, in the timezone above Format: minute hour day-of-month month day-of-week Examples: "0 0 * * *" - Daily at midnight "0 */6 * * *" - Every 6 hours "0 0 * * 0" - Weekly on Sunday at midnight "0 0 1 * *" - Monthly on the 1st at midnight

treasury

Government treasury settings

debt-handling

Debt handling configuration

collect-offline

transfer-commands

Commands that send money to another player as /<command> <player> <amount>. Evasion detection watches them, and block-economy blocks them.

retention

How long history is kept. Old entries are removed at startup and after each collection.

taxes

Tax configurations

evasion-detection

Tax evasion detection: watches the transfer-commands above