Updated documentation (README, manpage, etc..)
[tennix.git] / README
blob7dc5bfc140ac040c537c3618271cbce773b387d0
4           thpinfo.com presents
5           ****** *****  **   **  **   **  **  **   **
6             **   **     ***  **  ***  **  **  *** ***
7             ==   ====   == = ==  == = ==  ==    ===
8             ##   ##     ##  ###  ##  ###  ##  ### ###
9             ##   #####  ##   ##  ##   ##  ##  ##   ##
10                   2009 World Tennix Championship Tour
12  Copyright (C) 2003, 2007, 2008, 2009 Thomas Perl <thp@thpinfo.com>
16 LICENSE
17 =======
19     This program is free software; you can redistribute it and/or
20     modify it under the terms of the GNU General Public License
21     as published by the Free Software Foundation; either version 2
22     of the License, or (at your option) any later version.
23     
24     This program is distributed in the hope that it will be useful,
25     but WITHOUT ANY WARRANTY; without even the implied warranty of
26     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27     GNU General Public License for more details.
28     
29     You should have received a copy of the GNU General Public License
30     along with this program; if not, write to the Free Software
31     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
32     MA  02110-1301, USA.
35 ABOUT
36 =====
38    This is the SDL (Simple DirectMedia Layer) port of Tennix!, a 
39    game written by Thomas Perl in 2003. This version has been up-
40    scaled to a resolution of 640x480 in comparison to the 320x200 
41    format used in the original game.
43    Changes from the original Tennix to the first SDL release include
44    a new shadow, advanced alpha blending and the removal of the 
45    previously-included pseudo-advertisements.
47    For all changes, please see the ChangeLog file.
49    This port has been written on the 10th of May 2007 and is now 
50    being improved and updated since then.
53 INSTALLATION
54 ============
56    To build tennix, simply run "make" (on Unix-like systems) or 
57    follow the instructions for your platform in the README.* files.
59    Tennix is known to build on Debian GNU/Linux 4.0 (etch), 
60    Win32 (mingw32), Mac OS X 10.4 (using XCode tools) and in
61    the Maemo 4.0 SDK (for Nokia Internet Tables, IT OS2008).
63    Binaries of Tennix can be found on the webpage.
66 PLAYING TENNIX
67 ==============
69    You can play in either single-player or multi-player mode. You can even
70    let two AI players play against each other. This can be configured in
71    the controls screen.
73    THE POWERBAR
75    You have to keep your "hit" key pressed, so that your powerbar (on the
76    bottom of the screen) "fills up". The more power you have, the stronger
77    you will hit the ball (and the higher and longer it will fly). Too much
78    power could make the ball go into the OUT, so be sure to use it wisely.
80    CONTROLS
82    Select the controller you like from the input selection menu. Be sure
83    to connect gamepads and joysticks BEFORE starting Tennix, so they are
84    enumerated and detected correctly.
86    FUNCTION KEYS
88    Y  .... Make screenshot (save as screenshot.bmp)
89    F  .... Toggle fullscreen (X11 only)
91    Bonus (because you took the time to look at the README file):
92    Obviously, there are some hidden easter eggs that are still not available
93    via the UI, due to the fact that we didn't implement the UI for it yet :)
94    Think about [r]ain and fog (think fog[t], even..). Wind is also available,
95    but it's so broken, you'll have to look up the keys in game.c.
98 DEVELOPMENT/DEBUGGING
99 =====================
101    If you want to compile a debugging version of "tennix", you
102    have to set the environment variable "DEBUG" to "1", either by
103    using "DEBUG=1 make" or exporting the environment variable for
104    the current session, as in "export DEBUG=1" followed by "make".
106    See the HACKING and TODO files for more development information.
109 CREDITS
110 =======
112    Some sound effects are based on data from the Freesound Project.
114    Thanks to Esad Hajdarevic and Stefan Doesinger for some optimizations
115    done during the Effiziente Programme course in January 2009 :)
117    Public domain artwork (stadium photos) by
118    http://en.wikipedia.org/wiki/User:Ivan
119    http://fr.wikipedia.org/wiki/Utilisateur:Arnaud_25
120    http://en.wikipedia.org/wiki/User:Aleksmot
121    http://commons.wikimedia.org/wiki/User:Alexisrael
122    http://commons.wikimedia.org/wiki/User:Vardion
124    Additional artwork by
125    Martin Third (http://flickr.com/photos/mthird3rd/471720012/)
127    This project includes SDL_rotozoom by A. Schiffler
129    See data/COPYING and credits.h for more information about the data files.
131 CONTACT
132 =======
134     E-Mail: Thomas Perl <thp@thpinfo.com>
135     URL: http://icculus.org/tennix/