Configuration

Configuration

GPExpansion uses config.yml for all plugin settings.

File Location

plugins/GPExpansion/config.yml

Main Configuration Sections

Core Settings

# Debug mode for troubleshooting
debug:
  enabled: false

# GUI settings
gui:
  enabled: true
  # Permissions for GUI features
  permissions:
    return-command: "griefprevention.claim.gui.return"

# Mailbox protocol
# 'virtual' - Snapshot-based (works with all GP versions)
# 'real' - Live chest with subdivisions (requires GP3D)
mailbox-protocol: virtual

Claim Block Accruals

Claim block accrual profiles live under accruals.groups.

accruals:
  groups:
  - name: default
    blocks-per-hour: 100
    max-blocks: 80000
    max-claims: 0 # disabled
  - name: vip
    blocks-per-hour: 20
    max-blocks: 250000
    max-claims: 10
  - name: elite
    blocks-per-hour: 50
    max-blocks: 1000000
    max-claims: 20
    permission: elite-reward

Profiles can match by Vault/LuckPerms group, by griefprevention.accruals.<group>, or by the optional permission: node. See Claim Block Accruals for the full behavior and command list.

Default Values

defaults:
  # Currency type: money, xp, claimblocks, items
  currency: money
  
  # Sign limits per claim
  max-rent-signs-per-claim: 1
  max-mailbox-signs-per-claim: 1
  max-sell-signs-per-claim: 1
  max-self-mailboxes-per-claim: 3
  max-global-claims-per-player: -1  # -1 = unlimited
  
  # Tax settings (if enabled)
  tax-enabled: false
  tax-rate: 0.01  # Per claim block per period
  tax-period: 7d  # How often tax is collected
  tax-grace-period: 14d  # Days before claim deletion

Sign Settings

signs:
  rent:
    enabled: true
    allow-items: true
    item-types:
      - DIAMOND
      - EMERALD
      - GOLD_INGOT
    
  sell:
    enabled: true
    allow-items: true
    clear-trust-on-sale: true
    transfer-subclaims: true
    
  mailbox:
    enabled: true
    
  global:
    enabled: true
    instant-spawn-set: true

Global Claims

global-claims:
  enabled: true
  allow-teleport: true
  default-icon: GRASS_BLOCK
  max-description-length: 500
  max-name-length: 32
  require-approval: false

Tax System

tax:
  enabled: false
  rate: 0.01
  period: 7d
  grace-period: 14d
  exempt-permission: "griefprevention.tax.exempt"
  payment-methods:
    - money
    - claimblocks
  notification-days-before: [7, 3, 1]

Claim Flight

claim-flight:
  enabled: true
  default-time: 0  # 0 = unlimited for owners
  max-time: 3600  # seconds
  cost-per-second: 0.0

Mailbox Features

mailbox:
  storage-warnings:
    enabled: true
    thresholds:
      - 90
      - 95
      - 100
  
  sounds:
    open: true
    close: true
    
  # Virtual protocol settings
  virtual:
    snapshot-update-interval: 5s
    allow-multiple-depositors: false

GUI Settings

gui:
  enabled: true
  
  main-menu:
    show-global-claims: true
    show-rental-info: true
    
  claim-list:
    page-size: 10
    show-coordinates: true
    show-size: true
    
  colors:
    primary: "&6"
    secondary: "&e"
    error: "&c"
    success: "&a"

Database

storage:
  type: yaml  # yaml, sqlite, mysql
  
  # For MySQL
  mysql:
    host: localhost
    port: 3306
    database: gpexpansion
    username: root
    password: password
    pool-size: 10

Snapshots

snapshots:
  enabled: true
  max-per-claim: 10
  auto-cleanup:
    enabled: true
    days: 30
  compression: true

Economy Configuration

Vault Integration

If using Vault (currency: money):

• Requires Vault plugin
• Requires economy plugin (EssentialsX, etc.)

Experience

defaults:
  currency: xp

Uses player experience levels.

Claim Blocks

defaults:
  currency: claimblocks

Uses GriefPrevention accrued claim blocks.

Items

signs:
  rent:
    allow-items: true
    item-types:
      - DIAMOND
      - EMERALD

Specify allowed item types for item-based payments.

Reloading Configuration

Use /gpx reload to reload config without restart.

Note: Some settings require a full restart:

• Storage type changes
• MySQL connection settings
• Mailbox protocol changes

Complete Example Config

# GPExpansion Configuration

debug:
  enabled: false

gui:
  enabled: true
  
mailbox-protocol: virtual

defaults:
  currency: money
  max-rent-signs-per-claim: 1
  max-mailbox-signs-per-claim: 1
  max-sell-signs-per-claim: 1
  max-self-mailboxes-per-claim: 3
  max-global-claims-per-player: -1

signs:
  rent:
    enabled: true
    allow-items: true
  sell:
    enabled: true
    allow-items: true
    clear-trust-on-sale: true
  mailbox:
    enabled: true
  global:
    enabled: true

global-claims:
  enabled: true
  allow-teleport: true
  default-icon: GRASS_BLOCK

tax:
  enabled: false
  rate: 0.01
  period: 7d
  grace-period: 14d

mailbox:
  storage-warnings:
    enabled: true
    thresholds: [90, 95, 100]
  sounds:
    open: true
    close: true

snapshots:
  enabled: true
  max-per-claim: 10