Mod World Utils by masady

Description

World Utils adds several commands to manipulate or fix Minecraft worlds.

Some of the commands include:

• Remove duplicated entities - Fixes the 'Keeping entity Sheep that already exists with UUID xxxxxx' console spam that happens in MC 1.9+ if there are entities with the same UUID in the world.
• Remove scheduled tile ticks (by block name or mod name). This isn't required after Forge 2183 for 1.10.2 or 2184 for 1.11, since those versions include a fix for a crash that happened if there were scheduled tile ticks for blocks that don't exist anymore (for example after removing a mod). But if you are on earlier Minecraft versions, then removing a mod can still lead to crashes on world load, and this command can fix those.
• Replace blocks with another block (or with air, which of course is also a block) in the entire world
• A setblock command, which (only) works in unloaded chunks
• An inspectblock command, which shows block and TileEntity NBT data currently saved in the chunk data on disk
• Remove all entities by name from the world files
• Remove all tile entities by name from the world files
• Rename entities
• Rename tile entities
• Remove non-existing block entries from the block ID map (= clean-up after removing a mod)

A lot more commands are planned and will be implemented when I have free time to work on this mod.

There is also the Chunk Wand item (disabled by default), which allows:

• swapping selected chunks in the world to alternate versions (from different world saves or older backups etc.)
• instead of swapping the entire chunk, it can also just import the biomes from the alternate version
• or it can simply just set the biome to a given value

Story time! - Why I initially created this mod:

---

 

Before you start

Before you do anything with this mod, make sure you have a FULL world backup!
You should be keeping backups of any worlds (or ANY other data you care about in general) anyways, but at least make a FULL backup before using this mod. Many of the operations in this mod are very low level world file manipulations. If something goes wrong, it can permanently destroy parts or even your entire world save! And there is no magical undo! So make a backup first!

---

 

Chunk Wand

The basic idea of the Chunk Wand is this:

• Select areas of the world (point and left or right click in air to set the corner chunks)
• Make sure you are in the correct mode (Swap chunks, Import biomes or Set biomes) - change the mode by Ctrl + scrolling
• Select the source alternate world by Alt + scrolling, or
• Select the biome you want to set by Alt + scrolling
• Press the Toggle hotkey to execute the action

The alternate worlds directory is <worldname<>/alternate_worlds/.
Under that directory should be a directory for each alternate world you want to use, so that inside that alternate world directory should be the region/ directory from that world.

Basically you can just copy & paste worlds inside the alternate_worlds directory to have them available.

NOTE: When you execute a Swap chunk/Import biome/Set biome operation, that data is written directly to the chunk in the current world save! There is no undo!

