Missing Structure Fix - Modded structure cleaner for minecraft. Removes all references to non-existent structures to allow for clean error logs and chunk saving. The program goes through every chunk, in every region file of the world, removing the relevant structure reference and structure start tags.
Designed to fix worlds suffering from the [MC-194811] Missing structures will destroy saved worlds bug, where uninstalling a mod which generated custom structures causes the world to become unstable.
Fixes errors such as Unknown structure start: <missing structure>, Failed to save chunk
- Install the requirements: Python 3.x and Matcool's Anvil Parser.
- Download the latest release from the releases page and extract it.
- Once installed, double click on
main.pyto run the program. - You should see an interface like this.
todo
Only recommended if the GUI does not work on your device
-
Run main.py with any of the following parameters. I recommend using NBTExplorer to find the name, or just letting the program fix all non-vanilla names by not inputting any tag.
-hFor help on command line arguments.-tFor the tag you want removed, in quotes. Leave empty if you wish to remove ALL NON-VANILLA TAGS.-jFor the number of threads you want to run it on. Default: 2 x CPU logical processors.-wFor the name of the world you want to process. Default: "world".-pFor the path to the world you want to process. Default: current directory.-rFor the name of the sub-folder (dimension) in the world. Default: "".-oFor the path of the folder where the new region folder will be saved to. Default: current directory.- Example 1: This command will delete all non-vanilla structures (defined up to 1.17) in the overworld of the world "SMP"
python main.py -w "SMP"- Example 2: This command will delete all occurances of "Better Mineshaft" and of "Better Stronghold" in the world "MyWorld", in the Nether (DIM-1), using 8 threads. The world folder is located in the user's minecraft saves, and the output will be saved to the desktop.
python main.py -t "Better Mineshaft" "Better Stronghold" -j 8 -w "My World" -r "DIM-1" -p "C:\Users\X\AppData\Roaming\.minecraft\saves\MyWorld" -o "C:\Users\X\Desktop"
If you are on windows, I recommend using PowerShell.
-
Let it run. This may take a while, depending on the power of your computer and the size of your world.
-
Replace the contents of your region folder with the contents of new_region.
-
Enjoy your now working world 😊
- Always back up your worlds before making any changes to them.
- Structure specific effects that remained after uninstalling the mod will no longer work for the removed structures (This includes locating structures and custom loot tables).
- If you have corrupted region files (With the wrong data format, or a size of 0b) the script may crash.
Clone the repository, then install requirements:
pip install -r requirements.txt
pip install -r tests/requirements.txtMost standard linters are fine as long as the code is readable, the project files are currently linted with flake8.
- VSCode: the testing environment is already configured, simply press the
Run Testsbutton added by the official Python Extension. - Command Line:
pytest -v --cov=. tests/ --cov-report xml:cov.xml- Expected coverage: The
structurecleanerfolder should have 100% coverage.
- Generate your expected input files and output files. This can be done easily by running the program on a world, and then copying the region folder to the
testsfolder, and renaming it toexpected_inputandexpected_outputrespectively. However, for new formats it is important to thoroughly check the output or make it by hand with NBTExplorer! - Place them in the directory
tests/data/Xwhere X is the name of the test. (See other tests for reference) - Use
remove_tags_testin thetestsdirectory to create your test. (See other tests for reference) - Run pytest. The coverage should be the same as before, and the test should pass.
Contributions are always welcome! See the issues page for ideas, or feel free to suggest your own ideas.
- Feel free to message me on discord (Nyveon#9999) or twitter (Nyveon) if you need help using it.
- Why did we make this? To save our own SMP world after uninstalling some mods and getting the MC-194811 error. We had spent a lot of time on it, and didn't want anyone else to have to lose their world to the same bug.
- Thanks to @DemonInTheCloset for contributing to multiprocessing and command line arugments.
- Thanks to @lleheny0 for contributing to file validation.
