Skip to content

Commit 06f2ce0

Browse files
committed
Updated README to v4 again
1 parent 2fcd079 commit 06f2ce0

File tree

2 files changed

+95
-305
lines changed

2 files changed

+95
-305
lines changed

README.md

Lines changed: 95 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,38 @@
22
# TetrisGYM
33

44
<div align="center">
5-
<img src="./screens/menu3.png" alt="Menuscreen">
5+
<img src="./screens/menu.png" alt="Menuscreen">
66
<br>
77
</div>
88
<br>
99

10-
* [Getting Started](#guide)
11-
* [Trainers](#modes)
10+
* [Getting Started](#getting-started)
11+
* [Trainers](#trainers)
1212
* [Tetris](#tetris)
1313
* [T-Spins](#t-spins)
1414
* [Seed](#seed)
1515
* [Stacking](#stacking)
1616
* [Pace](#pace)
1717
* [Setups](#setups)
18+
* [B-Type](#b-type)
1819
* [Floor](#floor)
19-
* [(Quick)Tap](#%28quick%29-tap)
20+
* [(Quick)Tap](#quicktap)
21+
* [Transition](#transition)
2022
* [Garbage](#garbage)
2123
* [Drought](#drought)
24+
* [DAS Delay](#das-delay)
25+
* [Invisible](#invisible)
26+
* [Hard Drop](#hard-drop)
27+
* [Tap/Roll Speed Tester](#taproll-speed-tester)
28+
* [Hz Display](#hz-display)
2229
* [Input Display](#input-display)
23-
* [Debug Mode](#debug-mode)
30+
* [Goofy Foot](#goofy-foot)
31+
* [Block Tool](#block-tool)
2432
* [Level Editor](#level-editor)
2533
* [Savestates](#savestates)
34+
* [Qualifier Mode](#qual-mode)
2635
* [PAL Mode](#pal-mode)
36+
* [Bugfixes](#bugfixes)
2737
* [Resources](#resources)
2838

2939
## Getting Started
@@ -32,7 +42,9 @@ TetrisGYM is a modification of NES Tetris.
3242

3343
While originally based on the NTSC version of the game, the patched ROM supports PAL and NTSC gameplay types.
3444

35-
TetrisGYM is distributed in the form of a BPS patch and can be applied to the USA version of the game with [Rom PatcherJS](https://www.romhacking.net/patch/) or similar.
45+
TetrisGYM is distributed in the form of a BPS patch and can be applied to the USA version of the game with [Rom PatcherJS](https://www.romhacking.net/patch/) or similar.
46+
47+
`Unpatched File SHA-1: 77747840541BFC62A28A5957692A98C550BD6B2B`
3648

3749
A link to the BPS can be found on the [releases page](https://github.com/kirjavascript/TetrisGYM/releases).
3850

@@ -44,7 +56,7 @@ Some trainers have additional configuration values; use left and right to change
4456

4557
![Tetris](/screens/levelselect.png)
4658

47-
Same gameplay as Type-A, with some improvements: no score cap, no rocket, no curtain, always next box, better pause, extended level select.
59+
Same gameplay as A-Type, with some improvements: no score cap, no rocket, no curtain, always next box, better pause, extended level select.
4860

4961
### T-Spins
5062

@@ -58,6 +70,10 @@ Provides same piece sets for VS battles (or practise).
5870

5971
Press `select` to generate a random seed.
6072

73+
The seed trainer was improved in v3.1 to give a 'better' distribution of cases.
74+
75+
Different versions of TetrisGYM can still share SPS by setting the fifth digit to 0.
76+
6177
### Stacking
6278

6379
![Stacking](/screens/stacking.png)
@@ -101,7 +117,14 @@ Several preset playfields for practising different types of tucks and spins.
101117
3. I
102118
4. Buco
103119
5. Various
104-
6. L / J Double
120+
6. L / J Spintuck
121+
7. L / J Doubletuck
122+
123+
### B-Type
124+
125+
![B-Type](/screens/floor.png)
126+
127+
Same gameplay as B-Type in the original, except heights up to 8 are supported.
105128

106129
### Floor
107130

@@ -117,6 +140,14 @@ Setting the height to zero will result in a game mode with burns disabled.
117140

118141
For practising tapping and quicktapping pieces over towers. 0-G will have a tower on the left of the screen and H-W will have a tower to the right.
119142

143+
### Transition
144+
145+
![Transition](/screens/transition.png)
146+
147+
Puts you ten lines before transition. The value given will be added to your score, so set this to 5 and start on level 18 for a 'maxout trainer' style mode.
148+
149+
Setting the value to G causes the mode to act identical to the game genie code `SXTOKL`
150+
120151
### Garbage
121152

122153
![Garbage](/screens/garbage.png)
@@ -135,30 +166,57 @@ Create artificially inflated droughts. Increasing the value causes less I pieces
135166

136167
0 = normal gameplay I = no line pieces
137168

138-
### Input Display
169+
### DAS Delay
170+
171+
Change the auto-shift delay rate.
172+
173+
### Invisible
174+
175+
![Invisible](/screens/invisible.png)
176+
177+
Blocks are invisible until the end of the game.
178+
179+
### Hard Drop
180+
181+
![Hard Drop](/screens/harddrop.png)
182+
183+
Press `select` or `up` to hard drop.
184+
185+
## Tap/Roll Speed Tester
186+
187+
Practise tapping rate outside of gameplay.
188+
189+
## Hz Display
190+
191+
![Hz Display](/screens/hz.png)
192+
193+
Shows the average tapping rate for each tap in a burst.
194+
195+
Also shows frames between spawn and first tap, and current tap direction.
196+
197+
## Input Display
139198

140199
![Controller](/screens/controller.png)
141200

142-
In debug mode
201+
## Goofy Foot
143202

144-
* Select + Right
145-
Toggle controller input display
203+
Flips A/B, Start/Select, and inverts DPad directions like a Goofy Foot controller.
146204

147-
## Debug Mode
205+
## Block Tool
148206

149-
![Controller](/screens/debug.png)
207+
![Block](/screens/block.png)
150208

151209
Allow more fine control over aspects of gameplay.
152210

153-
This is a config option only, and will enable debug mode globally.
211+
This is a config option only, and will enable the block tool globally.
154212

155-
When enabled, press start to go into debug mode.
213+
When enabled, press start to use the editors.
156214

157215
### Level Editor
158216

159217
* DPad
160218
Move around
161-
* Select + Left
219+
* Select + Left/Right
162220
Switch between piece and playfield editors
163221

164222
In piece mode
@@ -181,7 +239,7 @@ When paused
181239

182240
* Select + Up
183241
Increment save slot
184-
* Select + Up
242+
* Select + Down
185243
Decrement save slot
186244
* Select + A
187245
Save state
@@ -199,12 +257,28 @@ Savestates require SRAM to work. Tested and working on Everdrive / Emulator / Mi
199257

200258
Combined with the level editor, savestates are effective for practising specific scenarios.
201259

260+
## Qual Mode
261+
262+
![Legal](/screens/legal.png)
263+
264+
![Rocket](/screens/rocket.png)
265+
266+
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.
267+
202268
## PAL Mode
203269

204270
Dictate if the NTSC or PAL gameplay mechanics should be used. Should automatically detect region, but can be manually overwritten otherwise.
205271

206-
## Resources
272+
## Bugfixes
273+
274+
TetrisGYM fixes some well known bugs in the original game;
207275

208-
base disassembly: [https://github.com/CelestialAmber/TetrisNESDisasm](https://github.com/CelestialAmber/TetrisNESDisasm)
209-
disassembly information: [https://github.com/ejona86/taus](https://github.com/ejona86/taus)
276+
- Resetting during a tetris no longer creates an invalid state
277+
- Level numbers are correct past level 29
278+
- Tetrimino colours are correct past level 138
279+
- Game no longer crashes after ~1550 lines
280+
281+
## Resources
210282

283+
Tools and references: [https://github.com/ejona86/taus](https://github.com/ejona86/taus)
284+
Disassembly, based on work from TAUS: [https://github.com/CelestialAmber/TetrisNESDisasm](https://github.com/CelestialAmber/TetrisNESDisasm)

0 commit comments

Comments
 (0)