Default config.yml

#      __________                      _________ __                 __                 
#      \______   \ ____  ______ ____  /   _____//  |______    ____ |  | __ ___________ 
#       |       _//  _ \/  ___// __ \ \_____  \\   __\__  \ _/ ___\|  |/ // __ \_  __ \
#       |    |   (  <_> )___ \\  ___/ /        \|  |  / __ \\  \___|    <\  ___/|  | \/
#       |____|_  /\____/____  >\___  >_______  /|__| (____  /\___  >__|_ \\___  >__|   
#              \/           \/     \/        \/           \/     \/     \/    \/       

# The locale to use in the /locale folder
# Default: en_US
locale: en_US

# A list of worlds that the plugin is disabled in
disabled-worlds:
  - disabled_world_name

# How often should we try to stack nearby entities?
# Higher values mean longer times between checks, but also less lag
# If you are having issues with TPS, increase this value
# Values are in ticks, do not set lower than 1
# Default: 20
stack-frequency: 20

# How often should we update stacked entity nametags?
# Default: 10
nametag-update-frequency: 10

# Global entity settings
# Changed values in entity_settings.yml will override these values
global-entity-settings:

  # Should entity stacking be enabled at all?
  # Default: true
  stacking-enabled: true

  # The minimum number of nearby entities required to form a stack
  # Do not set this lower than 2
  # Default: 2
  min-stack-size: 2

  # The maximum number of entities that can be in a single stack
  # Default: 128
  max-stack-size: 128

  # How close do entities need to be to merge with each other?
  # Default: 5
  merge-radius: 5

  # Should we merge all similar entities into a single stack per chunk?
  # This setting overrides the above
  # Default: false
  merge-entire-chunk: false

  # Should tags be displayed above stacks to show their amount and type?
  # Default: true
  display-tags: true

  # Should tags be displayed if the stack only has one entity?
  # Default: false
  display-tags-single: false

  # Do stacks need to be hovered over for their tags to be visible?
  # Default: false
  display-tags-hover: false

  # Should the entity custom name be visible with the stack size?
  # Default: true
  display-tags-custom-name: true

  # Should the entire stack of entities always be killed when the main entity dies?
  # Default: false
  kill-entire-stack-on-death: false

  # Under what conditions should the entire stack be killed when the main entity dies?
  # If kill-entire-stack-on-death is true, this setting will not be used
  # Valid conditions can be found here:
  # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.DamageCause.html
  kill-entire-stack-on-death-conditions:
    - FALL

  # Should knockback be transferred to the next entity in the stack?
  # Default: true
  kill-transfer-velocity: true

  # Should items be dropped for all entities when an entire stack is killed at once?
  # Default: true
  drop-accurate-items: true

  # Should exp be dropped for all entities when an entire stack is killed at once?
  # Default: true
  drop-accurate-exp: true

  # Should entity attributes (custom max health, custom damage, etc.) be saved in the stack data?
  # Disabled by default, as it increases the database size to have this enabled
  # Default: false
  save-attributes: false

  # Should newly stacked entities be put on the bottom of the stack?
  # Default: false
  stack-to-bottom: false

  # Do entities need to be able to see each other to be able to stack?
  # Setting this to true will prevent entities from stacking through walls
  # Default: true
  require-line-of-sight: true

  # Should the entire stack of entities be transformed when the main entity is transformed?
  # This applies to pigs getting struck by lightning, zombies drowning, etc
  # Default: true
  transform-entire-stack: true

  # Do entities have to be on the ground in order to stack?
  # This does not apply if the mobs can fly or live in the water
  # Default: false
  only-stack-on-ground: false

  # Should we stack entities if they are in the water?
  # This does not apply if the mobs can fly or live in the water
  # Default: false
  dont-stack-if-in-water: false

  # Should we stack entities if they are leashed?
  # You will still be able to leash stacks, it will just prevent them from stacking into other stacks
  # This can cause some weird effects if disabled
  # Default: true
  dont-stack-if-leashed: true

  # Should we stack entities if they are invulnerable?
  # Default: true
  dont-stack-if-invulnerable: true

  # Should we avoid stacking entities with custom names?
  # Default: false
  dont-stack-custom-named: false

  # Should flying mobs always be stacked downwards?
  # This is useful for mob grinders
  # Default: false
  stack-flying-downwards: false

  # Should we only stack entities spawned from spawners?
  # Default: false
  only-stack-from-spawners: false

  # Should an entity death event be triggered for each mob in a stack?
  # If you use custom drops plugins, make sure to enable this
  # Note to developers: The death events are asynchronous
  # Default: false
  trigger-death-event-for-entire-stack-kill: false