Tip: If you want to also be able to go back to the current version, then make a copy of the current world inside the alternate_words/ directory too!
But either make it before you copy the other alternate world there (so that you don't end up copying those too...), or alternatively, create a new directory, something like 'current' inside the alternate_worlds directory, and then copy over just the region/ directory from the current world inside that 'current' directory.

Basically you should have a directory structure like this:

• myworld/ - the main world directory
• myworld/region/ - the region files directory of the main world (make a copy of this under alternate_worlds/current/)
• myworld/alternate_worlds/ - the alternate worlds top level directory used for the Chunk Wand
• myworld/alternate_worlds/world_1/ - the top level directory of some world you want to use for the Chunk Wand
• myworld/alternate_worlds/world_1/region/ - the region directory of that world
• myworld/alternate_worlds/world_2/ - the top level directory of some world you want to use for the Chunk Wand
• myworld/alternate_worlds/world_2/region/ - the region directory of that world
• myworld/alternate_worlds/current/ - the top level directory for the copy of 'myworld'
• myworld/alternate_worlds/current/region/ - the region directory copied from 'myworld', so that you can also switch the chunks back to the 'current' version

---

 

Commands

The currently implemented "main" commands are:

• /worldutils batch-run <filename> - run commands from a file inside the config/worldutils/batch_commands/ directory
• /worldutils blockreplace - Replace a list of blocks with a single replacement block type
• /worldutils blockreplacepairs - Replace a specific block type with another specific block type. Can do an arbitrary number of pair replacements at once.
• /worldutils dump blocks - Currently just a block registry dump exists. (Use the TellMe mod for other types of registry dumps.)
• /worldutils entities - Manipulate entities (also tile entities) in various ways, see below
• /worldutils inspectblock - Shows block and TileEntity NBT data currently saved in the chunk data on disk
• /worldutils printspawn - Prints the current overworld spawn position
• /worldutils registry - Some Forge registry related operations
• /worldutils setblock - A setblock command that (only) works in unloaded chunks
• /worldutils tileticks - Remove scheduled tile ticks from the world, see below

Note: The entities and tileticks commands ONLY work in unloaded chunks! Also the blockreplace commands are HIGHLY recommended to be only run for unloaded chunks. Running the blockreplace command for loaded chunks is at least somewhere around 50-100x slower, and has some other implications as well (and hasn't been tested that much...).

To be able to use the commands on all your existing chunks while having the chunks unloaded, you should teleport and temporarily move the world spawn somewhere where there is currently no terrain, then re-load the world so that old areas unload. Then run the commands and then teleport back to your regular area and move the world spawn point back.
You can use the /worldutils printspawn command to see your current world spawn if you want to restore it using the /setworldspawn vanilla command, or you could also make a backup of the level.dat file before starting and just restore that afterwards to restore your old spawn.

I would recommend picking a temporary location in the middle of a region file somewhere far away from 0, 0, that way it is easy to simply delete that one region file afterwards to get rid of the temporary area of the world.
To get a location in the middle of a region file, select a location that is x = a * 512 + 256, z = b * 512 + 256. For example a = 40, b = 0 would be at x = 20736, z = 256. This would be in the middle of the region file r.40.0.mca. So the vanilla commands to get there and move the world spawn would be:

• Make a copy of the level.dat file first - restoring it is an easy way to restore the old spawnpoint after this
• /gamemode 1 - change to creative mode before teleporting to an unknown place...
• /tp @p 20736 160 256
• /setworldspawn

NOTE: If you are running these operations/using this mod for a world from another Minecraft version, or otherwise doing these operations without all the usual mods installed, then you should NOT at any point allow any of your actual world's chunks to load (meaning anything other than the temporary area should not be allowed to load)! So in such a case you must move the spawn point by directly editing the spawn coordinates in the level.dat file, using for example the NBT Explorer program, before loading the world for the first time for these operations. Also make a copy of the level.dat file before starting, so you can restore it afterwards, both for restoring the spawn point, and to make sure to preserve the ID maps in it without alterations. And you did read the warning about also making a FULL world backup first, right?!

---

 

Commands - batch-run

The /worldutils batch-run <filename> command allows running comands from "script files". For example running the blockreplace commands from a text file, instead of having to type or copy and paste them one by one to the game chat.
The command files must be placed in the config/worldutils/batch_commands/ directory. You can tab-complete the filename in the command.
Note: This is in no way tied to just worldutils commands. You can run a list of any valid Minecraft commands from the files.
Tip: Lines starting with '#' as the first character are ignored as comments. Also any blank lines are ignored.

---

 

Commands - setblock

The /worldutils setblock command allows setting a block at a specific location in the specified dimension to the given block.
This is probably most useful if you have a block that crashes the server or the client as soon as it gets loaded, and you know its exact location in the world (from a crash log perhaps).

The command syntax is simply:
/worldutils setblock <x> <y> <z> <block> [dimension id]

The dimension id is optional if you run the command as a player in the world, then it will use your current dimension.
The block specifier uses the same syntax as in the blockreplace commands.
The recommended/most common form for it is:
/worldutils setblock 123 68 123 minecraft:stone[variant=andesite]
Or without any blockstate properties changed from the default values (or blocks that have no properties):
/worldutils setblock 123 68 123 minecraft:air

---

 

Commands - inspectblock

The /worldutils inspectblock command allows looking at the block and TileEntity NBT data that is currently saved in the chunk data on disk.

The command syntax is simply:
/worldutils inspectblock <dump | print> <x> <y> <z> [dimension id]

If dump is used as the first argument, then the data is written into a file inside the config/worldutils/ directory.
If print is used as the first argument, then the data is printed to the game console.
The dimension id is optional if you run the command as a player in the world, then it will use your current dimension.

---

 

Commands - blockreplace

The /worldutils blockreplace command can be used to replace an arbitrary number of different blocks with a single replacement block in one go. So in other words it's a many-to-one replacement operation.

The command itself internally uses two separate lists for the to-be-replaced OR to-be-kept blocks. The blockstatelist is used for specifying ALL blocks from vanilla Minecraft up to and including a given Minecraft version, for example all blocks that exist in Minecraft 1.8.

The blocknamelist on the other hand is used for specifying individual blocks, or all blocks from a certain mod, etc. Basically anything that isn't "all blocks from vanilla version X".

There is one replacement block, which is by default minecraft:air.

The basic stages of using the blockreplace command are:

• Set the replacement block
• Prepare the blockstatelist and/or blocknamelist with blocks to either replace or keep
• Execute the command, specifying whether you want to keep or replace the blocks on the blockstatelist and blocknamelist
• Wait for it to finish - it uses a scheduler and tries to keep the total tick time under 48 ms, to not lower the TPS

Managing the blockstatelist

For managing the blockstatelist (for all blocks in vanilla versions), these commands exist:

• /worldutils blockreplace blockstatelist add-all-vanilla <version> - The version must be one of 1.5 to 1.12.
• /worldutils blockreplace blockstatelist clear - clears the list
• /worldutils blockreplace blockstatelist list - prints the current list to the console

Note: The add-all-vanilla command will add ALL vanilla blocks up to and including the version specified.

Managing the blocknamelist

The blocknamelist is used for specifying individual blocks. You can add as many blocks to the list at once as you want.
For managing the blocknamelist, these commands exist:

• /worldutils blockreplace blocknamelist add <block specifier> [block specifier ...] - Adds one block entry to the list. See "Supported block specifier formats" for details about the allowed formats.
• /worldutils blockreplace blocknamelist add-all-from-mod <modid> [modid ...] - Adds all blocks from the given mods to the list.
• /worldutils blockreplace blocknamelist add-all-removed-blocks - Adds all missing/removed blocks to the list. They are gotten from the registry, so any blocks that are in the registry, but aren't currently registered by any mod (ie. are marked as "dummied") will be added to the list. This allows clearing such blocks from the world, in case they are causing issues or ID shifts.
• /worldutils blockreplace blocknamelist add-all-removed-blocks-from-mod <modid> - Same as above, but only adds removed blocks from the given mod.
• /worldutils blockreplace blocknamelist add-with-spaces <block name with spaces in it> - Adds a block to the list which has spaces in its name (why do people do this?!).
• /worldutils blockreplace blocknamelist clear - clears the list
• /worldutils blockreplace blocknamelist list - prints the current list to the console
• /worldutils blockreplace blocknamelist remove <blockonthelist> [blockonthelist ...] - Removes names from the list
• /worldutils blockreplace blocknamelist remove-with-spaces <block name with spaces on the list> - Removes the given name from the list

NOTE: If you use a block specifier without metadata or blockstate properties, and if that block type does have sub blocks or metadata, then ALL of those sub-blocks/blocks with different metadata values will essentially be added to the list.

For example, if you use the command:
/worldutils blockreplace blocknamelist add minecraft:stained_hardened_clay
to add stained clay to the list, then ALL the different colors of stained clay will be affected or "added to the list"!
If you print out the list, there will only be minecraft:stained_hardened_clay on it, but when the list of block names eventually gets parsed into the raw numerical IDs upon execution of the command, then entries without metadata or blockstate properties (so only the block ID, or only the block name) will be added for ALL metadata values.
So if you want to target for example only yellow stained clay, add it as minecraft:stained_hardened_clay[color=yellow], or to only target the Granite variant of stone, add it as minecraft:stone[variant=granite].

Setting the replacement block

For managing the replacement block, these commands exist:

• /worldutils blockreplace replacement set <block specifier> - Sets the replacement block
• /worldutils blockreplace replacement print - Prints the currently set replacement block

Running the replacement operation

After you have set the replacement block, and added all the blocks to be either replaced or kept to the blockstatelist and/or blocknamelist, you will run one of the execute command variants. There are three different variants, for running the replacement in all chunks, or only loaded chunks, or only unloaded chunks.

NOTE: It is HIGHLY recommended to only run the command for unloaded chunks, as that is somewhere around 50 to 100 times or so faster than running it for loaded chunks!

These are the execute command variants:

• /worldutils blockreplace execute-all-chunks <keep-listed | replace-listed> [dimension id]
• /worldutils blockreplace execute-loaded-chunks <keep-listed | replace-listed> [dimension id]
• /worldutils blockreplace execute-unloaded-chunks <keep-listed | replace-listed> [dimension id]
• /worldutils blockreplace stoptask - Stops and removes a running scheduled operation/task.

NOTE: The keep-listed or the replace-listed argument is what defines what the blockstatelist and blocknamelist entries mean. In other words, it defines whether the blocks on the lists are all the blocks that will be replaced, or are those the ONLY blocks that will NOT be replaced.

Note: The stoptask command is not actually specific to the blockreplace command, but it will stop and remove ANY currently running task. There can only be one task of any type running at the same time, because the different commands manipulate the raw world NBT data (when run for unloaded chunks)!

Supported block specifier formats

The replacement set command and the blocknamelist add command take a "block specifier" argument to represent a block.
That block specifier can be in one of the following formats:

• Block ID: 49
• Block ID + meta: 49:0 or 49@0
• Block name: minecraft:obsidian
• Block name + meta: minecraft:stained_hardened_clay:4 or minecraft:stained_hardened_clay@9
• Block name + blockstate properties: somemod:some_block[color=red,facing=north,powered=false]

Examples

If all this seems confusing, here are some examples. It is in fact very simple.

Example 1: Remove ALL modded blocks from a 1.7.10 modded world:

• /worldutils blockreplace blockstatelist clear
• /worldutils blockreplace blocknamelist clear
• /worldutils blockreplace replacement set minecraft:air
• /worldutils blockreplace blockstatelist add-all-vanilla 1.7
• /worldutils blockreplace execute-unloaded-chunks keep-listed

So this will add ALL blocks from vanilla 1.7.10 to the list, and then set everything else to air.

Example 2: Remove ALL blocks from Biomes O' Plenty from the world

• /worldutils blockreplace blockstatelist clear
• /worldutils blockreplace blocknamelist clear
• /worldutils blockreplace replacement set minecraft:air
• /worldutils blockreplace blocknamelist add-all-from-mod biomesoplenty
• /worldutils blockreplace execute-unloaded-chunks replace-listed

So this will add ALL blocks from Biomes O' Plenty to the list, and then set all of the blocks on the list to air (so in this case all blocks from Biomes O' Plenty).

Example 3: Set ALL Redstone Ore and Diamond Ore blocks to stone in the currently generated chunks in the world

• /worldutils blockreplace blockstatelist clear
• /worldutils blockreplace blocknamelist clear
• /worldutils blockreplace replacement set minecraft:stone
• /worldutils blockreplace blocknamelist add minecraft:diamond_ore
• /worldutils blockreplace blocknamelist add minecraft:redstone_ore
• /worldutils blockreplace execute-unloaded-chunks replace-listed

So this will add Redstone Ore and Diamond Ore to the list, and then set all of the blocks on the list to stone.

Example 4: Create a glass world - set ALL vanilla blocks to light gray stained glass in the currently generated chunks in the world

• /worldutils blockreplace blockstatelist clear
• /worldutils blockreplace blocknamelist clear
• /worldutils blockreplace replacement set minecraft:stained_glass[color=silver]
• /worldutils blockreplace blockstatelist add-all-vanilla 1.11
• /worldutils blockreplace execute-unloaded-chunks replace-listed

So this will replace all vanilla blocks that exist in 1.11, with light gray stained glass (in the chunks that have been generated so far).

---

 

Commands - blockreplacepairs

The /worldutils blockreplacepairs command can be used to replace an arbitrary number of blocks, each with a specific replacement block, all in one go. So in other words it's a one-to-one replacement operation.

This command is very similar to the other blockreplace command in many ways. The main difference is, that it doesn't have a single relacement block, but instead you add blocks to the list in pairs: a block to replace, and the block that will replace it. There is also only one list, because there is no need for a all-vanilla-blocks list in this command. Because of certain (thankfully rare) mods with spaces in their block names, there are also special "prepare commands" to add such blocks with spaces in their names to the list.

To "prepare" and add block names with spaces in their name to the name pair list:

• /worldutils blockreplacepairs prepare-from <block specifier containing spaces> - Adds a "from" block, ie. what to replace, into the "prepared buffer".
• /worldutils blockreplacepairs prepare-to <block specifier containing spaces> - Adds a "to" block, ie. the replacement block, into the "prepared buffer".
• /worldutils blockreplacepairs add-prepared - Adds the previously "prepared" block names to the actual name pair list.

For normal blocks without spaces in their names, you would simply add them to the list like so:

• /worldutils blockreplacepairs add <block to replace> <replacement block>

There are also the clear, list and remove (and remove-with-spaces) commands to manage the list. The remove commands take the from-block name on the list.

When you have all the block pairs on the list, simply run the execute command. Like with the blockreplace command, there are separate variants for all chunks, loaded chunks and unloaded chunks. Again, only running the command for unloaded chunks is highly recommended. Also this command doesn't have the replace-listed or keep-listed argument, since all the replacement are exactly defined one-to-one.

• /worldutils blockreplacepairs execute-all-chunks [dimension id]
• /worldutils blockreplacepairs execute-loaded-chunks [dimension id]
• /worldutils blockreplacepairs execute-unloaded-chunks [dimension id]
• /worldutils blockreplacepairs stoptask - Stops and removes a running scheduled operation/task.

Example 1: Replace yellow stained clay with gold blocks, and water with lava:

• /worldutils blockreplacepairs clear
• /worldutils blockreplacepairs add minecraft:stained_hardened_clay[color=yellow] minecraft:gold_block
• /worldutils blockreplacepairs add minecraft:water minecraft:lava
• /worldutils blockreplacepairs execute-unloaded-chunks

---

 

Commands - entities

The currently implemented entities sub-commands are:

• /worldutils entities list-all - Outputs a list of all entities into a file in config/worldutils/. Uses the internal list gotten from a read-all command.
• /worldutils entities list-duplicates-all - Outputs a list of ALL entities that exist in more than one copy (by their UUID) in the world. Uses the internal list gotten from a read-all command.
• /worldutils entities list-duplicates-only - Outputs a list of only duplicate entities. The only difference from the above is that the first entity of each UUID is omitted.
• /worldutils entities read-all [dimension] - Reads all entities from the world files in the given dimension into an internal list
• /worldutils entities remove-duplicate-uuids [dimension] - Removes all the duplicated entities, leaving only one of each UUID. Note that you don't have any control over which one is left, but normally it is also dependent on chunk loading order which one of them spawns in the world.
• /worldutils entities remove <options> - Remove entities OR tile entities by name. See below.
• /worldutils entities rename <options> - Rename entities OR tile entities. See below.

Note: All of these operations currently only work in unloaded chunks!
Note: The list-all and the list-duplicates-* commands print from a list in memory. So you should run the read-all command first to read the entities from the world files into a list in memory.

The entities remove command in more detail:

• /worldutils entities remove add <name> [name] ... - Adds names of entities or tile entities to remove to the list
• /worldutils entities remove add-with-spaces these are name parts - An add command variant that allows specifying a name that contains spaces in it.
• /worldutils entities remove remove <name> [name] ... - Removes names from the list
• /worldutils entities remove remove-with-spaces these are name parts - A remove command variant that allows specifying a name that contains spaces in it.
• /worldutils entities remove list - Prints the current list of names to the console
• /worldutils entities remove clear - Clears the current list of names
• /worldutils entities remove execute-for-entities [dimension] - Executes the removal operation, removing all entities that have been added to the list
• /worldutils entities remove execute-for-tileentities [dimension] - Executes the removal operation, removing all tile entities that have been added to the list

The entities rename command in more detail:

• /worldutils entities rename add <name-from> <name-to> - Adds a pair of names to the list; anything matching <name-from> will be renamed to <name-to>
• /worldutils entities rename add-prepared - Adds the name pair, previously prepared with the prepare-from and prepare-to commands, to the list.
• /worldutils entities rename remove <name-from> [name-from] ... - Removes name pairs from the list, where the name-from is one of the given names.
• /worldutils entities rename remove-with-spaces these are name parts - A remove command variant that allows specifying a name that contains spaces in it.
• /worldutils entities rename prepare-from name with spaces - "Prepares" a 'name-from', which contains spaces in it
• /worldutils entities rename prepare-to name with spaces - "Prepares" a 'name-to', which contains spaces in it
• /worldutils entities rename list - Prints the current list of name pairs to the console
• /worldutils entities rename clear - Clears the current list of name pairs
• /worldutils entities rename execute-for-entities [dimension] - Executes the rename operation, renaming all entities that have been added to the list
• /worldutils entities rename execute-for-tileentities [dimension] - Executes the rename operation, renaming all tile entities that have been added to the list

---

 

Commands - tileticks

The currently implemented tileticks sub-commands are:

• /worldutils tileticks find-invalid [rescan] [dimension] - Reads all scheduled tile ticks from the world save in the given dimension and then finds ones that are for blocks that don't exist anymore. Give the rescan option to force re-reading the data from the world instead of using the cached read-all output list as a basis.
• /worldutils tileticks find-invalid list - Outputs the list of all found invalid tile ticks to a file in the config/worldutils/ directory, using the data from a previous find-invalid [rescan] command (see above).
• /worldutils tileticks list - Outputs the internal list of all scheduled tile ticks from a previous read-all command into a file inside the config/worldutils/ directory.
• /worldutils tileticks read-all [dimension] - Reads all scheduled tile ticks from the world save in the given dimension into an internal list
• /worldutils tileticks remove-all [dimension] - Removes ALL scheduled tile ticks in the given dimension
• /worldutils tileticks remove-by-mod <options, see below> - Removes all scheduled tile ticks belonging to blocks from the given mod
• /worldutils tileticks remove-by-name <options, see below> - Removes all scheduled tile ticks belonging to blocks by the given name
• /worldutils tileticks remove-invalid [rescan] [dimension] - Removes all scheduled tile ticks for blocks that don't exist anymore. These would normally lead to a crash when such chunks attempts to load (fixed in later Forge versions for 1.10.2+). Give the rescan option to force re-reading the data from the world instead of using the cached read-all output list as a basis.

The remove-by-mod and remove-by-name commands have several sub commands:

• /worldutils tileticks remove-by-mod add <name> [name] ... - Add the given name to the list of to-be-removed tile ticks
• /worldutils tileticks remove-by-mod remove <name> [name] ... - Remove the given name from the list of to-be-removed tile ticks
• /worldutils tileticks remove-by-mod list - Print out all the current names on the list of to-be-removed tile ticks
• /worldutils tileticks remove-by-mod clear-list - Empties the list of to-be-removed tile ticks
• /worldutils tileticks remove-by-mod execute [dimension] - Executes the tile tick removal operation in the given dimension, based on the list of to-be-removed tile ticks

Note: All of these operations currently only work in unloaded chunks!

---

 

Commands - registry

There is currently only one command implemented:

• /worldutils registry remove-missing-blocks [filename] - Removes any blocks that don't currently exist in the game (including Forge-added placeholder dummy air blocks), from a level.dat file's block ID map. The level.dat file should be placed/copied inside the config/worldutils/ directory for this operation. If the filename is given, then a level.dat file by that name is used instead (inside the config/worldutils/ directory still).

Mod packs/permissions

• Mod packs: go ahead! Although this mod probably doesn't belong in mod packs... It is mainly an admin tool.
• Re-hosting the mod file otherwise is not cool, mmkay?