# ======================================================================
#  Mines - config.yml
# ======================================================================
#  Need better performance?
#  ➜ Search this file for "(POSSIBLE PERFORMANCE BOOST)" to quickly
#    find all options that can help reduce lag and improve efficiency.
# ======================================================================


# ----------------------------------------------------------------------
#  Update Check
# ----------------------------------------------------------------------
update-check:
  enabled: true
  permission: mines.update
  message: "&bᴍɪɴᴇꜱ &8| &7A new version is available &8(&f%current% &7➜ &b%latest%&8)&7."


# ----------------------------------------------------------------------
#  Task Timers & Queues
#  These control how often Mines runs certain checks and updates.
#  Larger values = fewer checks = better performance, but less precision.
# ----------------------------------------------------------------------
Tasks:
  Queues:
    Timer: 0 # Seconds (POSSIBLE PERFORMANCE BOOST)
    # Mines resetting causing lag spikes?
    # ➜ Enable this by setting a value > 0 (try 3 to start).
    # Queues add a delay between each Mine resetting instead of doing
    # them all at the same time.
    # IMPORTANT: Changing this requires a full server restart.

  Percentage:
    Timer: 1 # Seconds (POSSIBLE PERFORMANCE BOOST)
    # Using "Percentage to reset" or percentage-based hologram placeholders?
    # ➜ Keep this enabled (value > 0).
    # Not using any percentage-based features? Set this to 0 to disable.
    #
    # Recommended values:
    #   50–100 Mines: 3–6 seconds
    #   100+ Mines : 7–10 seconds
    #
    # Note: Increasing this value improves performance but will make
    # "Percentage Mined/Left" and "Percentage to reset" less accurate.

  Holograms:
    Timer: 10 # Seconds (POSSIBLE PERFORMANCE BOOST)
    # Using the built-in hologram system?
    # ➜ Keep this enabled and tune the timer as needed.
    # Not using Mines holograms at all? Set this to 0 to disable updates.

  Signs:
    Timer: 1 # Seconds (POSSIBLE PERFORMANCE BOOST)
    # Using Mine Signs (status/reset signs)?
    # ➜ Keep this enabled.
    # Not using them? Set this to 0 to disable.
    #
    # This timer controls how often Mine Signs are refreshed.

    Enable-Reset-Signs-Cooldown: true # Not using any Mine reset signs? Set to false. (POSSIBLE PERFORMANCE BOOST)


# ----------------------------------------------------------------------
#  Performance Mode
# ----------------------------------------------------------------------
Performance-Focused: true
# When enabled, the main Mine reset logic runs async for better performance.
#
# ⚠ Important:
#   - Mines will ignore both MinePreResetEvent and MinePostResetEvent.
#   - If you don't use these events in custom plugins, you should leave
#     this enabled.
#   - Changing this option requires a full plugin restart
#     (server reboot strongly recommended).


# ----------------------------------------------------------------------
#  General Settings
# ----------------------------------------------------------------------
Settings:
  Check-For-Updates: true

  Mine-Fly-Height: 3
  # Maximum height (in blocks) above a Mine where the Mine Fly feature works.

  Mine-Effects-Height: 3
  # Maximum height (in blocks) above a Mine where Mine effects apply.

  Broadcast-Mines-Resetting: false
  # true  = All Mines broadcast a reset message and teleport alerts.
  # false = No reset broadcasts or teleport alerts.

  Allow-Block-Breaking-While-Mines-Reset: true
  # true  = Players can still break blocks while a Mine is resetting.
  # false = Block breaking is disabled during resets.


