Merge branch 'main' of https://github.com/ArchipelagoMW/Archipelago i…

…nto type-check-easy

README.md

@@ -1,8 +1,10 @@
 # [Archipelago](https://archipelago.gg) ![Discord Shield](https://discordapp.com/api/guilds/731205301247803413/widget.png?style=shield) | [Install](https://github.com/ArchipelagoMW/Archipelago/releases)
 
-Archipelago provides a generic framework for developing multiworld capability for game randomizers. In all cases, presently, Archipelago is also the randomizer itself.
+Archipelago provides a generic framework for developing multiworld capability for game randomizers. In all cases,
+presently, Archipelago is also the randomizer itself.
 
 Currently, the following games are supported:
+
 * The Legend of Zelda: A Link to the Past
 * Factorio
 * Minecraft
@@ -77,36 +79,57 @@ windows binaries.
 
 ## History
 
-Archipelago is built upon a strong legacy of brilliant hobbyists. We want to honor that legacy by showing it here. The repositories which Archipelago is built upon, inspired by, or otherwise owes its gratitude to are:
+Archipelago is built upon a strong legacy of brilliant hobbyists. We want to honor that legacy by showing it here.
+The repositories which Archipelago is built upon, inspired by, or otherwise owes its gratitude to are:
 
 * [bonta0's MultiWorld](https://github.com/Bonta0/ALttPEntranceRandomizer/tree/multiworld_31)
 * [AmazingAmpharos' Entrance Randomizer](https://github.com/AmazingAmpharos/ALttPEntranceRandomizer)
 * [VT Web Randomizer](https://github.com/sporchia/alttp_vt_randomizer)
 * [Dessyreqt's alttprandomizer](https://github.com/Dessyreqt/alttprandomizer)
-* [Zarby89's](https://github.com/Ijwu/Enemizer/commits?author=Zarby89) and [sosuke3's](https://github.com/Ijwu/Enemizer/commits?author=sosuke3) contributions to Enemizer, which make the vast majority of Enemizer contributions.
+* [Zarby89's](https://github.com/Ijwu/Enemizer/commits?author=Zarby89)
+  and [sosuke3's](https://github.com/Ijwu/Enemizer/commits?author=sosuke3) contributions to Enemizer, which make up the
+  vast majority of Enemizer contributions.
 
-We recognize that there is a strong community of incredibly smart people that have come before us and helped pave the path. Just because one person's name may be in a repository title does not mean that only one person made that project happen. We can't hope to perfectly cover every single contribution that lead up to Archipelago but we hope to honor them fairly.
+We recognize that there is a strong community of incredibly smart people that have come before us and helped pave the
+path. Just because one person's name may be in a repository title does not mean that only one person made that project
+happen. We can't hope to perfectly cover every single contribution that lead up to Archipelago, but we hope to honor
+them fairly.
 
 ### Path to the Archipelago
-Archipelago was directly forked from bonta0's `multiworld_31` branch of ALttPEntranceRandomizer (this project has a long legacy of its own, please check it out linked above) on January 12, 2020. The repository was then named to _MultiWorld-Utilities_ to better encompass its intended function. As Archipelago matured, then known as "Berserker's MultiWorld" by some, we found it necessary to transform our repository into a root level repository (as opposed to a 'forked repo') and change the name (which came later) to better reflect our project.
+
+Archipelago was directly forked from bonta0's `multiworld_31` branch of ALttPEntranceRandomizer (this project has a
+long legacy of its own, please check it out linked above) on January 12, 2020. The repository was then named to
+_MultiWorld-Utilities_ to better encompass its intended function. As Archipelago matured, then known as
+"Berserker's MultiWorld" by some, we found it necessary to transform our repository into a root level repository
+(as opposed to a 'forked repo') and change the name (which came later) to better reflect our project.
 
 ## Running Archipelago
-For most people, all you need to do is head over to the [releases](https://github.com/ArchipelagoMW/Archipelago/releases) page then download and run the appropriate installer, or AppImage for Linux-based systems.
 
-If you are a developer or are running on a platform with no compiled releases available, please see our doc on [running Archipelago from source](docs/running%20from%20source.md).
+For most people, all you need to do is head over to
+the [releases page](https://github.com/ArchipelagoMW/Archipelago/releases), then download and run the appropriate
+installer, or AppImage for Linux-based systems.
+
+If you are a developer or are running on a platform with no compiled releases available, please see our doc on
+[running Archipelago from source](docs/running%20from%20source.md).
 
 ## Related Repositories
-This project makes use of multiple other projects. We wouldn't be here without these other repositories and the contributions of their developers, past and present.
+
+This project makes use of multiple other projects. We wouldn't be here without these other repositories and the
+contributions of their developers, past and present.
 
 * [z3randomizer](https://github.com/ArchipelagoMW/z3randomizer)
 * [Enemizer](https://github.com/Ijwu/Enemizer)
 * [Ocarina of Time Randomizer](https://github.com/TestRunnerSRL/OoT-Randomizer)
 
 ## Contributing
-For contribution guidelines, please see our [Contributing doc.](/docs/contributing.md)
+
+To contribute to Archipelago, including the WebHost, core program, or by adding a new game, see our
+[Contributing guidelines](/docs/contributing.md).
 
 ## FAQ
-For Frequently asked questions, please see the website's [FAQ Page.](https://archipelago.gg/faq/en/)
+
+For Frequently asked questions, please see the website's [FAQ Page](https://archipelago.gg/faq/en/).
 
 ## Code of Conduct
-Please refer to our [code of conduct.](/docs/code_of_conduct.md)
+
+Please refer to our [code of conduct](/docs/code_of_conduct.md).

WebHostLib/generate.py

@@ -6,7 +6,7 @@
 import tempfile
 import zipfile
 from collections import Counter
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, Set
 
 from flask import flash, redirect, render_template, request, session, url_for
 from pony.orm import commit, db_session
@@ -16,32 +16,30 @@
 from Main import main as ERmain
 from Utils import __version__
 from WebHostLib import app
+from settings import ServerOptions, GeneratorOptions
 from worlds.alttp.EntranceRandomizer import parse_arguments
 from .check import get_yaml_data, roll_options
 from .models import Generation, STATE_ERROR, STATE_QUEUED, Seed, UUID
 from .upload import upload_zip_to_db
 
 
 def get_meta(options_source: dict, race: bool = False) -> Dict[str, Union[List[str], Dict[str, Any]]]:
-    plando_options = {
-        options_source.get("plando_bosses", ""),
-        options_source.get("plando_items", ""),
-        options_source.get("plando_connections", ""),
-        options_source.get("plando_texts", "")
-    }
-    plando_options -= {""}
+    plando_options: Set[str] = set()
+    for substr in ("bosses", "items", "connections", "texts"):
+        if options_source.get(f"plando_{substr}", substr in GeneratorOptions.plando_options):
+            plando_options.add(substr)
 
     server_options = {
-        "hint_cost": int(options_source.get("hint_cost", 10)),
-        "release_mode": options_source.get("release_mode", "goal"),
-        "remaining_mode": options_source.get("remaining_mode", "disabled"),
-        "collect_mode": options_source.get("collect_mode", "disabled"),
-        "item_cheat": bool(int(options_source.get("item_cheat", 1))),
+        "hint_cost": int(options_source.get("hint_cost", ServerOptions.hint_cost)),
+        "release_mode": options_source.get("release_mode", ServerOptions.release_mode),
+        "remaining_mode": options_source.get("remaining_mode", ServerOptions.remaining_mode),
+        "collect_mode": options_source.get("collect_mode", ServerOptions.collect_mode),
+        "item_cheat": bool(int(options_source.get("item_cheat", not ServerOptions.disable_item_cheat))),
         "server_password": options_source.get("server_password", None),
     }
     generator_options = {
-        "spoiler": int(options_source.get("spoiler", 0)),
-        "race": race
+        "spoiler": int(options_source.get("spoiler", GeneratorOptions.spoiler)),
+        "race": race,
     }
 
     if race:

WebHostLib/options.py

@@ -11,6 +11,7 @@
 from Utils import local_path
 from worlds.AutoWorld import AutoWorldRegister
 from . import app, cache
+from .generate import get_meta
 
 
 def create() -> None:
@@ -50,7 +51,7 @@ def render_options_page(template: str, world_name: str, is_complex: bool = False
 
 def generate_game(options: Dict[str, Union[dict, str]]) -> Union[Response, str]:
     from .generate import start_generation
-    return start_generation(options, {"plando_options": ["items", "connections", "texts", "bosses"]})
+    return start_generation(options, get_meta({}))
 
 
 def send_yaml(player_name: str, formatted_options: dict) -> Response:

docs/CODEOWNERS

@@ -6,10 +6,6 @@
 #
 # All usernames must be GitHub usernames (and are case sensitive).
 
-###################
-## Active Worlds ##
-###################
-
 # Adventure
 /worlds/adventure/ @JusticePS
 
@@ -67,9 +63,6 @@
 # Factorio
 /worlds/factorio/ @Berserker66
 
-# Final Fantasy
-/worlds/ff1/ @jtoyoda
-
 # Final Fantasy Mystic Quest
 /worlds/ffmq/ @Alchav @wildham0
 
@@ -215,9 +208,22 @@
 # Zork Grand Inquisitor
 /worlds/zork_grand_inquisitor/ @nbrochu
 
-##################################
-## Disabled Unmaintained Worlds ##
-##################################
+
+## Active Unmaintained Worlds
+
+# The following worlds in this repo are currently unmaintained, but currently still work in core. If any update breaks
+# compatibility, these worlds may be moved to `worlds_disabled`. If you are interested in stepping up as maintainer for
+# any of these worlds, please review `/docs/world maintainer.md` documentation.
+
+# Final Fantasy (1)
+# /worlds/ff1/
+
+
+## Disabled Unmaintained Worlds
+
+# The following worlds in this repo are currently unmaintained and disabled as they do not work in core. If you are
+# interested in stepping up as maintainer for any of these worlds, please review `/docs/world maintainer.md`
+# documentation.
 
 # Ori and the Blind Forest
-# /worlds_disabled/oribf/ <Unmaintained>
+# /worlds_disabled/oribf/

docs/contributing.md

@@ -1,43 +1,49 @@
 # Contributing
-Contributions are welcome. We have a few requests for new contributors:
+
+All contributions are welcome, though we have a few requests of contributors, whether they be for core, webhost, or new 
+game contributions:
 
 * **Follow styling guidelines.**
   Please take a look at the [code style documentation](/docs/style.md)
   to ensure ease of communication and uniformity.
 
-* **Ensure that critical changes are covered by tests.** 
-It is strongly recommended that unit tests are used to avoid regression and to ensure everything is still working.
-If you wish to contribute by adding a new game, please take a look at the [logic unit test documentation](/docs/tests.md).
-If you wish to contribute to the website, please take a look at [these tests](/test/webhost).
+* **Ensure that critical changes are covered by tests.**
+  It is strongly recommended that unit tests are used to avoid regression and to ensure everything is still working.
+  If you wish to contribute by adding a new game, please take a look at
+  the [logic unit test documentation](/docs/tests.md).
+  If you wish to contribute to the website, please take a look at [these tests](/test/webhost).
 
 * **Do not introduce unit test failures/regressions.**
-Archipelago supports multiple versions of Python. You may need to download older Python versions to fully test
-your changes. Currently, the oldest supported version is [Python 3.8](https://www.python.org/downloads/release/python-380/). 
-It is recommended that automated github actions are turned on in your fork to have github run all of the unit tests after pushing.
-You can turn them on here:  
-![Github actions example](./img/github-actions-example.png)
+  Archipelago supports multiple versions of Python. You may need to download older Python versions to fully test
+  your changes. Currently, the oldest supported version
+  is [Python 3.8](https://www.python.org/downloads/release/python-380/).
+  It is recommended that automated github actions are turned on in your fork to have github run unit tests after
+  pushing.
+  You can turn them on here:  
+  ![Github actions example](./img/github-actions-example.png)
 
 * **When reviewing PRs, please leave a message about what was done.**
-We don't have full test coverage, so manual testing can help.
-For code changes that could affect multiple worlds or that could have changes in unexpected code paths, manual testing
-or checking if all code paths are covered by automated tests is desired. The original author may not have been able
-to test all possibly affected worlds, or didn't know it would affect another world. In such cases, it is helpful to
-state which games or settings were rolled, if any.
-Please also tell us if you looked at code, just did functional testing, did both, or did neither.
-If testing the PR depends on other PRs, please state what you merged into what for testing.
-We cannot determine what "LGTM" means without additional context, so that should not be the norm.
+  We don't have full test coverage, so manual testing can help.
+  For code changes that could affect multiple worlds or that could have changes in unexpected code paths, manual testing
+  or checking if all code paths are covered by automated tests is desired. The original author may not have been able
+  to test all possibly affected worlds, or didn't know it would affect another world. In such cases, it is helpful to
+  state which games or settings were rolled, if any.
+  Please also tell us if you looked at code, just did functional testing, did both, or did neither.
+  If testing the PR depends on other PRs, please state what you merged into what for testing.
+  We cannot determine what "LGTM" means without additional context, so that should not be the norm.
 
-Other than these requests, we tend to judge code on a case-by-case basis. 
+Other than these requests, we tend to judge code on a case-by-case basis.
 
 For contribution to the website, please refer to the [WebHost README](/WebHostLib/README.md).
 
 If you want to contribute to the core, you will be subject to stricter review on your pull requests. It is recommended
 that you get in touch with other core maintainers via the [Discord](https://archipelago.gg/discord).
 
-If you want to add Archipelago support for a new game, please take a look at the [adding games documentation](/docs/adding%20games.md), which details what is required 
-to implement support for a game, as well as tips for how to get started.
-If you want to merge a new game into the main Archipelago repo, please make sure to read the responsibilities as a 
-[world maintainer](/docs/world%20maintainer.md).  
+If you want to add Archipelago support for a new game, please take a look at
+the [adding games documentation](/docs/adding%20games.md)
+which details what is required to implement support for a game, and has tips on to get started.
+If you want to merge a new game into the main Archipelago repo, please make sure to read the responsibilities as a
+[world maintainer](/docs/world%20maintainer.md).
 
-For other questions, feel free to explore the [main documentation folder](/docs/) and ask us questions in the #archipelago-dev channel 
-of the [Discord](https://archipelago.gg/discord).
+For other questions, feel free to explore the [main documentation folder](/docs), and ask us questions in the
+#ap-world-dev channel of the [Discord](https://archipelago.gg/discord).

settings.py

@@ -643,17 +643,6 @@ class Spoiler(IntEnum):
         PLAYTHROUGH = 2
         FULL = 3
 
-    class GlitchTriforceRoom(IntEnum):
-        """
-        Glitch to Triforce room from Ganon
-        When disabled, you have to have a weapon that can hurt ganon (master sword or swordless/easy item functionality
-        + hammer) and have completed the goal required for killing ganon to be able to access the triforce room.
-        1 -> Enabled.
-        0 -> Disabled (except in no-logic)
-        """
-        OFF = 0
-        ON = 1
-
     class PlandoOptions(str):
         """
         List of options that can be plando'd. Can be combined, for example "bosses, items"

worlds/hk/GodhomeData.py

@@ -9,7 +9,7 @@ def set_godhome_rules(hk_world, hk_set_rule):
     fn = partial(hk_set_rule, hk_world)
 
     required_events = {
-        "Godhome_Flower_Quest": lambda state: state.count('Defeated_Pantheon_5', player) and state.count('Room_Mansion[left1]', player) and state.count('Fungus3_49[right1]', player),
+        "Godhome_Flower_Quest": lambda state: state.count('Defeated_Pantheon_5', player) and state.count('Room_Mansion[left1]', player) and state.count('Fungus3_49[right1]', player) and state.has('Godtuner', player),
 
         "Defeated_Pantheon_5": lambda state: state.has('GG_Atrium_Roof', player) and state.has('WINGS', player) and (state.has('LEFTCLAW', player) or state.has('RIGHTCLAW', player)) and ((state.has('Defeated_Pantheon_1', player) and state.has('Defeated_Pantheon_2', player) and state.has('Defeated_Pantheon_3', player) and state.has('Defeated_Pantheon_4', player) and state.has('COMBAT[Radiance]', player))),
         "GG_Atrium_Roof": lambda state: state.has('GG_Atrium', player) and state.has('Hit_Pantheon_5_Unlock_Orb', player) and state.has('LEFTCLAW', player),

worlds/hk/__init__.py

@@ -659,6 +659,8 @@ class HKItem(Item):
     def __init__(self, name, advancement, code, type: str, player: int = None):
         if name == "Mimic_Grub":
             classification = ItemClassification.trap
+        elif name == "Godtuner":
+            classification = ItemClassification.progression
         elif type in ("Grub", "DreamWarrior", "Root", "Egg", "Dreamer"):
             classification = ItemClassification.progression_skip_balancing
         elif type == "Charm" and name not in progression_charms:

worlds/sc2/__init__.py

@@ -22,7 +22,7 @@
 
 
 class Starcraft2WebWorld(WebWorld):
-    setup = Tutorial(
+    setup_en = Tutorial(
         "Multiworld Setup Guide",
         "A guide to setting up the Starcraft 2 randomizer connected to an Archipelago Multiworld",
         "English",
@@ -31,7 +31,16 @@ class Starcraft2WebWorld(WebWorld):
         ["TheCondor", "Phaneros"]
     )
 
-    tutorials = [setup]
+    setup_fr = Tutorial(
+        setup_en.tutorial_name,
+        setup_en.description,
+        "Français",
+        "setup_fr.md",
+        "setup/fr",
+        ["Neocerber"]
+    )
+
+    tutorials = [setup_en, setup_fr]
 
 
 class SC2World(World):

worlds/sc2/docs/en_Starcraft 2.md

@@ -1,5 +1,8 @@
 # Starcraft 2
 
+## Game page in other languages:
+* [Français](/games/Starcraft%202/info/fr)
+
 ## What does randomization do to this game?
 
 The following unlocks are randomized as items:
@@ -39,7 +42,7 @@ The goal is to beat the final mission in the mission order. The yaml configurati
 ## Which of my items can be in another player's world?
 
 By default, any of StarCraft 2's items (specified above) can be in another player's world. See the
-[Advanced YAML Guide](https://archipelago.gg/tutorial/Archipelago/advanced_settings/en)
+[Advanced YAML Guide](/tutorial/Archipelago/advanced_settings/en)
 for more information on how to change this.
 
 ## Unique Local Commands