Merge pull request #4 from Nyveon/dev

Merging dev branch to main for release 1.4

Author: Nyveon

.gitignore

@@ -127,3 +127,7 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# testing stuff
+/new_region/
+/world/

.idea/.gitignore

@@ -9,34 +9,39 @@ Fixes errors such as `Unknown structure start: <missing structure>`, `Failed to
 # Usage
 
 1. Install the requirements: [Python 3.x](https://www.python.org/) and [Matcool's Anvil Parser](https://github.com/matcool/anvil-parser).
-2. Download the [latest release](https://github.com/Nyveon/MCStructureCleaner/releases/) and place main.py in the same directory as your world folder (e.g: if it's a server, in the server folder).
-3. Run main.py, and instruct it as to which structure tag you wish to remove. I recommend using [NBTExplorer](https://github.com/jaquadro/NBTExplorer) to find the name.
-   - -h For help on command line arguments.
-   - -t For the tag you want removed, in quotes.
-   - -j For the number of threads you want to run it on. Default: 2 x CPU Cores.
-   - -w For the name of the world you want to process. Default: "world".
-   - -r For the name of the sub-folder (dimension) in the world. Default: "".
-   - Example: 
+2. Download the [latest release](https://github.com/Nyveon/MCStructureCleaner/releases/) and place `main.py` in the same directory as your world folder 
+   - **Example:** If it's a server: in the server folder, or if it is a singleplayer world, in the saves folder.
+3. Run main.py with any of the following configuration properties. I recommend using [NBTExplorer](https://github.com/jaquadro/NBTExplorer) to find the name, or just letting the program fix all non-vanilla names by not inputting any tag.
+   - `-h` For help on command line arguments.
+   - `-t` For the tag you want removed, in quotes. Leave empty if you wish to remove ALL NON-VANILLA TAGS.
+   - `-j` For the number of threads you want to run it on. Default: 2 x CPU Cores.
+   - `-w` For the name of the world you want to process. Default: "world".
+   - `-r` For the name of the sub-folder (dimension) in the world. Default: "".
+   - **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" in the world "My World", in the Nether (DIM-1), using 8 threads. 
    ```
    python main.py -t "Better Mineshaft" -j 8 -w "My World" -r "DIM-1"
    ```
-   - This would remove all references of the tag "Better Mineshaft" from the nether (DIM-1) of the world named My World, using 8 threads.
-4. Let it run.
+4. Let it run. This may take a while, depending on the power of your computer and the size of your world.
 5. Replace the contents of your region folder with the contents of new_region.
+6. Enjoy your now working world 😊
 
 # Todo:
 
 - [x] More detailed output.
-- [ ] Multiple tag input. (In progress)
+- [x] Multiple tag input. (Implemented in 1.4)
 - [x] Multithreading. (Thanks DemonInTheCloset!, now 2.8x faster)
 - [x] Command line arguments. (Thanks DemonInTheCloset)
 - [x] Selection of world/dimensions.
 - [ ] Allow for picking up progress where program left off.
 - [ ] Checking disk space available.
-- [ ] Auto-removal of all non vanilla structures mode.
+- [x] Auto-removal of all non vanilla structures mode. (Implemented in 1.4)
 
 # Notes:
 
-- I have only tested this with 1.16 worlds.
-- Feel free to message me on twitter if you need help using it.
-- With large worlds, it may take a while to process, also depends on your hardware. 
+- I have only tested this with 1.16 worlds. In theory it should work with all worlds that use the anvil format though.
+- Feel free to message me on discord or twitter if you need help using it.
+- Why did we make this? To save our own SMP world after uninstalling some mods. 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.

.idea/MCStructureCleaner.iml

@@ -2,7 +2,7 @@
 MC Structure cleaner
 By: Nyveon and DemonInTheCloset
 
-v: 1.3
+v: 1.4
 Modded structure cleaner for minecraft. Removes all references to non-existent
 structures to allow for clean error logs and chunk saving.
 """
@@ -26,70 +26,119 @@
 from multiprocessing import Pool, cpu_count
 
 import anvil  # anvil-parser by matcool
-
-VERSION = "1.3"
-
-
+from typing import Set, Tuple
+
+VERSION = "1.4"
+
+# Configuration variables and constants
+# Gracias panchito, tomimi y puntito c:
+VANILLA_STRUCTURES = {
+    "bastion_remnant",
+    "buried_treasure",
+    "endcity",
+    "fortress",
+    "mansion",
+    "mineshaft",
+    "monument",
+    "nether_fossil",
+    "ocean_ruin",
+    "pillager_outpost",
+    "ruined_portal",
+    "shipwreck",
+    "stronghold",
+    "desert_pyramid",
+    "igloo",
+    "jungle_pyramid",
+    "swamp_hut",
+    "village"
+}
+
+
+# Print separator
 def sep():
     """Print separator line"""
     print("----------------------------------")
 
 
 # Removing Tags
-def _remove_tags_region(args: tuple[set[str], Path, Path]) -> int:
+def _remove_tags_region(args: Tuple[Set[str], Path, Path, str]) -> int:
     return remove_tags_region(*args)
 
 
-def remove_tags_region(to_replace: set[str], src: Path, dst: Path) -> int:
+def remove_tags_region(to_replace: Set[str], src: Path, dst: Path, mode: str) -> int:
     """Remove tags in to_replace from the src region
     Write changes to dst/src.name"""
     start: float = time.perf_counter()
     count: int = 0
 
+    print("Checking file:", src)
+
     coords = src.name.split(".")
     region = anvil.Region.from_file(str(src.resolve()))
     new_region = anvil.EmptyRegion(int(coords[1]), int(coords[2]))
+    removed_tags = set()
+
+    # Lambda function for checking if a tag is valid
+    if mode == "purge":
+        def check_tag(_tag):
+            return _tag.name not in VANILLA_STRUCTURES
+    else:
+        def check_tag(_tag):
+            return _tag.name in to_replace
 
     # Check chunks
     for chunk_x, chunk_z in it.product(range(32), repeat=2):
         # Chunk Exists
         if region.chunk_location(chunk_x, chunk_z) != (0, 0):
             data = region.chunk_data(chunk_x, chunk_z)
+            data_copy = region.chunk_data(chunk_x, chunk_z)
 
             for tag in data["Level"]["Structures"]["Starts"].tags:
-                if tag.name in to_replace:
-                    del data["Level"]["Structures"]["Starts"][tag.name]
+                if check_tag(tag):
+                    del data_copy["Level"]["Structures"]["Starts"][tag.name]
                     count += 1
+                    removed_tags.add(tag.name)
 
             for tag in data["Level"]["Structures"]["References"].tags:
-                if tag.name in to_replace:
-                    del data["Level"]["Structures"]["References"][tag.name]
+                if check_tag(tag):
+                    del data_copy["Level"]["Structures"]["References"][tag.name]
                     count += 1
+                    removed_tags.add(tag.name)
 
             # Add the modified chunk data to the new region
-            new_region.add_chunk(anvil.Chunk(data))
+            new_region.add_chunk(anvil.Chunk(data_copy))
 
     # Save Region
     new_region.save(str((dst / src.name).resolve()))
 
     end: float = time.perf_counter()
-    print(f"{count} instances of tags removed in {end - start:.3f} s")
+    print(f"File {src}: {count} instances of tags removed in {end - start:.3f} s")
+
+    # Output for purge mode (removed non vanilla tags per file)
+    if mode == "purge" and len(removed_tags) != 0:
+        print("Non-vanilla tags found:")
+        print(removed_tags)
+        sep()
 
     return count
 
 
-def remove_tags(tags: set[str], src: Path, dst: Path, jobs: int) -> None:
+def remove_tags(tags: Set[str], src: Path, dst: Path, jobs: int, mode: str) -> None:
     """Removes tags from src region files and writes them to dst"""
     with Pool(processes=jobs) as pool:
         start = time.perf_counter()
 
-        data = zip(it.repeat(tags), src.iterdir(), it.repeat(dst))
+        data = zip(it.repeat(tags), src.iterdir(), it.repeat(dst), it.repeat(mode))
         count = sum(pool.map(_remove_tags_region, data))
 
         end = time.perf_counter()
 
         sep()
-        print(f"Done!\nRemoved {count} instances of tags: {tags}")
+        if mode == "purge":
+            print(f"Done!\nRemoved {count} instances of non-vanilla tags")
+        else:
+            print(f"Done!\nRemoved {count} instances of tags: {tags}")
+
         print(f"Took {end - start:.3f} seconds")
 
 
@@ -99,7 +148,7 @@ def setup_environment(new_region: Path) -> bool:
     if new_region.exists():
         print(f"{new_region.resolve()} exists, this may cause problems")
         proceed = input("Do you want to proceed regardless? [y/N] ")
-
+        sep()
         return proceed.startswith("y")
 
     new_region.mkdir()
@@ -115,14 +164,14 @@ def get_args() -> Namespace:
 
     prog_msg = f"MC Structure cleaner\nBy: Nyveon\nVersion: {VERSION}"
     tag_help = "The EXACT structure tag name you want removed (Use NBTExplorer\
-            to find the name)"
+            to find the name), default is an empty string (for use in purge mode)"
     jobs_help = f"The number of processes to run (default: {jobs})"
     world_help = f"The name of the world you wish to process (default: \"world\")"
     region_help = f"The name of the region folder (dimension) you wish to process (default: "")"
 
     parser = ArgumentParser(prog=prog_msg)
 
-    parser.add_argument("-t", "--tag", type=str, help=tag_help, required=True)
+    parser.add_argument("-t", "--tag", type=str, help=tag_help, default="", nargs="*")
     parser.add_argument("-j", "--jobs", type=int, help=jobs_help, default=jobs)
     parser.add_argument("-w", "--world", type=str, help=world_help, default="world")
     parser.add_argument("-r", "--region", type=str, help=region_help, default="")
@@ -133,32 +182,49 @@ def get_args() -> Namespace:
 def _main() -> None:
     args = get_args()
 
-    to_replace = args.tag
+    to_replace = set(args.tag)
     new_region = Path("new_" + args.region + "region")
     world_region = Path(args.world + "/" + args.region + "/region")
     num_processes = args.jobs
 
-    print(f"Replacing {to_replace} in all region files in {world_region}.")
     sep()
 
+    # Force purge mode if no tag is given, otherwise normal.
+    mode = "normal"
+    if args.tag == "":
+        print("No tag given, will run in purge mode.")
+        mode = "purge"
+    else:
+        print("Tag(s) given, will run in normal mode.")
+
+    # Feedback as to what the program is about to do.
+    if mode == "normal":
+        print(f"Replacing {to_replace} in all region files in {world_region}.")
+    elif mode == "purge":
+        print(f"Replacing all non-vanilla structures in all region files in {world_region}.")
+    sep()
+
+    # Check if world exists
     if not world_region.exists():
         print(f"Couldn't find {world_region.resolve()}")
         return None
 
+    # Check if output already exists
     if not setup_environment(new_region):
         print("Aborted, nothing was done")
         return None
 
     n_to_process = len(list(world_region.iterdir()))
 
-    remove_tags({to_replace}, world_region, new_region, num_processes)
+    remove_tags(to_replace, world_region, new_region, num_processes, mode)
 
+    # End output
     sep()
     print(f"Processed {n_to_process} files")
     print(f"You can now replace {world_region} with {new_region}")
-
     return None
 
 
+# When running
 if __name__ == "__main__":
     _main()