Update kvui.py

* Add a ruff.toml to the root directory

* spell out C901

* Add target version

* Add some more of the suggested rules

* ignore PLC0415

* TC is bad

* ignore B0011

* ignore N818

* Ignore some more rules

* Add PLC1802 to ignore list

* Update ruff.toml

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

* oops

* R to RET and RSC

* oops

* Py311

* Update ruff.toml

---------

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

Generate.py

@@ -23,7 +23,7 @@ from BaseClasses import seeddigits, get_seed, PlandoOptions
 from Utils import parse_yamls, version_tuple, __version__, tuplize_version
 
 
-def mystery_argparse():
+def mystery_argparse(argv: list[str] | None = None):
     from settings import get_settings
     settings = get_settings()
     defaults = settings.generator
@@ -57,7 +57,7 @@ def mystery_argparse():
     parser.add_argument("--spoiler_only", action="store_true",
                         help="Skips generation assertion and multidata, outputting only a spoiler log. "
                              "Intended for debugging and testing purposes.")
-    args = parser.parse_args()
+    args = parser.parse_args(argv)
 
     if args.skip_output and args.spoiler_only:
         parser.error("Cannot mix --skip_output and --spoiler_only")

WebHostLib/__init__.py

@@ -1,6 +1,7 @@
 import base64
 import os
 import socket
+import typing
 import uuid
 
 from flask import Flask
@@ -61,20 +62,21 @@ cache = Cache()
 Compress(app)
 
 
-def to_python(value):
+def to_python(value: str) -> uuid.UUID:
     return uuid.UUID(bytes=base64.urlsafe_b64decode(value + '=='))
 
 
-def to_url(value):
+def to_url(value: uuid.UUID) -> str:
     return base64.urlsafe_b64encode(value.bytes).rstrip(b'=').decode('ascii')
 
 
 class B64UUIDConverter(BaseConverter):
 
-    def to_python(self, value):
+    def to_python(self, value: str) -> uuid.UUID:
         return to_python(value)
 
-    def to_url(self, value):
+    def to_url(self, value: typing.Any) -> str:
+        assert isinstance(value, uuid.UUID)
         return to_url(value)
 
 
@@ -84,7 +86,7 @@ app.jinja_env.filters["suuid"] = to_url
 app.jinja_env.filters["title_sorted"] = title_sorted
 
 
-def register():
+def register() -> None:
     """Import submodules, triggering their registering on flask routing.
     Note: initializes worlds subsystem."""
     import importlib

WebHostLib/autolauncher.py

@@ -17,7 +17,7 @@ from .locker import Locker, AlreadyRunningException
 _stop_event = Event()
 
 
-def stop():
+def stop() -> None:
     """Stops previously launched threads"""
     global _stop_event
     stop_event = _stop_event

WebHostLib/generate.py

