bactaria / yetris

Customizable Tetris(tm) for the terminal.

yetris

Customizable Tetris(tm) with textual interface.

Introduction

yetris is a customizable Tetris(tm) clone for the terminal. It has some features found on modern adaptations and aims to please both casual players and Tetris(tm) enthusiasts.

It has full textual interface, check out these features:

• Colors and animated interface;
• Customizable gameplay, with several game mode possibilities: ghost piece, hold piece, slide left/right, invisible and custom initial level and noise (like the old B-mode).
• Customizable interface: up to 7 next pieces, toggle game borders, center screen, modify game random algorithm...
• You can change settings on in-game menus and options;
• Game profiles: settings are automatically saved and restored at startup. Multple profiles supported.
• Game statistics: cleared lines, individual and total pieces...

yetris was originally developed in C, now reprogrammed in C++ with ncurses. It runs on pretty much every terminal around here, but it's limited to POSIX systems.

Screenshots

Controls

Key	Action
Left, Right	Controls the piece
Down	Soft-drop
Space	Hard-drop
c	Holds the piece
z, x	Rotates piece counter-clockwise/clockwise
p	Pauses the game
q	Quits the game at any time
r	Restart game
h	Show help window

Usage

Briefly, the following shell commands should configure, build and install this package:

$ make
$ [sudo] make install
$ man yetris

By default yetris is installed at /usr/games, with the settings and scores at ~/.local/share/yetris. To see how to change those, go to the file INSTALL.md.

If you want to test the game before installing, do:

$ make run

The Makefile has lots of toggles and switches, check out it's first lines.

Dependencies

To build yetris from source, you need the ncurses developer library libncurses5-dev (>= 5.7).

Note that this is not the one that comes by default with your distribution.

To get it, use your favorite package manager. An example on apt-based systems:

$ apt-get install ncurses-dev

Hacking

There's another README.md on the src/ directory. In there I try to explain the source and how could you play with it.

If you want to contribute, there's a lot we could do together! Don't hesitate to contact me, any addition is welcome.

The BUGS and TODO files are nice points to check out what we could do.

Also, if you're like me and love ncurses games, with textual interface and stuff, the src/Inteface/* files could be of great use. I tried to make them very flexible so you could just insert them into a project without too much change.

Contact

Hello there, I'm Alexandre Dantas (kure)!

Thanks for downloading and playing this game. I'm glad you had interest on this project.

You can send me comments, bugs, ideas or anything else by email. And if you have time, please visit my blog!

• My email: eu @ alexdantas.net
• My homepage: http://www.alexdantas.net/
• yetris main page: http://yetris.alexdantas.net/
• yetris on GitHub: https://github.com/alexdantas/yetris/

I'd appreciate any commentary - even if it's just "Hello, I play your game!".

Credits

Huge thanks for all the people that contributed to the project (in order of appearance):

• Karfield fixed a great mistake regarding typedefs and inclusions. Thanks to him, yetris now works on MacOsX!
• Rodrigo Rebello fixed some resource leaks and optimized the game by removing unnecessary fflush() calls.
• Damon McDougall pointed out a serious issue on the building process. Thanks to him yetris can be installed on BSD!

Also, some miscellaneous credits:

• Yetris' logo uses the Crawford2 Figlet Font.
• Thanks, Nicolas Devillard! Your iniParser helped me a lot!
• I'm also using clibs/commander, simples CLI argument parser I've ever seen.
• Emacs, Awesome and Arch Linux, the Ultimate Triforce.
• The OneUps kept me awake on several nights. Their music is great, specially Volume 2!

License

yetris - Customizable Tetris(tm) on the console. Copyright (C) 2013-2014 Alexandre Dantas (kure)

yetris is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.