# Global item settings
# Changed values in item_settings.yml will override these values
global-item-settings:

  # Should item stacking be enabled at all?
  # Default: true
  stacking-enabled: true

  # The maximum number of items that can be in a single stack
  # Default: 1024
  max-stack-size: 1024

  # How close do items need to be to merge with each other?
  # Default: 2.5
  merge-radius: 2.5

  # Should tags be displayed above stacks to show their amount and type?
  # Default: true
  display-tags: true

  # Should tags be displayed if the stack only has one item?
  # Default: false
  display-tags-single: false

  # Should items with custom names be shown on their tags?
  # Default: true
  display-custom-names: true

  # Should the color of custom names be shown on their tags?
  # Default: true
  display-custom-names-color: true

  # Should items with a custom name always display their tags?
  # This mirrors vanilla behavior
  # Default: true
  display-custom-names-always: true

# Global block settings
# Changed values in block_settings.yml will override these values
global-block-settings:

  # Should block stacking be enabled at all?
  # Default: true
  stacking-enabled: true

  # The maximum number of blocks that can be in a single stack
  # Default: 2048
  max-stack-size: 2048

  # Should tags be displayed above stacks to show their amount and type?
  # Default: true
  display-tags: true

  # Should stacked blocks be protected from explosions?
  # Default: true
  explosion-protection: true

  # If enabled, only the stack size will decrease from explosions, no items will be dropped
  # Default: true
  explosion-decrease-stack-size-only: true

  # The percentage chance of blocks getting destroyed from an explosion (0-100)
  # Default: 10.0
  explosion-destroy-chance: 10.0

  # The percentage of blocks in the stack that will be destroyed from an explosion
  # If a stack of 10 blocks is exploded with a chance of 50.0, 5 blocks will be saved
  # Default: 50.0
  explosion-amount-percentage: 50.0

  # The fixed amount of blocks in the stack to destroy
  # If this is set to 1 or greater, overrides explosion-amount-percentage
  # If a stack of 10 blocks is exploded with a fixed amount of 3, 7 blocks will be saved
  # Default: -1
  explosion-amount-fixed: -1

  # Should blocks be dropped directly into the player's inventory when broken?
  # Default: false
  drop-to-inventory: false

  # Should the entire stack be broken if the player is sneaking?
  # Default: true
  break-entire-stack-while-sneaking: true

  # Should the entire stack be broken into individual blocks?
  # Default: true
  break-entire-stack-into-separate: true

  # Should a GUI to edit the stack open when the player shift-right-clicks the stack?
  # Default: true
  gui-enabled: true

  # What material should be used for the border of the GUI?
  # If you want no border, set it to AIR
  # Default: BLUE_STAINED_GLASS_PANE
  gui-border-material: BLUE_STAINED_GLASS_PANE