@@ -137,7 +137,7 @@ def gen_game(gen_options: dict, meta: dict[str, Any] | None = None, owner=None,
 
         seedname = "W" + (f"{random.randint(0, pow(10, seeddigits) - 1)}".zfill(seeddigits))
 
-        args = mystery_argparse()
+        args = mystery_argparse([])  # Just to set up the Namespace with defaults
         args.multi = playercount
         args.seed = seed
         args.name = {x: "" for x in range(1, playercount + 1)}  # only so it can be overwritten in mystery

WebHostLib/requirements.txt

@@ -11,3 +11,4 @@ bokeh>=3.6.3
 markupsafe>=3.0.2
 setproctitle>=1.3.5
 mistune>=3.1.3
+docutils>=0.22.2

kvui.py

@@ -34,6 +34,17 @@ from kivy.config import Config
 Config.set("input", "mouse", "mouse,disable_multitouch")
 Config.set("kivy", "exit_on_escape", "0")
 Config.set("graphics", "multisamples", "0")  # multisamples crash old intel drivers
+
+# Workaround for an issue where importing kivy.core.window before loading sounds
+# will hang the whole application on Linux once the first sound is loaded.
+# kivymd imports kivy.core.window, so we have to do this before the first kivymd import.
+# No longer necessary when we switch to kivy 3.0.0, which fixes this issue.
+from kivy.core.audio import SoundLoader
+for classobj in SoundLoader._classes:
+    # The least invasive way to force a SoundLoader class to load its audio engine seems to be calling
+    # .extensions(), which e.g. in audio_sdl2.pyx then calls a function called "mix_init()"
+    classobj.extensions()
+
 from kivymd.uix.divider import MDDivider
 from kivy.core.window import Window
 from kivy.core.clipboard import Clipboard

ruff.toml

@@ -0,0 +1,16 @@
+line-length = 120
+indent-width = 4
+target-version = "py311"
+
+[lint]
+select = ["B", "C", "E", "F", "W", "I", "N", "Q", "UP", "RET", "RSE", "RUF", "ISC", "PLC", "PLE", "PLW", "T20", "PERF"]
+ignore = [
+    "B011",  # In AP, the use of assert False is essential because we optimise out these statements for release builds.
+    "C901",  # Author disagrees with limiting branch complexity
+    "N818",  # Author agrees with this rule, but Core AP violates this and changing it would be a hassle.
+    "PLC0415",  # In AP, we consider local imports totally fine & necessary
+    "PLC1802",  # Author agrees with this rule, but it literally changes the functionality of the code, which is unsafe.
+    "PLC1901",  # This is just not equivalent
+    "PLE1141",  # Gives false positives when the dict keys are tuples, but does not mention this in the suggested fix.
+    "UP015",  # Explicit is better than implicit, so we'd prefer to keep "r" in open() calls.
+]

setup.py

@@ -146,7 +146,16 @@ def download_SNI() -> None:
 
 signtool: str | None = None
 try:
-    with urllib.request.urlopen('http://192.168.206.4:12345/connector/status') as response:
+    import socket
+
+    sign_host, sign_port = "192.168.206.4", 12345
+    # check if the sign_host is on a local network
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    s.connect((sign_host, sign_port))
+    if s.getsockname()[0].rsplit(".", 1)[0] != sign_host.rsplit(".", 1)[0]:
+        raise ConnectionError()  # would go through default route
+    # configure signtool
+    with urllib.request.urlopen(f"http://{sign_host}:{sign_port}/connector/status") as response:
         html = response.read()
     if b"status=OK\n" in html:
         signtool = (r'signtool sign /sha1 6df76fe776b82869a5693ddcb1b04589cffa6faf /fd sha256 /td sha256 '

test/general/test_world_manifest.py

@@ -0,0 +1,102 @@
+"""Check world sources' manifest files"""
+
+import json
+import unittest
+from pathlib import Path
+from typing import Any, ClassVar
+
+import test
+from Utils import home_path, local_path
+from worlds.AutoWorld import AutoWorldRegister
+from ..param import classvar_matrix
+
+
+test_path = Path(test.__file__).parent
+worlds_paths = [
+    Path(local_path("worlds")),
+    Path(local_path("custom_worlds")),
+    Path(home_path("worlds")),
+    Path(home_path("custom_worlds")),
+]
+
+# Only check source folders for now. Zip validation should probably be in the loader and/or installer.
+source_world_names = [
+    k
+    for k, v in AutoWorldRegister.world_types.items()
+    if not v.zip_path and not Path(v.__file__).is_relative_to(test_path)
+]
+
+
+def get_source_world_manifest_path(game: str) -> Path | None:
+    """Get path of archipelago.json in the world's root folder from game name."""
+    # TODO: add a feature to AutoWorld that makes this less annoying
+    world_type = AutoWorldRegister.world_types[game]
+    world_type_path = Path(world_type.__file__)
+    for worlds_path in worlds_paths:
+        if world_type_path.is_relative_to(worlds_path):
+            world_root = worlds_path / world_type_path.relative_to(worlds_path).parents[0]
+            manifest_path = world_root / "archipelago.json"
+            return manifest_path if manifest_path.exists() else None
+    assert False, f"{world_type_path} not found in any worlds path"
+
+
+# TODO: remove the filter once manifests are mandatory.
+@classvar_matrix(game=filter(get_source_world_manifest_path, source_world_names))
+class TestWorldManifest(unittest.TestCase):
+    game: ClassVar[str]
+    manifest: ClassVar[dict[str, Any]]
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        world_type = AutoWorldRegister.world_types[cls.game]
+        assert world_type.game == cls.game
+        manifest_path = get_source_world_manifest_path(cls.game)
+        assert manifest_path  # make mypy happy
+        with manifest_path.open("r", encoding="utf-8") as f:
+            cls.manifest = json.load(f)
+
+    def test_game(self) -> None:
+        """Test that 'game' will be correctly defined when generating APWorld manifest from source."""
+        self.assertIn(
+            "game",
+            self.manifest,
+            f"archipelago.json manifest exists for {self.game} but does not contain 'game'",
+        )
+        self.assertEqual(
+            self.manifest["game"],
+            self.game,
+            f"archipelago.json manifest for {self.game} specifies wrong game '{self.manifest['game']}'",
+        )
+
+    def test_world_version(self) -> None:
+        """Test that world_version matches the requirements in apworld specification.md""" 
+        if "world_version" in self.manifest:
+            world_version: str = self.manifest["world_version"]
+            self.assertIsInstance(
+                world_version,
+                str,
+                f"world_version in archipelago.json for '{self.game}' has to be string if provided.",
+            )
+            parts = world_version.split(".")
+            self.assertEqual(
+                len(parts),
+                3,
+                f"world_version in archipelago.json for '{self.game}' has to be in the form of 'major.minor.build'.",
+            )
+            for part in parts:
+                self.assertTrue(
+                    part.isdigit(),
+                    f"world_version in archipelago.json for '{self.game}' may only contain numbers.",
+                )
+
+    def test_no_container_version(self) -> None:
+        self.assertNotIn(
+            "version",
+            self.manifest,
+            f"archipelago.json for '{self.game}' must not define 'version', see apworld specification.md.",
+        )
+        self.assertNotIn(
+            "compatible_version",
+            self.manifest,
+            f"archipelago.json for '{self.game}' must not define 'compatible_version', see apworld specification.md.",
+        )

test/hosting/__main__.py

@@ -3,6 +3,7 @@
 # Run with `python test/hosting` instead,
 import logging
 import traceback
+from pathlib import Path
 from tempfile import TemporaryDirectory
 from time import sleep
 from typing import Any
@@ -11,7 +12,7 @@ from test.hosting.client import Client
 from test.hosting.generate import generate_local
 from test.hosting.serve import ServeGame, LocalServeGame, WebHostServeGame
 from test.hosting.webhost import (create_room, get_app, get_multidata_for_room, set_multidata_for_room, start_room,
-                                  stop_autohost, upload_multidata)
+                                  stop_autogen, stop_autohost, upload_multidata, generate_remote)
 from test.hosting.world import copy as copy_world, delete as delete_world
 
 failure = False
@@ -56,35 +57,62 @@ else:
 
 
 if __name__ == "__main__":
+    import sys
     import warnings
+
     warnings.simplefilter("ignore", ResourceWarning)
     warnings.simplefilter("ignore", UserWarning)
+    warnings.simplefilter("ignore", DeprecationWarning)
 
     spacer = '=' * 80
 
     with TemporaryDirectory() as tempdir:
+        empty_file = str(Path(tempdir) / "empty")
+        open(empty_file, "w").close()
+        sys.argv += ["--config_override", empty_file]  # tests #5541
         multis = [["VVVVVV"], ["Temp World"], ["VVVVVV", "Temp World"]]
-        p1_games = []
-        data_paths = []
-        rooms = []
+        p1_games: list[str] = []
+        data_paths: list[Path | None] = []
+        rooms: list[str] = []
+        multidata: Path | None
 
         copy_world("VVVVVV", "Temp World")
         try:
             for n, games in enumerate(multis, 1):
-                print(f"Generating [{n}] {', '.join(games)}")
+                print(f"Generating [{n}] {', '.join(games)} offline")
                 multidata = generate_local(games, tempdir)
                 print(f"Generated [{n}] {', '.join(games)} as {multidata}\n")
-                p1_games.append(games[0])
                 data_paths.append(multidata)
+                p1_games.append(games[0])
         finally:
             delete_world("Temp World")
 
         webapp = get_app(tempdir)
         webhost_client = webapp.test_client()
+
         for n, multidata in enumerate(data_paths, 1):
+            assert multidata
             seed = upload_multidata(webhost_client, multidata)
+            print(f"Uploaded [{n}] {multidata} as {seed}\n")
             room = create_room(webhost_client, seed)
-            print(f"Uploaded [{n}] {multidata} as {room}\n")
+            print(f"Started [{n}] {seed} as {room}\n")
+            rooms.append(room)
+
+        # Generate 1 extra game on WebHost
+        from WebHostLib.autolauncher import autogen
+        for n, games in enumerate(multis[:1], len(multis) + 1):
+            multis.append(games)
+            try:
+                print(f"Generating [{n}] {', '.join(games)} online")
+                autogen(webapp.config)
+                sleep(5)  # until we have lazy loading of worlds, wait here for the process to start up
+                seed = generate_remote(webhost_client, games)
+                print(f"Generated [{n}] {', '.join(games)} as {seed}\n")
+            finally:
+                stop_autogen()
+            data_paths.append(None)  # WebHost-only
+            room = create_room(webhost_client, seed)
+            print(f"Started [{n}] {seed} as {room}\n")
             rooms.append(room)
 
         print("Starting autohost")
@@ -96,31 +124,10 @@ if __name__ == "__main__":
             for n, (multidata, room, game, multi_games) in enumerate(zip(data_paths, rooms, p1_games, multis), 1):
                 involved_games = {"Archipelago"} | set(multi_games)
                 for collected_items in range(3):
-                    print(f"\nTesting [{n}] {game} in {multidata} on MultiServer with {collected_items} items collected")
-                    with LocalServeGame(multidata) as host:
-                        with Client(host.address, game, "Player1") as client:
-                            local_data_packages = client.games_packages
-                            local_collected_items = len(client.checked_locations)
-                            if collected_items < 2:  # Don't collect anything on the last iteration
-                                client.collect_any()
-                            # TODO: Ctrl+C test here as well
-
-                    for game_name in sorted(involved_games):
-                        expect_true(game_name in local_data_packages,
-                                    f"{game_name} missing from MultiServer datap ackage")
-                        expect_true("item_name_groups" not in local_data_packages.get(game_name, {}),
-                                    f"item_name_groups are not supposed to be in MultiServer data for {game_name}")
-                        expect_true("location_name_groups" not in local_data_packages.get(game_name, {}),
-                                    f"location_name_groups are not supposed to be in MultiServer data for {game_name}")
-                    for game_name in local_data_packages:
-                        expect_true(game_name in involved_games,
-                                    f"Received unexpected extra data package for {game_name} from MultiServer")
-                    assert_equal(local_collected_items, collected_items,
-                                 "MultiServer did not load or save correctly")
-
                     print(f"\nTesting [{n}] {game} in {multidata} on customserver with {collected_items} items collected")
                     prev_host_adr: str
                     with WebHostServeGame(webhost_client, room) as host:
+                        sleep(.1)  # wait for the server to fully start before doing anything
                         prev_host_adr = host.address
                         with Client(host.address, game, "Player1") as client:
                             web_data_packages = client.games_packages
@@ -134,6 +141,7 @@ if __name__ == "__main__":
                                 autohost(webapp.config)  # this will spin the room right up again
                                 sleep(1)  # make log less annoying
                                 # if saving failed, the next iteration will fail below
+                        sleep(2)  # work around issue #5571
 
                     # verify server shut down
                     try:
@@ -156,6 +164,31 @@ if __name__ == "__main__":
                                  "customserver did not load or save correctly during/after "
                                  + ("Ctrl+C" if collected_items == 2 else "/exit"))
 
