63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# tetris
|
|
|
|
A terminal interface for Tetris
|
|
|
|
|
|
|
|
## installation
|
|
|
|
For Mac and ArchLinux, the binaries attached to the GitHub release should suffice ([instructions](#github-release-binaries)). For other Linux distros, you can try the Linux binary as well but no guarantees. See the other two options, installing from [source](#install-from-source) and [dex](#install-via-dex).
|
|
|
|
I have not tested Windows, but I do think it should work via dex. Please let me know in an issue if it fails so I can update documentation. Thanks!
|
|
|
|
#### github release binaries
|
|
Here is a quick way to get the one for your OS:
|
|
```bash
|
|
curl -L https://github.com/samtay/tetris/releases/download/0.1.2/tetris-`uname -s`-`uname -m` -o tetris
|
|
chmod +x tetris
|
|
sudo mv tetris /usr/local/bin/
|
|
```
|
|
|
|
#### 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
|
|
```
|
|
|
|
#### install via dex
|
|
[dex](https://github.com/dockerland/dex) is a really cool application manager that lets you run executables as docker images, so that you don't need to worry about installing them or their dependencies directly.
|
|
```bash
|
|
# get dex if you don't have it
|
|
curl -L http://get.iceburg.net/dex/latest-0.12.x/dex -o dex
|
|
chmod +x dex
|
|
sudo mv dex /usr/local/bin
|
|
|
|
# add tetris as a repo
|
|
dex repo add tetris https://github.com/samtay/tetris.git
|
|
|
|
# run tetris
|
|
dex run tetris
|
|
|
|
### optionally install tetris globally ###
|
|
export PATH="$HOME/.dex/bin:$PATH"
|
|
dex install --global tetris
|
|
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 always play on level `6` and want to skip the prompt, you can start the game immediately via
|
|
```shell
|
|
tetris --level 6
|
|
```
|
|
Lastly, to see the current highest score, you can run `tetris --high-score`.
|
|
And of course, see `tetris --help` for help.
|