Tennix 0.6.0 and documentation updates
[tennix.git] / README
blobbcc47e50c1a264bd4de6cf17fc96381d74434749
4           ###### #####  ##   ##  ##   ##  ##  ##   ##
5             ##   ##     ###  ##  ###  ##  ##  ### ###
6             ##   ####   ## # ##  ## # ##  ##    ###
7             ##   ##     ##  ###  ##  ###  ##  ### ###
8             ##   #####  ##   ##  ##   ##  ##  ##   ##
10                                            SDL Port
12      Copyright (C) 2003, 2007, 2008 Thomas Perl <thp@perli.net>
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) and Mac OS X 10.4 (using XCode tools).
62    Binaries of Tennix can be found on the webpage.
65 PLAYING TENNIX
66 ==============
68    You can play in either single-player or multi-player mode. 
69    For single player, Player 1 will play against the computer 
70    and for multi player, Player 1 will play against Player 2.
72    CONTROLS
74                          Player 1   |   Player 2
75                        ---------------------------
76    Move up                  W              O
77    Move down                S              L
78    Swing racket             D              K
79                        ---------------------------
81    See the manpage, tennix(6) for more controls (especially alternative
82    keyboard controls and mouse control, which is new since 0.6.0).
84    FUNCTION KEYS
86    Y  .... Make screenshot (save as screenshot.bmp)
87    F  .... Toggle fullscreen (X11 only)
88    C  .... Switch type of court (grass, clay, etc..)
91 DEVELOPMENT/DEBUGGING
92 =====================
94    If you want to compile a debugging version of "tennix", you
95    have to set the environment variable "DEBUG" to "1", either by
96    using "DEBUG=1 make" or exporting the environment variable for
97    the current session, as in "export DEBUG=1" followed by "make".
100 CREDITS
101 =======
103    The in-game music has been taken from the free loops available
104    from MelodyLoops. See http://www.melodyloops.com/ for a 
105    selection of Royality Free Music Loops.
108 CONTACT
109 =======
112     E-Mail: Thomas Perl <thp@perli.net>
113     URL: http://icculus.org/tennix/