Skip to content

starmun-0010/Prune-Addon-FTB-Chunks

Repository files navigation

Prune Addon

This mod adds admin commands to remove non-claimed chunks from saved game files.

Possible Usage

  • Regenerating chunks without having to reset the world.
  • Reducing the size of backup files.
  • Reducing the disk size of ridiculously large worlds. 
  • Getting rid of abandoned bases on multiplayer servers.

 

Prune Command

Prunes region and poi files of a dimension.
Removes all the files which do not contain any chunks claimed by FTB-Chunks.

Syntax: /prune [-deep <true/false>] [-filetype <region_files | poi_files>] [-dimension <dimension>] [do_not_backup <true | false>]

Parameters

  • deep: when set to true, the mod will go through each file containing claimed chunks and will manually remove all the adjacent non-claimed chunks. default: false
  • file-type: The types of files which should be pruned, possible values are region_files and poi_files, default:both
  • dimension: The dimension to prune the data from. default: overworld
  • do_not_backup: If set to true, pruned files will not be backed up. default: false
         Use with extreme caution! true will permanently delete files.

 

Instructions for Pruning

Make sure  of the following

  • Make sure that all the chunks which you want to purge are unloaded.
  • You are not in a chunk which you want to be pruned.,
  • If multiplayer, no other players are in chunks to be purged.
  • Restart the server after the prune command.
  • If you see the same files in origin or poi folder as the files in the backup origin and poi folder respectively, then something went wrong. The files you wanted to be purged had loaded chunks on the server so the server saved them again after they were pruned. You can bypass this by killing the server instantly after executing the prune command and preventing the server from saving  loaded chunks. Be careful because you can lose unsaved progress this way.

 

Deep pruning implemented!

You can now prune all unclaimed chunks with -deep parameter! Even the ones saved in same region files as claimed chunks.

 

Planned Features

  • Configurable paths for backup location of pruned files,
  • Compression of files to be backed up,
  • Automated scheduled pruning,
  • Pruning of non-claimed chunks stored in the same region file as claimed chunks.  DONE!!

 

Distribution

Feel free to use this in your modpack. 
Any form of distribution should either be via this CurseForge project or should include a link to this description page.

 

Join our discord to get access to the play/test Starpack server.