Merge branch 'main' of https://github.com/Berserker66/MultiWorld-Utilities into triforce_changes

2025-10-21 20:21:32 -06:00 · 2021-02-22 22:44:43 -06:00
parent d0d5ad4fe0 4c1033a91d
commit 222784dbb6
57 changed files with 11762 additions and 7233 deletions
--- a/Rom.py
+++ b/Rom.py
@@ -1,7 +1,7 @@
 from __future__ import annotations

 JAP10HASH = '03a63945398191337e896e5771f77173'
-RANDOMIZERBASEHASH = '9cbbc0876dd5748125eda8b315347ad2'
+RANDOMIZERBASEHASH = 'a0a9511a2a59e5e8009b38718f8da1bf'

 import io
 import json
@@ -18,7 +18,7 @@ import concurrent.futures
 from typing import Optional

 from BaseClasses import CollectionState, Region, Location
-from Shops import ShopType
+from Shops import ShopType, total_shop_slots
 from Dungeons import dungeon_music_addresses
 from Regions import location_table, old_location_address_to_new_location_address
 from Text import MultiByteTextMapper, CompressedTextMapper, text_addresses, Credits, TextTable
@@ -674,6 +674,14 @@ class Sprite(object):
        rom.write_bytes(0x307000, self.palette)
        rom.write_bytes(0x307078, self.glove_palette)

+bonk_addresses = [0x4CF6C, 0x4CFBA, 0x4CFE0, 0x4CFFB, 0x4D018, 0x4D01B, 0x4D028, 0x4D03C, 0x4D059, 0x4D07A,
+                  0x4D09E, 0x4D0A8, 0x4D0AB, 0x4D0AE, 0x4D0BE, 0x4D0DD,
+                  0x4D16A, 0x4D1E5, 0x4D1EE, 0x4D20B, 0x4CBBF, 0x4CBBF, 0x4CC17, 0x4CC1A, 0x4CC4A, 0x4CC4D,
+                  0x4CC53, 0x4CC69, 0x4CC6F, 0x4CC7C, 0x4CCEF, 0x4CD51,
+                  0x4CDC0, 0x4CDC3, 0x4CDC6, 0x4CE37, 0x4D2DE, 0x4D32F, 0x4D355, 0x4D367, 0x4D384, 0x4D387,
+                  0x4D397, 0x4D39E, 0x4D3AB, 0x4D3AE, 0x4D3D1, 0x4D3D7,
+                  0x4D3F8, 0x4D416, 0x4D420, 0x4D423, 0x4D42D, 0x4D449, 0x4D48C, 0x4D4D9, 0x4D4DC, 0x4D4E3,
+                  0x4D504, 0x4D507, 0x4D55E, 0x4D56A]

 def patch_rom(world, rom, player, team, enemized):
    local_random = world.rom_seeds[player]
@@ -791,6 +799,27 @@ def patch_rom(world, rom, player, team, enemized):

    write_custom_shops(rom, world, player)

+    def credits_digit(num):
+        # top: $54 is 1, 55 2, etc , so 57=4, 5C=9
+        # bot: $7A is 1, 7B is 2, etc so 7D=4, 82=9 (zero unknown...)
+        return 0x53 + int(num), 0x79 + int(num)
+
+    credits_total = 216
+    if world.retro[player]:  # Old man cave and Take any caves will count towards collection rate.
+        credits_total += 5
+    if world.shop_shuffle_slots[player]:  # Potion shop only counts towards collection rate if included in the shuffle.
+        credits_total += 30 if 'w' in world.shop_shuffle[player] else 27
+
+    rom.write_byte(0x187010, credits_total)  # dynamic credits
+    # collection rate address: 238C37
+    first_top, first_bot = credits_digit((credits_total / 100) % 10)
+    mid_top, mid_bot = credits_digit((credits_total / 10) % 10)
+    last_top, last_bot = credits_digit(credits_total % 10)
+    # top half
+    rom.write_bytes(0x118C46, [first_top, mid_top, last_top])
+    # bottom half
+    rom.write_bytes(0x118C64, [first_bot, mid_bot, last_bot])
+
    # patch medallion requirements
    if world.required_medallions[player][0] == 'Bombos':
        rom.write_byte(0x180022, 0x00)  # requirement
