[![bStats](https://bstats.org/signatures/bukkit/ClearLAGGG.svg)](https://bstats.org/plugin/bukkit/ClearLAGGG/32979) # Clearlagg ### *Prevention, not brute force.* > Full control over every source of entity, spawner, TNT and redstone lag on your server — lightweight, fully configurable down to the last message, and built to disappear from your timings report. --- ## ✨ Features | Feature | Description | |---|---| | **Entity Clearing** | Scheduled or on-demand clears, per-entity-type, with named/leashed/tamed protection. | | **Mob Killing** | Separate configurable kill-list, independent from the entity clearer. | | **Per-chunk Entity Limiter** | Hard caps per entity type, enforced live before they ever pile up. | | **Mob Spawner Limiter** | Caps spawners within a radius, force-sets delay & activation range. | | **Mob Egg Limiter** | Per-player, per-world cooldown-based cap on spawn-egg usage. | | **Breeding Limiter** | Caps breedable animals per chunk to stop farm-lag before it starts. | | **Per-item Live-time** | Custom despawn timers per material — keep valuables, clear junk faster. | | **TNT Lag Reduction** | Caps primed TNT per chunk, limits chain reactions, trims oversized explosions. | | **Hopper & Redstone Limiters** | Per-chunk caps on hopper transfers and redstone activity. | | **AI Limiter** | Reduces pathfinding/AI cost for mobs far from any player. | | **TPS/RAM Meter** | Background monitor that can execute commands when thresholds are crossed. | | **GC Monitoring** | Live JVM garbage-collection pause detection, straight from `com.sun.management`. | | **Full-tick Sampler** | Samples raw tick durations and flags spikes. | | **Memory Sampler & Profiler** | Heap-over-time sampling plus a lightweight chunk-activity profiler. | | **Halt Mode** | Temporarily suspends mob spawning, hopper transfer, redstone, fluid flow or item merging. | | **Module Admin** | Enable/disable every module live via command, no restart needed. | | **Destructive-command Confirmation** | Clear/killmobs/area/unloadchunks/gc require a confirming second run. | | **PlaceholderAPI Support** | 10 placeholders for TPS, RAM, entity counts and halt state. | | **12 Languages** | Fully translatable, with automatic fallback to English for missing keys. | | **Everything's configurable** | Every message, threshold, limit and interval lives in `config.yml`. | --- ## 📦 Dependencies - **Paper 1.21.x** — `required` — [papermc.io](https://papermc.io/) - **PlaceholderAPI** — `optional` — [Modrinth](https://modrinth.com/plugin/placeholderapi) --- ## 🔧 How It Works Clearlagg doesn't wait for your server to already be lagging — every limiter runs **at the point of creation**: a spawner placement, a bred animal, a primed TNT, a spawned item. If it would exceed your configured limit, it's stopped or removed immediately, instead of building up until a scheduled clear has to nuke half your world's entities at once. On top of that, a periodic scan sweeps loaded chunks for the entity-limiter and refreshes "never despawn" items, while the **TPS/RAM meter** watches server health continuously and can fire your own console commands the moment a threshold is crossed — including running `/lagg clear` automatically under critical load. **Halt mode** gives you an emergency lever: instantly suspend the systems you choose (mob spawning, hopper transfer, redstone, fluid flow, item merging) with one command, and resume just as fast. --- ## ⚙️ Configuration ```yaml # ===================================================================== # Clearlagg Configuration # Full control over every module. Disable anything you don't need - # Clearlagg only activates the systems you enable, so it stays # extremely lightweight on a stock configuration. # ===================================================================== settings: prefix: "&8[&bClearlagg&8] &7" language: "english" # english, german, french, spanish, russian, polish, # czech, japanese, korean, brazilianportuguese, # chinesesimplified, chinesetraditional startup-banner: true clean-logs-on-startup: enabled: false older-than-days: 14 entity-clear: enabled: true auto-clear-interval: 600 warn-before-clear: enabled: true warn-seconds-before: 10 excluded-worlds: [] entities: DROPPED_ITEM: true ARROW: true EGG: true SNOWBALL: true ignore-named-entities: true ignore-leashed-entities: true ignore-tamed-entities: true limiters: enabled: true scan-interval-ticks: 100 entity-limiter: enabled: true per-chunk-limits: DROPPED_ITEM: 40 ARROW: 20 default-limit: -1 mob-limiter: enabled: true per-chunk-limit: 25 prevent-spawns-at-limit: true tnt: enabled: true max-primed-per-chunk: 25 chain-reaction-radius-limit: 0 max-blocks-per-explosion: 500 disable-block-damage: false halt: enabled: true disable: mob-spawning: true hopper-transfer: true redstone: false fluid-flow: false item-merging: false commands: confirm-destructive-commands: true confirmation-window-seconds: 10 destructive-commands: ["clear", "killmobs", "area", "unloadchunks", "gc"] # ... every module (spawner-limiter, mob-egg-limiter, breeding-limiter, # item-livetime, chunk-analysis, chunk-unloader, ai-limiter, tps-meter, # gc-monitor, tick-sampler, memory-sampler, profiler) has its own fully # documented section in config.yml — nothing is hardcoded. ``` --- ## 🔑 Commands | Command | Permission | Default | |---|---|---| | `/lagg clear` | `lagg.clear` | OP | | `/lagg check [world1, world2...]` | `lagg.check` | OP | | `/lagg reload` | `lagg.reload` | OP | | `/lagg killmobs` | `lagg.killmobs` | OP | | `/lagg area ` | `lagg.area` | OP | | `/lagg tpchunk [world]` | `lagg.tpchunk` | OP | | `/lagg admin [module]` | `lagg.admin` | OP | | `/lagg gc` | `lagg.gc` | OP | | `/lagg tps` | `lagg.tps` | OP | | `/lagg halt` | `lagg.halt` | OP | | `/lagg sampleMemory ` | `lagg.samplememory` | OP | | `/lagg sampleTicks [raw]` | `lagg.sampleticks` | OP | | `/lagg unloadchunks` | `lagg.unloadchunks` | OP | | `/lagg profile ` | `lagg.profile` | OP | | `/lagg memory` | `lagg.memory` | OP | | `/lagg performance` | `lagg.performance` | OP | | — | `lagg.notify` | OP — receives GC/threshold notifications | --- ## 📋 Placeholders Requires [PlaceholderAPI](https://modrinth.com/plugin/placeholderapi) to be installed. | Placeholder | Description | |---|---| | `%clearlagg_tps%` | Current estimated TPS | | `%clearlagg_tps_colored%` | TPS with a color code based on health | | `%clearlagg_ram_used%` | Used RAM in MB | | `%clearlagg_ram_max%` | Max RAM in MB | | `%clearlagg_ram_percent%` | Used RAM as a percentage | | `%clearlagg_entities_world%` | Live entity count in the player's world | | `%clearlagg_entities_total%` | Live entity count across all worlds | | `%clearlagg_chunks_loaded%` | Loaded chunk count in the player's world | | `%clearlagg_last_clear_amount%` | Amount removed by the last `/lagg clear` | | `%clearlagg_halted%` | `true`/`false` whether halt mode is active | --- ## 👥 Credits | | | |---|---| | **LucasTHCR** | Creator & maintainer | Discord: [dc.gg/paperstream](https://dc.gg/paperstream)

ClearLAGG

1.1-RELEASE