Merge branch 'main' into setup_more_apworld

* Initial commit

* Shifted added code to the appropriate indentation.
Re-wrote for statement in proper python style.

* Update Generate.py

Co-authored-by: qwint <qwint.42@gmail.com>

* change to an elif to avoid unnecessary nesting

---------

Co-authored-by: qwint <qwint.42@gmail.com>
Co-authored-by: Benny D <78334662+benny-dreamly@users.noreply.github.com>

.github/workflows/unittests.yml

@@ -59,7 +59,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pytest pytest-subtests pytest-xdist
+        pip install -r ci-requirements.txt
         python ModuleUpdate.py --yes --force --append "WebHostLib/requirements.txt"
         python Launcher.py --update_settings  # make sure host.yaml exists for tests
     - name: Unittests

Generate.py

@@ -189,6 +189,11 @@ def main(args=None) -> tuple[argparse.Namespace, int]:
                                         yaml[category][key] = option
                             elif category_name not in yaml:
                                 logging.warning(f"Meta: Category {category_name} is not present in {path}.")
+                            elif key == "triggers":
+                                if "triggers" not in yaml[category_name]:
+                                    yaml[category_name][key] = []
+                                for trigger in option:
+                                    yaml[category_name][key].append(trigger)
                             else:
                                 yaml[category_name][key] = option
 
@@ -385,6 +390,8 @@ def roll_meta_option(option_key, game: str, category_dict: dict) -> Any:
             if options[option_key].supports_weighting:
                 return get_choice(option_key, category_dict)
             return category_dict[option_key]
+        if option_key == "triggers":
+            return category_dict[option_key]
     raise Options.OptionError(f"Error generating meta option {option_key} for {game}.")
 
 

ci-requirements.txt

@@ -0,0 +1,3 @@
+pytest>=8.4.2,<9  # pytest 9.0.0 is broken for our CI
+pytest-xdist>=3.8.0
+pytest-subtests>=0.15.0  # will not be required anymore once we upgrade to pytest 9.x

deploy/example_config.yaml

@@ -8,3 +8,7 @@ SELFLAUNCH: false
 # Host Address.  This is the address encoded into the patch that will be used for client auto-connect.
 # Set as your local IP (192.168.x.x) to serve over LAN.
 HOST_ADDRESS: localhost
+
+# Asset redistribution rights.  If true, the host affirms they have been given explicit permission to redistribute
+# the proprietary assets in WebHostLib
+#ASSET_RIGHTS: false

docs/network protocol.md

@@ -647,6 +647,16 @@ class Version(NamedTuple):
     build: int
 ```
 
+If constructing version information as a dict for a custom client rather than as a NamedTuple built into the CommonClient, you must add the `class` key to allow Archipelago to compare version support.
+```
+"version": {
+      "class": "Version",
+      "build": X,
+      "major": Y,
+      "minor": Z
+    }
+```
+
 ### SlotType
 An enum representing the nature of a slot.
 

setup.py

@@ -63,18 +63,11 @@ from Cython.Build import cythonize
 
 
 non_apworlds: set[str] = {
-    "A Link to the Past",
-    "Adventure",
-    "Archipelago",
-    "Lufia II Ancient Cave",
-    "Meritous",
-    "Ocarina of Time",
-    "Overcooked! 2",
-    "Raft",
-    "Sudoku",
-    "Super Mario 64",
-    "VVVVVV",
-    "Wargroove",
+    "Archipelago",  # needs a way to specify load order
+    "Final Fantasy",  # loads json files badly
+    "Lufia II Ancient Cave",  # loads basepatch badly
+    "Ocarina of Time",  # has executables in folder
+    "Raft",  # loads json files badly
 }
 
 

worlds/cccharles/docs/en_Choo-Choo Charles.md

@@ -13,7 +13,7 @@ All scraps or any collectable item on the ground (except from Loot Crates) and i
 Beating the evil train from Hell named "Charles".
 
 ## How is the game managed in Nightmare mode?
-At death, the player has to restart a brand-new game, giving him the choice to stay under the Nightmare mode or continuing with the Normal mode if considered too hard.
+At death, the player has to restart a brand-new game, giving them the choice to stay under the Nightmare Mode or continuing with the Classic Mode if considered too hard.
 In this case, all collected items will be redistributed in the inventory and the missions states will be kept.
 The Deathlink is not implemented yet. When this option will be available, a choice will be provided to:
 * Disable the Deathlink

worlds/cccharles/docs/fr_Choo-Choo Charles.md

@@ -3,14 +3,14 @@
 ## Où est la page d'options ?
 La [page d'options du joueur pour ce jeu](../player-options) contient toutes les options pour configurer et exporter un fichier de configuration yaml.
 
-## Qu'est ce que la randomisation fait au jeu ?
-Tous les débrits ou n'importe quel objet ramassable au sol (excepté les Caisses à Butin) et objets reçus par les missions de PNJs sont considérés comme emplacements à vérifier.
+## Qu'est-ce que la randomisation fait au jeu ?
+Tous les débris ou n'importe quel objet ramassable au sol (excepté les Caisses à Butin) et objets reçus par les missions de PNJs sont considérés comme emplacements à vérifier.
 
 ## Quel est le but de Choo-Choo Charles lorsqu'il est randomisé ?
 Vaincre le train démoniaque de l'Enfer nommé "Charles".
 
-## Comment le jeu est-il géré en mode Nightmare ?
-À sa mort, le joueur doit relancer une toute nouvelle partie, lui donnant la possisilité de rester en mode Nightmare ou de poursuivre la partie en mode Normal s'il considère la partie trop difficile.
+## Comment le jeu est-il géré en Mode Cauchemar ?
+À sa mort, le joueur doit relancer une toute nouvelle partie, lui donnant la possibilité de rester en Mode Cauchemar ou de poursuivre la partie en Mode Classique s'il considère la partie trop difficile.
 Dans ce cas, tous les objets collectés seront redistribués dans l'inventaire et les états des missions seront conservés.
 Le Deathlink n'est pas implémenté pour l'instant. Lorsque cette option sera disponible, un choix sera fourni pour :
 * Désactiver le Deathlink
@@ -18,7 +18,7 @@ Le Deathlink n'est pas implémenté pour l'instant. Lorsque cette option sera di
 * Activer le Deathlink strict avec suppression de la sauvegarde lorsqu'un évènement Deathlink est reçu
 
 ## À quoi ressemble un objet d'un autre monde dans Choo-Choo Charles ?
-Les apparances des objets sont conservés.
+Les apparences des objets sont conservées.
 Tout indice qui ne peut pas être représenté normalement dans le jeu est remplacé par l'Easter Egg "DeadDuck" miniaturisé qui peut être vu en dehors des limites murales physiques du jeu original.
 
 ## Comment le joueur est-il informé par une transmission d'objet et des indices ?
@@ -29,7 +29,7 @@ La même méthode est utilisée pour les indices.
 Non, ceci est un travail en cours.
 Les options suivantes seront possibles une fois les implémentations disponibles :
 
-À n'importe quel moment, le joueur peu appuyer sur l'une des touches suivantes pour afficher la console dans le jeu :
+À n'importe quel moment, le joueur peut appuyer sur l'une des touches suivantes pour afficher la console dans le jeu :
 * "~" (qwerty)
 * "²" (azerty)
 * "F10"

worlds/cccharles/docs/setup_en.md

@@ -27,7 +27,7 @@ The [Player Options page](/games/Choo-Choo%20Charles/player-options) allows to c
 Before playing, it is highly recommended to check out the **[Known Issues](setup_en#known-issues)** section
 * The game console must be opened to type Archipelago commands, press "F10" key or "`" (or "~") key in querty ("²" key in azerty)
 * Type ``/connect <IP> <PlayerName>`` with \<IP\> and \<PlayerName\> found on the hosting Archipelago web page in the form ``archipelago.gg:XXXXX`` and ``CCCharles``
