EClean Modern

This plugin is EClean Modern, maintained by the CoffeePopStudio organization. It aims to enhance the original EClean plugin's functionality, resolve compatibility issues with newer Minecraft versions, and introduce additional features and configuration options.

Why

The original EClean plugin issue

explicitly states: "No time, no plans for Folia support at the moment." Additionally, the EPlugin framework is built on the legacy Bukkit API rather than the Paper API.

As a result, many APIs are marked as Deprecated or even Removed in Paper, which means the original plugin may become unusable in future versions.

This plugin was developed to bring EClean's functionality to the Folia environment while adding more features and configuration options on top of the original.

Features

• Smart Entity Cleanup
  Automatically cleans up dropped items, living entities, and dense entities on a configurable interval. Supports countdown announcement messages and displays cleanup statistics upon completion.

• Dense Entity Detection Menu
  A visual GUI menu showing entity density per chunk, with one-click teleport and one-click cleanup — allowing admins to quickly locate and resolve dense entity issues.

• Shared Trash Can
  Automatically collects matched items into a shared trash can during drop cleanup on a first-come, first-served basis. The trash can empties automatically on a timer to prevent important items from being lost.

• Per-World Configuration
  Each world can independently override cleanup rules, disable cleanup, or customize cleanup intervals, providing flexibility for different gameplay scenarios.

• Blacklist / Whitelist System
  Supports blacklist or whitelist modes by entity type or item type, giving precise control over which entities or items are cleaned up or protected.

• Item Protection Rules
  Optionally protects enchanted items, items with lore, written books, and other special items from being accidentally removed during cleanup.

• On-Demand Cleanup Commands
  Allows admins to trigger cleanup instantly by world or by type, without waiting for the scheduled timer.

• Entity Statistics Query
  Query loaded chunk counts and entity distribution statistics by world or entity type, useful for server diagnostics and maintenance.

• PlaceholderAPI Support
  Provides PAPI variable expansions for easy integration with other plugins to display cleanup-related information.

• Native Folia Compatibility
  Supports both Paper and Folia servers out of the box, with automatic scheduler adaptation — no extra configuration needed.

• Temporary Teleport
  The dense entity menu supports temporary teleport, automatically returning the admin to their original location after 30 seconds for safe inspection.

• Multilingual / Highly Customizable
  All message text is configured via lang.yml with MiniMessage format support. Six independent configuration files, each serving its own purpose, can be hot-reloaded without a server restart.

Commands

The main plugin command is /eclean, with the alias /ecl. If /ecl conflicts with another plugin, use /eclean instead.

• /eclean reload — Reloads the plugin. Scheduled cleanup tasks will restart their timers after reloading.
• /eclean clean — Immediately performs a cleanup (no pre-cleanup announcement; use with caution on servers with players).
• /eclean clean entity — Immediately performs an entity cleanup (no pre-cleanup announcement).
• /eclean clean entity <world> — Immediately performs an entity cleanup in the specified world (no pre-cleanup announcement).
• /eclean clean drop — Immediately performs a drop cleanup (no pre-cleanup announcement).
• /eclean clean drop <world> — Immediately performs a drop cleanup in the specified world (no pre-cleanup announcement).
• /eclean clean chunk — Immediately performs a dense entity cleanup (no pre-cleanup announcement).
• /eclean clean chunk <world> — Immediately performs a dense entity cleanup in the specified world (no pre-cleanup announcement).
• /eclean entity <entity_type> — Displays statistics for the specified entity type across all chunks in the current world.
• /eclean entity <entity_type> <world> — Displays statistics for the specified entity type across all chunks in the specified world.
• /eclean entity <entity_type> <world> <threshold> — Displays statistics for the specified entity type in the specified world, hiding entries below the given threshold.
• /eclean stats — Displays entity and chunk statistics for the current world.
• /eclean stats <world> — Displays entity and chunk statistics for the specified world.
• /eclean trash — Opens the shared trash can.
• /eclean show — Opens the dense entity statistics menu.

Permissions

• eclean.admin — Allows use of plugin commands.
• eclean.trash — Allows opening the trash can.

PlaceholderAPI

• %eclean_before_next% — Time until the next cleanup (in seconds).
• %eclean_before_next_formatted% — Time until the next cleanup (formatted).
• %eclean_last_drop% — Number of dropped items cleaned up last time.
• %eclean_last_living% — Number of living entities cleaned up last time.
• %eclean_last_chunk% — Number of dense entities cleaned up last time.
• %eclean_trashcan_countdown% — Trash can cleanup countdown (in seconds).
• %eclean_trashcan_countdown_formatted% — Trash can cleanup countdown (formatted).

Configuration

The default plugin configuration has been split into multi-file templates under the src/main/resources/config/ directory. Each configuration entry includes comments describing its usage and meaning.

Changelog

See Changelog