README.md

Tetromino Game Engine + Terminal Application

This repo hosts

• tetrs_engine, a tetromino game engine implementing an API capable of handling some modern mechanics, and
• tetrs_tui, a simple but moderately polished Terminal User Interface for a typical cross-platform game experience.

---

(Author's Note : Due to irl circumstances I cannot continue development right now - issues may be worked on at a later time)

---

How to run

• Download a release for your platform if available.
• Run the application in your favourite terminal

Or compile it yourself:

• Have Rust (1.80.0+) installed.
• Download / git clone this repository.
• Navigate to tetrs_tui/ and cargo run.

Important

Use a terminal like kitty (or any terminal with support for progressive keyboard enhancement) for smoother gameplay experience. Note that otherwise DAS/ARR/Soft drop speed will be determined by Keyboard/OS/terminal emulator settings.

Explanation.

Terminals do not usually send "key released" signals, which is a problem for mechanics such as "press left to move left repeatedly until key is released". Crossterm automatically detects 'kitty-protocol'-compatible terminals where this issue is solved, allowing for smooth, configurable gameplay controls.

(*This also affects holding Soft Drop locking pieces on ground instantly, as opposed to only upon press down -- for ergonomics this is explicitly mitigated by the 'No soft drop lock' configuration.)*

Gallery

Classic game experience:

Efficient rendering in consoles, configurable controls, etc.:

Tip

Play Puzzle Mode with its 24 stages to test the custom Ocular Rotation System (+ unlock the experimental Descent Mode).

Various tileset + coloring combinations possible:

ASCII demo (GIF)

Electronika 60 demo (PNG)

*For display just like in the screenshot set your terminal text color to green and font to a Unicode-compatible one (e.g. DejaVu Sans Mono works)

Features of the Application

Gameplay

• Familiar stacker experience of moving, rotating, soft-/hard-dropping and holding Tetrominos and clearing completed rows.
• Colorful pieces.
• Next piece preview.
• Ghost piece.
• Animations: Hard drop, Line clears and Piece locking.
• Game stats: Current gravity level, lines cleared, points scored, time elapsed, pieces placed.

For more technical details see Features of the Tetrs Engine.

Gamemodes

• Standard modes:
  • 40-Lines: Clear 40-Lines as quickly as possible.
  • Marathon: Clear gravity levels 1-15 and achieve a highscore.
  • Time Trial: Get the highest score possible within three minutes.
  • Master: Clear 100 lines starting at the highest gravity.
• Special modes:
  • Puzzle: Advance through all 24 puzzle stages using perfect clears (and up to 5 attempts), enabled by piece acrobatics of the 'ocular' rotation system.
  • Cheese: Eat yourself through lines with random holes, with as few pieces as possible (default: 20).
  • Combo: Keep a line clear combo for as long as possible inside an infinite 4-wide well.
  • (Descent: Gather 'gems' as you navigate down (or up) an endless grid using an L or J piece - unlocked by completing Puzzle Mode)
• Custom mode: Change start gravity, toggle automatic gravity increase, set a game limit (Time, Score, Pieces, Lines, Gravity, or No limit).

Settings

• Look of the game:

  • Graphics (Unicode, ASCII, 'Electronika 60').
  • Colors (RGB Colors; 16 Colors (should work on all consoles), Monochrome).
  • Adjustable render rate and toggleable FPS counter.

• Play of the game:

  • Change controls.
  Default In-Game Controls

  Key	Action
  ←	Move left
  →	Move right
  A	Rotate left
  D	Rotate right
  (not set)	Rotate around (180°)
  ↓	Soft drop
  ↑	Hard drop
  (not set)	Sonic drop
  Esc	Pause game
  Ctrl+D	Forfeit game
  Ctrl+C	Exit program

  • Configure game.
    • Rotation system (Ocular, Classic, Super),
    • Piece generator (History, Uniform, Bag, Balance-Relative),
    • Preview count (0 - <terminal width limit>),
    • DAS, ARR, hard drop delay, line clear delay, appearance delay,
    • soft drop factor, ground time max,
  • Advanced, No soft drop lock (Enables soft drop not instantly locking pieces on ground even if keyboard enhancements are off, for better experience on typical consoles (soft drops for piece spins)).

• Keep Save File: By default this program won't store anything but just let you play the game. If you do want tetrs_tui to restore your settings and take record of past games upon startup then make sure this is set to ON!

Scoreboard

• History of games played in the current session (or in the past, if "keep save file" is toggled on).
• (*Games where 0 lines have been cleared are auto-deleted on exit.)

Note

If "keep save file for tetrs" is toggled ON then your settings and games will be stored in .tetrs_tui_savefile.json under a directory that tries to follow OS conventions [1, 2]:

	Windows	Linux	macOS	other
location	%APPDATA%	~/.config/	~/Library/Application Support/	(home directory)

(If this fails it tries to store it locally, ./.)

Features of the Tetrs Engine

The frontend application is proof-of-concept; Ultimately the tetrs engine tries to be modular and shifts the responsibility of detecting player input and chosen time of updates to the client. Basic interaction with the engine could look like the following:

// Starting a game.
let game = tetrs_engine::Game::new(Gamemode::marathon());

// Application loop.
loop {
  // Updating the game with a new button state at a point in time.
  game.update(Some(new_button_state), update_time);
  // ...
  // Updating the game with *no* change in button state (since previous).
  game.update(None, update_time_2);

  // View game state
  let GameState { board, .. } = game.state();
  // (Render the board, etc..)
}

Using the engine in a Rust project

Adding tetrs_engine as a dependency from git to a project:

[dependencies]
tetrs_engine = { git = "https://github.com/Strophox/tetrs.git" }

Game Configuration Aspects

• 'Standard' Gamemodes: Are encoded as a combination of starting level and whether to increment level and (one/several positive/negative) limits.
• Rotation Systems: Ocular Rotation System, Classic Rotation System, Super Rotation System. See Ocular Rotation System.
• Tetromino Generators: Recency-based, Bag, Uniformly random. Default is recency. See Tetromino Generation.
• Piece Preview (default 1)
• Delayed Auto Shift (default DAS = 167ms) (*Note: at very high levels DAS and ARR equal lock delay - 1ms.)
• Auto Repeat Rate (default ARR = 33ms)
• Soft Drop Factor (default SDF = 15.0)
• Hard drop delay (default 0.1ms)
• Line clear delay (default 200ms)
• Appearance Delay (default ARE = 50ms)

Currently, drop delay and lock delay* (*But not total ground time) are a function of the current level:

• Drop delay (1000ms at lvl 1 to 0.833ms ("20G") at lvl 19, as per guideline)
• 'Timer' variant of Extended Placement Lockdown (step reset); The piece tries to lock every 500ms at lvl 19 to every 150ms at lvl 30, and any given piece may only touch ground for 3000ms in total. See Piece Locking.

Most default values inspired by Guideline.

Game State Aspects

• Time: Game time is held abstract as "time elapsed since game started" and is not directly tied to real-world timestamps.
• Game finish: The game knows if it finished, and if session was won or lost. Normal Game Over scenarios are:
  • Block out: new piece spawn location is occupied.
  • Lock out: a piece was completely locked above the skyline (row 21 and above).
  • Forfeit: player stopped the current.
• Event queue: All game events are kept in an internal queue that is simulated through (up to the provided timestamp in the Game::update call).
• Buttons pressed state: The game keeps an abstract state of which buttons are currently pressed.
• Board state: (Yes).
• Active piece: The active piece is stored as a (tetromino, orientation, position) tuple plus some locking data.
• Next Pieces: Are polled from the generator, kept in a queue and can be viewed.
• Pieces played so far: A counter for each locked piece by type is stored.
• Lines cleared: (Yes)².
• Gravity Level: Increases every 10 line clears and influences only drop/lock delay.
• Scoring: Line clears trigger a score bonus, which takes into account number of lines cleared, spins, combos, back-to-backs; See Scoring.

Game Feedback Aspects

The game provides some useful feedback events upon every update, usually used to correctly implement visual frontend effects:

• Piece locked down, Lines cleared, Hard drop, Accolade (score bonus info), Message (generic message, currently unused for base gamemodes)

State of the Project

As much love and care went into building this project, it is of course not without its flaws;

• The README is not comprehensive:
  • Many small details of the tetrs_engine are not properly explained (e.g. the initial rotation mechanic, which allows spawning a piece immediately rotated if a rotation button was held).
• The engine itself might contain niche bugs as of this time. Concrete improvements include:
  • Better API documentation (cargo doc --open).
  • Simplification of code.
  • Proper commenting of implementation.
  • Refactor of complicated systems (e.g. locking).
  • Ideally: ensuring that Game::update is safe / actually panic-free.
• With regards to the terminal game experience, I'd like to argue the frontend is polished enough (much dedication went into making it nice for a 'proof-of-concept'). Regardless of whether this is actually the case, it is very lacking in aspects of code style, defects include:
  • The code for the menus is ad-hoc,
  • code duplication runs rampant,
  • no (or even worse, wrong) comments, and
  • possible panics may still be hiding around the corner.

A personal goal would be to (at least partially) amend these problems, step-by-step.

Project Highlights

While the 2009 Tetris Guideline serves as good inspiration, I ended up doing a lot of amateur research into a variety of game details present in modern games online (thank you Tetris Wiki and HardDrop!) and also by getting some help from asking people. I'd particularly like to thank the following people:

• GrBtAce, KonSola5 and bennxt for helping me with my questions early in development :-)
• Dunspixel for the O-spin inspiration,
• and madkiwi for advice regarding 4wide 6res layouts.