# ----------------------------------------------------------------------
#  Holograms
# ----------------------------------------------------------------------
Holograms:
  Default hologram:
    Layout:
      - "#ICON: %highestblockname%"
      - "%empty%"
      - "&b%name%"
      - "%empty%"
      - "&3&m———&f Percent bar &3&m———"
      - "%blocksprogressbar%"
      - "%empty%"
      - "&e♠ &fResets in &b%timeuntilreset% &e♠"

      # Previous default layout (for reference):
      # - "&8&m+----&7( &b%name% &7) &8&m----+"
      # - "&6♦ &fBlocks broken &7» &e%blocksbroken%"
      # - "&e♦ &fBlocks left &7» &b%blocksleft%"
      # - "%empty%"
      # - "&6• &fPercent broken &7» &e%percentbroken%"
      # - "&6• &fPercent left &7» &b%percentleft%"
      # - "&6• &fResets at &7» &e%percentlefttoreset% &8/ &b%percentbrokentoreset%"
      # - "&3&m———&f Percent bar &3&m———"
      # - "%blocksprogressbar%"
      # - "%empty%"
      # - "&e♠ &fResets in &b%timeuntilreset% &e♠"

      # Placeholders available in holograms and Mine messages:
      #   %name%                  - Mine name
      #   %blocksbroken%          - Blocks broken in the Mine **
      #   %blocksleft%            - Blocks remaining in the Mine **
      #   %percentbroken%         - % of blocks broken **
      #   %percentleft%           - % of blocks left **
      #   %percentbrokentoreset%  - % broken needed for a reset **
      #   %percentlefttoreset%    - % left before a reset **
      #   %resetpercent%          - Alias for %percentbrokentoreset% **
      #   %blocksprogressbar%     - Progress bar of Mine percentage **
      #   %timeuntilreset%        - Time remaining until the Mine resets
      #   %highestblockname%      - Material name of the highest % block
      #   %resetinterval%         - Reset interval (in ticks)
      #   %resettype%             - Reset type (Instant or Gradual)
      #   %resetspeed%            - Gradual reset speed (FAST, MAX, etc.)
      #   %flyenabled%            - true/false if flight is allowed in the Mine
      #   %isresetting%           - true if the Mine is currently resetting
      #   %position%              - Position of this Mine in the reset queue
      #   %empty%                 - Fully invisible spacer line
      #
      # ** Requires PercentageTask to be enabled
      #    (These are internal placeholders, not PlaceholderAPI placeholders.)

    Resetting:
      - "#ICON: %highestblockname%"
      - "%empty%"
      - "&b%name%"
      - "%empty%"
      - "&fThis mine is"
      - "&fcurrently resetting..."

    MineQueue:
      - "#ICON: %highestblockname%"
      - "%empty%"
      - "&b%name%"
      - "%empty%"
      - "&fThis mine is currently"
      - "&fin a queue to reset... &8(&b#%position%&8)"

    Height: 6
    # Vertical offset (in blocks) from the Mine to the hologram.

  PlaceholderAPI:
    Progress-Bar:
      Bars:
        Symbol: ":"
        Amount: 10
        Colors:
          Empty: "&7"
          Full: "&a"
      Prefix: "&8["
      Suffix: "&8]"

    Time-Until-Reset:
      Use-Shortened-Format: true
      # true  = Short format (e.g. "42s")
      # false = Long format  (e.g. "0h 0m 42s")


# ----------------------------------------------------------------------
#  Mine Signs
# ----------------------------------------------------------------------
Sign:
  Messages:
    Cooldown: "&bᴍɪɴᴇꜱ &8| &7You must wait &b%cooldown% &7before resetting &b%mine% &7again."
    Reset: "&bᴍɪɴᴇꜱ &8| &7You have successfully reset &b%mine% &7mine."
    Invalid Mine: "&bᴍɪɴᴇꜱ &8| &7The mine &b%mine% &7no longer exists."

  Types:
    Percentage Mined:
      1: "&bᴍɪɴᴇꜱ"
      2: "&9Percentage Mined"
      3: "&f%placeholder%%"
      4: "&bᴍɪɴᴇꜱ"

    Percentage Left:
      1: "&bᴍɪɴᴇꜱ"
      2: "&9Percentage Left"
      3: "&f%placeholder%%"
      4: "&bᴍɪɴᴇꜱ"

    Blocks Mined:
      1: "&bᴍɪɴᴇꜱ"
      2: "&9Blocks Mined"
      3: "&f%placeholder%"
      4: "&bᴍɪɴᴇꜱ"

    Time Left:
      1: "&bᴍɪɴᴇꜱ"
      2: "&9Resetting in"
      3: "&f%placeholder%"
      4: "&bᴍɪɴᴇꜱ"

    Reset Mine:
      1: "&bᴍɪɴᴇꜱ"
      2: "&9Click to reset"
      3: "&9this mine"
      4: "&bᴍɪɴᴇꜱ"