111 lines
3.5 KiB
Python
111 lines
3.5 KiB
Python
import hashlib
|
|
import os
|
|
|
|
import Utils
|
|
from Utils import read_snes_rom
|
|
from worlds.Files import APProcedurePatch, APPatchExtension, APTokenMixin, APTokenTypes
|
|
from worlds.smz3.ips import IPS_Patch
|
|
|
|
SMJUHASH = '21f3e98df4780ee1c667b84e57d88675'
|
|
LTTPJPN10HASH = '03a63945398191337e896e5771f77173'
|
|
ROM_PLAYER_LIMIT = 256
|
|
|
|
world_folder = os.path.dirname(__file__)
|
|
|
|
class SMZ3PatchExtensions(APPatchExtension):
|
|
game = "SMZ3"
|
|
|
|
@staticmethod
|
|
def apply_basepatch(caller: APProcedurePatch, rom: bytes) -> bytes:
|
|
basepatch = IPS_Patch.load(world_folder + "/data/zsm.ips")
|
|
return basepatch.apply(rom)
|
|
|
|
class SMZ3ProcedurePatch(APProcedurePatch, APTokenMixin):
|
|
hash = "3a177ba9879e3dd04fb623a219d175b2"
|
|
game = "SMZ3"
|
|
patch_file_ending = ".apsmz3"
|
|
|
|
procedure = [
|
|
("apply_basepatch", []),
|
|
("apply_tokens", ["token_data.bin"]),
|
|
]
|
|
|
|
def write_tokens(self, patches):
|
|
for addr, data in patches.items():
|
|
self.write_token(APTokenTypes.WRITE, addr, bytes(data))
|
|
self.write_file("token_data.bin", self.get_token_binary())
|
|
|
|
@classmethod
|
|
def get_source_data(cls) -> bytes:
|
|
return get_base_rom_bytes()
|
|
|
|
|
|
def get_base_rom_bytes() -> bytes:
|
|
base_rom_bytes = getattr(get_base_rom_bytes, "base_rom_bytes", None)
|
|
if not base_rom_bytes:
|
|
sm_file_name = get_sm_base_rom_path()
|
|
sm_base_rom_bytes = bytes(read_snes_rom(open(sm_file_name, "rb")))
|
|
|
|
basemd5 = hashlib.md5()
|
|
basemd5.update(sm_base_rom_bytes)
|
|
if SMJUHASH != basemd5.hexdigest():
|
|
raise Exception('Supplied Base Rom does not match known MD5 for SM Japan+US release. '
|
|
'Get the correct game and version, then dump it')
|
|
lttp_file_name = get_lttp_base_rom_path()
|
|
lttp_base_rom_bytes = bytes(read_snes_rom(open(lttp_file_name, "rb")))
|
|
|
|
basemd5 = hashlib.md5()
|
|
basemd5.update(lttp_base_rom_bytes)
|
|
if LTTPJPN10HASH != basemd5.hexdigest():
|
|
raise Exception('Supplied Base Rom does not match known MD5 for LttP Japan(1.0) release. '
|
|
'Get the correct game and version, then dump it')
|
|
|
|
get_base_rom_bytes.base_rom_bytes = bytes(combine_smz3_rom(sm_base_rom_bytes, lttp_base_rom_bytes))
|
|
return get_base_rom_bytes.base_rom_bytes
|
|
|
|
|
|
def get_sm_base_rom_path(file_name: str = "") -> str:
|
|
options = Utils.get_options()
|
|
if not file_name:
|
|
file_name = options["sm_options"]["rom_file"]
|
|
if not os.path.exists(file_name):
|
|
file_name = Utils.user_path(file_name)
|
|
return file_name
|
|
|
|
|
|
def get_lttp_base_rom_path(file_name: str = "") -> str:
|
|
options = Utils.get_options()
|
|
if not file_name:
|
|
file_name = options["lttp_options"]["rom_file"]
|
|
if not os.path.exists(file_name):
|
|
file_name = Utils.user_path(file_name)
|
|
return file_name
|
|
|
|
|
|
def combine_smz3_rom(sm_rom: bytes, lttp_rom: bytes) -> bytearray:
|
|
combined = bytearray(0x600000)
|
|
# SM hi bank
|
|
pos = 0
|
|
srcpos = 0
|
|
for i in range(0x40):
|
|
combined[pos + 0x8000:pos + 0x8000 + 0x8000] = sm_rom[srcpos:srcpos + 0x8000]
|
|
srcpos += 0x8000
|
|
pos += 0x10000
|
|
|
|
# SM lo bank
|
|
pos = 0
|
|
for i in range(0x20):
|
|
combined[pos:pos + 0x8000] = sm_rom[srcpos:srcpos + 0x8000]
|
|
srcpos += 0x8000
|
|
pos += 0x10000
|
|
|
|
# Z3 hi bank
|
|
pos = 0x400000
|
|
srcpos = 0
|
|
for i in range(0x20):
|
|
combined[pos + 0x8000:pos + 0x8000 + 0x8000] = lttp_rom[srcpos:srcpos + 0x8000]
|
|
srcpos += 0x8000
|
|
pos += 0x10000
|
|
|
|
return combined
|