Merge branch 'Dev' into dev-fenhl

# Conflicts:
#	ASM/build/asm_symbols.txt
#	ASM/build/bundle.o
#	ASM/build/c_symbols.txt
#	Goals.py
#	data/generated/patch_symbols.json
#	data/generated/rom_patch.txt
#	data/generated/symbols.json

Author: fenhl

ASM/build/asm_symbols.txt

@@ -51,6 +51,9 @@ void before_game_state_update() {
     manage_music_changes();
     manage_uninvert_yaxis();
     display_misc_messages();
+#if DEBUG_MODE
+    manage_debug_inputs();
+#endif
 }
 
 void after_game_state_update() {

ASM/build/bundle.o

@@ -238,79 +238,79 @@ void item_etcetera_draw(z64_actor_t* actor, z64_game_t* game) {
             .flag = 0x0A,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x0008 && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x0008 && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 1 Bottom Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x00,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x010D && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x010D && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 1 Top Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x01,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x0208 && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x0208 && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 2 Bottom Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x02,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x030D && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x030D && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 2 Top Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x03,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x0409 && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x0409 && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 3 Bottom Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x04,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x050D && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x050D && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 3 Top Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x05,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x0609 && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x0609 && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 4 Bottom Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x06,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x070D && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x070D && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 4 Top Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x07,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x080A && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x080A && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 5 Bottom Chest item inside chest
         override_key_t key = {
             .scene = 0x10,
             .type = OVR_CHEST,
             .flag = 0x08,
         };
         override = lookup_override_by_key(key);
-    } else if (actor->variable == 0x090D && SHUFFLE_CHEST_GAME) {
+    } else if (actor->variable == 0x090D && (SHUFFLE_CHEST_GAME || CUSTOM_KEY_MODELS)) {
         //Chest Game Room 5 Top Chest item inside chest
         override_key_t key = {
             .scene = 0x10,

ASM/build/c_symbols.txt

@@ -5,6 +5,8 @@
 #include "override.h"
 #include <stdint.h>
 
+extern uint8_t CUSTOM_KEY_MODELS;
+
 typedef struct model_t {
     uint16_t object_id;
     uint8_t graphic_id;

ASM/c/main.c

@@ -209,6 +209,8 @@ SHUFFLE_SILVER_RUPEES:
 .byte 0x00
 CFG_DUNGEON_INFO_SILVER_RUPEES:
 .byte 0x00
+CUSTOM_KEY_MODELS:
+.byte 0x00
 SHUFFLE_OCARINA_BUTTONS:
 .byte 0x00
 EPONAS_SONG_NOTES:

ASM/c/models.c

@@ -5,15 +5,21 @@
 * The `Free Reward from Rauru` has a new `Yes (Forced)` option which forces the check to be a dungeon reward even if these are otherwise shuffled.
 * The `Maps & Compasses` shuffle setting has been split into separate `Maps` and `Compasses` settings.
 * The Farore's Wind text box now distinguishes between Ganon's Castle and Ganon's Tower.
-* New `Water Hop` trick added to advanced logic.
+* New `Water Hop` trick and `BotW Cucco Dive` glitch added to advanced logic.
 * Improve Debug menu with new options.
+* Refill items sold as special deals are now less likely to cost more than the "market price" of a repeatable purchase.
+* The heart chest texture has been tweaked to display heart icons on the lid rather than triangles.
 
 ## Bug fixes
 * Fix a potential softlock when talking to Pierre (the upper scarecrow) as child in Lake Hylia.
 * Fix a generator failure when a dungeon reward is selected as a random starting item.
 * Fix a bug where the starting health capacity in game might be miscalculated when starting with a heart piece.
 * Fix the Chicken (child trade quest item) using the same get item text box as the Pocket Cucco (adult trade quest item).
 * Fix a vanilla bug where playing the ocarina with vibrato before recording the Scarecrow's Song could prevent Pierre from spawning.
+* Fix unshuffled treasure box shop keys showing the wrong item model while inside the chests if `Key Appearance Matches Dungeon` is enabled.
+* Add two missing locations: `Ganons Castle MQ Shadow Trial Explosives Wonderitem` and a `Bombable Fairy` in MQ Jabu.
+* Improve the error message when a settings string from the wrong randomizer version is imported.
+* Fix wrong Goal hints being generated for worlds other than the first in multiworld seeds.
 
 # 9.0
 

ASM/c/models.h

@@ -37,7 +37,10 @@ These labels are used to keep track of what still needs to be done for an issue
     * **Request changes:** There are parts of the code that you think should be changed, and/or you have questions that need to be clarified.
     * **Approve:** You think this PR is ready to go. This label will be removed once a PR has at least one approving review and none requesting changes (or the reviewers who requested changes have gone inactive).
 * **Needs Testing:** This label is given to every new PR. Someone (does not have to be a dev team member) should make sure the PR does what it says it does, usually by rolling a seed on the PR branch and either testing relevant parts of the game or checking the generated spoiler log, depending on the nature of the PR. Testing can be done by the PR author, so if you let us know what testing you've done on your PR and/or include screenshots or videos, we may skip adding this label entirely. The extent of testing required depends on how big the PR is; if you're not sure what exactly needs to be tested, ask in the PR thread or on Discord.
-* **Under Consideration:** This label is given to every enhancement (new feature) issue/PR. The dev team will decide whether this feature is something we want in the randomizer, usually in one of [our calls](https://wiki.ootrandomizer.com/index.php?title=Dev_team_calls). An issue being accepted doesn't necessarily mean that the dev team will actively work on it though.
+* **Under Consideration:** This label is given to every enhancement (new feature) issue/PR. The dev team will decide whether this feature is something we want in the randomizer, usually in one of [our calls](https://wiki.ootrandomizer.com/index.php?title=Dev_team_calls) or a private poll. An issue being accepted doesn't necessarily mean that the dev team will actively work on it though. An enhancement for which a poll is currently open is called “nominated”, and the possible outcomes are called “accepted” (indicated by the label being removed) and “rejected” (with the issue/PR being closed with an explanation). Note that this is independent of code review: an enhancement PR needs to be both accepted and approved to be merged. There are some exceptions where enhancements skip this label:
+    * Tournament organizers may request features privately to avoid revealing future tournament settings. In this case, the dev team still decides whether to accept or reject the feature, but the label is skipped if the feature has already been accepted at the time a PR is opened.
+    * If a PR is made for an issue that has already been accepted, the PR is accepted as well.
+    * Glitches and tricks added to advanced logic by @dotzo or @shirosoluna are preaccepted.
 * **Waiting for Author:** This label is given to PRs when changes were requested, e.g. in a code review. It's also given to bug reports when we need more info from the reporter.
 * **Waiting for Maintainers:** We need to do something to progress this issue/PR, e.g. make a decision on which way a new feature should work.
 * **Waiting for Release:** This PR is otherwise ready to be merged, but we are currently in feature freeze (and this is an enhancement PR) or full freeze, and so we're waiting until after the upcoming release to merge it. See the [Release cycle](#release-cycle) section for details.
@@ -78,4 +81,6 @@ Regular releases of the randomizer roughly follow this schedule:
 * Full freeze also lasts at least one week and may take longer if beta tester activity is low.
 * If no critical issues are found during beta testing, the release is published and any PRs labelled “waiting for release” are merged to start off the next release cycle.
 
+The current state of the release cycle is pinned in the #dev-public-talk Discord channel.
+
 There may also be hotfix releases which bypass this procedure, e.g. in case of a severe bug that wasn't caught in beta testing or in case of changes to racing presets.

ASM/src/config.asm

@@ -249,6 +249,13 @@ def update_goal_items(spoiler: Spoiler) -> None:
     woth_locations = list(required_locations['way of the hero'])
     del required_locations['way of the hero']
 
+    # Update category and goal weights that have required locations
+    for category_name, goals in required_locations.items():
+        for goal_name, goal_worlds in goals.items():
+            for world_id, locations in goal_worlds.items():
+                worlds[world_id].goal_categories[category_name].weight = 1
+                worlds[world_id].goal_categories[category_name].get_goal(goal_name).weight = 1
+
     # Generate location requirements for each WOTH location
     requirements_by_world = {}
     requirements = search_required_locations(woth_locations, woth_locations, worlds)
@@ -370,8 +377,7 @@ def search_goals(categories: dict[str, GoalCategory], reachable_goals: ValidGoal
                                     else:
                                         location_weights = (location, 1, 1)
                                     required_locations[category.name][goal.name][world_id].append(location_weights)
-                                goal.weight = 1
-                                category.weight = 1
+
                                 # Locations added to goal exclusion for future categories
                                 # Main use is to split goals between before/after rainbow bridge
                                 # Requires goal categories to be sorted by priority!