Merge branch 'master' of github.com:kirjavascript/TetrisGYM

Author: kirjavascript

CHANGELOG.md

@@ -7,6 +7,13 @@
 * Famicom Keyboard support
 * Fixed Floor-0 disabled burns
 * MMC3 Support
+* MMC5 Support
+* Fixed CNROM legal screen CHR bank
+* Fixed CNROM legal to title flicker
+* Block Tool pieces wrap around
+* Added hidden score option
+* Added marathon mode
+* 0001 seeds are ignored
 
 ## [v5 tournament]
 * Linecap Menu (from CTM Masters September 2022)

README.md

@@ -193,6 +193,10 @@ Puts you ten lines before transition. The value given will be added to your scor
 
 Setting the value to G causes the mode to act identical to the game genie code `SXTOKL`
 
+### Marathon
+
+Play as long as you are able to surive at a consistent speed.  While the level will increase normally, the drop rate and the points rewarded will remain fixed based on the starting level.
+
 ### Garbage
 
 ![Garbage](./assets/screens/garbage.png)
@@ -306,6 +310,12 @@ __Capped__
 
 Cap your score at 999999.
 
+__Hidden__
+
+![Hidden](./assets/screens/score-hidden.png)
+
+Hides score until game over.
+
 ## Hz Display
 
 ![Hz Display](./assets/screens/hz.png)

assets/screens/score-hidden.png

@@ -16,8 +16,8 @@ while getopts "vm:askh" flag; do
   case "${flag}" in
     v) set -x ;;
     m)
-        if ! [[ "${OPTARG}" =~ ^[134]$ ]]; then
-            echo "Valid INES_MAPPER (-m) options are 1, 3 or 4"
+        if ! [[ "${OPTARG}" =~ ^[1345]$ ]]; then
+            echo "Valid INES_MAPPER (-m) options are 1, 3, 4 or 5"
             exit 1
         fi
         compile_flags+=("-D INES_MAPPER=${OPTARG}")

build.sh

@@ -2,7 +2,7 @@
 INES_MAPPER := 1 ; supports 1, 3 and 4 (MMC1 / CNROM / MMC3)
 .endif
 
-HAS_MMC = INES_MAPPER = 1 || INES_MAPPER = 4
+HAS_MMC = INES_MAPPER = 1 || INES_MAPPER = 4 || INES_MAPPER = 5
 
 .ifndef SAVE_HIGHSCORES
 SAVE_HIGHSCORES := 1
@@ -52,46 +52,50 @@ BUTTON_SELECT := $20
 BUTTON_START := $10
 BUTTON_DPAD := BUTTON_UP | BUTTON_DOWN | BUTTON_LEFT | BUTTON_RIGHT
 
-MODE_TETRIS := 0
-MODE_TSPINS := 1
-MODE_SEED := 2
-MODE_PARITY := 3
-MODE_PACE := 4
-MODE_PRESETS := 5
-MODE_TYPEB := 6
-MODE_FLOOR := 7
-MODE_CRUNCH := 8
-MODE_TAP := 9
-MODE_TRANSITION := 10
-MODE_TAPQTY := 11
-MODE_CHECKERBOARD := 12
-MODE_GARBAGE := 13
-MODE_DROUGHT := 14
-MODE_DAS := 15
-MODE_KILLX2 := 16
-MODE_INVISIBLE := 17
-MODE_HARDDROP := 18
-MODE_SPEED_TEST := 19
-MODE_SCORE_DISPLAY := 20
-MODE_HZ_DISPLAY := 21
-MODE_INPUT_DISPLAY := 22
-MODE_DISABLE_FLASH := 23
-MODE_DISABLE_PAUSE := 24
-MODE_GOOFY := 25
-MODE_DEBUG := 26
-MODE_LINECAP := 27
-MODE_DASONLY := 28
-MODE_QUAL := 29
-MODE_PAL := 30
-
-MODE_QUANTITY := 31
-MODE_GAME_QUANTITY := 19
+.enum
+MODE_TETRIS
+MODE_TSPINS
+MODE_SEED
+MODE_PARITY
+MODE_PACE
+MODE_PRESETS
+MODE_TYPEB
+MODE_FLOOR
+MODE_CRUNCH
+MODE_TAP
+MODE_TRANSITION
+MODE_MARATHON
+MODE_TAPQTY
+MODE_CHECKERBOARD
+MODE_GARBAGE
+MODE_DROUGHT
+MODE_DAS
+MODE_KILLX2
+MODE_INVISIBLE
+MODE_HARDDROP
+MODE_SPEED_TEST
+MODE_SCORE_DISPLAY
+MODE_HZ_DISPLAY
+MODE_INPUT_DISPLAY
+MODE_DISABLE_FLASH
+MODE_DISABLE_PAUSE
+MODE_GOOFY
+MODE_DEBUG
+MODE_LINECAP
+MODE_DASONLY
+MODE_QUAL
+MODE_PAL
+.endenum
+
+MODE_QUANTITY = MODE_PAL + 1
+MODE_GAME_QUANTITY = MODE_HARDDROP + 1
 
 SCORING_CLASSIC := 0 ; for scoringModifier
 SCORING_LETTERS := 1
 SCORING_SEVENDIGIT := 2
 SCORING_FLOAT := 3
 SCORING_SCORECAP := 4