-* Disconnection is automatic at game closure but can be manually done with ``/disconnect``
+* Disconnection is automatic at game closure, but can be manually done with ``/disconnect``
 
 ## Hosting a MultiWorld or Single-Player Game
 See the [Mod Download](setup_en#mod-download) section to get the **cccharles.apworld** file.

worlds/cccharles/docs/setup_fr.md

@@ -4,7 +4,7 @@ Cette page est un guide simplifié de la [page du Mod Randomiseur Multiworld de
 ## Exigences et Logiciels Nécessaires
 * Un ordinateur utilisant Windows (le Mod n'est pas utilisable sous Linux ou Mac)
 * [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases)
-* Une copie légale du jeu original Choo-Choo Charles (peut être trouvé sur [Steam](https://store.steampowered.com/app/1766740/ChooChoo_Charles/)
+* Une copie légale du jeu original Choo-Choo Charles (peut être trouvé sur [Steam](https://store.steampowered.com/app/1766740/ChooChoo_Charles/))
 
 ## Installation du Mod pour jouer
 ### Téléchargement du Mod
@@ -27,7 +27,7 @@ La [page d'Options Joueur](/games/Choo-Choo%20Charles/player-options) permet de
 Avant de jouer, il est fortement recommandé de consulter la section **[Problèmes Connus](setup_fr#probl%C3%A8mes-connus)**.
 * La console du jeu doit être ouverte pour taper des commandes Archipelago, appuyer sur la touche "F10" ou "`" (ou "~") en querty (touche "²" en azerty)
 * Taper ``/connect <IP> <NomDuJoueur>`` avec \<IP\> et \<NomDuJoueur\> trouvés sur la page web d'hébergement Archipelago sous la forme ``archipelago.gg:XXXXX`` et ``CCCharles``
-* La déconnexion est automatique à la fermeture du jeu mais peut être faite manuellement avec ``/disconnect``
+* La déconnexion est automatique à la fermeture du jeu, mais peut être faite manuellement avec ``/disconnect``
 
 ## Héberger une partie MultiWorld ou un Seul Joueur
 Voir la section [Téléchargement du Mod](setup_fr#téléchargement-du-mod) pour récupérer le fichier **cccharles.apworld**.
@@ -39,7 +39,7 @@ Suivre ces étapes pour héberger une session multijoueur à distance ou locale
 2. Placer le **CCCharles.yaml** dans **Archipelago/Players/** avec le YAML de chaque joueur à héberger
 3. Exécuter le lanceur Archipelago et cliquer sur "Generate" pour configurer une partie avec les YAML dans **Archipelago/output/**
 4. Pour une session multijoueur, aller à la [page Archipelago HOST GAME](https://archipelago.gg/uploads)
-5. Cliquer sur "Upload File" et selectionner le **AP_\<seed\>.zip** généré dans **Archipelago/output/**
+5. Cliquer sur "Upload File" et sélectionner le **AP_\<seed\>.zip** généré dans **Archipelago/output/**
 6. Envoyer la page de la partie générée à chaque joueur
 
 Pour une session locale à un seul joueur, cliquer sur "Host" dans le lanceur Archipelago en utilisant **AP_\<seed\>.zip** généré dans **Archipelago/output/**