Merge pull request #93 from kirjavascript/readme_v6

README for v6

Author: kirjavascript

CHANGELOG.md

@@ -1,12 +1,12 @@
 # Changelog
 
-## [unreleased]
-* Crash Behaviours
-* Crunch Mode
-* Marathon Mode
+## v6
+* Crunch Trainer
+* Marathon Trainer
+* Low Stack Trainer
+* Crash Modes
 * Hidden Score Mode
 * Dark Mode
-* Low Stack Mode
 * M Score changed to Classic Scoring + Millions counter
 * Invisible linecap turns entire playfield invisible
 * Invisible mode preserves original piece colors
@@ -19,6 +19,7 @@
 * Floor no longer gobbled up by top line clear
 * Floor 0 has original no-burns behaviour again
 * [Fixed ingame score display at 8/9 million with Classic Scoring](https://www.youtube.com/watch?v=fYdXky2i5AE)
+* Fixed highscore layout for 10million+ score games
 * Fixed CNROM legal screen CHR bank
 * Fixed CNROM legal to title flicker
 * Fixed piece skip when doing Sonic Drop then Hard Drop immediately
@@ -32,7 +33,7 @@
 * MMC3 Support
 * MMC5 Support
 
-## [v5 tournament]
+## v5 tournament
 * Linecap Menu (from CTM Masters September 2022)
     * Trigger from any level or lines
     * Killscreen x2
@@ -48,7 +49,7 @@
 * Fixed the first mino becoming visible in Invisible
 * Other buttons can be pressed when using A+Start to add 10 levels
 
-## [v5]
+## v5
 * Tap Quantity Trainer
 * Checkerboard Trainer
 * Double Killscreen Trainer
@@ -109,12 +110,12 @@
 * Added input log to Speed Test
 * Fixed a bug where Rocket wouldn't show with a score between 1.0 and 1.03
 
-## [v4 classic]
+## v4 classic
 - Standard Pause in Qual Mode
 - No Next Box allowed in Qual Mode
 - Block Tool cannot be used in Qual Mode
 
-## [v4]
+## v4
 - B-Type Trainer (height 0-8)
 - Transition Trainer
 - Invisible Trainer
@@ -134,19 +135,19 @@
 - Added DAS-like movement to main menu
 - Added DAS-like movement to Block Tool
 
-## [v3.1]
+## v3.1
 - Added new setup (L/J doubletuck)
 - Improved seeds while retaining backwards compatibility
 - Improved region detection
 
-## [v3]
+## v3
 - Pace Trainer
 - Seed Trainer
 - Controller input can be enabled outside of Debug Mode
 - PAL Mode now has correct SFX
 - Tweaks to make Garbage Trainer more realistic
 
-## [v2]
+## v2
 - Savestates added to Debug Mode
 - Controller input added to Debug Mode
 - Garbage Trainer
@@ -164,7 +165,7 @@
     - Tetrimino colours are correct past level 138
     - Game no longer crashes after ~1550 lines
 
-## [v1]
+## v1
 - Tetris Trainer
 - T-Spins Trainer
 - Stacking Trainer

README.md

@@ -1,7 +1,7 @@
 # TetrisGYM
 
 <div align="center">
-    <img src="./assets/screens/menu5.png" alt="Menuscreen">
+    <img src="./assets/screens/menu6.png" alt="Menuscreen">
     <br>
 </div>
 <br>
@@ -16,24 +16,29 @@
     * [Setups](#setups)
     * [B-Type](#b-type)
     * [Floor](#floor)
+    * [Crunch](#crunch)
     * [(Quick)Tap](#quicktap)
     * [Tap Quantity](#tap-quantity)
     * [Checkerboard](#checkerboard)
     * [Transition](#transition)
+    * [Marathon](#marathon)
     * [Garbage](#garbage)
     * [Drought](#drought)
     * [DAS Delay](#das-delay)
+    * [Low Stack](#low-stack)
     * [Double Killscreen](#double-killscreen)
     * [Invisible](#invisible)
     * [Hard Drop](#hard-drop)
 * [Level Menu](#level-menu)
 * [Highscores](#highscores)
 * [Tap/Roll Speed Tester](#taproll-speed-tester)
 * [Scoring](#scoring)
+* [Crash](#crash)
 * [Hz Display](#hz-display)
 * [Input Display](#input-display)
 * [Disable Flash](#disable-flash)
 * [Disable Pause](#disable-pause)
+* [Dark Mode](#dark-mode)
 * [Goofy Foot](#goofy-foot)
 * [Block Tool](#block-tool)
     * [Level Editor](#level-editor)
@@ -61,7 +66,7 @@ ROM CRC32: 1394F57E
 
 A link to the BPS can be found on the [releases page](https://github.com/kirjavascript/TetrisGYM/releases).
 
-TetrisGYM supports the mappers MMC1, MMC3, and CNROM. The default build is MMC1.
+The BPS produces a file with an MMC1 header, but it also works when treated as CNROM.
 
 ## Trainers
 
@@ -151,6 +156,16 @@ Fill in the floor to a certain height to force higher stacking. This mode is oft
 
 Setting the height to zero will result in a game mode with burns disabled.
 
+### Crunch
+
+![Crunch](./assets/screens/crunch.png)
+
+Shrink the width of the playfield to force cramped stacking.
+
+Every increment of 4 will decrease the width from the left.
+
+Every increment of 1 will decrease the width from the right until it reaches its maximum of 3, where it will be reset to 0.
+
 ### (Quick)Tap
 
 ![Tap](./assets/screens/tap.png)
@@ -181,6 +196,14 @@ 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 survive at a consistent speed.
+
+0. Level transitions do not happen, game remains on the same level for as long as you are able to survive.
+1. Levels will transition normally, but speed and points will remain fixed based on your starting level.
+2. Similar to 1, speed and points will remain fixed based on the starting level you choose, but actual game will begin at level 0.
+
 ### Garbage
 
 ![Garbage](./assets/screens/garbage.png)
@@ -203,6 +226,12 @@ Create artificially inflated droughts. Increasing the value causes less I pieces
 
 Change the auto-shift delay rate.
 
+### Low Stack
+
+![Low-Stack](./assets/screens/lowstack.png)
+
+Choose a height limit for your stack and stay below or else it's game over.  
+
 ### Double Killscreen
 
 The pieces fall by two blocks every frame. It's hard.
@@ -286,7 +315,7 @@ __M__
 
 ![M](./assets/screens/score-m.png)
 
-Shows your score in millions, rolls over at 100 million.
+Same as Classic scoring, except additionally display your score in millions.
 
 __Capped__
 
@@ -300,6 +329,27 @@ __Hidden__
 
 Hides score until game over.
 
+## Crash
+
+![Crash](./assets/screens/crash.png)
+
+Recreation of the crash conditions and behaviour seen in the original game.
+
+For example; crashing, level lag, confetti, satan spawn
+
+* Off  
+        Normal Mode - No behaviour caused by the crash bug is present. Same behaviour as versions before v6.  
+* Show  
+        Enable crash glitches. Instead of crashing, show an icon next to score and continue the game.  
+* Topout  
+        Enable crash glitches. Instead of crashing, behave as if the player topped out.  
+* Crash  
+        Enable crash glitches, actually crash on crash triggers.
+
+## Strict Crash
+
+By enabling this option the crash triggers based on probabilities will always crash at the earliest opportunity.
+
 ## Hz Display
 
 ![Hz Display](./assets/screens/hz.png)
@@ -324,6 +374,14 @@ Disable the ability to pause the game.
 
 Flips A/B, Start/Select, and inverts DPad directions like a Goofy Foot controller.
 
+## Dark Mode
+
+![Dark Mode](./assets/screens/dark.png)
+
+Alternative pattern-less backgrounds.
+
+Dark, Neon, Lite, Teal, and OG versions are available.
+
 ## Block Tool
 
 ![Block](./assets/screens/block.png)
@@ -428,4 +486,10 @@ To build, you need a copy of `node` installed on your system. No other dependenc
 
 Provide a `clean.nes` file of the unpatched ROM and run `node build.js`
 
-This project descends from the [https://github.com/ejona86/taus](TAUS) and [https://github.com/CelestialAmber/TetrisNESDisasm](CelestialAmber) disassemblies of NES Tetris and has been heavily modified. Large parts have been replaced, lots of optimisations, removal of unused code, non-game-mechanics related bugfixes, tooling, and different approaches to the disassembly work itself has taken place.
+TetrisGYM supports being built for mappers NROM, MMC1, MMC3, MMC5, and CNROM.
+
+Run `node build.js -h` for a list of build options.
+
+---
+
+This project descends from ejona's [TAUS](https://github.com/ejona86/taus) disassembly and [CelestialAmber's](https://github.com/CelestialAmber/TetrisNESDisasm) subsequent take on it.

assets/screens/crash.png

@@ -125,7 +125,7 @@ CRASH_CRASH := 3
 LINECAP_WHEN_STRING_OFFSET := $10
 LINECAP_HOW_STRING_OFFSET := $12
 
-MENU_SPRITE_Y_BASE := $47
+MENU_SPRITE_Y_BASE := $46
 MENU_MAX_Y_SCROLL := $A0
 MENU_TOP_MARGIN_SCROLL := 7 ; in blocks
 
@@ -149,7 +149,7 @@ MENU_TOP_MARGIN_SCROLL := 7 ; in blocks
     .byte $4    ; MODE_GARBAGE
     .byte $12   ; MODE_DROUGHT
     .byte $10   ; MODE_DAS
-    .byte $0F   ; MODE_LOWSTACK
+    .byte $12   ; MODE_LOWSTACK
     .byte $0    ; MODE_KILLX2
     .byte $0    ; MODE_INVISIBLE
     .byte $0    ; MODE_HARDDROP
@@ -161,7 +161,7 @@ MENU_TOP_MARGIN_SCROLL := 7 ; in blocks
     .byte $1    ; MODE_INPUT_DISPLAY
     .byte $1    ; MODE_DISABLE_FLASH
     .byte $1    ; MODE_DISABLE_PAUSE
-    .byte $1    ; MODE_DARK
+    .byte $5    ; MODE_DARK
     .byte $1    ; MODE_GOOFY
     .byte $1    ; MODE_DEBUG
     .byte $1    ; MODE_LINECAP

assets/screens/dark.png

@@ -468,6 +468,8 @@ menuYTmp := tmp2
         cmp #MODE_CRASH
         beq @renderCrashMode
 
+        cmp #MODE_DARK
+        beq @renderDarkMode
 
         jsr menuItemY16Offset
         bne @loopNext
@@ -518,25 +520,26 @@ menuYTmp := tmp2
         lda scoringModifier
         sta spriteIndexInOamContentLookup
         lda #(MODE_SCORE_DISPLAY*8) + MENU_SPRITE_Y_BASE + 1
-        sbc menuScrollY
-        sta spriteYOffset
-        lda #$e9
-        sta spriteXOffset
-        jsr stringSpriteAlignRight
-        jmp @loopNext
+        jmp @renderOption
 
 @renderCrashMode:
         jsr menuItemY16Offset
         bne @loopNext
-@doRender:
-        lda crashModifier
-        cmp #CRASH_OFF
-        bne @notOff
-        lda #$F3
-@notOff:
-        adc #$14
+        ldx crashModifier
+        lda crashOptions, x
         sta spriteIndexInOamContentLookup
         lda #(MODE_CRASH*8) + MENU_SPRITE_Y_BASE + 1
+        jmp @renderOption
+
+@renderDarkMode:
+        jsr menuItemY16Offset
+        bne @loopNext
+        ldx darkModifier
+        lda darkOptions, x
+        sta spriteIndexInOamContentLookup
+        lda #(MODE_DARK*8) + MENU_SPRITE_Y_BASE + 1
+
+@renderOption:
         sec
         sbc menuScrollY
         sta spriteYOffset
@@ -545,6 +548,12 @@ menuYTmp := tmp2
         jsr stringSpriteAlignRight
         jmp @loopNext
 
+crashOptions:
+        .byte $8, $16, $17, $18
+
+darkOptions:
+        .byte $8, $9, $1B, $1C, $1D, $1e
+
 ; <- menu item index in A
 ; -> high byte of offset in A
 ; -> low byte in X

assets/screens/menu6.png

@@ -2,7 +2,11 @@ gameModeState_handleGameOver:
 .if AUTO_WIN
         lda newlyPressedButtons_player1
         and #BUTTON_SELECT
-        bne @gameOver
+        beq @continue
+        lda #$0A ; playState_checkStartGameOver
+        sta playState
+        jmp @ret
+@continue:
 .endif
         lda #$05
         sta generalCounter2

src/constants.asm

@@ -12,7 +12,7 @@ gameModeState_initGameBackground:
         jsr scoringBackground
         jsr debugNametableUI
 
-        lda darkMode
+        ldy darkModifier
         beq @notDarkMode
         jsr drawDarkMode
 @notDarkMode:
@@ -229,10 +229,22 @@ savestate_nametable:
 NORMAL_CORNER_TILES := $70
 DARK_CORNER_TILES := $80
 
+darkModeColors:
+        .byte $2D,$3C,$10,$0C,$3C
+
 drawDarkMode:
 
 darkBuffer := playfield ; cleared right after in initGameState
 
+        ; set the border colour
+        lda #$3F
+        sta PPUADDR
+        lda #$D
+        sta PPUADDR
+        ldx darkModifier
+        lda darkModeColors-1,x
+        sta PPUDATA
+
         ; process the playfield in 60 chunks
         lda #60
         sta tmpZ