Fixed bug, improved second controller handling, added splash screen

Author: idlechild

src/BRBmenu.asm

@@ -10,6 +10,10 @@ cm_brb_table:
 ; 1000h bytes transferred
 incbin ../resources/cm_brb_gfx.bin
 
+%endfree(8E)
+
+
+%startfree(A1)
 
 ; --------
 ; BRB Menu
@@ -182,9 +186,15 @@ cm_brb_loop:
 cm_draw_brb:
 {
     JSL cm_tilemap_bg_interior_long
+    LDA !ram_sram_detection : BNE .splash_screen
     JSR cm_tilemap_brb
     JSL cm_tilemap_transfer_long
     JMP cm_brb_scroll_BG3
+
+  .splash_screen
+    JSR cm_tilemap_splash_screen
+    JSL cm_tilemap_transfer_long
+    RTS
 }
 
 cm_tilemap_brb:
@@ -287,6 +297,36 @@ cm_tilemap_brb:
     RTS
 }
 
+cm_tilemap_splash_screen:
+{
+    ; Same bank for all of the BRB text
+    PHK : PHK : PLA : STA !DP_CurrentMenu+2
+
+    LDA !ram_sram_detection
+    CMP !SRAM_DETECTION_32KB : BEQ .legacy
+    CMP !SRAM_DETECTION_128KB : BEQ .tinystates
+    CMP !SRAM_DETECTION_ZSNES : BEQ .zsnes
+    BRK
+
+  .legacy
+    LDA.w #BRB_legacy : STA !DP_CurrentMenu
+    LDX #$0286
+    JSR cm_draw_brb_text
+    RTS
+
+  .tinystates
+    LDA.w #BRB_tinystates : STA !DP_CurrentMenu
+    LDX #$0286
+    JSR cm_draw_brb_text
+    RTS
+
+  .zsnes
+    LDA.w #BRB_zsnes : STA !DP_CurrentMenu
+    LDX #$0286
+    JSR cm_draw_brb_text
+    RTS
+}
+
 brb_handle_countup_timer:
 {
     LDA !ram_cm_brb_frames : INC : STA !ram_cm_brb_frames
@@ -470,6 +510,15 @@ table ../resources/header.tbl
 
 BRB_common_2:
     db #$28, "    Will Be Right Back", #$FF
+
+BRB_legacy:
+db #$28, "    SNES CLASSIC OR VC", #$FF
+
+BRB_tinystates:
+db #$28, "  SELECT MODERN EMULATORS", #$FF
+
+BRB_zsnes:
+db #$28, "    DO NOT USE ZSNES", #$FF
 table ../resources/normal.tbl
 
 BRBTilemapAddress:
@@ -532,5 +581,5 @@ BRB_screen_07:
 BRB_screen2_07:
     db #$28, "        crocomi.re", #$FF
 
-%endfree(8E)
+%endfree(A1)
 

src/defines.asm

@@ -6,7 +6,7 @@
 ; The crash buffer and initial address can be moved around as needed
 ; It is currently placed in the back half of the backup of BG2 tilemap during x-ray,
 ; which means it is unlikely to overwrite anything relevant for debugging
-!CRASHDUMP_TILEMAP_BUFFER = !ram_tilemap_buffer ; 2048 bytes
+!CRASHDUMP_TILEMAP_BUFFER = $7E5800 ; 2048 bytes
 !CRASH_INITIAL_ADDRESS = #$7E0A44
 
 ; Practice hack menu tilemap buffer
@@ -271,9 +271,7 @@
 !ram_cm_sfxlib2 = !WRAM_MENU_START+$58
 !ram_cm_sfxlib3 = !WRAM_MENU_START+$5A
 
-if !FEATURE_SD2SNES
-!ram_sram_savestates = !WRAM_MENU_START+$5C
-endif
+!ram_sram_detection = !WRAM_MENU_START+$5C
 
 !ram_timers_autoupdate = !WRAM_MENU_START+$5E
 !ram_cm_gmode = !WRAM_MENU_START+$60
@@ -354,6 +352,7 @@ endif
 !ram_cm_ctrl_assign = !WRAM_MENU_START+$96
 !ram_cm_ctrl_swap = !WRAM_MENU_START+$98
 !ram_cm_ctrl_timer = !WRAM_MENU_START+$9A
+!ram_cm_ctrl_savestates_allowed = !WRAM_MENU_START+$9C
 
 !ram_cm_crop_mode = !WRAM_MENU_START+$90
 !ram_cm_crop_tile = !WRAM_MENU_START+$92
@@ -1145,6 +1144,11 @@ endif
 !CTRL_SHORTCUT_TYPE_MASK = #$007F
 !CTRL_SHORTCUT_EXACT_MATCH = #$0080
 
+; By default, value is zero and we assume there are no issues
+!SRAM_DETECTION_32KB = #$0032
+!SRAM_DETECTION_128KB = #$0128
+!SRAM_DETECTION_ZSNES = #$0505
+
 !SUIT_PROPERTIES_MASK = #$0007
 !SUIT_PROPRETIES_PAL_DEBUG_FLAG = #$0008
 

src/gamemode.asm

@@ -549,7 +549,7 @@ endif
     BPL .initialFirstCheckInputs
     CMP #$01 : BEQ .initialFirstCheckInputs
 if !FEATURE_SD2SNES
-    LDA !ram_sram_savestates : BNE .initialFirstCheckInputs
+    LDA !ram_sram_detection : BEQ .initialFirstCheckInputs
 endif
   .initialFirstInvalid
     TDC : STA !CTRL_SHORTCUT_TABLE,X
@@ -593,7 +593,7 @@ endif
     BPL .initialSecondCheckInputs
     CMP #$01 : BEQ .initialSecondCheckInputs
 if !FEATURE_SD2SNES
-    LDA !ram_sram_savestates : BNE .initialSecondCheckInputs
+    LDA !ram_sram_detection : BEQ .initialSecondCheckInputs
 endif
   .initialSecondInvalid
     TDC : STA !CTRL_SHORTCUT_TABLE,X
@@ -825,7 +825,7 @@ endif
     LDA #$F0 : STA !CTRL_SHORTCUT_ROUTINE,X : INX
 
     ; Determine how much to branch by
-    PHX : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
+    PHX : TDC : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
     LDA.l ctrl_shortcut_jsl_word_lsb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_LSB
     LDA.l ctrl_shortcut_jsl_word_msb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_MSB
     LDA.l ctrl_shortcut_cancel_gameplay_table,X : BNE .priWriteMatchClc
@@ -888,7 +888,7 @@ endif
     LDA #$F0 : STA !CTRL_SHORTCUT_ROUTINE,X : INX
 
     ; Determine how much to branch by
-    PHX : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
+    PHX : TDC : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
     LDA.l ctrl_shortcut_jsl_word_lsb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_LSB
     LDA.l ctrl_shortcut_jsl_word_msb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_MSB
     LDA.l ctrl_shortcut_cancel_gameplay_table,X : BNE .priWriteSpecialClc
@@ -1065,7 +1065,7 @@ endif
     LDA #$F0 : STA !CTRL_SHORTCUT_ROUTINE,X : INX
 
     ; Determine how much to branch by
-    PHX : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
+    PHX : TDC : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
     LDA.l ctrl_shortcut_jsl_word_lsb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_LSB
     LDA.l ctrl_shortcut_jsl_word_msb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_MSB
     LDA.l ctrl_shortcut_cancel_gameplay_table,X : BNE .secWriteMatchClc
@@ -1128,7 +1128,7 @@ endif
     LDA #$F0 : STA !CTRL_SHORTCUT_ROUTINE,X : INX
 
     ; Determine how much to branch by
-    PHX : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
+    PHX : TDC : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
     LDA.l ctrl_shortcut_jsl_word_lsb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_LSB
     LDA.l ctrl_shortcut_jsl_word_msb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_MSB
     LDA.l ctrl_shortcut_cancel_gameplay_table,X : BNE .secWriteSpecialClc
@@ -1261,7 +1261,7 @@ endif
     LDA #$F0 : STA !CTRL_SHORTCUT_ROUTINE,X : INX
 
     ; Determine how much to branch by
-    PHX : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
+    PHX : TDC : LDA !CTRL_SHORTCUT_TYPE : AND.b !CTRL_SHORTCUT_TYPE_MASK : TAX
     LDA.l ctrl_shortcut_jsl_word_lsb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_LSB
     LDA.l ctrl_shortcut_jsl_word_msb_table,X : STA !CTRL_SHORTCUT_JSL_WORD_MSB
     LDA.l ctrl_shortcut_cancel_gameplay_table,X : BNE .dualWriteMatchClc
@@ -1396,35 +1396,75 @@ cm_condense_ctrl_shortcuts:
     RTL
 }
 