+                    if not multidata:
+                        continue  # games rolled on WebHost can not be tested against MultiServer
+
+                    print(f"\nTesting [{n}] {game} in {multidata} on MultiServer with {collected_items} items collected")
+                    with LocalServeGame(multidata) as host:
+                        with Client(host.address, game, "Player1") as client:
+                            local_data_packages = client.games_packages
+                            local_collected_items = len(client.checked_locations)
+                            if collected_items < 2:  # Don't collect anything on the last iteration
+                                client.collect_any()
+                            # TODO: Ctrl+C test here as well
+
+                    for game_name in sorted(involved_games):
+                        expect_true(game_name in local_data_packages,
+                                    f"{game_name} missing from MultiServer datapackage")
+                        expect_true("item_name_groups" not in local_data_packages.get(game_name, {}),
+                                    f"item_name_groups are not supposed to be in MultiServer data for {game_name}")
+                        expect_true("location_name_groups" not in local_data_packages.get(game_name, {}),
+                                    f"location_name_groups are not supposed to be in MultiServer data for {game_name}")
+                    for game_name in local_data_packages:
+                        expect_true(game_name in involved_games,
+                                    f"Received unexpected extra data package for {game_name} from MultiServer")
+                    assert_equal(local_collected_items, collected_items,
+                                 "MultiServer did not load or save correctly")
+
                     # compare customserver to MultiServer
                     expect_equal(local_data_packages, web_data_packages,
                                  "customserver datapackage differs from MultiServer")
