WorldCleaner Module

The WorldCleaner module automatically removes excess items, creatures, and projectiles from your worlds. It helps reduce server lag by cleaning up unused entities and managing the abyss storage.

WorldCleaner:
  enabled: true
  worlds:
    - world
    - world_the_end
    - world_nether
  values:
    interval: 600
    alerts: true

    items:
      enabled: true
      disable_item_despawn: false
      time_lived: 10000
      blacklist:
        - BEACON
      abyss:
        enabled: false
        alerts: true
        permission: "lagfixer.abyss"
        item_despawn: true
        close: 60
        blacklist:
          - BEDROCK
          - BEACON

    creatures:
      enabled: true
      named: false
      drop_items: false
      stacked: true
      levelled: true
      ignore_models: true
      list_mode: true
      list:
        - BAT
        - ZOMBIE
        - SKELETON
        - SLIME
        - CREEPER
        - SPIDER
        - PHANTOM
        - SILVERFISH
        - SQUID
        - GLOW_SQUID
        - COD
        - SALMON
        - PUFFERFISH
        - TROPICAL_FISH

    projectiles:
      enabled: true
      blacklist:
        - ENDER_PEARL
        - EXPERIENCE_BOTTLE
        - FIREBALL
        - POTION
        - LINGERING_POTION
        - SPLASH_POTION
        - WITHER_SKULL
        - TRIDENT

🧩 Option Explanations

πŸ”Ή Interval (interval)

Time in seconds between WorldCleaner runs.

  • Example: 600 β†’ cleans every 10 minutes.


πŸ”Ή Alerts (alerts)

If true, players and administrators will be notified when the module removes items or creatures.

  • Customizable in lang.yml.


πŸ”Ή Items (items)

Controls automatic item cleanup.

  • enabled β€” Enable or disable item removal.

  • disable_item_despawn β€” If true, LagFixer handles item despawning instead of Bukkit.

  • time_lived β€” Minimum time in milliseconds an item must exist before removal. Set -1 to disable.

  • blacklist β€” Items that should never be removed.

πŸ”Ή Abyss

Optional storage for deleted items, retrievable with /abyss.

  • enabled β€” Enable or disable abyss feature.

  • alerts β€” Notify players when items are added to abyss.

  • permission β€” Permission required to access the abyss.

  • item_despawn β€” If true, items removed by despawn are added to abyss.

  • close β€” Time in seconds to automatically clear abyss inventory.

  • blacklist β€” Items that cannot enter the abyss.


πŸ”Ή Creatures (creatures)

Controls automatic creature removal.

  • enabled β€” Enable or disable creature cleanup.

  • named β€” Remove named creatures if true.

  • drop_items β€” Drop items when removing creatures.

  • stacked β€” Remove stacked entities (supports WildStacker, RoseStacker, UltimateStacker).

  • levelled β€” Remove levelled mobs (LevelledMobs support).

  • ignore_models β€” Exclude ModelEngine or MythicMobs entities from removal.

  • list_mode β€” If true, only entities in list are removed; otherwise, unlisted entities are removed.

  • list β€” Entity types allowed for removal.


πŸ”Ή Projectiles (projectiles)

Controls automatic removal of projectiles, like arrows or snowballs.

  • enabled β€” Enable or disable projectile cleanup.

  • blacklist β€” Projectiles excluded from removal.

Last updated