59 lines
2.4 KiB
Markdown
59 lines
2.4 KiB
Markdown
# tetris [](https://github.com/samtay/tetris/actions/workflows/ci.yaml)
|
|
|
|
A terminal interface for Tetris
|
|
|
|
[FORK: I forked this from github.com/samtay/tetris, but added optional level progression to the game, and level tracking, and all the corresponding UI elements]
|
|
|
|
|
|
|
|
## installation
|
|
Installation on MacOS and Linux is outlined below. Windows support is questionable, but you can try to install from [source](#install-from-source).
|
|
|
|
#### MacOS
|
|
Installation on a Mac is simple with Homebrew:
|
|
```bash
|
|
brew install samtay/tui/tetris
|
|
```
|
|
#### Arch Linux
|
|
Arch Linux users can install from the [AUR](https://aur.archlinux.org/packages/tetris-terminal-git/), e.g.
|
|
```bash
|
|
yay -S tetris-terminal-git # or yaourt, etc.
|
|
```
|
|
#### Snapcraft
|
|
Thanks to **@thefenriswolf** this is available on most Linux distributions via [snapcraft](https://snapcraft.io/tetris-thefenriswolf):
|
|
```bash
|
|
sudo snap install tetris-thefenriswolf
|
|
alias tetris=/snap/bin/tetris-thefenriswolf.tetris # add to .bashrc or .zshrc etc.
|
|
```
|
|
#### install from source
|
|
First [get stack](https://docs.haskellstack.org/en/stable/README/#how-to-install). Then
|
|
```bash
|
|
git clone https://github.com/samtay/tetris.git
|
|
cd tetris
|
|
stack install tetris
|
|
```
|
|
|
|
## usage
|
|
|
|
The default game is run by simply executing the `tetris` command.
|
|
If the unicode characters look a bit
|
|
wonky in your terminal, you can also run
|
|
```shell
|
|
tetris --ascii-only # uses [] as preview cell
|
|
# or
|
|
tetris --preview-chars 'XX' # uses custom characters as preview cell
|
|
```
|
|
If you want to skip the level prompt, you can start the game immediately via
|
|
```shell
|
|
tetris --level n
|
|
```
|
|
Lastly, to see the current high score, you can run `tetris --high-score`.
|
|
And of course, see `tetris --help` for help.
|
|
|
|
## tips
|
|
|
|
#### troubleshooting
|
|
People seem to have varying levels of success with the linux binary. Please note that it is compiled dynamically and hence should not be expected to work on most distros. If you have other problems, feel free to open an issue.
|
|
|
|
#### roll your own
|
|
If you like games in your terminal and have an interest in functional programming, write your own! This code is built on top of [brick](https://github.com/jtdaugherty/brick) which makes building terminal user interfaces very accessible. I also have a [tutorial](https://samtay.github.io/posts/introduction-to-brick) that can help you get started.
|