[![Discord](https://img.shields.io/badge/Discord-dc.gg%2Fpaperstream-5865F2?style=flat-square&logo=discord&logoColor=white)](https://dc.gg/paperstream) [![Release](https://img.shields.io/modrinth/v/clearlaggg?style=flat-square&label=release&color=00AF5C)](https://modrinth.com/plugin/clearlaggg/versions) [![Downloads](https://img.shields.io/modrinth/dt/clearlaggg?style=flat-square&label=downloads&color=00AF5C)](https://modrinth.com/plugin/clearlaggg) [![Servers](https://img.shields.io/bstats/servers/32979?style=flat-square&label=servers&color=1E90FF)](https://bstats.org/plugin/bukkit/ClearLAGGG/32979) [![License](https://img.shields.io/badge/license-GPL--3.0-blue?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.txt) [![Built with Java 21](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/built-with/java21_vector.svg)](https://adoptium.net/) [![Available for Paper](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/paper_vector.svg)](https://papermc.io/) [![Available for Purpur](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/purpur_vector.svg)](https://purpurmc.org/) [![Available for Spigot](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/spigot_vector.svg)](https://www.spigotmc.org/) [![Available for Bukkit](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/bukkit_vector.svg)](https://dev.bukkit.org/) [![Chat with us on Discord](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/social/discord-plural_vector.svg)](https://dc.gg/paperstream) [![Available on Codeberg](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/available/codeberg_vector.svg)](https://codeberg.org/LucasTHCR/ClearLAGGG)

# ClearLAGGG A lag-reduction plugin for Paper servers. It targets the usual suspects behind poor tick times: runaway entity counts, spawner farms, mob-egg spam, uncontrolled breeding, dropped items that never expire, and TNT chain reactions. On top of the limiters it ships the monitoring tools you need to find out what is actually costing you ticks: TPS/RAM tracking, chunk analysis, a tick sampler and a memory sampler. The design goal is prevention rather than brute force. Clearing entities every five minutes hides the symptom; the limiters keep the entities from piling up in the first place. ## Requirements - Paper (or a fork) on Minecraft 1.21+ - Java 21 PlaceholderAPI is optional. If it is installed, ClearLAGGG registers its placeholders automatically; if not, everything else works unchanged. ## Commands All commands live under `/lagg` (aliases: `/clearlag`, `/clearlagg`, `/clearlaggg`). | Command | Description | | --- | --- | | `/lagg clear` | Remove the entity types configured under `entity-clear` | | `/lagg check` | Show world and chunk information | | `/lagg killmobs` | Kill the mob types configured under `kill-mobs` | | `/lagg area ` | Remove non-player entities within a radius | | `/lagg tpchunk [world]` | Teleport to a chunk by its coordinates | | `/lagg tps` | Show estimated TPS over 5s, 1m and 5m | | `/lagg memory` | Watch heap usage in realtime | | `/lagg performance` | Watch main-thread usage in realtime | | `/lagg sampleTicks [raw]` | Sample tick durations and report spikes | | `/lagg sampleMemory ` | Sample memory usage and collector timings | | `/lagg profile ` | Profile server activity | | `/lagg unloadchunks` | Attempt to unload chunks | | `/lagg halt` | Temporarily halt basic server functions | | `/lagg admin [module]` | Enable or disable individual modules at runtime | | `/lagg reload` | Reload the configuration | Each subcommand has a matching permission (`lagg.clear`, `lagg.check`, and so on), all defaulting to op. `lagg.*` grants everything. `lagg.notify` controls who receives the automatic threshold notifications. ## Configuration `config.yml` is split into one section per feature, each documented inline: - `settings` - prefix, language, update checks, startup banner - `entity-clear` / `kill-mobs` - what gets removed, on which schedule, with warnings - `limiters` - per-chunk and per-world entity caps - `spawner-limiter`, `mob-egg-limiter`, `breeding-limiter` - caps on the common farm exploits - `item-livetime` - per-item despawn times - `tnt` - chain-reaction and block-damage limits - `chunk-analysis`, `chunk-unloader` - finding and unloading expensive chunks - `ai-limiter` - distance-based mob AI throttling - `tps-meter` - run commands when TPS or RAM crosses a threshold - `tick-sampler`, `memory-sampler`, `profiler` - the measurement tools - `halt` - what `/lagg halt` actually freezes Twelve languages ship in `lang/`; pick one with `settings.language`. `tps-meter` triggers are opt-in. No trigger is enabled by default, so ClearLAGGG will not broadcast anything to your players unless you configure it to. ## Placeholders Available when PlaceholderAPI is installed: ``` %clearlaggg_tps% %clearlaggg_entities_world% %clearlaggg_tps_colored% %clearlaggg_entities_total% %clearlaggg_ram_used% %clearlaggg_chunks_loaded% %clearlaggg_ram_max% %clearlaggg_last_clear_amount% %clearlaggg_ram_percent% %clearlaggg_halted% ``` ## Building ```bash mvn clean package ``` The shaded jar lands in `target/clearlaggg-1.1-RELEASE.jar`. bStats is shaded and relocated into `de.empireblocks.clearlaggg.libs.bstats`; paper-api and PlaceholderAPI are `provided` and stay out of the jar. ## License GNU General Public License v3.0. See [LICENSE](LICENSE).