promotional bannermobile promotional banner
premium banner

Clearity

Clearity is a lightweight Hytale plugin that automatically clears dropped items on a configurable timer to reduce server lag and improve performance.

Description

🪴 THE PLUGIN IS DEVELOPED SPECIFICALLY FOR THE KWEEBEC WORLD SERVER 🪴
IP: world.kweebec.xyz

Clearity is a server management plugin for Hytale that automatically removes dropped items to help maintain server performance and reduce lag. It offers a configurable cleanup system, customizable messages, and clear operational controls for administrators.

Key Features

  • Two Cleanup Modes
    • GlobalTime: Works like a classic timer. A global countdown runs, warnings are broadcast, and all dropped items are cleared when the timer hits 0.
    • DroppedBased: Cleans items individually based on how long each item has been on the ground. Items are removed only after they have existed for at least the configured interval. This mode runs silently (no global broadcasts).
  • Configurable Interval
    • Set the cleanup interval via config or command (supports flexible duration formats).
  • Configurable Countdown Warnings (GlobalTime only)
    • Broadcast warnings at configured times before the cleanup.
  • Permission-Based Control
    • Administrative commands are protected by permissions.
  • Instant Cleanup Command
    • /clearity now always clears all dropped items immediately, regardless of cleanup mode.

Commands

  • /clearity - Show cleanup information (mode-aware)
  • /clearity info - Show cleanup information (mode-aware)
    • In DroppedBased, shows that items are removed individually after interval
    • In GlobalTime, shows time remaining until next global cleanup
  • /clearity now - (OP only) Immediately clears all dropped items
  • /clearity timeout <duration> - (OP only) Set the cleanup interval (e.g. /clearity timeout 1h)

Time Format Examples

  • 1h - 1 hour
  • 30min - 30 minutes
  • 2h15min - 2 hours and 15 minutes
  • 1d30min20sec - 1 day, 30 minutes, and 20 seconds

Permissions

  • clearity.op - Grants access to administrative commands (now and timeout)

Configuration

Clearity stores its configuration in mods/Clearity/config.json.

Main fields:

  • interval: The cleanup time setting used by both modes
    • In GlobalTime: global countdown duration
    • In DroppedBased: per-item lifetime threshold before removal
  • cleanupMode: "GlobalTime" or "DroppedBased"
  • notifyDelays (GlobalTime only): List of warning delays (e.g. ["30min","10min","1min","10sec","5sec"])
  • messages: All messages are configurable and support placeholders:
    • {delay} - formatted delay label (for warnings / timeout set)
    • {count} - number of items removed (used after a global clear)

Color & Formatting Codes in Messages

All configurable messages support Minecraft-style & codes:

  • Colors: &0-&9, &a-&f
  • Formatting:
    • &l Bold
    • &n Underline
    • &o Italic
    • &m Strikethrough
    • &k Obfuscated
    • &r Reset (resets color and formatting)

Technical Details

Clearity uses Hytale’s ECS (Entity Component System) queries to identify and remove dropped item entities efficiently. Scheduling runs on a dedicated timer thread, and all world modifications are executed safely inside the world execution context.

Perfect for busy servers where item accumulation can degrade performance, Clearity balances automated maintenance with admin control and full message customization.