Merge 'Move CFG_{ADULT,CHILD}_TRADE_SHUFFLE into auto-tracker context' (#2156)

Author: cjohnson57

ASM/build/asm_symbols.txt

@@ -32,8 +32,8 @@ extern uint8_t CFG_DPAD_ON_THE_LEFT;
                      0x00200000 | \
                      0x08000000)
 
-extern uint16_t CFG_ADULT_TRADE_SHUFFLE;
-extern uint16_t CFG_CHILD_TRADE_SHUFFLE;
+extern uint8_t CFG_ADULT_TRADE_SHUFFLE;
+extern uint8_t CFG_CHILD_TRADE_SHUFFLE;
 
 #define CAN_DRAW_TRADE_DPAD (z64_game.pause_ctxt.state == PAUSE_STATE_MAIN && \
                             z64_game.pause_ctxt.screen_idx == 0 && \

ASM/build/bundle.o

@@ -6,8 +6,8 @@
 #include "en_item00.h"
 #include "override.h"
 
-extern uint16_t CFG_ADULT_TRADE_SHUFFLE;
-extern uint16_t CFG_CHILD_TRADE_SHUFFLE;
+extern uint8_t CFG_ADULT_TRADE_SHUFFLE;
+extern uint8_t CFG_CHILD_TRADE_SHUFFLE;
 
 void item_overrides_init();
 void handle_pending_items();

ASM/c/dpad.h

@@ -1,6 +1,6 @@
 #include "trade_quests.h"
 