+SCORING_HIDDEN := 5
 
 LINECAP_KILLX2 := 1
 LINECAP_FLOOR := 2
@@ -107,7 +111,40 @@ MENU_TOP_MARGIN_SCROLL := 7 ; in blocks
 
 ; menuConfigSizeLookup
 ; menu ram is defined at menuRAM in ./ram.asm
-.define MENUSIZES $0, $0, $0, $0, $F, $7, $8, $C, $F, $20, $10, $1F, $8, $4, $12, $10, $0, $0, $0, $0, $4, $1, $1, $1, $1, $1, $1, $1, $1, $1, $1
+.macro MENUSIZES 
+    .byte $0    ; MODE_TETRIS
+    .byte $0    ; MODE_TSPINS
+    .byte $0    ; MODE_SEED
+    .byte $0    ; MODE_PARITY
+    .byte $F    ; MODE_PACE
+    .byte $7    ; MODE_PRESETS
+    .byte $8    ; MODE_TYPEB
+    .byte $C    ; MODE_FLOOR
+    .byte $F    ; MODE_CRUNCH
+    .byte $20   ; MODE_TAP
+    .byte $10   ; MODE_TRANSITION
+    .byte $0    ; MODE_MARATHON
+    .byte $1F   ; MODE_TAPQTY
+    .byte $8    ; MODE_CHECKERBOARD
+    .byte $4    ; MODE_GARBAGE
+    .byte $12   ; MODE_DROUGHT
+    .byte $10   ; MODE_DAS
+    .byte $0    ; MODE_KILLX2
+    .byte $0    ; MODE_INVISIBLE
+    .byte $0    ; MODE_HARDDROP
+    .byte $0    ; MODE_SPEED_TEST
+    .byte $5    ; MODE_SCORE_DISPLAY
+    .byte $1    ; MODE_HZ_DISPLAY
+    .byte $1    ; MODE_INPUT_DISPLAY
+    .byte $1    ; MODE_DISABLE_FLASH
+    .byte $1    ; MODE_DISABLE_PAUSE
+    .byte $1    ; MODE_GOOFY
+    .byte $1    ; MODE_DEBUG
+    .byte $1    ; MODE_LINECAP
+    .byte $1    ; MODE_DASONLY
+    .byte $1    ; MODE_QUAL
+    .byte $1    ; MODE_PAL
+.endmacro
 
 .macro MODENAMES
     .byte   "TETRIS"
@@ -121,6 +158,7 @@ MENU_TOP_MARGIN_SCROLL := 7 ; in blocks
     .byte   "CRUNCH"
     .byte   "QCKTAP"
     .byte   "TRNSTN"
+    .byte   "MARTHN"
     .byte   "TAPQTY"
     .byte   "CKRBRD"
     .byte   "GARBGE"

src/constants.asm

@@ -21,6 +21,10 @@ gameMode_gameTypeMenu:
         ; Horizontal mirroring
         lda #$1
         sta MMC3_MIRRORING
