LagCleaner

# LagCleaner - entity limits, item merging, a timed sweep, and a hotspot finder.
#
# Everything that deletes something is careful on purpose: named, tamed, leashed and ridden
# entities are skipped, the sweep only touches items that have been lying around, and the throttles
# that change how farms behave are off until you turn them on.

# Bare /lagcleaner opens the panel instead of printing the numbers.
menu: true

# Worlds this plugin leaves completely alone.
ignored-worlds: []

limits:
  every-ticks: 200            # how often the chunks are checked (200 = ten seconds)
  items-per-chunk: 64         # 0 turns the limit off
  mobs-per-chunk: 48
  other-per-chunk: 32         # armour stands, minecarts, boats, projectiles
  only-below-tps: false       # true = only enforce when the server is actually struggling
  tps-threshold: 18.0

merge:
  enabled: true
  every-ticks: 100
  radius: 3.0                 # blocks between two stacks that should become one
  max-stack: 0                # 0 = the item's own stack size

sweep:
  enabled: true
  every-minutes: 15           # 0 turns the timer off
  announce: true
  warn-seconds: [60, 30, 10, 5]
  min-age-ticks: 200          # an item has to have lain there ten seconds before a sweep takes it
  # A boss bar that counts down the last seconds before a timed sweep. false hides it.
  boss-bar: true
  boss-bar-seconds: 30        # how long before the sweep the bar appears
  boss-bar-colour: YELLOW     # PINK, BLUE, RED, GREEN, YELLOW, PURPLE, WHITE

# What is never removed, whatever a chunk looks like.
protect:
  named: true                 # anything with a custom name
  tamed: true
  leashed: true
  carrying-passengers: true
  types: [ARMOR_STAND, ITEM_FRAME, GLOW_ITEM_FRAME, PAINTING, END_CRYSTAL]
  items: [NETHER_STAR, DRAGON_EGG, ELYTRA, TOTEM_OF_UNDYING, BEACON, SHULKER_BOX]

# These change how machines behave, so they are off. Turn one on only when a farm is the problem.
throttle:
  hopper-moves-per-chunk-per-second: 0
  redstone-changes-per-chunk-per-second: 0
  spawner-mobs-per-chunk-per-second: 0

hotspots:
  report-above: 25            # a chunk needs this many entities before it is worth listing

# ------------------------------------------------------------------------------------------------
# THEME
# ------------------------------------------------------------------------------------------------
# Every message below is written against these names, not against hex codes: <accent>Open</accent>
# rather than <#7ed957>Open</#7ed957>. Change a colour here and it changes on every screen at
# once. Ordinary MiniMessage still works, so <gradient:#a:#b> and <#ff0000> are fine anywhere.
theme:
  accent: "#7ed957"     # your colour: headings and anything the player is meant to click
  accent2: "#b8eaa3"    # a lighter accent, for a second level of emphasis
  title: "#f4f7ff"      # screen titles
  text: "#c2ccdd"       # ordinary prose
  muted: "#6b7a94"      # hints, separators, anything the eye should skip
  value: "#ffffff"      # the numbers and names the player opened the screen to read
  good: "#57e08a"
  warn: "#ffc857"
  bad: "#ff6b6b"
  small-caps: false     # ᴇхᴀᴍᴘʟᴇ - a garnish; whole menus in it read badly
  # Real Minecraft item pictures beside the buttons and in the chest screens. Drawn from the
  # client's own textures, so there is nothing to install and no resource pack: it needs a
  # 1.21.9 or newer client, and older ones simply see the buttons as words.
  item-icons: true