# Global spawner settings
# Changed values in spawner_settings.yml will override these values
global-spawner-settings:

  # Should spawner stacking be enabled at all?
  # Default: true
  stacking-enabled: true

  # The maximum number of spawners that can be in a single stack
  # Default: 32
  max-stack-size: 32

  # Should tags be displayed above stacks to show their amount and type?
  # Default: true
  display-tags: true

  # Should tags be displayed if the stack only has one spawner?
  # Default: false
  display-tags-single: false

  # Should mob AI be disabled for mobs spawned by spawners?
  # If you enable this, it is highly recommended to enable global-entity-settings.save-attributes
  # Enabling attribute saving will make sure all mob AIs get disabled properly
  # Default: false
  disable-mob-ai: false

  # How many random blocks should we check to spawn a mob before giving up?
  # Default: 50
  max-failed-spawn-attempts: 50

  # Should spawners turn off when powered by redstone?
  # Default: false
  deactivate-when-powered: false

  # Should spawners be protected from explosions?
  # Default: true
  explosion-protection: true

  # If enabled, only the stack size will decrease from explosions, no items will be dropped
  # Default: true
  explosion-decrease-stack-size-only: true

  # The percentage chance of spawners getting destroyed from an explosion (0-100)
  # Default: 10.0
  explosion-destroy-chance: 10.0

  # The percentage of spawners in the stack that will be destroyed from an explosion
  # If a stack of 10 spawners is exploded with a chance of 50.0, 5 blocks will be saved
  # Default: 50.0
  explosion-amount-percentage: 50.0

  # The fixed amount of spawners in the stack to destroy
  # If this is set to 0 or greater, overrides explosion-amount-percentage
  # If a stack of 10 spawners is exploded with a fixed amount of 3, 7 blocks will be saved
  # Default: -1
  explosion-amount-fixed: -1

  # Should spawners be dropped directly into the player's inventory when broken?
  # Default: false
  drop-to-inventory: false

  # Should the entire stack be broken if the player is sneaking?
  # Default: true
  break-entire-stack-while-sneaking: true

  # Should the entire stack be broken into individual spawners?
  # Default: false
  break-entire-stack-into-separate: false

  # Should silk touch be required to pick up spawners?
  # Default: false
  silk-touch-required: false

  # The chance that spawners will be picked up with a silk touch tool
  # Default: 100
  silk-touch-chance: 100

  # Should silk touch of level II or higher be guaranteed to pick up the spawner?
  # Default: true
  silk-touch-guarantee: true

  # Should the permission rosestacker.silktouch be required
  # to be able to pick up spawners with silk touch?
  # Default: false
  silk-touch-require-permission: false

  # Should spawners be protected from being destroyed without silk touch?
  # A message will be sent to the player explaining why it cannot be broken
  # Default: false
  silk-touch-protect: false

  # Should the same number of spawn eggs as the spawner stack be required for conversion?
  # Default: false
  convert-require-same-amount: false

  # How many mobs should spawn per stacked spawner?
  # Default: 4
  spawn-count-stack-size-multiplier: 4

  # Should the amount of mobs spawned be randomized between the stack size and the max spawn amount?
  # Default: true
  spawn-count-stack-size-randomized: true

  # The minimum number of ticks between spawn attempts
  # Default: 200
  spawn-delay-minimum: 200

  # The maximum number of ticks between spawn attempts
  # Default: 800
  spawn-delay-maximum: 800

  # If more than this number of entities are near the spawner, it will not spawn anything
  # This only counts the individual mobs, and not the stack size
  # Can be overridden for each spawner type using the max-nearby-entities:# spawn requirement
  # Default: 6
  spawn-max-nearby-entities: 6

  # How close do players need to be to activate the spawner?
  # Default: 16
  spawn-player-activation-range: 16

  # How far away can entities be spawned from the spawner?
  # Default: 4
  spawn-range: 4

  # Should a GUI to view the spawner information open when the player shift-right-clicks the stack?
  # Default: true
  gui-enabled: true

  # How often should the time before next spawn message be updated?
  # Value is measured in ticks, do not go below 1
  # Default: 2
  gui-tick-update-rate: 2

  # What material should be used for the border of the GUI?
  # Default: GRAY_STAINED_GLASS_PANE
  gui-border-material: GRAY_STAINED_GLASS_PANE

  # What material should be used for the top right and bottom left corners of the GUI?
  # Default: LIGHT_BLUE_STAINED_GLASS_PANE
  gui-border-corner-material: LIGHT_BLUE_STAINED_GLASS_PANE

  # What material should be used for the corner accents of the GUI?
  # Default: BLUE_STAINED_GLASS_PANE
  gui-border-accent-material: BLUE_STAINED_GLASS_PANE

  # What material should the spawner stats icon be?
  # Default: BOOK
  gui-spawner-stats-material: BOOK

  # What material should the central icon be?
  # Default: SPAWNER
  gui-central-material: SPAWNER

  # What material should the valid spawn conditions icon be?
  # Default: EMERALD_BLOCK
  gui-valid-spawn-conditions-material: EMERALD_BLOCK

  # What material should the invalid spawn conditions icon be?
  # Default: REDSTONE_BLOCK
  gui-invalid-spawn-conditions-material: REDSTONE_BLOCK