-if !FEATURE_SD2SNES
-validate_sram_for_savestates:
+validate_sram:
 {
+    ; check if this is ZSNES
+    PHP : SEP #$28
+    LDA #$FF : CLC : ADC #$FF
+    CMP #$64 : CLD : BNE .doneZSNES
+    PLP
+    LDA !SRAM_DETECTION_ZSNES : STA !ram_sram_detection
+    JMP .fail
+
+  .doneZSNES
+    PLP
+
+if !FEATURE_SD2SNES
     ; check if required SRAM range is valid
     ; writes to SRAM will mirror in other banks if not valid
-if !FEATURE_TINYSTATES
+    LDA $707FFE : PHA
     LDA $737FFE : INC : STA $707FFE
-    CMP $737FFE : BNE .success
-else
-    LDA $777FFE : INC : STA $707FFE
-    CMP $777FFE : BNE .success
-endif
+    CMP $737FFE : BNE .first128CheckPass
 
     ; double check
-if !FEATURE_TINYSTATES
+    LDA $702FFE : PHA
     LDA $732FFE : INC : STA $702FFE
-    CMP $732FFE : BEQ .fail
+    CMP $732FFE : BNE .second128CheckPass
+
+    ; 128kb check failed
+    PLA : STA $702FFE
+    PLA : STA $707FFE
+    LDA !SRAM_DETECTION_32KB : STA !ram_sram_detection
+    BRA .fail
+
+  .second128CheckPass
+    PLA : STA $702FFE
+  .first128CheckPass
+    PLA : STA $707FFE
+
+if !FEATURE_TINYSTATES
 else
-    LDA $772FFE : INC : STA $702FFE
-    CMP $772FFE : BEQ .fail
+    LDA $737FFE : PHA
+    LDA $777FFE : INC : STA $737FFE
+    CMP $777FFE : BNE .first256CheckPass
+
+    ; double check
+    LDA $732FFE : PHA
+    LDA $772FFE : INC : STA $732FFE
+    CMP $772FFE : BNE .second256CheckPass
+
+    ; 256kb check failed
+    PLA : STA $732FFE
+    PLA : STA $737FFE
+    LDA !SRAM_DETECTION_128KB : STA !ram_sram_detection
+    BRA .fail
+
+  .second256CheckPass
+    PLA : STA $732FFE
+  .first256CheckPass
+    PLA : STA $737FFE
+endif
 endif
 
-  .success
-    LDA #$0001 : STA !ram_sram_savestates
+    ; success
+    TDC : STA !ram_sram_detection
     RTL
 
   .fail
+    LDA !sram_cutscenes : ORA !CUTSCENE_QUICKBOOT : STA !sram_cutscenes
+if !FEATURE_SD2SNES
     ; disable savestate controls
-    TDC : TAX : STA !ram_sram_savestates
+    TDC : TAX
     %a8()
   .firstLoop
     LDA !sram_ctrl_shortcut_selections,X : ASL
@@ -1440,9 +1480,9 @@ endif
     INX : CPX #$0030 : BMI .secondLoop
   .found
     %a16()
+endif
     RTL
 }
