mapcleaner

Overview

Removes unused and unprotected map chunks on an online server or exports the area-protected chunks to a new map-database

Features

Removes map chunks based on a nodename whitelist
Nodename whitelist defines which nodes should be kept
One layer safety-range around protected chunks
areas mod integration
Can be paused (state and config is maintained in mapcleaner.json)
Export area-protected chunks to a new map.sqlite

Installing / Running

Download the latest binary
Prepare a mapcleaner_protect.txt file with protected nodenames and place it in the world folder (see section below)
Optionally: configure the mapcleaner.json file with start/end positions
Start the mapcleaner binary in your world directory
Wait a few hours or days (depending on world-size, range-limits and cpu/io-speed)

Operation modes

# remove unprotected chunks from the database
./mapcleaner -mode prune_unproteced

# export protected areas (from the areas mod) to a new map.sqlite in the "area-export" directory
./mapcleaner -mode export_protected

Configuration files

`mapcleaner_protect.txt`

The mapcleaner needs a mapcleaner_protect.txt file with nodenames that need to be kept.

An example:

bones:bones
travelnet:travelnet
protector:protect

With the above file all the chunks without those nodes (or not in the neighborhood of those) will be removed

NOTE: the mapcleaner refuses to work without this file (for good reasons)

`mapcleaner.json`

This file is used for state tracking and cleaning range config.

An example:

{
  "chunk_x": -40,
  "chunk_y": -10,
  "chunk_z": -40,
  "removed_chunks": 0,
  "retained_chunks": 0,
  "processed_chunks": 0,
  "from_x": -40,
  "from_z": -40,
  "to_x": 40,
  "to_y": 10,
  "to_z": 40,
  "delay": 10
}

The above config will process all chunks between (-40,-10,-40) and (40,10,40) (chunk-positions). This translates roughly to (-3200,-800,-3200) and (3200,800,3200) in node-positions.

delay can be used to slow down the cpu usage of the cleaning (delay is in milliseconds between each new chunk-check)
removed_chunks total of removed chunks
retained_chunks chunks with or around protected nodes
processed_chunks total processed chunks (emerged or not)

NOTE: a chunk has 5x5x5 mapblocks and a mapblock 16x16x16 nodes, chunks have a mapblock-offset of (-2,-2,-2)

Warnings

This program removes data from your world, try it out on a backup/throw-away world first!

License

MIT

minetest-go/mapcleaner