The Messenger: content update (#2823)

* map option objects to a `World.options` dict

* convert RoR2 to options dict system for testing

* add temp behavior for lttp with notes

* copy/paste bad

* convert `set_default_common_options` to a namespace property

* reorganize test call order

* have fill_restrictive use the new options system

* update world api

* update soe tests

* fix world api

* core: auto initialize a dataclass on the World class with the option results

* core: auto initialize a dataclass on the World class with the option results: small tying improvement

* add `as_dict` method to the options dataclass

* fix namespace issues with tests

* have current option updates use `.value` instead of changing the option

* update ror2 to use the new options system again

* revert the junk pool dict since it's cased differently

* fix begin_with_loop typo

* write new and old options to spoiler

* change factorio option behavior back

* fix comparisons

* move common and per_game_common options to new system

* core: automatically create missing options_dataclass from legacy option_definitions

* remove spoiler special casing and add back the Factorio option changing but in new system

* give ArchipIDLE the default options_dataclass so its options get generated and spoilered properly

* reimplement `inspect.get_annotations`

* move option info generation for webhost to new system

* need to include Common and PerGame common since __annotations__ doesn't include super

* use get_type_hints for the options dictionary

* typing.get_type_hints returns the bases too.

* forgot to sweep through generate

* sweep through all the tests

* swap to a metaclass property

* move remaining usages from get_type_hints to metaclass property

* move remaining usages from __annotations__ to metaclass property

* move remaining usages from legacy dictionaries to metaclass property

* remove legacy dictionaries

* cache the metaclass property

* clarify inheritance in world api

* move the messenger to new options system

* add an assert for my dumb

* update the doc

* rename o to options

* missed a spot

* update new messenger options

* comment spacing

Co-authored-by: Doug Hoskisson <[email protected]>

* fix tests

* fix missing import

* make the documentation definition more accurate

* use options system for loc creation

* type cast MessengerWorld

* fix typo and use quotes for cast

* LTTP: set random seed in tests

* ArchipIdle: remove change here as it's default on AutoWorld

* Stardew: Need to set state because `set_default_common_options` used to

* The Messenger: update shop rando and helpers to new system; optimize imports

* Add a kwarg to `as_dict` to do the casing for you

* RoR2: use new kwarg for less code

* RoR2: revert some accidental reverts

* The Messenger: remove an unnecessary variable

* remove TypeVar that isn't used

* CommonOptions not abstract

* Docs: fix mistake in options api.md

Co-authored-by: Doug Hoskisson <[email protected]>

* create options for item link worlds

* revert accidental doc removals

* Item Links: set default options on group

* Messenger: Limited Movement option first draft

* The Messenger: add automated setup through the launcher

* drop tomllib

* don't uselessly import launcher

* The Messenger: fix missing goal requirement for power seal hunt

* make hard mode goal harder

* make fire seal a bit more lenient

* have limited movement force minimal accessibility

* add an early meditation option

* clean up precollected notes tests a bit

* add linux support

* add steam deck support

* await monokickstart

* minor styling cleanup

* more minor styling cleanup

* Initial implementation of Generic ER

* Move ERType to Entrance.Type, fix typing imports

* updates based on testing (read: flailing)

* Updates from feedback

* Various bug fixes in ERCollectionState

* Use deque instead of queue.Queue

* Allow partial entrances in collection state earlier, doc improvements

* Prevent early loops in region graph, improve reusability of ER stage code

* Typos, grammar, PEP8, and style "fixes"

* use RuntimeError instead of bare Exceptions

* return tuples from connect since it's slightly faster for our purposes

* move the shuffle to the beginning of find_pairing

* do er_state placements within pairing lookups to remove code duplication

* requested adjustments

* Add some temporary performance logging

* Use CollectionState to track available exits and placed regions

* remove seal shuffle option

* some cleanup stuff

* portal rando progress

* pre-emptive region creation

* seals need to be in the datapackage

* put mega shards in old order

* fix typos and make it actually work

* fix more missed connections and add portal events

* fix all the portal rando code

* finish initial logic implementation

* remove/comment out debug stuff

* does not actually support plando yet

* typos and fix a crash when 3 available portals was selected

* finish initial logic for all connections and remove/rename as necessary

* fix typos and add some more leniency

* move item classification determination to its own method rather than split between two spots

* super complicated solution for handling installing the alpha builds

* fix logic bugs and add a test

* implement logic to shuffle the cutscene portals even though it's probably not possible

* just use the one list

* fix some issues with the mod checking/downloading

* Core: have webhost slot name links go through the launcher so that components can use them

* add uri support to the launcher component function

* generate output file under specific conditions

* cleanup connections.py

* set topology_present to true when portals are shuffled

* add requirement for ghost pit loc since it's pretty hard without movement

* bring hard logic back

* misc cleanup

* fix asset grabbing of latest version

* implement ER

* just use the entrances for the spoiler instead of manipulating the cache

* remove test defaults

* remove excessive comprehension

* cleanup and cater data for the client

* add elemental skylands to the shuffle pools

* initial attempts at hint text

* use network items for offline seeds

* change around the offline seed data again

* move er after portal shuffle and ensure a minimal sphere 1

* Add a method to automatically disconnect entrances in a coupled-compliant way

 Update docs and cleanup todos

* Make find_placeable_exits deterministic by sorting blocked_connections set

* add more ER transitions

* fix spoiler output of portal warps

* add path to hint_data

* rename entrance to tot to be a bit clearer

* cleanup imports and update description for hard logic

* cleanup for PR to main

* missed a spot

* cleanup monokickstart

* add location_name_groups

* update docs for new setup

* client can reconnect on its own now, no need for a button.

* fix mod download link grabbing the wrong assets

* cleanup mod pulling a bit and display version it's trying to update to

* plando support

* comment out broken steam deck support

* supports plando

* satisfy flake for currently unused file

* fix the items accessibility test

* review comments

* add searing crags portal to starting portals when disabled like option says

* address sliver comments

* rip out currently unused transition shuffle

* add aerobatics warrior requirement to fire seal

---------

Co-authored-by: el-u <[email protected]>
Co-authored-by: Doug Hoskisson <[email protected]>
Co-authored-by: Doug Hoskisson <[email protected]>
Co-authored-by: Sean Dempsey <[email protected]>
Co-authored-by: qwint <[email protected]>

worlds/messenger/client_setup.py

@@ -0,0 +1,164 @@
+import io
+import logging
+import os.path
+import subprocess
+import urllib.request
+from shutil import which
+from tkinter.messagebox import askyesnocancel
+from typing import Any, Optional
+from zipfile import ZipFile
+from Utils import open_file
+
+import requests
+
+from Utils import is_windows, messagebox, tuplize_version
+
+
+MOD_URL = "https://api.github.com/repos/alwaysintreble/TheMessengerRandomizerModAP/releases/latest"
+
+
+def launch_game(url: Optional[str] = None) -> None:
+    """Check the game installation, then launch it"""
+    def courier_installed() -> bool:
+        """Check if Courier is installed"""
+        return os.path.exists(os.path.join(game_folder, "TheMessenger_Data", "Managed", "Assembly-CSharp.Courier.mm.dll"))
+
+    def mod_installed() -> bool:
+        """Check if the mod is installed"""
+        return os.path.exists(os.path.join(game_folder, "Mods", "TheMessengerRandomizerAP", "courier.toml"))
+
+    def request_data(request_url: str) -> Any:
+        """Fetches json response from given url"""
+        logging.info(f"requesting {request_url}")
+        response = requests.get(request_url)
+        if response.status_code == 200:  # success
+            try:
+                data = response.json()
+            except requests.exceptions.JSONDecodeError:
+                raise RuntimeError(f"Unable to fetch data. (status code {response.status_code})")
+        else:
+            raise RuntimeError(f"Unable to fetch data. (status code {response.status_code})")
+        return data
+
+    def install_courier() -> None:
+        """Installs latest version of Courier"""
+        # can't use latest since courier uses pre-release tags
+        courier_url = "https://api.github.com/repos/Brokemia/Courier/releases"
+        latest_download = request_data(courier_url)[0]["assets"][-1]["browser_download_url"]
+
+        with urllib.request.urlopen(latest_download) as download:
+            with ZipFile(io.BytesIO(download.read()), "r") as zf:
+                for member in zf.infolist():
+                    zf.extract(member, path=game_folder)
+
+        os.chdir(game_folder)
+        # linux and mac handling
+        if not is_windows:
+            mono_exe = which("mono")
+            if not mono_exe:
+                # steam deck support but doesn't currently work
+                messagebox("Failure", "Failed to install Courier", True)
+                raise RuntimeError("Failed to install Courier")
+                # # download and use mono kickstart
+                # # this allows steam deck support
+                # mono_kick_url = "https://github.com/flibitijibibo/MonoKickstart/archive/refs/heads/master.zip"
+                # target = os.path.join(folder, "monoKickstart")
+                # os.makedirs(target, exist_ok=True)
+                # with urllib.request.urlopen(mono_kick_url) as download:
+                #     with ZipFile(io.BytesIO(download.read()), "r") as zf:
+                #         for member in zf.infolist():
+                #             zf.extract(member, path=target)
+                # installer = subprocess.Popen([os.path.join(target, "precompiled"),
+                #                               os.path.join(folder, "MiniInstaller.exe")], shell=False)
+                # os.remove(target)
+            else:
+                installer = subprocess.Popen([mono_exe, os.path.join(game_folder, "MiniInstaller.exe")], shell=False)
+        else:
+            installer = subprocess.Popen(os.path.join(game_folder, "MiniInstaller.exe"), shell=False)
+
+        failure = installer.wait()
+        if failure:
+            messagebox("Failure", "Failed to install Courier", True)
+            os.chdir(working_directory)
+            raise RuntimeError("Failed to install Courier")
+        os.chdir(working_directory)
+
+        if courier_installed():
+            messagebox("Success!", "Courier successfully installed!")
+            return
+        messagebox("Failure", "Failed to install Courier", True)
+        raise RuntimeError("Failed to install Courier")
+
+    def install_mod() -> None:
+        """Installs latest version of the mod"""
+        assets = request_data(MOD_URL)["assets"]
+        if len(assets) == 1:
+            release_url = assets[0]["browser_download_url"]
+        else:
+            for asset in assets:
+                if "TheMessengerRandomizerAP" in asset["name"]:
+                    release_url = asset["browser_download_url"]
+                    break
+            else:
+                messagebox("Failure", "Failed to find latest mod download", True)
+                raise RuntimeError("Failed to install Mod")
+
+        mod_folder = os.path.join(game_folder, "Mods")
+        os.makedirs(mod_folder, exist_ok=True)
+        with urllib.request.urlopen(release_url) as download:
+            with ZipFile(io.BytesIO(download.read()), "r") as zf:
+                for member in zf.infolist():
+                    zf.extract(member, path=mod_folder)
+
+        messagebox("Success!", "Latest mod successfully installed!")
+
+    def available_mod_update(latest_version: str) -> bool:
+        """Check if there's an available update"""
+        latest_version = latest_version.lstrip("v")
+        toml_path = os.path.join(game_folder, "Mods", "TheMessengerRandomizerAP", "courier.toml")
+        with open(toml_path, "r") as f:
+            installed_version = f.read().splitlines()[1].strip("version = \"")
+
+        logging.info(f"Installed version: {installed_version}. Latest version: {latest_version}")
+        # one of the alpha builds
+        return "alpha" in latest_version or tuplize_version(latest_version) > tuplize_version(installed_version)
+
+    from . import MessengerWorld
+    game_folder = os.path.dirname(MessengerWorld.settings.game_path)
+    working_directory = os.getcwd()
+    if not courier_installed():
+        should_install = askyesnocancel("Install Courier",
+                                        "No Courier installation detected. Would you like to install now?")
+        if not should_install:
+            return
+        logging.info("Installing Courier")
+        install_courier()
+    if not mod_installed():
+        should_install = askyesnocancel("Install Mod",
+                                        "No randomizer mod detected. Would you like to install now?")
+        if not should_install:
+            return
+        logging.info("Installing Mod")
+        install_mod()
+    else:
+        latest = request_data(MOD_URL)["tag_name"]
+        if available_mod_update(latest):
+            should_update = askyesnocancel("Update Mod",
+                                           f"New mod version detected. Would you like to update to {latest} now?")
+            if should_update:
+                logging.info("Updating mod")
+                install_mod()
+            elif should_update is None:
+                return
+    if not is_windows:
+        if url:
+            open_file(f"steam://rungameid/764790//{url}/")
+        else:
+            open_file("steam://rungameid/764790")
+    else:
+        os.chdir(game_folder)
+        if url:
+            subprocess.Popen([MessengerWorld.settings.game_path, str(url)])
+        else:
+            subprocess.Popen(MessengerWorld.settings.game_path)
+        os.chdir(working_directory)