-extern uint16_t CFG_ADULT_TRADE_SHUFFLE;
+extern uint8_t CFG_ADULT_TRADE_SHUFFLE;
 
 const exchange_item_t trade_quest_items[] = {
     {  0, Z64_ITEM_WEIRD_EGG,           Z64_EXCH_ITEM_WEIRD_EGG,    PLAYER_AP_WEIRD_EGG    , 0 }, // "Weird Egg"

ASM/c/get_items.h

@@ -264,7 +264,7 @@ CFG_DUNGEON_PRECOMPLETED:
 ; Any changes made here should be documented in Notes/auto-tracker-ctx.md
 AUTO_TRACKER_CONTEXT:
 AUTO_TRACKER_VERSION:
-.word 4 ; Increment this if the auto-tracker context layout changes
+.word 5 ; Increment this if the auto-tracker context layout changes
 
 CFG_DUNGEON_INFO_ENABLE:
 .word 0
@@ -326,4 +326,9 @@ SPECIAL_DEAL_COUNTS:
 CFG_DUNGEON_REWARD_AREAS:
 .endarea
 
+CFG_ADULT_TRADE_SHUFFLE:
+.byte 0x00
+CFG_CHILD_TRADE_SHUFFLE:
+.byte 0x00
+
 .align 4

ASM/c/trade_quests.c

@@ -272,7 +272,7 @@ set_mask_text_hook:
     sw      v1, 0x14(sp)
     sw      ra, 0x18(sp)
 
-    lh      v0, CFG_CHILD_TRADE_SHUFFLE
+    lbu     v0, CFG_CHILD_TRADE_SHUFFLE
     beqz    v0, @@return_mask_text
     nop
     jal     SaveFile_TradeItemIsOwned
@@ -295,7 +295,7 @@ set_mask_sold_out:
     sw      a1, 0x14(sp)
     sw      ra, 0x1C(sp)
 
-    lh      v0, CFG_CHILD_TRADE_SHUFFLE
+    lbu     v0, CFG_CHILD_TRADE_SHUFFLE
     beqz    v0, @@return_mask_so
     nop
 

ASM/src/config.asm

@@ -1,7 +1,3 @@
-CFG_ADULT_TRADE_SHUFFLE:
-    .halfword 0x0000
-CFG_CHILD_TRADE_SHUFFLE:
-    .halfword 0x0000
 ADULT_ANJU_ITEM_DIALOG:
     .word 0x00000000
 
@@ -89,7 +85,7 @@ check_skull_kid_spawn_flags:
 check_if_biggoron_should_cry_eye_hook:
     addiu   sp, sp, -0x18
     sw      ra, 0x14(sp)
-    lh      v0, CFG_ADULT_TRADE_SHUFFLE
+    lbu     v0, CFG_ADULT_TRADE_SHUFFLE
     beqz    v0, @@vanilla_eye_hook
     nop
     jal     check_if_biggoron_should_cry
@@ -108,7 +104,7 @@ check_if_biggoron_should_cry_eye_hook:
 check_if_biggoron_should_cry_anim_hook:
     addiu   sp, sp, -0x18
     sw      ra, 0x14(sp)
-    lh      v0, CFG_ADULT_TRADE_SHUFFLE
+    lbu     v0, CFG_ADULT_TRADE_SHUFFLE
     beqz    v0, @@vanilla_anim_hook
     nop
     jal     check_if_biggoron_should_cry
@@ -130,7 +126,7 @@ check_if_biggoron_should_cry_sfx_hook:
     addiu   sp, sp, -0x18
     sw      a3, 0x10(sp)
     sw      ra, 0x14(sp)
-    lh      v0, CFG_ADULT_TRADE_SHUFFLE
+    lbu     v0, CFG_ADULT_TRADE_SHUFFLE
     beqz    v0, @@vanilla_sfx_hook
     nop
     jal     check_if_biggoron_should_cry
@@ -159,7 +155,7 @@ check_if_biggoron_should_cry:
     sw      ra, 0x1C(sp)
 
     ; Don't change behavior if trade shuffle is off
-    lh      at, CFG_ADULT_TRADE_SHUFFLE
+    lbu     at, CFG_ADULT_TRADE_SHUFFLE
     beqz    at, @@return_crybaby
     nop
 
@@ -234,9 +230,9 @@ check_trade_item_traded:
 
     ; Default behavior if Adult and Child
     ; Trade Quest Shuffles Off
-    lh      t3, CFG_ADULT_TRADE_SHUFFLE
+    lbu     t3, CFG_ADULT_TRADE_SHUFFLE
     bnez    t3, @@check_trade_flags
-    lh      t3, CFG_CHILD_TRADE_SHUFFLE
+    lbu     t3, CFG_CHILD_TRADE_SHUFFLE
     beqz    t3, @@return_traded
     nop
 
@@ -290,7 +286,7 @@ check_if_mask_sells_out:
     or      v1, $zero, $zero
 
     ; Skip giving item if partial/full mask shuffle enabled
-    lh      v1, CFG_CHILD_TRADE_SHUFFLE
+    lbu     v1, CFG_CHILD_TRADE_SHUFFLE
 
 @@return_sold_out:
     jr      ra
@@ -449,7 +445,7 @@ set_bunny_hood_traded_flag:
 ;==================================================================================================
 
 handle_child_zelda_savewarp:
-    lh      v0, CFG_CHILD_TRADE_SHUFFLE
+    lbu     v0, CFG_CHILD_TRADE_SHUFFLE
     bnez    v0, @@return
     nop
 

ASM/src/shop.asm

@@ -1,6 +1,6 @@
 The **auto-tracker context** is a region of memory where a portion of the randomizer's configuration variables are stored in a versioned layout defined below. Its intent is to give some symbols added by the randomizer well-defined addresses so that auto-trackers can read them reliably without needing the symbols.json for the specific randomizer version that was used to generate the seed.
 
-The starting address of the auto-tracker context is listed at address `0x8040_000C` (randomizer context + `0xC`). On versions of the randomizer before this feature was added, the starting address is given as zero. At that address, a 4-byte integer can be found. This is the version number of the auto-tracker context and defines the layout of the remainder of the context according to the sections below. The current version is 4.
+The starting address of the auto-tracker context is listed at address `0x8040_000C` (randomizer context + `0xC`). On versions of the randomizer before this feature was added, the starting address is given as zero. At that address, a 4-byte integer can be found. This is the version number of the auto-tracker context and defines the layout of the remainder of the context according to the sections below. The current version is 5.
 
 # Versions 1–2
 
@@ -27,24 +27,26 @@ The starting address of the auto-tracker context is listed at address `0x8040_00
 
 Special care needs to be taken when working with version 3 of the auto-tracker context, since a breaking change was made in version 6.2.181 of the randomizer without an accompanying change to the auto-tracker context version. Versions 6.2.180 of the randomizer and earlier use the same layout as version 2 described above (with the addition of the `CFG_DUNGEON_REWARD_AREAS` field), while versions 6.2.181 and later use the same layout as version 4 described below. The version number at addresses 0x35–0x37 of the ROM header may be used to check for the randomizer version, but this may not be accurate for forks of the randomizer if they merged the change early.
 
-# Version 4
+# Versions 4–5
 
 |Offset|Name|Min version|Size|Description|
 |--:|---|--:|--:|---|
-|`0x04`|`CFG_DUNGEON_INFO_ENABLE`|4|`0x04`|Defines how information about dungeons will be displayed on the inventory screen on the pause menu. `0` = disabled, `1` = a single menu shown when holding A, `2` = separate menus shown when holding D-pad buttons in addition to the summary menu on A.|
-|`0x08`|`CFG_DUNGEON_INFO_MQ_ENABLE`|1|`0x04`|`1` if the dungeon info in the pause menu should include info about which dungeons are in Master Quest mode.|
-|`0x0C`|`CFG_DUNGEON_INFO_MQ_NEED_MAP`|1|`0x04`|`1` if the Master Quest info should only be displayed for dungeons whose maps have been obtained or which don't have maps.|
-|`0x10`|`CFG_DUNGEON_INFO_REWARD_ENABLE`|1|`0x04`|`1` if the dungeon info in the pause menu should include info about which medallions and stones are in which dungeon.|
-|`0x14`|`CFG_DUNGEON_INFO_REWARD_NEED_COMPASS`|1|`0x04`|Defines which item is required to display the location of a dungeon reward in the pause menu. `0` = no item required, `1` = the compass of the dungeon in which the reward is found, `2` = the compass of the reward's vanilla dungeon. For example, if the Kokiri Emerald is in the Fire Temple, `1` means the Fire Temple compass is required and `2` means the Deku Tree compass is required.|
-|`0x18`|`CFG_DUNGEON_INFO_REWARD_NEED_ALTAR`|1|`0x04`|`1` if the reward info should only be displayed for rewards whose Temple of Time altar text boxes have been read.|
-|`0x1C`|`CFG_DUNGEON_INFO_REWARD_SUMMARY_ENABLE`|4|`0x04`|`1` if the summary menu shown when holding A should display dungeon reward locations.|
-|`0x20`|`CFG_DUNGEON_REWARDS`|4|`0x0E`|A byte representing the medallion or stone for each dungeon. Dungeons without rewards are listed as `0xFF`, and one reward is chosen arbitrarily if the dungeon has multiple rewards. For more complete data, use `CFG_DUNGEON_REWARD_AREAS` instead.|
-|`0x2E`|`CFG_DUNGEON_IS_MQ`|4|`0x0E`|A byte set to `1` for each dungeon in Master Quest mode.|
-|`0x3C`|`RAINBOW_BRIDGE_CONDITION`|4|`0x04`|The condition for spawning the rainbow bridge. `0` = open, `1` = medallions, `2` = dungeon rewards, `3` = stones, `4` = vanilla, `5` = tokens, `6` = hearts.|
-|`0x40`|`LACS_CONDITION`|4|`0x04`|The condition for triggering the light arrow cutscene. `0` = vanilla, `1` = medallions, `2` = dungeons, `3` = stones, `4` = tokens, `5` = hearts.|
-|`0x44`|`RAINBOW_BRIDGE_COUNT`|4|`0x02`|The number of items (of the kind defined in `RAINBOW_BRIDGE_CONDITION`) required to spawn the rainbow bridge.|
-|`0x46`|`LACS_CONDITION_COUNT`|4|`0x02`|The number of items (of the kind defined in `LACS_CONDITION`) required to trigger the light arrow cutscene.|
-|`0x48`|`TRIFORCE_HUNT_ENABLED`|4|`0x02`|`1` if Triforce hunt is enabled.|
-|`0x4A`|`TRIFORCE_PIECES_REQUIRED`|4|`0x02`|In Triforce hunt, the total number of Triforce pieces (across all worlds) required to win the game.|
-|`0x4C`|`SPECIAL_DEAL_COUNTS`|4|`0x08`|A byte representing the number of special deal slots in each shop, in the following order: KF Shop, Market Bazaar, Market Potion Shop, Market Bombchu Shop, Kak Bazaar, Kak Potion Shop, GC Shop, ZD Shop.|
-|`0x54`|`CFG_DUNGEON_REWARD_AREAS`|4|`0xCF`|For each dungeon reward in the order of Emerald, Ruby, Sapphire, Light, Forest, Fire, Water, Shadow, and Spirit, a null-terminated `0x16`-byte (`0x17` including the null terminator) ASCII string containing the hint area of that reward, padded with spaces on the right.|
+|`0x0004`|`CFG_DUNGEON_INFO_ENABLE`|4|`0x04`|Defines how information about dungeons will be displayed on the inventory screen on the pause menu. `0` = disabled, `1` = a single menu shown when holding A, `2` = separate menus shown when holding D-pad buttons in addition to the summary menu on A.|
+|`0x0008`|`CFG_DUNGEON_INFO_MQ_ENABLE`|1|`0x04`|`1` if the dungeon info in the pause menu should include info about which dungeons are in Master Quest mode.|
+|`0x000C`|`CFG_DUNGEON_INFO_MQ_NEED_MAP`|1|`0x04`|`1` if the Master Quest info should only be displayed for dungeons whose maps have been obtained or which don't have maps.|
+|`0x0010`|`CFG_DUNGEON_INFO_REWARD_ENABLE`|1|`0x04`|`1` if the dungeon info in the pause menu should include info about which medallions and stones are in which dungeon.|
+|`0x0014`|`CFG_DUNGEON_INFO_REWARD_NEED_COMPASS`|1|`0x04`|Defines which item is required to display the location of a dungeon reward in the pause menu. `0` = no item required, `1` = the compass of the dungeon in which the reward is found, `2` = the compass of the reward's vanilla dungeon. For example, if the Kokiri Emerald is in the Fire Temple, `1` means the Fire Temple compass is required and `2` means the Deku Tree compass is required.|
+|`0x0018`|`CFG_DUNGEON_INFO_REWARD_NEED_ALTAR`|1|`0x04`|`1` if the reward info should only be displayed for rewards whose Temple of Time altar text boxes have been read.|
+|`0x001C`|`CFG_DUNGEON_INFO_REWARD_SUMMARY_ENABLE`|4|`0x04`|`1` if the summary menu shown when holding A should display dungeon reward locations.|
+|`0x0020`|`CFG_DUNGEON_REWARDS`|4|`0x0E`|A byte representing the medallion or stone for each dungeon. Dungeons without rewards are listed as `0xFF`, and one reward is chosen arbitrarily if the dungeon has multiple rewards. For more complete data, use `CFG_DUNGEON_REWARD_AREAS` instead.|
+|`0x002E`|`CFG_DUNGEON_IS_MQ`|4|`0x0E`|A byte set to `1` for each dungeon in Master Quest mode.|
+|`0x003C`|`RAINBOW_BRIDGE_CONDITION`|4|`0x04`|The condition for spawning the rainbow bridge. `0` = open, `1` = medallions, `2` = dungeon rewards, `3` = stones, `4` = vanilla, `5` = tokens, `6` = hearts.|
+|`0x0040`|`LACS_CONDITION`|4|`0x04`|The condition for triggering the light arrow cutscene. `0` = vanilla, `1` = medallions, `2` = dungeons, `3` = stones, `4` = tokens, `5` = hearts.|
+|`0x0044`|`RAINBOW_BRIDGE_COUNT`|4|`0x02`|The number of items (of the kind defined in `RAINBOW_BRIDGE_CONDITION`) required to spawn the rainbow bridge.|
+|`0x0046`|`LACS_CONDITION_COUNT`|4|`0x02`|The number of items (of the kind defined in `LACS_CONDITION`) required to trigger the light arrow cutscene.|
+|`0x0048`|`TRIFORCE_HUNT_ENABLED`|4|`0x02`|`1` if Triforce hunt is enabled.|
+|`0x004A`|`TRIFORCE_PIECES_REQUIRED`|4|`0x02`|In Triforce hunt, the total number of Triforce pieces (across all worlds) required to win the game.|
+|`0x004C`|`SPECIAL_DEAL_COUNTS`|4|`0x08`|A byte representing the number of special deal slots in each shop, in the following order: KF Shop, Market Bazaar, Market Potion Shop, Market Bombchu Shop, Kak Bazaar, Kak Potion Shop, GC Shop, ZD Shop.|
+|`0x0054`|`CFG_DUNGEON_REWARD_AREAS`|4|`0xCF`|For each dungeon reward in the order of Emerald, Ruby, Sapphire, Light, Forest, Fire, Water, Shadow, and Spirit, a null-terminated `0x16`-byte (`0x17` including the null terminator) ASCII string containing the hint area of that reward, padded with spaces on the right.|
+|`0x0123`|`CFG_ADULT_TRADE_SHUFFLE`|5|`0x01`|`1` if the item-cycling functionality for the adult trade inventory slot is enabled.|
+|`0x0124`|`CFG_CHILD_TRADE_SHUFFLE`|5|`0x01`|`1` if the item-cycling functionality for the child trade inventory slot is enabled.|

ASM/src/trade_quests.asm

@@ -763,10 +763,10 @@ def set_entrance_updates(entrances: Iterable[Entrance]) -> None:
         rom.write_int16s(0xB6D460, [0x0030, 0x0035, 0x0036])  # Change trade items revert table to prevent all reverts
 
     if world.settings.adult_trade_shuffle or world.settings.item_pool_value in ('plentiful', 'ludicrous'):
-        rom.write_int16(rom.sym('CFG_ADULT_TRADE_SHUFFLE'), 0x0001)
+        rom.write_byte(rom.sym('CFG_ADULT_TRADE_SHUFFLE'), 0x01)
         move_fado_in_lost_woods(rom)
     if world.settings.shuffle_child_trade or world.settings.logic_rules == 'glitched':
-        rom.write_int16(rom.sym('CFG_CHILD_TRADE_SHUFFLE'), 0x0001)
+        rom.write_byte(rom.sym('CFG_CHILD_TRADE_SHUFFLE'), 0x01)
 
     if world.settings.shuffle_overworld_entrances:
         rom.write_byte(rom.sym('OVERWORLD_SHUFFLED'), 1)