In the following I detail various interesting concepts I tackled on my way to bringing this project to life - I was essentially new to the Tetris Community and couldn't remember playing it for more than a couple minutes (in the last decade), so I had to figure all this out from scratch!

Tetromino Generation

Tetromino generators are interesting, and a core part of the game.

A trivial generator chooses tetrominos uniformly at random. This already works decent for a playable game.

However, typically players tend to get very frustrated when they don't get "the pieces they need" for a while. (*There's even a term for not getting an I-piece for an extended period of time: Drought.)

In modern games, the bag-based generation system is ubiquitous; The system simply takes all 7 pieces once, hands them out in random order, repeat.

It's quite nice knowing an I piece will come after 12 pieces, every time. One may even start strategizing and counting where one bag ends and the next starts.

It also takes a bit of the "fun" out of the randomness.

An alternative that seems to work well is recency-based generation: Remember the last time each piece was generated and when choosing the next one randomly, do so weighted by when each one was last seen so it is more likely to choose a piece not played in a while.

This preserves "possibly complete randomness" in the sense that any piece may be generated at any time, while still mitigating droughts.

Unlike bag it possibly provides a more continuous "gut feeling" of what piece(s) might come next, where in bag the order upon refill really is completely random.

Ocular Rotation System

"tetris has a great rotation system and is not flawed at all"