@@ -847,8 +876,8 @@ def patch_rom(world, rom, player, team, enemized):

    rom.write_byte(0x18004F, 0x01)  # Byrna Invulnerability: on

-    # handle difficulty_adjustments
-    if world.difficulty_adjustments[player] == 'hard':
+    # handle item_functionality
+    if world.item_functionality[player] == 'hard':
        rom.write_byte(0x180181, 0x01)  # Make silver arrows work only on ganon
        rom.write_byte(0x180182, 0x00)  # Don't auto equip silvers on pickup
        # Powdered Fairies Prize
@@ -868,7 +897,7 @@ def patch_rom(world, rom, player, team, enemized):
        rom.write_int16(0x180036, world.rupoor_cost)
        # Set stun items
        rom.write_byte(0x180180, 0x02)  # Hookshot only
-    elif world.difficulty_adjustments[player] == 'expert':
+    elif world.item_functionality[player] == 'expert':
        rom.write_byte(0x180181, 0x01)  # Make silver arrows work only on ganon
        rom.write_byte(0x180182, 0x00)  # Don't auto equip silvers on pickup
        # Powdered Fairies Prize
@@ -937,6 +966,15 @@ def patch_rom(world, rom, player, team, enemized):

    # set up game internal RNG seed
    rom.write_bytes(0x178000, local_random.getrandbits(8 * 1024).to_bytes(1024, 'big'))
