Merge pull request #7 from timotheeg/standard_pause_in_qual_mode

Restore standard pause in qual mode / Added classic mode options

Author: kirjavascript

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## [v4 classic]
+- Standard Pause in Qual Mode
+- No Next Box allowed in Qual Mode
+- Block Tool cannot be used in Qual Mode
 
 ## [v4]
 - B-Type Trainer (height 0-8)

README.md

@@ -265,6 +265,12 @@ Combined with the level editor, savestates are effective for practising specific
 
 Reintroduces the 'wait screens', intended for use in qualifiers where the the player would otherwise gain a time advantage skipping the rocket, legal and title screens.
 
+Also reintroduces other classic features like the end game curtain, standard pause, and no next box.
+
+These features make TetrisGYM work better with post processing tools like [NestrisChamps](https://github.com/timotheeg/nestrischamps) and [MaxoutClub](https://maxoutclub.com/).
+
+You cannot use the Block Tool and Qual mode at the same time.
+
 ## PAL Mode
 
 Dictate if the NTSC or PAL gameplay mechanics should be used. Should automatically detect region, but can be manually overwritten otherwise.

main.asm

@@ -9,7 +9,6 @@
 
 PRACTISE_MODE := 1
 NO_MUSIC := 1
-ALWAYS_NEXT_BOX := 1
 AUTO_WIN := 0
 NO_SCORING := 0
 DEV_MODE := 0
@@ -1047,7 +1046,7 @@ menuConfigControls:
         dec menuVars, x
         lda #$01
         sta soundEffectSlot1Init
-        jsr checkGoofy
+        jsr assertValues
 @skipLeftConfig:
 
         ; check if pressing right
@@ -1061,15 +1060,33 @@ menuConfigControls:
         inc menuVars, x
         lda #$01
         sta soundEffectSlot1Init
-        jsr checkGoofy
+        jsr assertValues
 @skipRightConfig:
 @configEnd:
         rts
 
 menuConfigSizeLookup:
         .byte   MENUSIZES
 
-checkGoofy:
+assertValues:
+        ; make sure you can only have block or qual
+        lda practiseType
+        cmp #MODE_QUAL
+        bne @noQual
+        lda menuVars, x
+        beq @noQual
+        lda #0
+        sta debugFlag
+@noQual:
+        lda practiseType
+        cmp #MODE_DEBUG
+        bne @noDebug
+        lda menuVars, x
+        beq @noDebug
+        lda #0
+        sta qualFlag
+@noDebug:
+        ; goofy
         lda practiseType
         cmp #MODE_GOOFY
         bne @noFlip
@@ -2392,10 +2409,12 @@ orientationTable:
         .byte   $FF,$00,$00,$FF,$00,$00,$FF,$00
 
 stageSpriteForNextPiece:
-.if !ALWAYS_NEXT_BOX
+        lda qualFlag
+        beq @alwaysNextBox
         lda displayNextPiece
         bne @ret
-.endif
+
+@alwaysNextBox:
         lda #$C8
         sta spriteXOffset
         lda #$77
@@ -4949,51 +4968,84 @@ gameModeState_startButtonHandling:
         ; do nothing if curtain is being lowered
         lda playState
         cmp #$0A
-        bne @pause
-        jmp @ret
+        beq @ret
+        jsr pause
+
+@ret:   inc gameModeState
+        rts
 
-@pause:
+pause:
         lda #$05
         sta musicStagingNoiseHi
+
+        lda qualFlag
+        beq @pauseSetupNotClassic
+
+@pauseSetupClassic:
+        lda #$00
+        sta renderMode
+        lda #$16
+        sta PPUMASK
+        jmp @pauseSetupPart2
+
+@pauseSetupNotClassic:
         lda #$04 ; render_mode_pause
         sta renderMode
+
+@pauseSetupPart2:
         jsr updateAudioAndWaitForNmi
-        lda #$1E ; $16 for black
-        sta PPUMASK
         lda #$FF
         ldx #$02
         ldy #$02
         jsr memset_page
+
 @pauseLoop:
+        lda qualFlag
+        beq @pauseLoopNotClassic
+
+@pauseLoopClassic:
+        lda #$70
+        sta spriteXOffset
+        lda #$77
+        sta spriteYOffset
+        jmp @pauseLoopCommon
+
+@pauseLoopNotClassic:
         lda #$74
         sta spriteXOffset
         lda #$58
         sta spriteYOffset
+
+@pauseLoopCommon:
         ; put 3 or 5 in a
         lda debugFlag
         asl
         adc #3
         sta spriteIndexInOamContentLookup
         jsr loadSpriteIntoOamStaging
 
+        lda qualFlag
+        bne @pauseCheckStart
+
         jsr practiseGameHUD
         jsr debugMode
         ; debugMode calls stageSpriteForNextPiece, stageSpriteForCurrentPiece
 
+@pauseCheckStart:
         lda newlyPressedButtons_player1
         cmp #$10
         beq @resume
         jsr updateAudioWaitForNmiAndResetOamStaging
         jmp @pauseLoop
 
-@resume:lda #$1E
+@resume:
+        lda #$1E
         sta PPUMASK
         lda #$00
         sta musicStagingNoiseHi
         sta vramRow
         lda #$03
         sta renderMode
-@ret:   inc gameModeState
         rts
 
 ; canon is waitForVerticalBlankingInterval