— said no one ever, not even the creator of Tetris himself.

Considering the sheer size of the franchise and range of players coming from all sorts of niches and previous game version the official Super Rotation System 'gets its job done'™ - nevertheless it was the mechanic I wanted to redo even before starting this project.

Creating a Rotation System.

My personal gripes with SRS are:

• The system is not symmetric.
  • Symmetric pieces can look exactly the same in different rotation states, but have different behaviour.
  • Doing rotation, then Mirroring board and piece ≠ Mirroring board and piece, then Doing mirrored rotation.
• It's an advanced system with things like different rotation points for different purposes, yet it re-uses the exact same kicks for 5 out of the 7 pieces, even though they have completely different symmetries.
• ^{Not a hot take, but some rotations are just weird (to be chosen over other possibilities).}
• Piece elevators.

Good general criteria for a rotation system I can think of would be:

1. Rotation must behave visually symmetrically;
   • equal-looking rotation states must behave the same,
   • and mirroring the board/pieces mirrors the rotation behaviour perfectly.
2. The kicks should be intuitive
   • the way pieces rotate should look 'feasible' to any given person;
   • e.g. the new position cannot be completely disjoint from previously.
3. Rotation should be fun! :D
   • but also any rotations should 'feel good' to a player.
   • (but don't overdo it - no teleporting pieces.)

The result of this was the 'Ocular' Rotation System, which was made by... looking at each piece and orientation and drawing the 'best' position(s) for it to land in after rotating (following above points and gut feeling).

I present to you - the Ocular Rotation System Heatmap:

How to read it: This heatmap is created by considering each combination of (piece, orientation, rotate left or right). By overlapping all the new possible positions for a piece after rotation, one gets a compact visualization of where the piece will most likely land, going from brightest color (yellow, first position attempt) to darkest (purple, last attempt):

Here's a comparison with SRS - the Super Rotation System Heatmap:

With SRS one starts to spot some rotational symmetries (you can always rotate back-and-forth between two positions), but I think it's overshadowed by all the asymmetrical kicks and very lenient (downwards and upwards) vertical kicks that contribute to SRS' unintuitiveness.

In the end I'm happy with how the custom rotation system turned out. It vaguely follows the mantra "if the rotation looks like it could reasonably work visually, it should" (+ some added kicks for flexibility and fun :-), hence its name, Ocular rotation system.

Ocular Rotation System - Comments

The general rationale behind most kicks is, "these first kicks feel most natural, any additional kicks after that serve flexibility, cool tricks and skill ceiling". However, more concrete heuristics can be stated:

• A general trend with kicks is to prevent needless upwarping of pieces. This simply means we first prefer rotations into a position further down before trying further up (foregoing nonsensical upward kicks in the first place).
• New positions must look 'visually close' to the original position. One thing observed in this system is that there are no disjoint rotation states, i.e. the old and new position always overlap in at least one tile. This heuristic also influenced the L/J rotations, always incorporating all rotations where two of the new pieces overlap with the old.
• The I, S and Z pieces are more rotationally symmetric than T, L and J, yielding the same visual shape whether rotated left or right. However, they do not have a natural 'center' in a way that would allow them to be rotated precisely in this sense, forcing us to choose their new position to be more left or right. We use this to our advantage and allow the player to have direct control over this by inputting one of the two rotation directions. This may arguably aid both directional intuition as well as allow for better finesse. It should not hurt rotational intuition ("piece stays in place if rotated 360°") as a player in a sense would never need to rotate such symmetrical pieces (especially mid-air) more than once anyway. :P

*Notation: nTlr 0-3 describes kick positions 0 to 3 when rotating a north-facing T-piece to the left or right.

• O-piece.
  • As the most symmetrical piece, having no kicks would be most natural, but also make it the only piece where rotation is 'useless'. Adding limited kicks however already turns out to be very useful to the player:
    • nOl 0: Simple sideways O-'roll', providing a second way to move O.
    • nOl 1: Allows for O-spins.
    • nOl 2: Also allows for O-spins and - more likely - 'rolling' the O out of a shallow well, possibly useful under high gravity.
    • nOl 3: While invisible on the chart, this technically allows the O to always successfully change its orientation upon rotation.
• I-piece.
  • As the longest piece, it has the most kicks to accommodate its visual range. What's special is that in its horizontal position it may rotate left or right into any reachable space around itself.
    • nIl 0-7: Rotating in it from a horizontal to a vertical position will very strongly prefer placing it in the desired direction of rotation first.
    • nIl 8-9: Fallback rotation states.
    • eIl 5-6: Allows tucking the I down flat.
    • Non-existent higher-positioned eIl: Intentionally left away to prevent upwarping.
• S/Z-piece.
  • The rotations for these pieces also allow for directional finesse.
    • nSZlr: Kept simple and symmetrical.
    • eSr 2|eZl 2: Useful and commonly applicable S/Z spin.
    • eSl 2|eZr 2: Tucking in an S/Z in this position might be handy.
• T-piece.
  • This piece has a relatively natural center of rotation, making for a good first rotation reposition.
    • neswTlr 0: 'Center' rotation.
    • nTlr 4: A T-'turn'.
    • eTl 4|wTr 4: A T-'insert', allowing it to warp down.
    • sTlr 4: A T-'turn'.
    • sTlr 5: This kick enables T-spin triples.
    • wTl 3-4|eTr 3-4: Two T-'turns'.
• L/J-piece.
  • Surprisingly, the most common center of rotation for L/J does not lead to a first rotation reposition where an overlap of two tiles with the original position is observed.
    • neswLJlr 0: 'Center' rotation.
    • nLl 4|nJr 4, eLl 5|wJr 5, sLl 2|sJr 2, wLl 1|wJr 1: Additional 'wall'-kicks that come after trying the 'center' rotation.
    • nLr 4|nJl 4, eLr 5|wJl 5, sLr 4|sJl 4, wLr 2|eJl 2: Somewhat weird kicks that are mostly included due to context and symmetry in rotation.
    • wLl 6-7|eJr 6-7: Two ways to specially tuck an L/J down.
    • sLr 6|sJl 6: Allows rotation into upright state even when resting on other blocks in a well.

Piece Locking

The mechanics of locking down a piece on the grid can be more complicated than it might sound at first glance.

Good criteria for a locking system I can think of would be:

1. Keep players from stalling / force players to make a choice eventually.
2. Give players enough flexibility to manipulate the piece even if it's on the ground.
3. Force players to react/input faster on faster levels, as speed is supposed to increase.
4. Implement all these limitations as naturally/simply as possible.

So I started looking and deciding which locking system to implement;

Creating a Locking System.

Classic lock down is simple, but if one decreases the lock timer on faster levels (3.) then it might become exceedingly difficult for players to actually have enough time to do adjustments (2.).

Classic Lock Down

• If the piece touches a surface
  • start a lock timer of 500ms (*var with lvl).
  • record the lowest y coordinate the piece has reached.
• If the lock timer runs out, lock the piece immediately as soon as it touches the next surface.
• If the piece falls below the previously lowest recorded y coordinate, reset lock timer.

Infinite lock down essentially mitigates the flexibility issue by saying, "if the player manipulated his piece, give him some more time". It's very simple, but the fact that it lets players stall forever (1.) is less nice.

Infinite Lock Down

• If the piece touches a surface
  • start a lock timer of 500ms (*var with lvl).
• If the lock timer runs out, lock the piece immediately as soon as it touches the next surface.
• If the piece moves/rotates (change in position), reset lock timer ('move reset').

The standard recommended by the guideline is therefore extended placement lock down.

Extended Placement Lock Down

• If the piece touches a surface
  • start a lock timer of 500ms (*var with lvl).
  • start counting the number of moves/rotates the player makes.
  • record the lowest y coordinate the piece has reached.
• If the piece moves/rotates (change in position), reset lock timer ('move reset').
• If the number of moves reaches 15, do not reset the lock timer anymore.
• If the lock timer runs out, lock the piece immediately as soon as it touches the next surface.
• If the piece falls below the previously lowest recorded y coordinate, reset counted number of moves.

(*This probably misses a few edge cases, but you get the gist.)

Yeah.

It's pretty flexible (2.) yet forces a decision (1.), but the 'count to 15 moves' part of this lock down seems somewhat arbitrary (4.) ^{(*Also note that after the 15 moves run out one can still manipulate the piece till lock down.)}

Idea.

What if we limit the total amount of time a piece may touch a surface (1.) instead of number of moves/rotates (4.), but on faster levels the piece attempts to lock down faster (3.), re-attempting later upon move/rotate; This still allows for plenty ^{*technically arbitrarily many} piece manipulations (2.) while still fulfilling the other points :D

'Timer' Placement Lock Down

Let 'ground time' denote the amount of time a piece touches a surface

• If the piece touches a surface
  • start a lock timer of 500ms (*var with lvl).
  • start measuring the ground time.
  • record the lowest y coordinate the piece has reached.
• If the piece moves/rotates (change in position), reset lock timer ('move reset').
• If the lock timer runs out or the ground time reaches 2.25s, lock the piece immediately as soon as it touches the next surface.
• If the piece falls below the previously lowest recorded y coordinate, reset the ground time.

Nice.

Although now it may potentially be abused by players which keep pieces in the air, only to occasionally touch down and reset the lock timer while hardly adding any ground time (note that this problem vanishes at 20G).

A small patch for this is to check the last time the piece touched the ground, and if that was, say, less than 2×(drop delay) ago, then act as if the piece had been touching ground all along. This way the piece is guaranteed to be counted as "continuously on ground" even with fast upward kicks of height ≤ 2.

In the end, a timer-based extended placement lockdown (+ ground continuity fix) is what I used. Although there might be a nicer system somehow..

Scoring

The exact scoring formula is given as follows:

Scoring Formula

score_bonus = 10
            * (lines + combo - 1) ^ 2
            * maximum [1, backToBack]
            * (if spin then 4 else 1)
            * (if perfect then 100 else 1)
  where lines = "number of lines cleared simultaneously"
        spin = "piece could not move up when locking occurred"
        perfect = "board is empty after line clear"
        combo = "number of consecutive played pieces where line clear occurred"
        backToBack = "number of consecutive line clears where spin, perfect or quadruple line clear occurred"

Table of Example Bonuses

A table of some example bonuses:

Score bonus	Action
+10	Single
+40	Double
+90	Triple
+160	Quadruple
+40	?-Spin Single
+160	?-Spin Double
+360	?-Spin Triple
+40	Single (2.combo)
+90	Single (3.combo)
+160	Single (4.combo)
+90	Double (2.combo)
+160	Double (3.combo)
+250	Double (4.combo)
+160	Triple (2.combo)
+250	Triple (3.combo)
+360	Triple (4.combo)
+320	Quadruple (2.B2B)
+480	Quadruple (3.B2B)
+640	Quadruple (4.B2B)
+1'000	Perfect Single
+16'000	Perfect L-Spin Double

Coming up with a good scoring system is easier with practical experience and playtesters.

I did actually try to come up with a new, simple, good formula, but it's tough to judge how much to reward the player for any given action (how many points should a 'perfect clear' receive? - I've never achieved a single perfect clear in my life!). The one I came up with, put mildly, probably sucks.

