# Configuration for Mines

# Having TPS issues with Mines? Search this document for "(POSSIBLE PERFORMANCE BOOST)"
# to easily locate settings to improve the performance from Mines within' seconds!

update-check:
  enabled: true
  permission: mines.update
  message: "&bᴍɪɴᴇꜱ &7» &fVersion&7: &b%latest% &fis available. You're running &b%current%&f."

Tasks:
    Queues:
        Timer: 0 # Seconds (POSSIBLE PERFORMANCE BOOST)
        # Mines resetting causing lag? Enable this! (Suggested to try 3 at 1st, increase if needed)
        #
        # Queues allow you to add delays in-between each mine resetting.
        # Changing this will require a server reboot to work.
    Percentage:
        Timer: 1 # Seconds (POSSIBLE PERFORMANCE BOOST)
        # Are you using Timed Resets or just not using percentages to reset? Disable this! (Set it to 0)
        #
        # Changing this affects how many seconds all the mines are checked for their percentages left.
        #
        # 50-100 mines: Suggested to set this number to 3-6.
        # If you have 100+ mines, I'd highly suggest raising this number to 7-10.
        #
        # Note: Increasing this number will affect "Percentage Mined/Left" & "Percentage to reset" accuracy.
    Holograms:
        Timer: 10 # Seconds (POSSIBLE PERFORMANCE BOOST)
        # Not using Mines built in hologram system? (You... you should be.) Disable this! (Set it to 0)
        #
        # Changing this affects how often all the Mines holograms are updated.
    Signs:
        Timer: 1 # Seconds (POSSIBLE PERFORMANCE BOOST)
        # Not using Mine Signs? Disable this!
        #
        # This timer affects when Mine Signs are updated.
        Enable-Reset-Signs-Cooldown: true # Not using any Mine reset signs? Disable this! (POSSIBLE PERFORMANCE BOOST)

Performance-Focused: true
# Enabling this makes the main mine resetting event go into async mode. (More efficient)
# Note: Enabling this will cause Mines to completely ignore both the 'MinePreResetEvent' & 'MinePostResetEvent'
# If you don't even know what these two events are or what they're used for, I'd highly suggest leaving this option enabled.
# Also, changing this requires the plugin to be completely restarted. (Server reboot recommended)

Settings:
    Check-For-Updates: true
    Mine-Fly-Height: 3
    # The amount of blocks above a mine that mine fly will cut off at.
    Mine-Effects-Height: 3
    # The amount of blocks above a mine that the mines effects will work within'.
    Broadcast-Mines-Resetting: false
    # true = All mines will broadcast that they reset & alert players that are teleported out of them.
    # false = No broadcasts & no player teleport message alerts.
    Allow-Block-Breaking-While-Mines-Reset: true

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♠'
        # Placeholders you can use in your Mine Hologram or Messages:
        # %name% - Name of the Mine.
        # %blocksbroken% - Amount of blocks currently broken in the Mine. **
        # %blocksleft% - Amount of blocks currently left in the Mine. **
        # %percentbroken% - Percentage of the currently broken blocks in the Mine. **
        # %percentleft% - Percentage of the currently remaining blocks in the Mine. **
        # %percentbrokentoreset% - The percentage of the percent broken amount for the Mine to reset. **
        # %percentlefttoreset% - The percentage of the percent left amount for the Mine to reset. **
        # %resetpercent% - Alias for %percentbrokentoreset%. **
        # %blocksprogressbar% - The progress bar of the percentage for the Mine. **
        # %timeuntilreset% - The amount of time until the Mine resets.
        # %highestblockname% - Outputs the string of the material type of the block with the highest % for the Mine.
        # %resetinterval% - The reset interval (in ticks) for the Mine.
        # %resettype% - The type of reset (Instant or Gradual).
        # %resetspeed% - The speed setting used during Gradual resets (FAST, MAX, etc.).
        # %flyenabled% - Returns true or false depending on whether flight is allowed in the Mine.
        # %isresetting% - Returns true if the Mine is currently resetting, otherwise false.
        # %position% - The position of this Mine in the reset queue.
        # %empty% - An invisible line in the hologram so you don't see an empty line of text.

        # ** = Only works when PercentageTask is enabled (NOT a PlaceholderAPI placeholder)

        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 # The amount of blocks the default hologram is raised above the Mine.
    PlaceholderAPI:
        Progress-Bar:
            Bars:
                Symbol: ':'
                Amount: 10
                Colors:
                    Empty: '&7'
                    Full: '&a'
            Prefix: '&8['
            Suffix: '&8]'
        Time-Until-Reset:
            Use-Shortened-Format: true
            # Enabled = 42s
            # Disabled = 0h 0m 42s

# Configuration for Mine signs
Sign:
  Messages:
    Cooldown: "&bᴍɪɴᴇꜱ &fYou must wait &b%cooldown% &fbefore trying to reset &b%mine% &fmine"
    Reset: "&bᴍɪɴᴇꜱ &fYou have reset &b%mine% &fmine."
    Invalid Mine: "&bᴍɪɴᴇꜱ &fSorry, but the mine &b%mine% &fno 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ᴍɪɴᴇꜱ"