X-Clearlag

📄 Description

X-ClearLag is the ultimate, professional-grade entity management solution for modern servers. Completely rebuilt from the ground up, it offers native Folia compatibility, wall-clock precision tasks, and advanced performance optimizations. Protect your players' experience with the brand-new Proximity Protection system, automatically intervene during lag spikes with TPS-based emergency cleanups, and monitor your world smoothly using the Interactive Chunk Inspector.

All of this without a single annoying console warning. Supports Spigot, Paper, Purpur, and Folia (1.8.x - 26.1).

⚡ Main Commands

/xcl [subcommand] (Aliases: /clearlag, /xclearlag)

• help - Shows the interactive help menu.
• reload - Hot-reloads configuration and language files.
• clear - Manually triggers the main cleanup tasks instantly.
• inspect - Opens the Interactive Chunk Inspector to hunt down entity clusters.
• clearchunk <world> <x> <z> - Wipes all entities from a targeted chunk.
• tpchunk <world> <x> <z> - Teleports instantly to a specific chunk coordinate.
• update - Checks for the latest X-ClearLag updates.

⭐ Key Features

• Folia & Next-Gen Support — 100% compatible with Folia's regional threading model. Built for elite performance.
• Player Proximity Protection — Smartly ignores dropped items and entities that are right next to your active players.
• TPS Monitor & Auto-Cleanup — Server lagging? X-ClearLag detects TPS drops and automatically triggers an emergency surgical cleanup.
• Batch Processing & Anti-Spike — Removes thousands of entities in controlled batches over multiple ticks, preventing the classic "clearlag server freeze".
• Interactive Chunk Inspector — View the Top 12 busiest chunks and manage them through interactive chat clicks.
• Internal Notifications & PAPI — Use [TITLE], [ACTIONBAR], [BROADCAST], [SOUND] directly in config. Full PlaceholderAPI support.
• BossBar Countdown — Elegant visual countdown bar for players during the last 60s (Requires 1.9+).
• Task-Based Architecture — Create unlimited independent cleanup tasks. Make one run every 5 mins for drops, and another every 30 mins to run save-all.
• Granular Protection — Secure mobs by name-tag, leash state, type whitelist, or world blacklists.

🌐 Multi-Language Support

• English — en
• Español — es
• Português — pt
• 日本語 — ja
• Русский — ru
• Custom — custom

🔑 Permissions

• xclearlag.admin.* — Grants all admin permissions (Default: OP).
• xclearlag.admin.reload — Access to /xcl reload.
• xclearlag.admin.clear — Access to /xcl clear.
• xclearlag.admin.inspect — Access to /xcl inspect.
• xclearlag.admin.clearchunk — Access to /xcl clearchunk.
• xclearlag.admin.tpchunk — Access to /xcl tpchunk.
• xclearlag.admin.update — Access to /xcl update.
• xclearlag.bypass — Bypass countdown messages (Default: false).
• xclearlag.notify — Receive cleanup notifications (Default: true).

🧩 Developer API

X-ClearLag provides a lightweight API for other plugins to interact with the cleanup engine. Support for custom events like XPreClearEvent (cancellable) and XPostClearEvent allows you to prevent cleanups during critical moments or track performance metrics easily. Full PlaceholderAPI support included!

⚙️ Configuration Example

[!TIP] This is a basic example. For a full explanation of every setting and module, please visit our Official Wiki.

prefix: "&8[&bX-ClearLag&8] &7"
language: "en"

tps-check:
  enabled: true
  threshold: 16.0
  interval: 60
  task-to-run: ["clearlag"]

bossbar:
  enabled: false
  color: "RED"
  style: "SOLID"

tasks:
  clearlag:
    enabled: true
    interval: 300
    min-players: 3
    remove-drops: true
    protect-named: true
    protect-leashed: true
    protect-near-player: false
    near-player-radius: 16
    countdown: [60, 30, 10, 5, 3, 2, 1]
    countdown-commands:
      60:
        - '[TITLE] &b&lX-ClearLag'
        - '[SUBTITLE] &7Cleanup in &c60s'
        - '[SOUND] NOTE_PLING'
      10:
        - '[ACTIONBAR] &eEntities removed in &c10s&e!'
    entities: [ARROW, SNOWBALL, EXPERIENCE_ORB]
    protected-entities: [PLAYER, VILLAGER, ARMOR_STAND]
    commands: []

optimizations:
  batch-size: 100
  chunks-per-tick: 40