Add APWorld version check prior to patching

Author: snowflav-goob

Patch.py

@@ -9,6 +9,8 @@
     ModuleUpdate.update()
 
 from worlds.Files import AutoPatchRegister, APAutoPatchInterface
+from worlds.AutoWorld import AutoWorldRegister
+from Utils import messagebox
 
 
 class RomMeta(TypedDict):
@@ -21,6 +23,14 @@ def create_rom_file(patch_file: str) -> Tuple[RomMeta, str]:
     auto_handler = AutoPatchRegister.get_handler(patch_file)
     if auto_handler:
         handler: APAutoPatchInterface = auto_handler(patch_file)
+        handler.read()
+        game_version = AutoWorldRegister.world_types[handler.game].world_version
+        if handler.world_version and game_version != handler.world_version:
+            info_msg = "This patch was generated with " \
+                       f"{handler.game} version {handler.world_version.as_simple_string()}, " \
+                       f"but its currently installed version is {game_version.as_simple_string()}. " \
+                       "You may encounter errors while patching or connecting."
+            messagebox("APWorld version mismatch", info_msg, False)
         target = os.path.splitext(patch_file)[0]+handler.result_file_ending
         handler.patch(target)
         return {"server": handler.server,

worlds/Files.py

@@ -221,6 +221,7 @@ def get_manifest(self) -> Dict[str, Any]:
 class APPlayerContainer(APContainer):
     """A zipfile containing at least archipelago.json meant for a player"""
     game: ClassVar[Optional[str]] = None
+    world_version: "Version | None" = None
     patch_file_ending: str = ""
 
     player: Optional[int]
@@ -235,10 +236,13 @@ def __init__(self, path: Optional[str] = None, player: Optional[int] = None,
         self.server = server
 
     def read_contents(self, opened_zipfile: zipfile.ZipFile) -> Dict[str, Any]:
+        from Utils import tuplize_version
         manifest = super().read_contents(opened_zipfile)
         self.player = manifest["player"]
         self.server = manifest["server"]
         self.player_name = manifest["player_name"]
+        if "world_version" in manifest:
+            self.world_version = tuplize_version(manifest["world_version"])
         return manifest
 
     def get_manifest(self) -> Dict[str, Any]:
@@ -250,6 +254,9 @@ def get_manifest(self) -> Dict[str, Any]:
             "game": self.game,
             "patch_file_ending": self.patch_file_ending,
         })
+        if self.game:
+            from .AutoWorld import AutoWorldRegister
+            manifest["world_version"] = AutoWorldRegister.world_types[self.game].world_version.as_simple_string()
         return manifest
 
 
@@ -343,7 +350,6 @@ def write_file(self, file_name: str, file: bytes) -> None:
         self.files[file_name] = file
 
     def patch(self, target: str) -> None:
-        self.read()
         base_data = self.get_source_data_with_cache()
         patch_extender = AutoPatchExtensionRegister.get_handler(self.game)
         assert not isinstance(self.procedure, str), f"{type(self)} must define procedures"