# Settings that apply to the tags above stacks
# These settings require their respective display-tags settings to be set to true to function
# These settings run at the same frequency as the stack-frequency setting
# If you are seeing impacts to server performance, consider disabling these settings
dynamic-tag-settings:

  # Should entity tags be hidden when the player is a certain distance away?
  # Note: This overrides global-entity-settings.display-tags-hover if enabled
  # Default: true
  entity-dynamic-tag-view-range-enabled: true

  # Should item tags be hidden when the player is a certain distance away?
  # Default: true
  item-dynamic-tag-view-range-enabled: true

  # Should block/spawner tags be hidden when the player is a certain distance away?
  # Default: true
  block-dynamic-tag-view-range-enabled: true

  # How far away should a player be able to see entity tags?
  # Default: 32
  entity-dynamic-tag-view-range: 32

  # How far away should a player be able to see item tags?
  # Default: 32
  item-dynamic-tag-view-range: 32

  # How far away should a player be able to see block/spawner tags?
  # Default: 32
  block-dynamic-tag-view-range: 32

  # Should entity tags be hidden if they are out of view?
  # Default: true
  entity-dynamic-tag-view-range-wall-detection-enabled: true

  # Should item tags be hidden if they are out of view?
  # Default: true
  item-dynamic-tag-view-range-wall-detection-enabled: true

  # Should block/spawner tags be hidden if they are out of view?
  # Default: true
  block-dynamic-tag-view-range-wall-detection-enabled: true

# Settings that apply to the item given from '/rs stacktool'
stack-tool-settings:

  # The material of the stacking tool
  # Default: STICK
  material: STICK

  # The name to display on the stacking tool
  # Default: <g:#ed3737:#ffaf3e>Stacking Tool
  name: <g:#ed3737:#ffaf3e>Stacking Tool

  # The lore to display on the stacking tool
  lore:
    - '&bLeft Click:'
    - '&7- &eSelect two mobs to test if they can stack together.'
    - '&bShift Left Click:'
    - '&7- &eView stack details, works on all stack types.'
    - '&bRight Click:'
    - '&7- &eToggle if a mob is stackable or not.'
    - '&bShift Right Click:'
    - '&7- &eMark an entire entity stack as unstackable.'
    - '&7- &eThis will cause everything to unstack.'
    - '&bWhile Held:'
    - '&7- &eA particle will appear above nearby mobs.'
    - '&7- &aGreen &emeans the mob can stack.'
    - '&7- &cRed &emeans the mob can not stack.'

# Miscellaneous other settings for the plugin
misc-settings:

  # If CoreProtect is installed, should we log stacked block/spawner break/placing?
  # Default: true
  coreprotect-logging-enabled: true

  # If Clearlag is installed, should we clear stacked entities?
  # Default: true
  clearlag-clear-entities: true

  # If Clearlag is installed, should we clear stacked items?
  # Default: true
  clearlag-clear-items: true

  # Should single mobs be removed with `/rs clearall`?
  # This will also affect the clearlag-clear-entities setting above
  # Default: false
  clearall-remove-single: false

# Settings for if you want to use MySQL for data management
mysql-settings:

  # Enable MySQL
  # If false, SQLite will be used instead
  # Default: false
  enabled: false

  # MySQL Database Hostname
  # Default: 
  hostname: ''

  # MySQL Database Port
  # Default: 3306
  port: 3306

  # MySQL Database Name
  # Default: 
  database-name: ''

  # MySQL Database User Name
  # Default: 
  user-name: ''

  # MySQL Database User Password
  # Default: 
  user-password: ''

  # If the database connection should use SSL
  # You should enable this if your database supports SSL
  # Default: false
  use-ssl: false

# That's everything! You reached the end of the configuration.
# Enjoy the plugin!