VZone Plugins/VGraves/Configurations/config.yml

Config

This page mirrors the default config.yml file from the plugin.

config.yml
# ============================================================================
# VGraves main configuration
# ----------------------------------------------------------------------------
# This file controls the gameplay side of the plugin:
# - grave lifetime
# - reclaim pricing
# - reclaim limits
# - GUI file locations
# - logging and debug options
# - exception item filters
# - language selection
# - physical ticket item appearance
#
# Existing values are preserved when the plugin updates missing keys.
# ============================================================================
config-version: 2

settings:
  # Grave lifetime in hours.
  expire_hours: 24

  # Maximum amount of saved graves per player.
  # If this limit is exceeded, the oldest grave is removed first.
  max_saves: 5

  # Save loaded player data when the plugin disables.
  autosave_on_disable: true

  # Run expired grave cleanup when the plugin starts.
  cleanup_on_start: true

  # Expired grave behavior.
  # DELETE = remove the grave
  # DROP   = drop saved contents and XP at the death location
  expired_grave_action: DELETE

  # Time zone used in formatted placeholders and GUI text.
  # Example: Europe/Budapest
  time_zone: Europe/Budapest

  # Admin self-claim behavior.
  # true  = self-claim consumes the grave
  # false = self-claim copies the contents and keeps the grave
  admin_self_claim_consumes_grave: false

debug:
  # Enables extra debug logs for save/load and GUI flows.
  enabled: false

limitation:
  # Maximum amount of paid reclaims a player can use.
  # -1 = unlimited
  maximum_buy_usage: -1

  # Maximum amount of ticket reclaims a player can use.
  # -1 = unlimited
  maximum_ticket_usage: -1

pricing:
  currency:
    # Console command that removes currency from a player.
    # Supported replacements:
    # %player% = player name
    # %amount% = reclaim price
    take-command: "customcurrency take %player% %amount%"

    # Console command used for refund if a paid reclaim fails after withdrawal.
    give-command: "customcurrency give %player% %amount%"

    # Currency name shown in GUI and messages.
    name: "Custom Currency"

    # PlaceholderAPI placeholder used to read the player's balance.
    # It must resolve to a plain number.
    placeholder: "%custom_currency%"

    # false = player may have more than the required amount
    # true  = player must have exactly the required amount
    require_exact: false

    # If true, the plugin verifies that balance really changed after take/give.
    verify_balance_change: true

    # Allowed decimal tolerance during balance verification.
    balance_check_tolerance: 0.01

    # Delay before balance is rechecked.
    # Useful if the economy placeholder updates a few ticks later.
    verification_delay_ticks: 0

  calculate:
    # Enables calculated pricing.
    # Used as:
    # - the main pricing mode when fix pricing is disabled
    # - a fallback when fix pricing is enabled but the current claim number
    #   has no fixed value
    enable: false

    # Flat base amount.
    base_price: 10

    # Added price per saved item.
    per_item: 2

    # Scaling multiplier used as item count grows.
    scale_multiplier: 1.25

    # Maximum allowed calculated price.
    max_price: 5000

  fix:
    # Enables fixed pricing by paid-claim number.
    enable: true

    # Priority rules:
    # - fix pricing is checked first
    # - if both fix and calculate are enabled, calculate is only a fallback
    # - if only fix is enabled and a claim number is missing, that grave
    #   cannot be reclaimed with currency
    values:
      # claim-number: price
      1: 650000
      2: 1200000
      3: 5000000
      4: 20000000
      5: 30000000

menus:
  # Paths to GUI files inside the plugin folder.
  main_menu: guis/main.yml
  view_menu: guis/view.yml
  admin_main_menu: guis/admin_main.yml
  admin_view_menu: guis/admin_view.yml

logging:
  # Logs death save creation.
  log_deaths: true

  # Logs successful restore-related actions.
  log_claims: true

# If a player has any permission below, no grave is created for them.
grave-permissions:
  - example.permission

exception-items:
  # If lore contains one of these values, the item is ignored.
  in-description:
    - "EXAMPLE LORE PART"
    - "EXAMPLE LORE PART2"

  # If display name contains one of these values, the item is ignored.
  in-name:
    - "EXAMPLE NAME PART"
    - "EXAMPLE NAME PART2"

  # If display name exactly equals one of these values, the item is ignored.
  name:
    - "EXAMPLE NAME"
    - "EXAMPLE NAME2"

  # If custom model data equals one of these values, the item is ignored.
  model-data:
    - 100
    - 200

ticket-item:
  # Material of the physical ticket item.
  material: PAPER

  # CustomModelData for the physical ticket item.
  custom_model_data: 0

  # Adds enchantment glow to the physical ticket item.
  glow: true

  # Display name of the physical ticket item.
  name: "&#1378FFɢ&#1A7EFFʀ&#2185FEᴀ&#288BFEᴠ&#2F92FEᴇ &#3D9FFDᴛ&#44A5FCɪ&#4BACFCᴄ&#52B2FCᴋ&#59B9FBᴇ&#60BFFBᴛ"

  # Lore of the physical ticket item.
  # Supported replacement:
  # %ticket-value% = stored ticket amount inside the physical item
  lore:
    - ""
    - "&#1378FFɪɴꜰᴏʀᴍᴀᴛɪᴏɴ:"
    - " &8&l| &#60BFFBValue: &7%ticket-value%"
    - " &8&l| &#60BFFBUsage: &7shift + right click"

messages:
  # Selected language file.
  # Bundled language files live in the lang/ folder.
  # Examples:
  # lang_en.yml
  # lang_hu.yml
  # lang/custom.yml
  lang_file: lang_en.yml