z_sram_NES with 2 NON_MATCHINGs and 1 NON_EQUIVALENTs (#531)

* Rename Sram_InitDebugSave

* Sram_InitDebugSave

* err

* Sram_IncrementDay

* non_matchings

* func_80146F5C and protos

* func_80146EE8

* func_80145698

* func_80143A54

* Split SaveContext

* problems with bss

* Fix bss

* more

* a small bunch

* Fix warnings

* almost everything

* two attempts

* at least compiles

* import data

* bss

* format

* stuff?

* Progress?

* More progress

* clean up data a little

* More progress

* disaster

* re split data

* A bit less of a disaster

* Fix renamed stuff

* data stuff

* fix conflicts

* format

* CycleSceneFlags

* some enums

* cleanup

* Fix merge issues

* format

* some changes

* format

* Lots of progress on z_sram_NES, but no matches yet

* SaveContent Documentation

* Oops

* Oops2

* Document more SaveContext

* Oops, don't need that anymore

* add small comment

* Another comment

* dekuPlaygroundPlayerName

* Fix merge issues

* format

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* remove magic number

* format

* fix merge issues

* bss

* format

* macro cleanup

* review

* merge issues

* review

* cleanup

* UNK_TYPE1

* Fix

* Remove comment

* small change

* conflicts

* review

* fix

* fixes

* format

* Update actorCtx renames part

* Match func_80143B0C thanks to Petrie and Anon

* minor cleaning pass

* format

* cleanup

* more minor cleanups

* Macros for accessing gSaveContext.save.stolenItems

* Introduce STOLEN_ITEM_NONE and remove CLEAR_STOLEN_ITEM_

* format

* Update include/macros.h

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_sram_NES.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_sram_NES.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_sram_NES.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_sram_NES.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_sram_NES.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_sram_NES.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_sram_NES.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* @hensldm review

* Update include/functions.h

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update include/functions.h

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Rename QUEST_SONG_NEW_WAVE

* Add scene name comments to D_801C5FC0

* rename horseData.yaw

* Update include/functions.h

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/code/z_sram_NES.c

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* // = CUR_UPG_VALUE(UPG_WALLET);

* run actorfixer and format

* fix bss

* Fix merge problems and run format

* Some improvements to func_801457CC by anon

* bss

* format

* run actorfixer

* actorfixer, bss and format

* Use original names for the RESPAWN_MODE enum because the current ones are bad

* QUEST_SONG_BOSSA_NOVA

* some minor fixes on the SaveContext struct according to the debug rom

* Merge Inventory.items and Inventory.masks

* a

* simplify saveBuf accesses

* A few func renames

* actorfixer

* bss

* fixes

* bss

* actorfixer

* actorfixer and format

* actorfixer

* whoops

* whops

* bss

Co-authored-by: engineer124 <engineer124engineer124@gmail.com>
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

tools/actorfixer.py

@@ -489,16 +489,32 @@ animdict = {
     "actor.minVelocityY": "actor.terminalVelocity",
     "actor.yDistToWater": "actor.depthInWater",
     "actor.yDistToPlayer": "actor.playerHeightRel",
-    "globalCtx->mf_187FC": "globalCtx->billboardMtxF",
-    "globalCtx->projectionMatrix": "globalCtx->viewProjectionMtxF",
-    "csCtx.npcActions": "csCtx.actorActions",
-    "csCtx->npcActions": "csCtx->actorActions",
-    "csCtx.unk_12": "csCtx.currentCsIndex",
-    "globalCtx->envCtx.unk_8C": "globalCtx->envCtx.lightSettings",
-    "globalCtx->envCtx.unk_E5": "globalCtx->envCtx.fillScreen",
-    "globalCtx->envCtx.unk_E6": "globalCtx->envCtx.screenFillColor",
-    "globalCtx->envCtx.unk_C3": "globalCtx->envCtx.lightSettingOverride",
-    "globalCtx->envCtx.unk_DC": "globalCtx->envCtx.lightBlend",
+    "gSaveContext.weekEventReg": "gSaveContext.save.weekEventReg",
+    "gSaveContext.playerForm": "gSaveContext.save.playerForm",
+    "gSaveContext.day": "gSaveContext.save.day",
+    # "gSaveContext.cutscene": "gSaveContext.save.cutscene",
+    "gSaveContext.isNight": "gSaveContext.save.isNight",
+    "gSaveContext.naviTimer": "gSaveContext.save.playerData.tatlTimer",
+    "gSaveContext.tatlTimer": "gSaveContext.save.playerData.tatlTimer",
+    # "gSaveContext.health": "gSaveContext.save.playerData.health",
+    "gSaveContext.rupees": "gSaveContext.save.playerData.rupees",
+    "gSaveContext.magicAcquired": "gSaveContext.save.playerData.magicAcquired",
+    "gSaveContext.doubleMagic": "gSaveContext.save.playerData.doubleMagic",
+    "gSaveContext.doubleDefense": "gSaveContext.save.playerData.doubleDefense",
+    "gSaveContext.playerName": "gSaveContext.save.playerData.playerName",
+    "gSaveContext.inventory": "gSaveContext.save.inventory",
+    "gSaveContext.equippedMask": "gSaveContext.save.equippedMask",
+    "gSaveContext.entranceIndex": "gSaveContext.save.entranceIndex",
+    "gSaveContext.time": "gSaveContext.save.time",
+    "gSaveContext.unk_14": "gSaveContext.save.daySpeed",
+    "gSaveContext.unk_FE6": "gSaveContext.save.bombersCaughtNum",
+    "gSaveContext.unk_FE7": "gSaveContext.save.bombersCaughtOrder",
+    "gSaveContext.linkAge": "gSaveContext.save.linkAge",
+    "gSaveContext.dekuPlaygroundHighScores": "gSaveContext.save.dekuPlaygroundHighScores",
+    "gSaveContext.lotteryCodeGuess": "gSaveContext.save.lotteryCodeGuess",
+    "gSaveContext.permanentSceneFlags": "gSaveContext.save.permanentSceneFlags",
+    "gSaveContext.bomberCode": "gSaveContext.save.bomberCode",
+    "gSaveContext.skullTokenCount": "gSaveContext.save.skullTokenCount",
     "player->unk_A87": "player->exchangeItemId",
     "player->leftHandActor": "player->heldActor",
     "player->unk_384": "player->getItemId",
@@ -506,7 +522,17 @@ animdict = {
     "player->unk_388": "player->interactRangeActor",
     "player->unk_38C": "player->mountSide",
     "player->unk_394": "player->csMode",
+    "csCtx.npcActions": "csCtx.actorActions",
+    "csCtx->npcActions": "csCtx->actorActions",
+    "csCtx.unk_12": "csCtx.currentCsIndex",
+    "globalCtx->mf_187FC": "globalCtx->billboardMtxF",
+    "globalCtx->projectionMatrix": "globalCtx->viewProjectionMtxF",
     "globalCtx->actorCtx.actorList[": "globalCtx->actorCtx.actorLists[",
+    "globalCtx->envCtx.unk_8C": "globalCtx->envCtx.lightSettings",
+    "globalCtx->envCtx.unk_E5": "globalCtx->envCtx.fillScreen",
+    "globalCtx->envCtx.unk_E6": "globalCtx->envCtx.screenFillColor",
+    "globalCtx->envCtx.unk_C3": "globalCtx->envCtx.lightSettingOverride",
+    "globalCtx->envCtx.unk_DC": "globalCtx->envCtx.lightBlend",
     "gSaveContext.unk_1016": "gSaveContext.jinxTimer",
     "gSaveContext.unk_3F58": "gSaveContext.sunsSongState",
     "globalCtx->msgCtx.unk1202A": "globalCtx->msgCtx.ocarinaMode",
@@ -527,6 +553,9 @@ animdict = {
     "ActorAnimationEntryS": "AnimationInfoS",
     "struct_80B8E1A8": "AnimationSpeedInfo",
 
+    # Macros
+    "CUR_EQUIP_VALUE_VOID": "GET_CUR_EQUIP_VALUE",
+    "CUR_UPG_VALUE_VOID": "GET_CUR_UPG_VALUE",
     "ICHAIN_F32_DIV1000(minVelocityY,": "ICHAIN_F32_DIV1000(terminalVelocity,",
     "ICHAIN_F32(minVelocityY,": "ICHAIN_F32(terminalVelocity,",
 }

tools/disasm/files.txt

@@ -561,6 +561,7 @@
             0x801C5DD0 : "z_vimode",
             0x801C5E30 : "z_vr_box",
             0x801C5FC0 : "z_sram_NES",
+            0x801C6A70 : "z_message",
             0x801D0470 : "z_message_nes",
             0x801D0B50 : "z_player_call",
             0x801D0B70 : "z_kaleido_manager",

tools/disasm/functions.txt

@@ -2787,30 +2787,30 @@
     0x80143624:("SkyboxDraw_SetColors",),
     0x80143668:("SkyboxDraw_Draw",),
     0x80143A04:("SkyboxDraw_Noop",),
-    0x80143A10:("func_80143A10",),
-    0x80143A54:("func_80143A54",),
-    0x80143AC4:("func_80143AC4",),
-    0x80143B0C:("func_80143B0C",),
+    0x80143A10:("Sram_ActivateOwl",),
+    0x80143A54:("Sram_ClearHighscores",),
+    0x80143AC4:("Sram_ClearFlagsAtDawnOfTheFirstDay",),
+    0x80143B0C:("Sram_SaveEndOfCycle",),
     0x80144574:("Sram_IncrementDay",),
     0x801445E4:("Sram_CalcChecksum",),
-    0x80144628:("func_80144628",),
+    0x80144628:("Sram_ResetSave",),
     0x80144684:("Sram_GenerateRandomSaveFields",),
-    0x80144890:("func_80144890",),
+    0x80144890:("Sram_InitNewSave",),
     0x80144968:("Sram_InitDebugSave",),
     0x80144A94:("func_80144A94",),
-    0x80144E78:("func_80144E78",),
+    0x80144E78:("Sram_OpenSave",),
     0x8014546C:("func_8014546C",),
     0x80145698:("func_80145698",),
     0x801457CC:("func_801457CC",),
     0x80146580:("func_80146580",),
     0x80146628:("func_80146628",),
-    0x80146AA0:("func_80146AA0",),
+    0x80146AA0:("Sram_InitSave",),
     0x80146DF8:("func_80146DF8",),
-    0x80146E40:("func_80146E40",),
+    0x80146E40:("Sram_InitSram",),
     0x80146E70:("Sram_Alloc",),
     0x80146EBC:("func_80146EBC",),
-    0x80146EE8:("func_80146EE8",),
-    0x80146F5C:("func_80146F5C",),
+    0x80146EE8:("Sram_SaveSpecialEnterClockTown",),
+    0x80146F5C:("Sram_SaveSpecialNewDay",),
     0x80147008:("func_80147008",),
     0x80147020:("func_80147020",),
     0x80147068:("func_80147068",),

tools/disasm/variables.txt

@@ -1983,33 +1983,27 @@
     0x801C5EB0:("D_801C5EB0","UNK_TYPE4","",0x4),
     0x801C5EC4:("D_801C5EC4","UNK_TYPE2","",0x2),
     0x801C5F44:("D_801C5F44","UNK_TYPE4","",0x4),
-    0x801C5FC0:("D_801C5FC0","UNK_TYPE4","",0x4),
-    0x801C5FC4:("D_801C5FC4","UNK_TYPE4","",0x4),
-    0x801C5FC8:("D_801C5FC8","UNK_TYPE4","",0x4),
-    0x801C5FCC:("D_801C5FCC","UNK_TYPE4","",0x4),
-    0x801C5FD0:("D_801C5FD0","UNK_TYPE4","",0x4),
+    0x801C5FC0:("D_801C5FC0","u32","[452]",0x710),
     0x801C66D0:("D_801C66D0","UNK_TYPE2","",0x2),
     0x801C6798:("D_801C6798","UNK_TYPE4","",0x4),
     0x801C67B0:("D_801C67B0","UNK_TYPE1","",0x1),
-    0x801C67C8:("D_801C67C8","UNK_TYPE4","",0x4),
-    0x801C67CC:("D_801C67CC","UNK_TYPE4","",0x4),
+    0x801C67C8:("D_801C67C8","s32","[8]",0x20),
     0x801C67E8:("D_801C67E8","UNK_TYPE4","",0x4),
-    0x801C67F0:("D_801C67F0","UNK_TYPE4","",0x4),
-    0x801C67F4:("D_801C67F4","UNK_TYPE4","",0x4),
+    0x801C67F0:("D_801C67F0","s32","[8]",0x20),
     0x801C6818:("D_801C6818","UNK_TYPE1","",0x1),
     0x801C6838:("D_801C6838","UNK_TYPE4","",0x4),
     0x801C6840:("D_801C6840","UNK_TYPE1","",0x1),
     0x801C6850:("D_801C6850","UNK_TYPE1","",0x1),
     0x801C6870:("D_801C6870","UNK_TYPE1","",0x1),
     0x801C6890:("D_801C6890","UNK_TYPE1","",0x1),
-    0x801C6898:("D_801C6898","SaveInfo","",0x28),
-    0x801C68C0:("D_801C68C0","SaveContext_struct2","",0x22),
-    0x801C68E4:("gSaveDefaultInventory","Inventory","",0x88),
-    0x801C696C:("gSaveDefaultChecksum","u16","",0x2),
-    0x801C6970:("D_801C6970","SaveInfo","",0x28),
-    0x801C6998:("D_801C6998","SaveContext_struct2","",0x22),
-    0x801C69BC:("D_801C69BC","Inventory","",0x88),
-    0x801C6A44:("D_801C6A44","u16","",0x2),
+    0x801C6898:("sSaveDefaultPlayerData","SavePlayerData","",0x28),
+    0x801C68C0:("sSaveDefaultItemEquips","ItemEquips","",0x22),
+    0x801C68E4:("sSaveDefaultInventory","Inventory","",0x88),
+    0x801C696C:("sSaveDefaultChecksum","u16","",0x2),
+    0x801C6970:("sSaveDebugPlayerData","SaveInfo","",0x28),
+    0x801C6998:("sSaveDebugItemEquips","ItemEquips","",0x22),
+    0x801C69BC:("sSaveDebugInventory","Inventory","",0x88),
+    0x801C6A44:("sSaveDebugChecksum","u16","",0x2),
     0x801C6A48:("D_801C6A48","UNK_TYPE1","",0x1),
     0x801C6A50:("D_801C6A50","UNK_TYPE1","",0x1),
     0x801C6A58:("D_801C6A58","UNK_TYPE1","",0x1),

tools/permuter_settings.toml

@@ -13,6 +13,7 @@ SQ = "int"
 CLAMP = "int"
 CLOCK_TIME = "int"
 CURRENT_DAY = "int"
+CHECK_NEWF = "int"
 NULL = "int"
 
 [decompme.compilers]

tools/sizes/code_functions.csv

@@ -2301,30 +2301,30 @@ asm/non_matchings/code/z_vr_box_draw/func_801435A0.s,func_801435A0,0x801435A0,0x
 asm/non_matchings/code/z_vr_box_draw/func_80143624.s,func_80143624,0x80143624,0x11
 asm/non_matchings/code/z_vr_box_draw/func_80143668.s,func_80143668,0x80143668,0xE7
 asm/non_matchings/code/z_vr_box_draw/func_80143A04.s,func_80143A04,0x80143A04,0x3
-asm/non_matchings/code/z_sram_NES/func_80143A10.s,func_80143A10,0x80143A10,0x11
-asm/non_matchings/code/z_sram_NES/func_80143A54.s,func_80143A54,0x80143A54,0x1C
-asm/non_matchings/code/z_sram_NES/func_80143AC4.s,func_80143AC4,0x80143AC4,0x12
-asm/non_matchings/code/z_sram_NES/func_80143B0C.s,func_80143B0C,0x80143B0C,0x29A
+asm/non_matchings/code/z_sram_NES/Sram_ActivateOwl.s,Sram_ActivateOwl,0x80143A10,0x11
+asm/non_matchings/code/z_sram_NES/Sram_ClearHighscores.s,Sram_ClearHighscores,0x80143A54,0x1C
+asm/non_matchings/code/z_sram_NES/Sram_ClearFlagsAtDawnOfTheFirstDay.s,Sram_ClearFlagsAtDawnOfTheFirstDay,0x80143AC4,0x12
+asm/non_matchings/code/z_sram_NES/Sram_SaveEndOfCycle.s,Sram_SaveEndOfCycle,0x80143B0C,0x29A
 asm/non_matchings/code/z_sram_NES/Sram_IncrementDay.s,Sram_IncrementDay,0x80144574,0x1C
 asm/non_matchings/code/z_sram_NES/Sram_CalcChecksum.s,Sram_CalcChecksum,0x801445E4,0x11
-asm/non_matchings/code/z_sram_NES/func_80144628.s,func_80144628,0x80144628,0x17
+asm/non_matchings/code/z_sram_NES/Sram_ResetSave.s,Sram_ResetSave,0x80144628,0x17
 asm/non_matchings/code/z_sram_NES/Sram_GenerateRandomSaveFields.s,Sram_GenerateRandomSaveFields,0x80144684,0x83
 asm/non_matchings/code/z_sram_NES/func_80144890.s,func_80144890,0x80144890,0x36
 asm/non_matchings/code/z_sram_NES/Sram_InitDebugSave.s,Sram_InitDebugSave,0x80144968,0x4B
 asm/non_matchings/code/z_sram_NES/func_80144A94.s,func_80144A94,0x80144A94,0xF9
-asm/non_matchings/code/z_sram_NES/func_80144E78.s,func_80144E78,0x80144E78,0x17D
+asm/non_matchings/code/z_sram_NES/Sram_OpenSave.s,Sram_OpenSave,0x80144E78,0x17D
 asm/non_matchings/code/z_sram_NES/func_8014546C.s,func_8014546C,0x8014546C,0x8B
 asm/non_matchings/code/z_sram_NES/func_80145698.s,func_80145698,0x80145698,0x4D
 asm/non_matchings/code/z_sram_NES/func_801457CC.s,func_801457CC,0x801457CC,0x36D
 asm/non_matchings/code/z_sram_NES/func_80146580.s,func_80146580,0x80146580,0x2A
 asm/non_matchings/code/z_sram_NES/func_80146628.s,func_80146628,0x80146628,0x11E
-asm/non_matchings/code/z_sram_NES/func_80146AA0.s,func_80146AA0,0x80146AA0,0xD6
+asm/non_matchings/code/z_sram_NES/Sram_InitSave.s,Sram_InitSave,0x80146AA0,0xD6
 asm/non_matchings/code/z_sram_NES/func_80146DF8.s,func_80146DF8,0x80146DF8,0x12
-asm/non_matchings/code/z_sram_NES/func_80146E40.s,func_80146E40,0x80146E40,0xC
+asm/non_matchings/code/z_sram_NES/Sram_InitSram.s,Sram_InitSram,0x80146E40,0xC
 asm/non_matchings/code/z_sram_NES/Sram_Alloc.s,Sram_Alloc,0x80146E70,0x13
 asm/non_matchings/code/z_sram_NES/func_80146EBC.s,func_80146EBC,0x80146EBC,0xB
-asm/non_matchings/code/z_sram_NES/func_80146EE8.s,func_80146EE8,0x80146EE8,0x1D
-asm/non_matchings/code/z_sram_NES/func_80146F5C.s,func_80146F5C,0x80146F5C,0x2B
+asm/non_matchings/code/z_sram_NES/Sram_SaveSpecialEnterClockTown.s,Sram_SaveSpecialEnterClockTown,0x80146EE8,0x1D
+asm/non_matchings/code/z_sram_NES/Sram_SaveSpecialNewDay.s,Sram_SaveSpecialNewDay,0x80146F5C,0x2B
 asm/non_matchings/code/z_sram_NES/func_80147008.s,func_80147008,0x80147008,0x6
 asm/non_matchings/code/z_sram_NES/func_80147020.s,func_80147020,0x80147020,0x12
 asm/non_matchings/code/z_sram_NES/func_80147068.s,func_80147068,0x80147068,0x34