Metadata-Version: 2.1
Name: terminal2048
Version: 0.1.0
Summary: 2048 for the terminal. Inspired by Gabriele Cirulli's 2048.
Author: Evan Jones
Author-email: evan_jones@mac.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: blessed (>=1.20.0,<2.0.0)
Description-Content-Type: text/markdown

# `terminal2048`: 2048 in the terminal

!['terminal2048'](img/terminal2048_screenshot.png)

This is a small implementation of Gabriele Cirulli's [2048 game](https://play2048.co/) in the terminal using Python. I wrote it to learn about using the [`curses`](https://docs.python.org/3/howto/curses.html)library in Python. I learned enough about `curses` to prefer the much smoother [`blessed`](https://blessed.readthedocs.io/en/latest/intro.html) library instead, so that's what's used here.

(You might also be interested in a more common package, [term2048](https://github.com/bfontaine/term2048), also available at [PyPI](https://pypi.org/project/term2048/).)

## Installation

```bash
pip install terminal2048
```

## Running `terminal2048`

Once you've installed the package, you can run the game from the terminal:

```bash
terminal2048
```

Use `terminal2048 --help` to print help options:

```bash
usage: terminal2048 [-h] [-w WIDTH] [--height HEIGHT] [-s {S,M,L,XL}] [--start_value START_VALUE]

2048 game in the terminal. Inspired by https://play2048.co/

options:
  -h, --help            show this help message and exit
  -w WIDTH, --width WIDTH
                        Width of the board (default: 4)
  --height HEIGHT       Height of the board (default: 4)
  -s {S,M,L,XL}, --size {S,M,L,XL}
                        Board size (options: S, M, L, XL; default: M)
  --start_value START_VALUE
                        Highest starting tile value (default: 4)
```

## Compatibility

I've only run this on MacOS so far, and the terminal management is pretty naive.
Let me know if you have issues on a given OS or terminal setup.

### Contact & bug reports

Bug reports and pull requests are welcome!
Feel free to contact me on [Github](https://github.com/etjones/terminal2048) or by email at [evan_jones@mac.com](mailto:evan_jones@mac.com).)