+.elseif INES_MAPPER = 5
+        ; Horizontal mirroring
+        lda #$50
+        sta MMC5_NT_MAPPING
 .endif
         lda #%10011 ; used to be $10 (enable horizontal mirroring)
         jsr setMMC1Control
@@ -97,6 +101,7 @@ gameTypeLoopCheckStart:
         lda set_seed_input
         bne @checkSelectable
         lda set_seed_input+1
+        and #$FE ; treat 0001 like 0000
         beq gameTypeLoopNext
 
 @checkSelectable:
@@ -305,7 +310,7 @@ menuConfigControls:
         rts
 
 menuConfigSizeLookup:
-        .byte   MENUSIZES
+        MENUSIZES
 
 assertValues:
         ; make sure you can only have block or qual
@@ -410,6 +415,7 @@ renderMenuVars:
         lda set_seed_input
         bne @renderIndicator
         lda set_seed_input+1
+        and #$FE ; treat 0001 like 0000
         beq @cursorFinished
 @renderIndicator:
         ldx #$E

src/gamemode/gametypemenu/menu.asm

@@ -51,6 +51,10 @@ gameModeState_initGameBackground:
         ; Vertical mirroring (Prevents screen glitching)
         lda #$0
         sta MMC3_MIRRORING
+.elseif INES_MAPPER = 5
+        ; Single screen (Prevents screen glitching)
+        lda #$0
+        sta MMC5_NT_MAPPING
 .endif
         jsr resetScroll
         jsr waitForVBlankAndEnableNmi
@@ -80,7 +84,19 @@ scoringBackground:
         sta PPUADDR
         lda #$16
         sta PPUDATA
+        jmp @noSevenDigit
 @noFloat:
+        cmp #SCORING_HIDDEN
+        bne @notHidden
+        jsr scoreSetupPPU
+        lda #$FF
+        ldx #$6
+@hiddenScoreLoop:
+        sta PPUDATA
+        dex
+        bne @hiddenScoreLoop
+        jmp @noSevenDigit
+@notHidden:
         cmp #SCORING_SEVENDIGIT
         bne @noSevenDigit
         jsr bulkCopyToPpu

src/gamemodestate/initbackground.asm

@@ -38,10 +38,7 @@ pause:
 
 @pauseSetupPart2:
         jsr updateAudioAndWaitForNmi
-        lda #$FF
-        ldx #$02
-        ldy #$02
-        jsr memset_page
+        jsr resetOAMStaging
 
 @pauseLoop:
         lda qualFlag

src/gamemodestate/pause.asm

@@ -49,9 +49,20 @@ MMC1_CHR1   := $DFFF
 MMC3_BANK_SELECT := $8000
 MMC3_BANK_DATA := $8001
 MMC3_MIRRORING := $A000
+MMC3_PRG_RAM := $A001
+
+; https://www.nesdev.org/wiki/MMC5#Configuration
+MMC5_PRG_MODE := $5100
+MMC5_CHR_MODE := $5101
+MMC5_RAM_PROTECT1 := $5102
+MMC5_RAM_PROTECT2 := $5103
+MMC5_NT_MAPPING := $5105 ; $50 horizontal, $44 vertical, $00 single
+MMC5_CHR_BANK0 := $5123 ; 4kb page index
+MMC5_CHR_BANK1 := $5127
 
 .macro RESET_MMC1
 .if INES_MAPPER = 1
-        inc $8000 ; initRam
+:       inc :-  ; increments inc ($aa), writing a negative value to prg
+                ; https://www.nesdev.org/wiki/MMC1#Reset
 .endif
 .endmacro

src/io.asm

@@ -15,6 +15,9 @@
 
 .segment    "PRG_chunk1": absolute
 
+; region code at start of page to keep cycle count consistent
+.include "util/check_region.asm"
+
 initRam:
 
 .include "boot.asm"
@@ -46,7 +49,6 @@ mainLoop:
 .include "highscores/entry_screen.asm"
 
 .include "util/core.asm"
-.include "util/check_region.asm"
 .include "util/bytesprite.asm"
 .include "util/strings.asm"
 .include "util/math.asm"