Skip to main content

A tetris game runs in the terminal

Project description

gameplay
English | 中文

Tetris Terminal🎮

A terminal-based Tetris game written in Python using the curses library.

License: MIT Python 3.10+

Features

  • Modern Tetris design following the Tetris Design Guideline
    • Extended Placement
    • Next Piece Preview
    • SRS System
    • Piece Holding
    • Shadow Piece
    • Modern Scoring System
    • Modern Level System

Platform Support

Based on Python's curses module:

  • Linux/macOS: Works out of the box
  • ✅️ Windows: With windows-curses
  • Can run on basically any terminal setup, even a linux tty.

Installation & Usage

pip install tetris-terminal
tetris

Controls

Key Action
a, Move left
d, Move right
w, ,x Rotate cw
z Rotate ccw
s, Soft drop
space Hard drop
c Hold
p Pause
q Quit game

CLI Options

Option Description
--generate-config Generate a default config file and exit
--disable-config Ignore config file and run with built-in defaults
--version Show version and exit

Multiplayer (Versus Mode)

Compete in real-time 1v1 battles over WebSocket. Clear lines to send garbage to your opponent — the last player standing wins.

flowchart LR
    subgraph A ["Client A"]
        A1[game loop]
        A2[network]
    end

    subgraph S ["Server"]
        S1[Room]
    end

    subgraph B ["Client B"]
        B1[game loop]
        B2[network]
    end

    A1 <--> S1
    S1 <--> B1
    A2 <--> S1
    S1 <--> B2

Quick Start

# Terminal 1 — start the server
tetris-server

# Terminal 2 — connect client A
tetris --server localhost:8765

# Terminal 3 — connect client B
tetris --server localhost:8765

Once both clients connect, the server matches them and the battle begins.

CLI

Command Description
tetris-server Start the WebSocket matchmaking server
tetris Launch the game in single-player modes
tetris --server HOST:PORT Launch the game in multiplayer mode

tetris-server Options

Option Default Description
--host 0.0.0.0 Host address to bind
--port 8765 Port to listen on
--version Show version and exit

tetris --server Options

Option Description
--server HOST:PORT Connect to a multiplayer server (default: localhost:8765)
--disable-config Ignore config file and run with built-in defaults
--version Show version and exit

Gameplay

  • Garbage system: Each cleared line generates garbage based on the standard Tetris scoring — more lines at once send more garbage.
  • Incoming garbage is shown as a Garbage counter on the side panel.
  • Garbage cancellation: Clearing lines while you have pending garbage cancels an equal number of incoming lines.
  • No pause: Versus mode disables pause to keep both players in sync.
  • Opponent disconnect: If the opponent disconnects, the match ends immediately.

Configuration

multi_play

Connection settings for multiplayer mode.

Key Default Description
host "localhost" Server hostname or IP
port 8765 Server port

Configuration

On first run, or via tetris --generate-config, a configuration file is created at:

Platform Path
Linux ~/.config/tetris-terminal/config.json
macOS ~/Library/Application Support/tetris-terminal/config.json
Windows %APPDATA%/tetris-terminal/config.json

The config file references a JSON Schema for editor autocompletion and validation. All fields are optional — missing keys fall back to their defaults.

display

Visual appearance of the game board.

Key Default Description
empty_cell " " Empty cell character
solid_cell "██" Filled cell character
shadow_cell "░░" Shadow piece character
bd_v "│" Border vertical
bd_h "─" Border horizontal
bd_tl "╭" Border top-left
bd_tr "╮" Border top-right
bd_bl "╰" Border bottom-left
bd_br "╯" Border bottom-right
bd_vr "├" Border T-right
bd_vl "┤" Border T-left
bd_hb "┬" Border T-bottom
bd_ht "┴" Border T-top

timing

Frame rate and animation settings.

Key Default Description
fps 30 Frames per second
clear_anim_flash_interval 0.05 Line clear flash interval (seconds)
clear_anim_duration 0.3 Line clear animation duration (seconds)

game_rules

Gameplay parameters.

Key Default Description
max_lock_down_move_count 15 Max moves before piece locks down
time_attack_duration 120 Time Attack mode duration (seconds)

License

MIT License - see LICENSE for details.

Acknowledgements

Idea from tinytetris (a C implementation).

Going to be implemented(Maybe)

  1. sound
  2. ...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tetris_terminal-0.4.0.tar.gz (37.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tetris_terminal-0.4.0-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file tetris_terminal-0.4.0.tar.gz.

File metadata

  • Download URL: tetris_terminal-0.4.0.tar.gz
  • Upload date:
  • Size: 37.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for tetris_terminal-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a449ea963f8b72d5561ed4a8633a17d39499c16c29cd5282aea995327711b2ce
MD5 dab10adb8e64c53f3d52fe8e02e746b5
BLAKE2b-256 2fc45cf68961af91f816395d0967646a67353bcb05c793a7ee395254d9f8c3a1

See more details on using hashes here.

File details

Details for the file tetris_terminal-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tetris_terminal-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6b4385fb2aab920c5bbb8d9451bb9dfae8637e71c726e5c7e326fd58132f79e
MD5 b51c5ac042c2dd677525e225b29e589c
BLAKE2b-256 e163e94abe51daad8f7fba9d3bababa68ae67a99c89961f0723aace5ccb4387d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page