/ChunkCleaner

Minecraft tool to automatically delete unused chunks/region based on the time played in them.

Primary LanguageGoMIT LicenseMIT

ChunkCleaner

A tool designed to automatically delete region files (.mca) with low playtime, optimizing space usage and improving performance.

logo

discord reddit last commit code size downloads

Considerations

In some chunks in Minecraft, the "InhabitedTime" variable does not update as expected, resulting in slower increments than anticipated. This issue has been observed in multiple versions of the game, including 1.12.2, 1.17.1 and 1.18.2. See https://bugs.mojang.com/browse/MC-127407.

Example

ChunkCleaner-Linux64 -path /mc-srv/world_nether/DIM-1/region -newPath /mc-srv/world_nether/DIM-1/region_old -minInhabitedTicks 200

Arguments

Argument Default Description
-h See the arguments and their usage
-dryRun false Trial run that doesn't make any changes
-minInhabitedTicks 250 The value that has to be passed so that a chunk will be seen as "used"
-mode perChunk The mode by which the inhabited time will be compared to options: "perChunk" / "regionSum"
-newPath The path where to move the region files to (if not provided .mca files will be deleted)
-path The path of the directory with the .mca files that should be cleaned
-v false This option increases the amount of information you are given during the process

TODO

  • Add LightPopulated and TerrainPopulated as options

Warranty

The Software is provided "as is" and without warranties of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the Authors or copyright owners be liable for any claims, damages or other liability, whether in an action in contract, tort or otherwise, arising from, out of or in connection with the Software or the use or other dealings in the Software.