But I still allowed myself to experiment, because I really liked the idea of rewarding all spins (and don't understand modern Tetris' obsession with T-spins when S-, Z-, L- and J-spins are also so satisfying).

Controls

A search for the 'best' / 'most ergonomic' game keybinds was inconclusive. In a sample of a few dozen opinions from reddit posts there was about a 50/50 split on

move	rotate
a d	← →
← →	z x

Frequent advice I saw was: "choose what feels best for you", which sounds about right. :P (*though some mentioned one should not hammer spacebar for hard drops, though it's the only button the Guideline binds to this action.)

Menu Navigation

Modeling how a TUI should handle menus and move between them was unclear initially. Luckily, I was able to look at how Noita's menus are connected and saw that it was quite structured: The menus form a graph (with menus as nodes and valid transitions as directed edges), with only some menus ('pop-ups') that allow backtracking to a previous menu.

Tetrs Terminal Menu Graph

Combo Bot

Screencast.from.2024-09-08.22-21-45.combot-demo.webm

Background

The goal of 'Combo Mode' is to keep a combo going for as many pieces/lines as possible, where combo is maintained by clearing lines with consecutive pieces.

The fact that this is playable as its own gamemode is due to a special strategy known as the 4 wide (3 residual) combo setup. Here the board is completely filled except for a dedicated 4-wide vertical tunnel, at the bottom of which there are always 'residual' cells that help in clearing a line with the upcoming piece.

It turns out there are only a finite number of these configurations inside a 4-wide well are useful to keep a combo:

Image of 4-wide 3-residual combo setup configurations.

Notice how due to the fact that a tetromino consists of 4 cells, clearing a line like this will always leave another 3 cells in the otherwise perfectly vertical 4-wide tunnel.

Graphic with modifications courtesy of harddrop.

Problem Approach

Given finite piece preview and armed with the knowledge of how these combo states transition into each other, how do we find the best way to continue a combo?

It turns out we can model this as a graph where we can see what paths we can take from our current state:

Graph of all states reachable with 4 preview pieces + hold.

Different decisions can be made depending on whether we hold the current piece and use a different one, which can radically change the outcome.

What the bot does with this is to look at the farthest states it finds, and chooses the branch that maximizes depth and possibilities to make different decisions later on (states with many continuations).

While humans can vaguely do this for certain previews and also get a feeling for it, one can program a computer to do this automatically even for larger preview sizes (see a 12-lookahead state graph here).

The bot currently only supports lookahead up to 42 (number of bit triplets that fit into u128), although it already tends to get quite slow for values half of that. As we'll see, it still does pretty okay for reasonable preview sizes.

Results and Evaluation

Sidenote: weeeeeee

Screencast.from.2024-09-08.22-52-51.combot-weee.webm

In short, the bot is pretty good and gets exponentially longer combos with larger preview, as can also be seen from the following chart.

Samples	Randomizer	Lookahead	Median combo	Average combo	Maximum combo
10000	'bag'	0	8	11	114
10000	'bag'	1	17	22	232
10000	'bag'	2	29	40	426
10000	'bag'	3	50	76	695
10000	'bag'	4	82	129	1434
10000	'bag'	5	150	244	2435
10000	'bag'	6	300	502	5028
10000	'bag'	7	540	985	10663
10000	'bag'	8	1123	2126	24040
10000	'bag'	9	2255	4199	54664

It is also interesting to note the differences depending on the randomizer used to generate the next pieces.

Another table.

Samples	Randomizer	Lookahead	Median combo	Average combo	Maximum combo
100000	'uniform'	3	15	23	287
100000	'balance-relative'	3	23	33	470
100000	'bag'	3	50	74	988
100000	'bag-2'	3	25	37	555
100000	'bag-3'	3	20	29	363
100000	'bag-2_restock-on-7'	3	21	28	328
100000	'bag-3_restock-on-7'	3	21	28	328
100000	'recency-0.0'	3	15	23	303
100000	'recency-0.5'	3	34	55	734
100000	'recency-1.0'	3	46	73	918
100000	'recency-1.5'	3	58	92	1238
100000	'recency-2.0'	3	68	107	1477
100000	'recency'	3	76	120	1592
100000	'recency-3.0'	3	83	129	1837
100000	'recency-7.0'	3	118	184	2715
100000	'recency-16.0'	3	223	374	4961
100000	'recency-32.0'	3	2583	4798	70998

Additionally, these benchmarks also produce visualization of the actual distribution of combos:

It is interesting to note how these distributions can spread out quickly for higher lookaheads.

Running the bot on a uniform randomizer for 1'000'000 samples yields a much nicer, smooth curve.

Basically all common randomizers I implemented will have a exponential-decay-looking curves smoothing out for many samples like this.

According to some programming Okey_Dokey did on 4wide combos, there are deadly sequences of 'bags' that will kill the combo (and needless to say, randomizers which allow truer forms of randomness can kill even more easily). This somewhat explains that the curves are at least somewhat of exponential (decay) nature, as it gets more likely over time that the bot slips up and a random sequence appears that kills the combo.

One more thing - I lied about all distributions looking the same.

Look at this curious chart for the bag randomizer, which despite a million samples does not seem to smooth out:

What's happening with these obvious valleys and peaks? Upon further inspection, the peaks are at: 6, 13, 20, 27, 34, 41, ... can you spot the pattern?

The answer is that the most of the runs die toward the end of a (7-piece) bag, because the bot optimizes paths expecting arbitrary pieces, but due to how this randomizer works every 7th piece is in fact never random, while every 7th+1 piece is completely random. That's why the bot is tripping over hurdles at those points, and shows that it is not actually making use of all the information that would be available to make the best decisions.

Overall this is an interesting topic in the overlap of tetromino randomizers, graph theory and a bit of statistics. There's a larger space to be explored here - 4wide 3res is not the only combo setup (and this bot is pretty hardcoded in that respect). An interesting project would be to do something with 4wide 6res, which I heard is more resilient to combo killers, but that might have to wait for some other time :-)

Note

The bot can be enabled to run in Combo Mode with a cmdline flag (./tetrs_tui -e).

To make it output the lookahead graphs, a feature is needed at compile time: cargo run --release --features graphviz.

To produce statistics, cargo test <"simple"|"lookaheads"|"randomizers"> was used.

Miscellaneous Author Notes

In the two very intense weeks of developing a majority of this project I had my first proper learning experience with building: a larger Rust project, an interactive game (in the console no less), and the intricacies of modern tetrs mechanics, all at the same time.

Gamedev-wise I can mention the modern game loop; Finding a proper abstraction for Game::update (allowing arbitrary-time user input, making updates decoupled from framerate) wasn't so obvious at the beginning.

Frontend-wise I may as well have used Ratatui, but decided to just do some basic menus using trusty Crossterm for cross-platform terminal manipulation. However, next time I should use a TUI crate so as to sleep more peacefully at night not having to take responsibility for the horrible ad-hoc code I wrote for the interface aaaAAAA .

On the Rust side of things I read / learned about / read:

• some primers on coding style guidelines & cargo fmt (#[rustfmt::skip]),
• "How to order Rust code",
• an introduction to writing documentation (like the fact they can even contain tested examples) & cargo doc,
• std traits,
• using serde (to save some structured data locally),
• conditional derives based on feature flags & cargo check --features serde,
• conditional compilation,
• basic file system shenanigans,
• clap to parse simple command line arguments (& passing them with cargo run -- --descent-mode),
• formatting the time with chrono,
• the format! macro (the analogue to Python's f-strings! my beloved),
• debug_struct (helpful to impl Debug for structs with weird fields),
• the annoyances with terminal emulators including how slow they can be,
• BufWriter as an easy wrapper (diminished flickering!),
• setting a custom panic hook (TUI stuff tends to mess with console state upon crash),
• more practice with Rust's module system,
• super handy multithreading with std::sync::mpsc
• cargo workspaces (to fully separate frontend and backend),
• how cargo git dependencies work (so one could reuse the backend from this repository),
• and cross-compilation (for releases).

All in all, Rust (known for its safety and performance while still providing ADTs) - proved to be an excellent choice for this project!

Also, can we appreciate how nice the name tetrs fits for a Rust game that does not infringe on TTC's copyright? ^{though there were like a million other tetrs's on GitHub before me oof}.

Other stuff:

• For the menu navigation graph I learned DOT (and used graphviz).
• For the combo bot graph I learned and generated simple SVG myself.
• For the terminal GIF recordings I used asciinema + agg:

  agg --font-family="DejaVu Sans Mono" --line-height=1.17 --renderer=resvg --font-size=20, --fps-cap=30 --last-frame-duration=0  my_rec.cast my_rec.gif

- If you find any typos in this readme you're more than welcome to keep them! ;D (*actually you can open a PR if you really want to)

„Piecement Places!“ - CTWC 2016.

██ ▄▄▄▄ ▄█▀ ▀█▄ ▄█▄ ▄▄█ █▄▄