@@ -176,10 +209,12 @@ if __name__ == "__main__":
             print(f"Restoring multidata for {room}")
             set_multidata_for_room(webhost_client, room, old_data)
             with WebHostServeGame(webhost_client, room) as host:
+                sleep(.1)  # wait for the server to fully start before doing anything
                 with Client(host.address, game, "Player1") as client:
                     assert_equal(len(client.checked_locations), 2,
                                  "Save was destroyed during exception in customserver")
                     print("Save file is not busted 🥳")
+                sleep(2)  # work around issue #5571
 
         finally:
             print("Stopping autohost")

test/hosting/webhost.py

@@ -1,6 +1,10 @@
+import io
+import json
 import re
+import time
+import zipfile
 from pathlib import Path
-from typing import TYPE_CHECKING, Optional, cast
+from typing import TYPE_CHECKING, Iterable, Optional, cast
 
 from WebHostLib import to_python
 
@@ -10,6 +14,7 @@ if TYPE_CHECKING:
 
 __all__ = [
     "get_app",
+    "generate_remote",
     "upload_multidata",
     "create_room",
     "start_room",
@@ -17,6 +22,7 @@ __all__ = [
     "set_room_timeout",
     "get_multidata_for_room",
     "set_multidata_for_room",
+    "stop_autogen",
     "stop_autohost",
 ]
 
@@ -33,10 +39,43 @@ def get_app(tempdir: str) -> "Flask":
         "TESTING": True,
         "HOST_ADDRESS": "localhost",
         "HOSTERS": 1,
+        "GENERATORS": 1,
+        "JOB_THRESHOLD": 1,
     })
     return get_app()
 
 
