README

   1
   2
   3
   4           ###### #####  ##   ##  ##   ##  ##  ##   ##
   5             ##   ##     ###  ##  ###  ##  ##  ### ###
   6             ##   ####   ## # ##  ## # ##  ##    ###
   7             ##   ##     ##  ###  ##  ###  ##  ### ###
   8             ##   #####  ##   ##  ##   ##  ##  ##   ##
   9
  10                                            SDL Port
  11
  12  Copyright (C) 2003, 2007, 2008, 2009 Thomas Perl <thp@thpinfo.com>
  13
  14
  15
  16 LICENSE
  17 =======
  18
  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.
  33
  34
  35 ABOUT
  36 =====
  37
  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.
  42
  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.
  46
  47    For all changes, please see the ChangeLog file.
  48
  49    This port has been written on the 10th of May 2007 and is now
  50    being improved and updated since then.
  51
  52
  53 INSTALLATION
  54 ============
  55
  56    To build tennix, simply run "make" (on Unix-like systems) or
  57    follow the instructions for your platform in the README.* files.
  58
  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).
  62
  63    Binaries of Tennix can be found on the webpage.
  64
  65
  66 PLAYING TENNIX
  67 ==============
  68
  69    You can play in either single-player or multi-player mode.
  70    For single player, Player 1 will play against the computer
  71    and for multi player, Player 1 will play against Player 2.
  72
  73    CONTROLS
  74
  75                          Player 1   |   Player 2
  76                        ---------------------------
  77    Move up                  W              O
  78    Move down                S              L
  79    Swing racket             D              K
  80                        ---------------------------
  81
  82    See the manpage, tennix(6) for more controls (especially alternative
  83    keyboard controls and mouse control, which is new since 0.6.0).
  84
  85    FUNCTION KEYS
  86
  87    Y  .... Make screenshot (save as screenshot.bmp)
  88    F  .... Toggle fullscreen (X11 only)
  89    C  .... Switch type of court (grass, clay, etc..)
  90
  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 [n]ight, [r]ain and fog (think fog[t], even..). Wind is also
  95    available, but it's so broken, you'll have to look up the keys in game.c.
  96
  97
  98 DEVELOPMENT/DEBUGGING
  99 =====================
 100
 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".
 105
 106
 107 CREDITS
 108 =======
 109
 110    Some sound effects are based on data from the Freesound Project.
 111
 112    Thanks to Esad Hajdarevic and Stefan Doesinger for some optimizations
 113    done during the Effiziente Programme course in January 2009 :)
 114
 115
 116 CONTACT
 117 =======
 118
 119     E-Mail: Thomas Perl <thp@thpinfo.com>
 120     URL: http://icculus.org/tennix/
 121
 122