-endif
 
 
 ; ------------------
@@ -1662,19 +1702,19 @@ ctrl_select_shortcut_goto_page3:
 if !FEATURE_SD2SNES
 ctrl_add_save_state_dynamic:
     dw !ACTION_DYNAMIC
-    dl #!ram_sram_savestates
+    dl #!ram_cm_ctrl_savestates_allowed
     dw #$0000
     dw #ctrl_add_save_state
 
 ctrl_add_load_state_dynamic:
     dw !ACTION_DYNAMIC
-    dl #!ram_sram_savestates
+    dl #!ram_cm_ctrl_savestates_allowed
     dw #$0000
     dw #ctrl_add_load_state
 
 ctrl_add_auto_save_state_dynamic:
     dw !ACTION_DYNAMIC
-    dl #!ram_sram_savestates
+    dl #!ram_cm_ctrl_savestates_allowed
     dw #$0000
     dw #ctrl_add_auto_save_state
 endif
@@ -1986,8 +2026,8 @@ endif
 
 ctrl_add_shortcut_select:
 {
-    LDA !ram_cm_ctrl_add_shortcut_slot : TAX
-    CMP #$001E : BPL .additional
+    LDA !ram_cm_ctrl_add_shortcut_slot
+    TAX : CPX #$001E : BPL .additional
     TYA : %a8() : STA !sram_ctrl_shortcut_selections,X
     INX : CPX #$001E : BPL .secondLoop
   .firstLoop

src/init.asm

@@ -237,7 +237,7 @@ init_sram_controller_shortcuts:
     ; Main Menu
     LDA #$81 : LDX #$0000 : STA !sram_ctrl_shortcut_selections,X
 if !FEATURE_SD2SNES
-    LDA !ram_sram_savestates : BEQ .skipTypes
+    LDA !ram_sram_detection : BNE .skipTypes
     ; Save State
     LDA #$82 : INX : STA !sram_ctrl_shortcut_selections,X
     ; Load State
@@ -246,6 +246,8 @@ if !FEATURE_SD2SNES
 endif
     ; Reload Preset
     LDA #$86 : INX : STA !sram_ctrl_shortcut_selections,X
+    ; Main Menu
+    LDA #$81 : INX : STA !sram_ctrl_shortcut_selections,X
     ; Pause
     LDA #$95 : INX : STA !sram_ctrl_shortcut_selections,X
     ; Unpause
@@ -276,7 +278,7 @@ endif
     ; Main Menu (Controller 1, Start + Select)
     LDA #$3000 : LDX #$0000 : STA !sram_ctrl_1_shortcut_inputs,X
 if !FEATURE_SD2SNES
-    LDA !ram_sram_savestates : BEQ .skipValues
+    LDA !ram_sram_detection : BNE .skipValues
     ; Save State (Controller 1, Select + Y + R)
     LDA #$6010 : INX #2 : STA !sram_ctrl_1_shortcut_inputs,X
     ; Load State (Controller 1, Select + Y + L)
@@ -285,6 +287,8 @@ if !FEATURE_SD2SNES
 endif
     ; Reload Preset (Controller 1, Start + Y + L)
     LDA #$5020 : INX #2 : STA !sram_ctrl_1_shortcut_inputs,X
+    ; Main Menu (Controller 2, Start + Select)
+    LDA #$3000 : INX #2 : STA !sram_ctrl_2_shortcut_inputs,X
     ; Pause (Controller 2, Right)
     LDA #$0100 : INX #2 : STA !sram_ctrl_2_shortcut_inputs,X
     ; Unpause (Controller 2, Left)

src/macros.asm

@@ -523,7 +523,7 @@ endmacro
 
 macro SDE_dec(label, address)
 ; increments or decrements an address based on controller input, used in cm_edit_decimal_digits
-    LDA !IH_CONTROLLER_PRI : BIT !IH_INPUT_UP : BNE .<label>_inc
+    LDA !IH_CONTROLLER_PRI : ORA !IH_CONTROLLER_SEC : BIT !IH_INPUT_UP : BNE .<label>_inc
     ; dec
     LDA <address> : DEC : BPL .store_<label>
     LDA #$0009 : BRA .store_<label>