Skip to content
OreCruncher edited this page Oct 23, 2018 · 2 revisions

Welcome to the TidyChunk wiki!

TidyChunk is a Minecraft Forge mod which removes EntityItems from the chunk after it has been generated. Main purpose, for me at least, is to try and cut down on the amount of crap when exploring and avoid filling up the player inventory.

The way it works is pretty straight forward. During world gen Forge posts events that TinyChunk listens for. If a new chunk is being generated it remembers that chunk. Subsequently, when an EntityItem joins the world TinyChunks cross checks the EntityItem location in it's remembered chunk list. If the item is present in one of these newly generated chunks the EntityItem is set dead and the Forge event is canceled. Net result is fewer pieces of trash in the world.

Note that this only works with chunk generated and Minecraft driven world gen. Some mods do world gen outside the normal ways Minecraft does. Under these circumstances TidyChunk does nothing because it cannot reliably determine if an EntityItem is being created because of chunk generation. A good example of this is AncientWarfare 2's structure generation. A lot of the time generation of a structure occurs right around chunk generation so TidyChunk can clean up any drops left behind. However, there are times where a structure will be generated into an existing chunk, and because the chunk has existed TidyChunk will not clean it up.

The main configuration setting that post modpack authors will be interested in is "tickSpan". This is the number of world ticks that TidyChunk will remove EntityItems from the world after the chunk has been generated. Main reason for this time window is to take into account any delayed block actions such as flowers determining they are not on a valid block thus break. By default this setting is 0, which means that TidyChunk will use an internal default of 15 ticks.

The possible range is 0 - 500 ticks, with 0 meaning use the internal default (which is 15 ticks at the time of this writing). The window could be widened, but caution must be taken. Main thing I would worry about is a server that has some sort of random TP ability and a player RTPing, dying, and having his items scattered as EntityItem's. Having TidyChunk clear out those items just adds insult to injury. However, if you normally run with keep inventory on, or have some sort of gravestone mod installed, feel free to explore increasing this value to match your expectations.

This mod is a server side mod, meaning that it is not required to have it installed on the client to function. If it is installed on the client you can access the mod's configuration settings using the Forge Configuration system.

Clone this wiki locally