messages:
  prefix: "<accent><bold>Lag</bold></accent> <muted>»</muted> "
  no-permission: "<bad>You cannot do that.</bad>"
  reloaded: "<value>Config reloaded.</value>"
  never: "never"
  help: "<text>/lagcleaner · status · hotspots · sweep · trim · reload</text>"
  sweep-warning: "<text>Dropped items are cleared in </text><value>{seconds}s</value><text>. Pick up what you want.</text>"
  sweep-bar: "<warn>Dropped items are cleared in </warn><value>{seconds}s</value>"
  sweep-done: "<text>Cleared </text><value>{count}</value><text> dropped item(s).</text>"
  swept: "<text>Cleared </text><value>{count}</value><text> item(s).</text>"
  trimmed: "<text>Removed {items} item(s) and {mobs} entity(s), merged {merged} stack(s).</text>"

  # The panel. Every line here is a screen title, a button label or a tooltip.
  # The icon rows: a small item beside a bold name and a grey line, so the panel can be scanned.
  row-world: "<accent><bold>{world}</bold></accent>"
  row-world-detail: "<text>{items} items · {mobs} mobs · {other} other · {chunks} chunks</text>"
  row-sweep: "<accent><bold>Next sweep</bold></accent>"
  row-sweep-detail: "<text>in {time}</text>"
  row-removed: "<accent><bold>Cleaned up</bold></accent>"
  row-removed-detail: "<text>{items} items, {mobs} mobs, {merged} stacks merged</text>"
  menu-title: "<value>LagCleaner</value>"
  menu-close: "<white><icon:close></white><text>Close</text>"
  menu-back: "<white><icon:back></white><text>Back</text>"
  menu-back-tip: "<text>Back to the first screen.</text>"
  menu-tps: "<text>Server at </text><value>{tps} TPS</value><text> · {chunks} chunk(s) hitting a throttle</text>"
  menu-world: "<value>{world}</value><text>: {items} items · {mobs} mobs · {other} other · {chunks} chunks loaded</text>"
  menu-next-sweep: "<text>Next sweep in </text><value>{time}</value>"
  menu-removed: "<text>Since the last reset: {items} items and {mobs} entities removed, {merged} stacks merged</text>"
  menu-hotspots: "<white><icon:compass></white><accent>Hotspots</accent>"
  menu-hotspots-tip: "<text>The busiest chunks on the server.</text>"
  menu-hotspots-title: "<value>Hotspots</value>"
  menu-spot: "<value>{world} {x},{z}</value><text> · {total} entities · mostly {worst}</text>"
  menu-spot-go: "<white><icon:teleport></white><value>Go to {x},{z}</value>"
  menu-spot-go-tip: "<text>Teleport above that chunk.</text>"
  menu-no-spots: "<text>No chunk is busy enough to worry about.</text>"
  menu-sweep: "<white><icon:clean></white><value>Clear dropped items now</value>"
  menu-sweep-tip: "<text>Runs the sweep at once, with its warning.</text>"
  menu-trim: "<white><icon:clean></white><value>Trim and merge now</value>"
  menu-trim-tip: "<text>Bring every chunk back under its limits.</text>"
  menu-reset: "<white><icon:dot></white><text>Reset the counters</text>"
  menu-reset-tip: "<text>Start counting removals again from zero.</text>"
  menu-reload: "<white><icon:reload></white><text>Reload config</text>"
  menu-reload-tip: "<text>Read config.yml again.</text>"
  switch-sweep: "Timed sweep"
  switch-sweep-tip: "<text>The clear on a timer, with its warnings.</text>"
  switch-sweep-bar: "Sweep countdown bar"
  switch-sweep-bar-tip: "<text>A boss bar counts down the last seconds before the sweep.</text>"
  switch-merge: "Item merging"
  switch-merge-tip: "<text>Two stacks of the same thing become one.</text>"
  switch-on: "<white><icon:yes></white><good><bold>ON</bold></good>  <value>{title}</value>"
  switch-off: "<white><icon:no></white><bad><bold>OFF</bold></bad> <text>{title}</text>"

# One thank-you line with the BuiltByBit review link: once in the console after install and once
# in chat for the first operator who joins. It never repeats and sends nothing anywhere. false turns it off.
review-reminder: true