+def generate_remote(app_client: "FlaskClient", games: Iterable[str]) -> str:
+    data = io.BytesIO()
+    with zipfile.ZipFile(data, "a", zipfile.ZIP_DEFLATED, False) as zip_file:
+        for n, game in enumerate(games, 1):
+            name = f"{n}.yaml"
+            zip_file.writestr(name, json.dumps({
+                "name": f"Player{n}",
+                "game": game,
+                game: {},
+                "description": f"generate_remote slot {n} ('Player{n}'): {game}",
+            }))
+    data.seek(0)
+    response = app_client.post("/generate", content_type="multipart/form-data", data={
+        "file": (data, "yamls.zip"),
+    })
+    assert response.status_code < 400, f"Starting gen failed: status {response.status_code}"
+    assert "Location" in response.headers, f"Starting gen failed: no redirect"
+    location = response.headers["Location"]
+    assert isinstance(location, str)
+    assert location.startswith("/wait/"), f"Starting WebHost gen failed: unexpected redirect to {location}"
+    for attempt in range(10):
+        response = app_client.get(location)
+        if "Location" in response.headers:
+            location = response.headers["Location"]
+            assert isinstance(location, str)
+            assert location.startswith("/seed/"), f"Finishing WebHost gen failed: unexpected redirect to {location}"
+            return location[6:]
+        time.sleep(1)
+    raise TimeoutError("WebHost gen did not finish")
+
+
 def upload_multidata(app_client: "FlaskClient", multidata: Path) -> str:
     response = app_client.post("/uploads", data={
         "file": multidata.open("rb"),
@@ -188,7 +227,7 @@ def set_multidata_for_room(webhost_client: "FlaskClient", room_id: str, data: by
         room.seed.multidata = data
 
 
-def stop_autohost(graceful: bool = True) -> None:
+def _stop_webhost_mp(name_filter: str, graceful: bool = True) -> None:
     import os
     import signal
 
@@ -198,13 +237,30 @@ def stop_autohost(graceful: bool = True) -> None:
 
     stop()
     proc: multiprocessing.process.BaseProcess
-    for proc in filter(lambda child: child.name.startswith("MultiHoster"), multiprocessing.active_children()):
+    for proc in filter(lambda child: child.name.startswith(name_filter), multiprocessing.active_children()):
+        # FIXME: graceful currently does not work on Windows because the signals are not properly emulated
+        #        and ungraceful may not save the game
+        if proc.pid == os.getpid():
+            continue
         if graceful and proc.pid:
             os.kill(proc.pid, getattr(signal, "CTRL_C_EVENT", signal.SIGINT))
         else:
             proc.kill()
         try:
-            proc.join(30)
+            try:
+                proc.join(30)
+            except TimeoutError:
+                raise
+            except KeyboardInterrupt:
+                # on Windows, the MP exception may be forwarded to the host, so ignore once and retry
+                proc.join(30)
         except TimeoutError:
             proc.kill()
             proc.join()
+
+def stop_autogen(graceful: bool = True) -> None:
+    # FIXME: this name filter is jank, but there seems to be no way to add a custom prefix for a Pool
+    _stop_webhost_mp("SpawnPoolWorker-", graceful)
+
+def stop_autohost(graceful: bool = True) -> None:
+    _stop_webhost_mp("MultiHoster", graceful)

test/hosting/world.py

@@ -11,7 +11,7 @@ _new_worlds: dict[str, str] = {}
 
 def copy(src: str, dst: str) -> None:
     from Utils import get_file_safe_name
-    from worlds import AutoWorldRegister
+    from worlds.AutoWorld import AutoWorldRegister
 
     assert dst not in _new_worlds, "World already created"
     if '"' in dst or "\\" in dst:  # easier to reject than to escape

worlds/ahit/Client.py

@@ -1,4 +1,6 @@
 import asyncio
+import time
+
 import Utils
 import websockets
 import functools
@@ -208,6 +210,9 @@ async def proxy(websocket, path: str = "/", ctx: AHITContext = None):
                     if not ctx.is_proxy_connected():
                         break
 
+                    if msg["cmd"] == "Bounce" and msg.get("tags") == ["DeathLink"] and "data" in msg:
+                        msg["data"]["time"] = time.time()
+
                     await ctx.send_msgs([msg])
 
     except Exception as e:

worlds/ahit/Regions.py

@@ -243,7 +243,7 @@ guaranteed_first_acts = [
     "Time Rift - Mafia of Cooks",
     "Time Rift - Dead Bird Studio",
     "Time Rift - Sleepy Subcon",
-    "Time Rift - Alpine Skyline"
+    "Time Rift - Alpine Skyline",
     "Time Rift - Tour",
     "Time Rift - Rumbi Factory",
 ]

worlds/kh1/Client.py

@@ -134,13 +134,13 @@ class KH1Context(CommonContext):
                 os.makedirs(self.game_communication_path)
             for ss in self.checked_locations:
                 filename = f"send{ss}"
-                with open(os.path.join(self.game_communication_path, filename), 'w') as f:
+                with open(os.path.join(self.game_communication_path, filename), 'w', encoding='utf-8') as f:
                     f.close()
             
             # Handle Slot Data
             self.slot_data = args['slot_data']
             for key in list(args['slot_data'].keys()):
-                with open(os.path.join(self.game_communication_path, key + ".cfg"), 'w') as f:
+                with open(os.path.join(self.game_communication_path, key + ".cfg"), 'w', encoding='utf-8') as f:
                     f.write(str(args['slot_data'][key]))
                     f.close()
                 if key == "remote_location_ids":
@@ -161,7 +161,7 @@ class KH1Context(CommonContext):
                             found = True
                     if not found:
                         if (NetworkItem(*item).player == self.slot and (NetworkItem(*item).location in self.remote_location_ids) or (NetworkItem(*item).location < 0)) or NetworkItem(*item).player != self.slot:
-                            with open(os.path.join(self.game_communication_path, item_filename), 'w') as f:
+                            with open(os.path.join(self.game_communication_path, item_filename), 'w', encoding='utf-8') as f:
                                 f.write(str(NetworkItem(*item).item) + "\n" + str(NetworkItem(*item).location) + "\n" + str(NetworkItem(*item).player))
                                 f.close()
                                 self.item_num += 1
@@ -170,7 +170,7 @@ class KH1Context(CommonContext):
             if "checked_locations" in args:
                 for ss in self.checked_locations:
                     filename = f"send{ss}"
-                    with open(os.path.join(self.game_communication_path, filename), 'w') as f:
+                    with open(os.path.join(self.game_communication_path, filename), 'w', encoding='utf-8') as f:
                         f.close()
 
         if cmd in {"PrintJSON"} and "type" in args:
@@ -195,7 +195,7 @@ class KH1Context(CommonContext):
                     filename = "msg"
                     if message != "":
                         if not os.path.exists(self.game_communication_path + "/" + filename):
-                            with open(os.path.join(self.game_communication_path, filename), 'w') as f:
+                            with open(os.path.join(self.game_communication_path, filename), 'w', encoding='utf-8') as f:
                                 f.write(message)
                                 f.close()
             if args["type"] == "ItemCheat":
@@ -207,7 +207,7 @@ class KH1Context(CommonContext):
                     filename = "msg"
                     message = "Received " + itemName + "\nfrom server"
                     if not os.path.exists(self.game_communication_path + "/" + filename):
-                        with open(os.path.join(self.game_communication_path, filename), 'w') as f:
+                        with open(os.path.join(self.game_communication_path, filename), 'w', encoding='utf-8') as f:
                             f.write(message)
                             f.close()
 
@@ -218,7 +218,7 @@ class KH1Context(CommonContext):
             logger.info(f"DeathLink: {text}")
         else:
             logger.info(f"DeathLink: Received from {data['source']}")
-        with open(os.path.join(self.game_communication_path, 'dlreceive'), 'w') as f:
+        with open(os.path.join(self.game_communication_path, 'dlreceive'), 'w', encoding='utf-8') as f:
             f.write(str(int(data["time"])))
             f.close()
 

worlds/ladx/LADXR/generator.py

@@ -57,6 +57,7 @@ from .patches import bingo as _
 from .patches import multiworld as _
 from .patches import tradeSequence as _
 from . import hints
+from . import utils
 
 from .patches import bank34
 from .roomEditor import RoomEditor, Object
@@ -231,10 +232,10 @@ def generateRom(base_rom: bytes, args, patch_data: Dict):
         rom.patch(0, 0x0003, "00", "01")
 
     # Patch the sword check on the shopkeeper turning around.
-    #if ladxr_settings["steal"] == 'never':
-    #    rom.patch(4, 0x36F9, "FA4EDB", "3E0000")
-    #elif ladxr_settings["steal"] == 'always':
-    #    rom.patch(4, 0x36F9, "FA4EDB", "3E0100")
+    if options["stealing"] == Options.Stealing.option_disabled:
+        rom.patch(4, 0x36F9, "FA4EDB", "3E0000")
+        rom.texts[0x2E] = utils.formatText("Hey!  Welcome!  Did you know that I have eyes on the back of my head?")
+        rom.texts[0x2F] = utils.formatText("Nothing escapes my gaze! Your thieving ways shall never prosper!")
 
     #if ladxr_settings["hpmode"] == 'inverted':
     #    patches.health.setStartHealth(rom, 9)
@@ -325,7 +326,7 @@ def generateRom(base_rom: bytes, args, patch_data: Dict):
             0x1A9, 0x1AA, 0x1AB, 0x1AC, 0x1AD,
 
             # Prices
-            0x02C, 0x02D, 0x030, 0x031, 0x032, 0x033, # Shop items
+            0x02C, 0x02D, 0x02E, 0x02F, 0x030, 0x031, 0x032, 0x033, # Shop items
             0x03B, # Trendy Game
             0x045, # Fisherman
             0x018, 0x019, # Crazy Tracy

worlds/ladx/LADXR/logic/overworld.py

@@ -43,8 +43,12 @@ class World:
         self._addEntrance("start_house", mabe_village, start_house, None)
 
         shop = Location("Shop")
-        Location().add(ShopItem(0)).connect(shop, OR(AND(r.can_farm, COUNT("RUPEES", 500)), SWORD))
-        Location().add(ShopItem(1)).connect(shop, OR(AND(r.can_farm, COUNT("RUPEES", 1480)), SWORD))
+        if options.steal == "inlogic":
+            Location().add(ShopItem(0)).connect(shop, OR(SWORD, AND(r.can_farm, COUNT("RUPEES", 500))))
+            Location().add(ShopItem(1)).connect(shop, OR(SWORD, AND(r.can_farm, COUNT("RUPEES", 1480))))
+        else:
+            Location().add(ShopItem(0)).connect(shop, AND(r.can_farm, COUNT("RUPEES", 500)))
+            Location().add(ShopItem(1)).connect(shop, AND(r.can_farm, COUNT("RUPEES", 1480)))
         self._addEntrance("shop", mabe_village, shop, None)
 
         dream_hut = Location("Dream Hut")

worlds/ladx/LADXR/settings.py

@@ -162,8 +162,8 @@ Note, some entrances can lead into water, use the warp-to-home from the save&qui
 [Hero] Switch version hero mode, double damage, no heart/fairy drops.
 [One hit KO] You die on a single hit, always."""),
             Setting('steal', 'Gameplay', 't', 'Stealing from the shop',
-                options=[('always', 'a', 'Always'), ('never', 'n', 'Never'), ('default', '', 'Normal')], default='default',
-                description="""Effects when you can steal from the shop. Stealing is bad and never in logic.
+                options=[('inlogic', 'a', 'In logic'), ('disabled', 'n', 'Disabled'), ('outoflogic', '', 'Out of logic')], default='outoflogic',
+                description="""Effects when you can steal from the shop and if it is in logic.
 [Normal] requires the sword before you can steal.
 [Always] you can always steal from the shop
 [Never] you can never steal from the shop."""),
@@ -286,7 +286,7 @@ Note, some entrances can lead into water, use the warp-to-home from the save&qui
         if self.goal in ("bingo", "bingo-full"):
             req("overworld", "normal", "Bingo goal does not work with dungeondive")
             req("accessibility", "all", "Bingo goal needs 'all' accessibility")
-            dis("steal", "never", "default", "With bingo goal, stealing should be allowed")
+            dis("steal", "disabled", "default", "With bingo goal, stealing should be allowed")
             dis("boss", "random", "shuffle", "With bingo goal, bosses need to be on normal or shuffle")
             dis("miniboss", "random", "shuffle", "With bingo goal, minibosses need to be on normal or shuffle")
         if self.overworld == "dungeondive":

worlds/ladx/Options.py

@@ -325,6 +325,18 @@ class HardMode(Choice, LADXROption):
     default = option_none
 
 
+class Stealing(Choice, LADXROption):
+    """
+    Puts stealing from the shop in logic if the player has a sword.
+    """
+    display_name = "Stealing"
+    ladxr_name = "steal"
+    option_in_logic = 1
+    option_out_of_logic = 2
+    option_disabled = 3
+    default = option_out_of_logic
+
+
 class Overworld(Choice, LADXROption):
     """
     **Open Mabe:** Replaces rock on the east side of Mabe Village with bushes,
@@ -656,6 +668,7 @@ class LinksAwakeningOptions(PerGameCommonOptions):
     nag_messages: NagMessages
     ap_title_screen: APTitleScreen
     boots_controls: BootsControls
+    stealing: Stealing
     quickswap: Quickswap
     hard_mode: HardMode
     low_hp_beep: LowHpBeep

worlds/ladx/Rom.py

@@ -97,7 +97,7 @@ def write_patch_data(world: "LinksAwakeningWorld", patch: LADXProcedurePatch):
             "nag_messages",
             "ap_title_screen",
             "boots_controls",
-            # "stealing",
+            "stealing",
             "quickswap",
             "hard_mode",
             "low_hp_beep",

worlds/mm2/rom.py

@@ -16,7 +16,7 @@ if TYPE_CHECKING:
     from . import MM2World
 
 MM2LCHASH = "37f2c36ce7592f1e16b3434b3985c497"
-PROTEUSHASH = "9ff045a3ca30018b6e874c749abb3ec4"
+PROTEUSHASH = "b69fff40212b80c94f19e786d1efbf61"
 MM2NESHASH = "0527a0ee512f69e08b8db6dc97964632"
 MM2VCHASH = "0c78dfe8e90fb8f3eed022ff01126ad3"
 
@@ -404,7 +404,7 @@ def get_base_rom_path(file_name: str = "") -> str:
     return file_name
 
 
-PRG_OFFSET = 0x8ED70
+PRG_OFFSET = 0x8F170
 PRG_SIZE = 0x40000
 
 

worlds/pokemon_rb/regions.py

@@ -1237,7 +1237,7 @@ saffron_gym_warps = [
 
 entrance_only = [
     "Route 4-W to Mt Moon 1F", "Saffron City-G to Saffron Gym-S", "Saffron City-Copycat to Saffron Copycat's House 1F",
-    "Saffron City-Pidgey to Saffron Pidgey House", "Celadon Game Corner-Hidden Stairs to Rocket Hideout B1F"
+    "Saffron City-Pidgey to Saffron Pidgey House", "Celadon Game Corner-Hidden Stairs to Rocket Hideout B1F",
     "Cinnabar Island-M to Pokemon Mansion 1F", "Mt Moon B2F to Mt Moon B1F-W", "Silph Co 7F-NW to Silph Co 11F-W",
     "Viridian City-G", "Cerulean City-Cave to Cerulean Cave 1F-SE", "Cerulean City-T to Cerulean Trashed House",
     "Route 10-P to Power Plant", "S.S. Anne 2F to S.S. Anne Captain's Room", "Pewter City-M to Pewter Museum 1F-E",

worlds/yugioh06/boosterpacks.py

@@ -423,7 +423,7 @@ booster_contents: Dict[str, List[str]] = {
         "Kaiser Glider",
         "Horus the Black Flame Dragon LV6",
         "Luster Dragon",
-        "Luster Dragon #2"
+        "Luster Dragon #2",
         "Spear Dragon",
         "Armed Dragon LV3",
         "Armed Dragon LV5",
@@ -634,7 +634,7 @@ booster_contents: Dict[str, List[str]] = {
         "Mystic Swordsman LV6",
         "Horus the Black Flame Dragon LV6",
         "Horus the Black Flame Dragon LV4",
-        "Armed Dragon LV3"
+        "Armed Dragon LV3",
         "Armed Dragon LV5",
         "Silent Swordsman Lv3",
         "Silent Swordsman Lv5",
@@ -750,7 +750,7 @@ booster_contents: Dict[str, List[str]] = {
         "Formation Union",
         "Princess Pikeru",
         "Skull Zoma",
-        "Metal Reflect Slime"
+        "Metal Reflect Slime",
         "Level Up!",
         "Howling Insect",
         "Tribute Doll",

worlds/yugioh06/rules.py

@@ -668,7 +668,7 @@ def only_dragon(state, player):
     ], player) and (state.count_from_list_unique([
         "Luster Dragon",
         "Spear Dragon",
-        "Cave Dragon"
+        "Cave Dragon",
         "Armed Dragon LV3",
         "Masked Dragon",
         "Twin-Headed Behemoth",