GroundClean

GROUND CLEAN
============

Adds two admin chat commands to Core Keeper: /clean deletes items lying on
the ground, and /collect picks them up into your inventory.

Manual only - there is no timer. They run exactly when you type them, and
nothing happens otherwise.

WHY
---

Dropped items in Core Keeper never despawn. On a long-running server they
pile up, and every one of them is a live ECS entity the server has to
simulate and stream to players. The result is rubber-banding and lag.
/clean wipes them out on demand; /collect lets you pick them up instead.

COMMANDS
--------

/clean                 Remove every dropped item on the ground.
/clean 64              Keep items within 64 blocks of a player (remove the rest).
/clean +64             Same as /clean 64 (explicit "farther than").
/clean -64             Remove only items within 64 blocks of a player.
/clean scan            Diagnostics: dumps counters to the server log.

/collect               Pick up every dropped item into YOUR inventory.
/collect 64            Pick up only items farther than 64 blocks from you.
/collect +64           Same as /collect 64.
/collect -64           Pick up only items within 64 blocks of you.
/collect scan          Diagnostics: inventory slots and ground items.

/collect picks up the NEAREST items first. It fills your inventory with
whatever fits and leaves the rest on the ground. Backpacks and pouches
count as inventory, whether from the base game or from any mod.

SAFETY
------

Only entities whose objectID is DroppedItem are ever touched. Neither
command removes players, graves, chests, placed objects, enemies, plants
nor bosses.

/collect never destroys an item it cannot take: if your inventory is full,
the items simply stay on the ground. Items with durability or quality data
(tools, weapons, gear) are skipped by /collect by default, so their data is
never at risk.

LIMITS
------

Both commands only affect LOADED chunks, i.e. the parts of the world the
server currently has in memory. Chunks load around online players (and
around anchors such as bases/waypoints) and unload when nobody is near.

So they are not global: dropped items sitting in unloaded areas are not
seen and not touched - they stay saved in the world and appear again when
you travel there. To clean or collect a far area, go there (or have a
player there) first.

Distance arguments: /clean measures against every online player, while
/collect measures against the player who runs it.

REQUIREMENTS
------------

1. Core Keeper 1.3.0 or newer (tested on 1.3.0.4).
2. CoreLib - declared as a dependency, install it too.
3. Install it on the server AND on every client that should use the
   commands.
4. Only configured admins can run them by default (server Admins.json).

Everything runs 100% server-side. The client copy exists only because the
chat box must capture the "/" prefix and forward it as a command. Without
it, /clean and /collect are sent as plain chat text and nothing happens.
Players without the mod can still connect (it declares no required
netcode); they just cannot use the commands.

CONFIGURATION
-------------

File groundclean.json, created on first use in the game's mod config
folder.

- requireAdmin (default true): set to false to let anyone run /clean.
- defaultMinDistance (default 0): distance used by a bare /clean; items
  within it are kept, the rest deleted.
- collectRequireAdmin (default true): set to false to let anyone run
  /collect.
- collectMaxPerCall (default 0): cap items per /collect call. 0 = no cap.
- collectAllowAuxItems (default false): set to true to also collect items
  with durability/quality data.

Restart the game or the server after editing this file.

MADE WITH AI
------------

This mod was written with the assistance of AI.