1- # yetris README
1+ # yetris
22
3- Customizable Tetris(tm) on the console .
3+ Customizable Tetris(tm) with textual interface .
44
5- ![ screenshot] ( http://yetris.alexdantas.net/images/1gameplay .png )
5+ ![ screenshot] ( http://yetris.alexdantas.net/images/classic-tetris .png )
66
77## Introduction
88
9- yetris is a customizable Tetris(tm) clone for the console .
10- It aims to follow modern implementations with lots of features
11- and please both casual players and Tetris(tm) enthusiasts.
9+ yetris is a customizable Tetris(tm) clone for the terminal .
10+ It has some features found on modern adaptations and aims
11+ to please both casual players and Tetris(tm) enthusiasts.
1212
13- It has full textual interface, with colors and many features:
13+ It has full textual interface, check out these features:
1414
15- * Customizable by commandline arguments and config file.
16- * High score.
17- * Up to 6 next pieces.
18- * Hold, Combo and back-to-back sequences.
19- * Scoring system compliant to the (conjectured)
20- * Tetris(tm) Guideline* .
15+ * _ Colors_ and animated interface;
16+ * _ Customizable gameplay_ , with several game mode
17+ possibilities: ghost piece, hold piece, slide left/right,
18+ _ invisible_ and custom initial level and noise (like
19+ the old B-mode).
20+ * _ Customizable interface_ : up to 7 next pieces, toggle
21+ game borders, center screen, modify game _ random algorithm_ ...
22+ * You can change settings on _ in-game menus_ and options;
23+ * _ Game profiles_ : settings are automatically saved and
24+ restored at startup. _ Multple profiles_ supported.
25+ * _ Game statistics_ : cleared lines, individual and total pieces...
2126
22- yetris is developed on C and ncurses, running on (most) Linux
23- terminals.
24- It currently lacks some expected features but is on active
25- development.
27+ yetris was originally developed in C, now reprogrammed in C++
28+ with ncurses. It runs on pretty much every terminal around here,
29+ but it's limited to POSIX systems.
2630
27- Also, the source code is clean and commented, allowing much better
28- understanding and easing feature-implementation.
31+ ## Screenshots
32+
33+ ![ main-menu] ( http://yetris.alexdantas.net/images/main-menu-without-borders.png )
34+
35+ ![ profile-menu] ( http://yetris.alexdantas.net/images/profile-menu.png )
36+
37+ ![ single-player-menu] ( http://yetris.alexdantas.net/images/single-player-menu.png )
38+
39+ ![ options-menu] ( http://yetris.alexdantas.net/images/options-menu.png )
40+
41+ ![ b-mode] ( http://yetris.alexdantas.net/images/b-mode.png )
42+
43+ ![ help] ( http://yetris.alexdantas.net/images/help.png )
44+
45+ ![ pause-menu] ( http://yetris.alexdantas.net/images/pause-menu.png )
46+
47+ ![ game-statistics] ( http://yetris.alexdantas.net/images/statistics.png )
2948
3049## Controls
3150
@@ -40,26 +59,26 @@ understanding and easing feature-implementation.
4059| q | Quits the game at any time |
4160| r | Restart game |
4261| h | Show help window |
43- | F2 | Switch statistics |
44- | F3 | Show high scores |
45- | F5 | Refresh game based on config file |
4662
47- To see more info, run ` yetris --help ` and ` yetris --usage ` .
48-
49- ## Installation
63+ ## Usage
5064
5165Briefly, the following shell commands should configure,
52- build and install this package on the default directories :
66+ build and install this package:
5367
5468 $ make
5569 $ [sudo] make install
70+ $ man yetris
71+
72+ By default yetris is installed at ` /usr/games ` , with the
73+ settings and scores at ` ~/.local/share/yetris ` . To
74+ see how to change those, go to the file ` INSTALL.md ` .
5675
5776If you want to test the game before installing, do:
5877
5978 $ make run
6079
61- To see how things end up being installed on your system,
62- see file ` INSTALL.md ` .
80+ The ` Makefile ` has lots of toggles and switches, check out
81+ it's first lines .
6382
6483## Dependencies
6584
@@ -74,27 +93,23 @@ An example on apt-based systems:
7493
7594 $ apt-get install ncurses-dev
7695
77- ## Main Directory Structure
78-
79- | File | What it is |
80- | -------- | ---------------------------------------------------------------- |
81- | README | General game information |
82- | INSTALL | Installation instructions |
83- | COPYING | Copyright and warranty info |
84- | Doxyfile | Doxygen file for generating the source documentation |
85- | Makefile | Instructions to the ` make ` program (build and install the game) |
86- | TODO | Work that needs to be done or ideas for future versions |
87- | BUGS | Known and solved bugs on the game |
88- | bin/ | Location of the executable generated after compilation |
89- | doc/ | The documentation files (explaining the source code) and manpage |
90- | obj/ | Location of resulting object files after compilation |
91- | src/ | All of the source code files |
92- | doc/index.html | Complete source code documentation |
93- | doc/yetris.6.gz | The manpage |
94-
9596## Hacking
9697
97- I'll add more info about development here soon, so stay tuned.
98+ There's another ` README.md ` on the ` src/ ` directory.
99+ In there I try to explain the source and how could you play
100+ with it.
101+
102+ If you want to contribute,
103+ [ there's a lot we could do together] ( https://github.com/alexdantas/yetris/issues ) !
104+ Don't hesitate to contact me, any addition is welcome.
105+
106+ The ` BUGS ` and ` TODO ` files are nice points to check out
107+ what we could do.
108+
109+ Also, if you're like me and * love* ncurses games, with textual
110+ interface and stuff, the ` src/Inteface/* ` files could be of
111+ great use. I tried to make them very flexible so you could
112+ just insert them into a project without too much change.
98113
99114## Contact
100115
@@ -130,10 +145,23 @@ Huge thanks for all the people that contributed to the project
130145 on the building process. Thanks to him * yetris can be installed
131146 on BSD* !
132147
148+ Also, some miscellaneous credits:
149+
150+ * Yetris' logo uses the * Crawford2* _ Figlet Font_ .
151+ * Thanks, * Nicolas Devillard* ! Your
152+ [ _ iniParser_ ] ( http://ndevilla.free.fr/iniparser/ ) helped me
153+ a lot!
154+ * I'm also using
155+ [ clibs/commander] ( https://github.com/clibs/commander ) ,
156+ simples CLI argument parser I've ever seen.
157+ * _ Emacs_ , _ Awesome_ and _ Arch Linux_ , the Ultimate Triforce.
158+ * [ The OneUps] ( https://theoneups.bandcamp.com/ ) kept me awake
159+ on several nights. Their music is great, specially _ Volume 2_ !
160+
133161## License
134162
135163 yetris - Customizable Tetris(tm) on the console.
136- Copyright (C) 2013 Alexandre Dantas (kure)
164+ Copyright (C) 2013-2014 Alexandre Dantas (kure)
137165
138166 yetris is free software: you can redistribute it and/or modify
139167 it under the terms of the GNU General Public License as published by
0 commit comments