+    prize_replacements = {}
+    if world.item_functionality[player] in ['hard', 'expert']:
+        prize_replacements[0xE0] = 0xDF  # Fairy -> heart
+        prize_replacements[0xE3] = 0xD8  # Big magic -> small magic
+
+    if world.retro[player]:
+        prize_replacements[0xE1] = 0xDA  # 5 Arrows -> Blue Rupee
+        prize_replacements[0xE2] = 0xDB  # 10 Arrows -> Red Rupee
+
    if "g" in world.shuffle_prizes[player]:
        # shuffle prize packs
        prizes = [0xD8, 0xD8, 0xD8, 0xD8, 0xD9, 0xD8, 0xD8, 0xD9, 0xDA, 0xD9, 0xDA, 0xDB, 0xDA, 0xD9, 0xDA, 0xDA, 0xE0,
@@ -962,18 +1000,10 @@ def patch_rom(world, rom, player, team, enemized):
        packs = chunk(prizes[:56], 8)
        local_random.shuffle(packs)
        prizes[:56] = [drop for pack in packs for drop in pack]
-
-        if world.difficulty_adjustments[player] in ['hard', 'expert']:
-            prize_replacements = {0xE0: 0xDF,  # Fairy -> heart
-                                  0xE3: 0xD8}  # Big magic -> small magic
+        if prize_replacements:
            prizes = [prize_replacements.get(prize, prize) for prize in prizes]
            dig_prizes = [prize_replacements.get(prize, prize) for prize in dig_prizes]

-        if world.retro[player]:
-            prize_replacements = {0xE1: 0xDA,  # 5 Arrows -> Blue Rupee
-                                  0xE2: 0xDB}  # 10 Arrows -> Red Rupee
-            prizes = [prize_replacements.get(prize, prize) for prize in prizes]
-            dig_prizes = [prize_replacements.get(prize, prize) for prize in dig_prizes]
        rom.write_bytes(0x180100, dig_prizes)

        # write tree pull prizes
@@ -994,6 +1024,19 @@ def patch_rom(world, rom, player, team, enemized):
        # fill enemy prize packs
        rom.write_bytes(0x37A78, prizes)

+    elif prize_replacements:
+        dig_prizes = list(rom.read_bytes(0x180100, 64))
+        dig_prizes = [prize_replacements.get(byte, byte) for byte in dig_prizes]
+        rom.write_bytes(0x180100, dig_prizes)
+
+        prizes = list(rom.read_bytes(0x37A78, 56))
+        prizes = [prize_replacements.get(byte, byte) for byte in prizes]
+        rom.write_bytes(0x37A78, prizes)
+
+        for address in (0xEFBD4, 0xEFBD5, 0xEFBD6, 0x329C8, 0x329C4, 0x37993, 0xE82CC):
+            byte = int(rom.read_byte(address))
+            rom.write_byte(address, prize_replacements.get(byte, byte))
+
    if "b" in world.shuffle_prizes[player]:
        # set bonk prizes
        bonk_prizes = [0x79, 0xE3, 0x79, 0xAC, 0xAC, 0xE0, 0xDC, 0xAC, 0xE3, 0xE3, 0xDA, 0xE3, 0xDA, 0xD8, 0xAC,
@@ -1001,18 +1044,21 @@ def patch_rom(world, rom, player, team, enemized):
                       0xE3, 0xE3,
                       0xDA, 0x79, 0xAC, 0xAC, 0x79, 0xE3, 0x79, 0xAC, 0xAC, 0xE0, 0xDC, 0xE3, 0x79, 0xDE, 0xE3,
                       0xAC, 0xDB, 0x79, 0xE3, 0xD8, 0xAC, 0x79, 0xE3, 0xDB, 0xDB, 0xE3, 0xE3, 0x79, 0xD8, 0xDD]
-        bonk_addresses = [0x4CF6C, 0x4CFBA, 0x4CFE0, 0x4CFFB, 0x4D018, 0x4D01B, 0x4D028, 0x4D03C, 0x4D059, 0x4D07A,
-                          0x4D09E, 0x4D0A8, 0x4D0AB, 0x4D0AE, 0x4D0BE, 0x4D0DD,
-                          0x4D16A, 0x4D1E5, 0x4D1EE, 0x4D20B, 0x4CBBF, 0x4CBBF, 0x4CC17, 0x4CC1A, 0x4CC4A, 0x4CC4D,
-                          0x4CC53, 0x4CC69, 0x4CC6F, 0x4CC7C, 0x4CCEF, 0x4CD51,
-                          0x4CDC0, 0x4CDC3, 0x4CDC6, 0x4CE37, 0x4D2DE, 0x4D32F, 0x4D355, 0x4D367, 0x4D384, 0x4D387,
-                          0x4D397, 0x4D39E, 0x4D3AB, 0x4D3AE, 0x4D3D1, 0x4D3D7,
-                          0x4D3F8, 0x4D416, 0x4D420, 0x4D423, 0x4D42D, 0x4D449, 0x4D48C, 0x4D4D9, 0x4D4DC, 0x4D4E3,
-                          0x4D504, 0x4D507, 0x4D55E, 0x4D56A]
+
        local_random.shuffle(bonk_prizes)
+
+        if prize_replacements:
+            bonk_prizes = [prize_replacements.get(prize, prize) for prize in bonk_prizes]
+
        for prize, address in zip(bonk_prizes, bonk_addresses):
            rom.write_byte(address, prize)

+    elif prize_replacements:
+        for address in bonk_addresses:
+            byte = int(rom.read_byte(address))
+            rom.write_byte(address, prize_replacements.get(byte, byte))
+
+
    # Fill in item substitutions table
    rom.write_bytes(0x184000, [
        # original_item, limit, replacement_item, filler
@@ -1071,7 +1117,7 @@ def patch_rom(world, rom, player, team, enemized):
    rom.write_byte(0x180043, 0xFF if world.swords[player] == 'swordless' else 0x00)  # starting sword for link
    rom.write_byte(0x180044, 0x01 if world.swords[player] == 'swordless' else 0x00)  # hammer activates tablets

-    if world.difficulty_adjustments[player] == 'easy':
+    if world.item_functionality[player] == 'easy':
        rom.write_byte(0x18003F, 0x01)  # hammer can harm ganon
        rom.write_byte(0x180041, 0x02)  # Allow swordless medallion use EVERYWHERE.
        rom.write_byte(0x180044, 0x01)  # hammer activates tablets
@@ -1250,7 +1296,9 @@ def patch_rom(world, rom, player, team, enemized):
                    'Big Key (Ganons Tower)': (0x366, 0x04), 'Compass (Ganons Tower)': (0x364, 0x04),
                    'Map (Ganons Tower)': (0x368, 0x04)}
        set_or_table = {'Flippers': (0x356, 1, 0x379, 0x02), 'Pegasus Boots': (0x355, 1, 0x379, 0x04),
-                        'Shovel': (0x34C, 1, 0x38C, 0x04), 'Flute': (0x34C, 3, 0x38C, 0x01),
+                        'Shovel': (0x34C, 1, 0x38C, 0x04),
+                        'Flute': (0x34C, 2, 0x38C, 0x02),
+                        'Activated Flute': (0x34C, 3, 0x38C, 0x01),
                        'Mushroom': (0x344, 1, 0x38C, 0x20 | 0x08), 'Magic Powder': (0x344, 2, 0x38C, 0x10),
                        'Blue Boomerang': (0x341, 1, 0x38C, 0x80), 'Red Boomerang': (0x341, 2, 0x38C, 0x40)}
        keys = {'Small Key (Eastern Palace)': [0x37E], 'Small Key (Desert Palace)': [0x37F],
@@ -1560,6 +1608,7 @@ def write_custom_shops(rom, world, player):

    shop_data = bytearray()
    items_data = bytearray()
+    retro_shop_slots = bytearray()

    for shop_id, shop in enumerate(shops):
        if shop_id == len(shops) - 1:
@@ -1568,10 +1617,27 @@ def write_custom_shops(rom, world, player):
        bytes[0] = shop_id
        bytes[-1] = shop.sram_offset
        shop_data.extend(bytes)
-        # [id][item][price-low][price-high][max][repl_id][repl_price-low][repl_price-high][player]
-        for item in shop.inventory:
+
+        arrow_mask = 0x00
+        for index, item in enumerate(shop.inventory):
+            slot = 0 if shop.type == ShopType.TakeAny else index
            if item is None:
                break
+            if world.shop_shuffle_slots[player] or shop.type == ShopType.TakeAny:
+                count_shop = (shop.region.name != 'Potion Shop' or 'w' in world.shop_shuffle[player]) and \
+                             shop.region.name != 'Capacity Upgrade'
+                rom.write_byte(0x186560 + shop.sram_offset + slot, 1 if count_shop else 0)
+            if item['item'] == 'Single Arrow' and item['player'] == 0:
+                arrow_mask |= 1 << index
+                retro_shop_slots.append(shop.sram_offset + slot)
+
+        # [id][item][price-low][price-high][max][repl_id][repl_price-low][repl_price-high][player]
+        for index, item in enumerate(shop.inventory):
+            slot = 0 if shop.type == ShopType.TakeAny else index
+            if item is None:
+                break
+            if item['item'] == 'Single Arrow' and item['player'] == 0 and world.retro[player]:
+                rom.write_byte(0x186500 + shop.sram_offset + slot, arrow_mask)
            item_data = [shop_id, ItemFactory(item['item'], player).code] + int16_as_bytes(item['price']) + \
                        [item['max'], ItemFactory(item['replacement'], player).code if item['replacement'] else 0xFF] + \
                        int16_as_bytes(item['replacement_price']) + [0 if item['player'] == player else item['player']]
@@ -1582,6 +1648,10 @@ def write_custom_shops(rom, world, player):
    items_data.extend([0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF])
    rom.write_bytes(0x184900, items_data)

+    if world.retro[player]:
+        retro_shop_slots.append(0xFF)
+        rom.write_bytes(0x186540, retro_shop_slots)
+

 def hud_format_text(text):
    output = bytes()
@@ -1602,7 +1672,7 @@ def hud_format_text(text):


 def apply_rom_settings(rom, beep, color, quickswap, fastmenu, disable_music, triforcehud, sprite: str, palettes_options,
-                       world=None, player=1, allow_random_on_event=False):
+                       world=None, player=1, allow_random_on_event=False, reduceflashing=False):
    local_random = random if not world else world.rom_seeds[player]

    # enable instant item menu
@@ -1627,6 +1697,23 @@ def apply_rom_settings(rom, beep, color, quickswap, fastmenu, disable_music, tri
    else:
        rom.write_byte(0x180048, 0x08)

+
+    # Reduce flashing by nopping out instructions
+    if reduceflashing:
+        rom.write_bytes(0x17E07, [0x06]) # reduce amount of colors changed, add this branch if we need to reduce more  ""+ [0x80] + [(0x81-0x08)]""
+        rom.write_bytes(0x17EAB, [0xD0, 0x03, 0xA9, 0x40, 0x29, 0x60]) # nullifies aga lightning, cutscene, vitreous, bat, ether
+        # ONLY write to black values with this low pale blue to indicate flashing, that's IT.  ""BNE + : LDA #$2940 : + : RTS""
+        rom.write_bytes(0x123FE, [0x72]) # set lightning flash in misery mire (and standard) to brightness 0x72
+        rom.write_bytes(0x3FA7B, [0x80, 0xac-0x7b]) # branch from palette writing lightning on death mountain
+        rom.write_byte(0x10817F, 0x01) # internal rom option
+    else:
+        rom.write_bytes(0x17E07, [0x00]) 
+        rom.write_bytes(0x17EAB, [0x85, 0x00, 0x29, 0x1F, 0x00, 0x18])
+        rom.write_bytes(0x123FE, [0x32]) # original weather flash value
+        rom.write_bytes(0x3FA7B, [0xc2, 0x20]) # rep #$20
+        rom.write_byte(0x10817F, 0x00) # internal rom option
+
+
    rom.write_byte(0x18004B, 0x01 if quickswap else 0x00)

    rom.write_byte(0x0CFE18, 0x00 if disable_music else rom.orig_buffer[0x0CFE18] if rom.orig_buffer else 0x70)
@@ -1911,6 +1998,9 @@ def write_strings(rom, world, player, team):
        tt['kakariko_flophouse_man_no_flippers'] = 'I really hate mowing my yard.\n{PAGEBREAK}\nI should move.'
        tt['kakariko_flophouse_man'] = 'I really hate mowing my yard.\n{PAGEBREAK}\nI should move.'

+    if world.mode[player] == 'inverted':
+        tt['sign_village_of_outcasts'] = 'attention\nferal ducks sighted\nhiding in statues\n\nflute players beware\n'
+
    def hint_text(dest, ped_hint=False):
        if not dest:
            return "nothing"
@@ -1929,6 +2019,15 @@ def write_strings(rom, world, player, team):

    # For hints, first we write hints about entrances, some from the inconvenient list others from all reasonable entrances.
    if world.hints[player]:
+        # Zora hint
+        zora_location = world.get_location("King Zora", player)
+        tt['zora_tells_cost'] = f"You got 500 rupees to buy {hint_text(zora_location.item)}" \
+                                f"\n  ≥ Duh\n    Oh carp\n{{CHOICE}}"
+        # Bottle Vendor hint
+        vendor_location = world.get_location("Bottle Merchant", player)
+        tt['bottle_vendor_choice'] = f"I gots {hint_text(vendor_location.item)}\nYous gots 100 rupees?"\
+                                     f"\n  ≥ I want\n    no way!\n{{CHOICE}}"
+
        tt['sign_north_of_links_house'] = '> Randomizer The telepathic tiles can have hints!'
        hint_locations = HintLocations.copy()
        local_random.shuffle(hint_locations)
@@ -1961,7 +2060,7 @@ def write_strings(rom, world, player, team):
            hint_count = 4
        for entrance in all_entrances:
            if entrance.name in entrances_to_hint:
-                if hint_count > 0:
+                if hint_count:
                    this_hint = entrances_to_hint[entrance.name] + ' leads to ' + hint_text(
                        entrance.connected_region) + '.'
                    tt[hint_locations.pop(0)] = this_hint
@@ -1998,7 +2097,7 @@ def write_strings(rom, world, player, team):
        hint_count = 4 if world.shuffle[player] not in ['vanilla', 'dungeonssimple', 'dungeonsfull'] else 0
        for entrance in all_entrances:
            if entrance.name in entrances_to_hint:
-                if hint_count > 0:
+                if hint_count:
                    this_hint = entrances_to_hint[entrance.name] + ' leads to ' + hint_text(
                        entrance.connected_region) + '.'
                    tt[hint_locations.pop(0)] = this_hint
@@ -2013,10 +2112,9 @@ def write_strings(rom, world, player, team):
            locations_to_hint.extend(InconvenientVanillaLocations)
        local_random.shuffle(locations_to_hint)
        hint_count = 3 if world.shuffle[player] not in ['vanilla', 'dungeonssimple', 'dungeonsfull'] else 5
-        del locations_to_hint[hint_count:]
-        for location in locations_to_hint:
+        for location in locations_to_hint[:hint_count]:
            if location == 'Swamp Left':
-                if local_random.randint(0, 1) == 0:
+                if local_random.randint(0, 1):
                    first_item = hint_text(world.get_location('Swamp Palace - West Chest', player).item)
                    second_item = hint_text(world.get_location('Swamp Palace - Big Key Chest', player).item)
                else:
@@ -2025,7 +2123,7 @@ def write_strings(rom, world, player, team):
                this_hint = ('The westmost chests in Swamp Palace contain ' + first_item + ' and ' + second_item + '.')
                tt[hint_locations.pop(0)] = this_hint
            elif location == 'Mire Left':
-                if local_random.randint(0, 1) == 0:
+                if local_random.randint(0, 1):
                    first_item = hint_text(world.get_location('Misery Mire - Compass Chest', player).item)
                    second_item = hint_text(world.get_location('Misery Mire - Big Key Chest', player).item)
                else:
@@ -2085,8 +2183,8 @@ def write_strings(rom, world, player, team):
        # All remaining hint slots are filled with junk hints. It is done this way to ensure the same junk hint isn't selected twice.
        junk_hints = junk_texts.copy()
        local_random.shuffle(junk_hints)
-        for location in hint_locations:
-            tt[location] = junk_hints.pop(0)
+        for location, text in zip(hint_locations, junk_hints):
+            tt[location] = text

    # We still need the older hints of course. Those are done here.

@@ -2273,6 +2371,10 @@ def set_inverted_mode(world, player, rom):
    rom.write_byte(snes_to_pc(0x05AF79), 0xF0)
    rom.write_byte(snes_to_pc(0x0DB3C5), 0xC6)
    rom.write_byte(snes_to_pc(0x07A3F4), 0xF0)  # duck
+    rom.write_byte(0xDC21D, 0x6B)  # inverted mode flute activation (skip weathervane overlay)
+    rom.write_bytes(0x48DB3, [0xF8, 0x01])  # inverted mode (bird X)
+    rom.write_byte(0x48D5E, 0x01)  # inverted mode (rock X)
+    rom.write_bytes(0x48CC1+36, bytes([0xF8]*12)) # (rock X)
    rom.write_int16s(snes_to_pc(0x02E849),
                     [0x0043, 0x0056, 0x0058, 0x006C, 0x006F, 0x0070, 0x007B, 0x007F, 0x001B])  # dw flute
    rom.write_int16(snes_to_pc(0x02E8D5), 0x07C8)