README

   1
   2
   3
   4                  thp.io presents...
   5
   6                  ****** *****  **   **  **   **  **  **   **
   7                    **   **     ***  **  ***  **  **  *** ***
   8                    ==   ====   == = ==  == = ==  ==    ===
   9                    ##   ##     ##  ###  ##  ###  ##  ### ###
  10                    ##   #####  ##   ##  ##   ##  ##  ##   ##
  11                          Classic Championship Tour 2011
  12
  13                Copyright (C) 2003, 2007-2011 Thomas Perl <thp.io>
  14
  15
  16
  17 LICENSE
  18 =======
  19
  20     This program is free software; you can redistribute it and/or
  21     modify it under the terms of the GNU General Public License
  22     as published by the Free Software Foundation; either version 2
  23     of the License, or (at your option) any later version.
  24
  25     This program is distributed in the hope that it will be useful,
  26     but WITHOUT ANY WARRANTY; without even the implied warranty of
  27     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28     GNU General Public License for more details.
  29
  30     You should have received a copy of the GNU General Public License
  31     along with this program; if not, write to the Free Software
  32     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  33     MA  02110-1301, USA.
  34
  35
  36 ABOUT
  37 =====
  38
  39    This is the SDL (Simple DirectMedia Layer) port of Tennix!, a
  40    game written by Thomas Perl in 2003. This version has been up-
  41    scaled to a resolution of 640x480 in comparison to the 320x200
  42    format used in the original game.
  43
  44    Changes from the original Tennix to the first SDL release include
  45    a new shadow, advanced alpha blending and the removal of the
  46    previously-included pseudo-advertisements.
  47
  48    For all changes, please see the ChangeLog file.
  49
  50    This port has been written on the 10th of May 2007 and is now
  51    being improved and updated since then.
  52
  53
  54 INSTALLATION AND BUILD INSTRUCTIONS
  55 ===================================
  56
  57    To build tennix, simply run "make" (on Unix-like systems) or
  58    follow the instructions for your platform in the README.* files.
  59    Be sure to install all the dependencies listed below and check out the
  60    makefile for instructions on what you can enable/disable with the help
  61    of environment variables (e.g. USE_PYTHON, NONFREE_LOCATIONS, DEBUG, ...)
  62
  63    Tennix is known to build on Debian GNU/Linux 4.0, Ubuntu 8.10, Windows XP
  64    and Windows Vista (using MSYS/mingw32 - see README.win32), Mac OS X 10.4
  65    and Mac OS X 10.5 (using XCode Tools - see README.MacOSX), the Maemo 4.0
  66    and Maemo 4.1 SDKs (Chinook/Diablo - see README.Maemo).
  67
  68    Dependencies:
  69      · SDL       >= 1.2.13 (www.libsdl.org)
  70      · SDL_image >= 1.2.6  (www.libsdl.org/projects/SDL_image)
  71      · SDL_mixer >= 1.2.8  (www.libsdl.org/projects/SDL_mixer)
  72      · SDL_ttf   >= 2.0.9  (www.libsdl.org/projects/SDL_ttf)
  73      · SDL_net   >= 1.2.7  (www.libsdl.org/projects/SDL_net)
  74
  75    (Tennix might compile and work with earlier versions of the respective
  76    libraries, but the versions here have been the ones that I've tested it
  77    with, so if there are problems, try to use the versions specified here)
  78
  79    Optional dependencies:
  80      · Python    >=  2.5.x  (www.python.org)
  81        => If you don't want to use the Python integration, set the variable
  82           USE_PYTHON to a value other than 1 by specifying it on the "make"
  83           command line like this:      make USE_PYTHON=0
  84
  85    On a Debian-based system, you can get all dependencies with the following
  86    command line:
  87
  88     aptitude install libsdl1.2-dev libsdl-image1.2-dev libsdl-mixer1.2-dev \
  89                      libsdl-ttf2.0-dev libsdl-net1.2-dev python-dev
  90
  91
  92 PLAYING TENNIX
  93 ==============
  94
  95    You can play in either single-player or multi-player mode. You can even
  96    let two AI players play against each other. This can be configured in
  97    the controls screen.
  98
  99    THE POWERBAR
 100
 101    You have to keep your "hit" key pressed, so that your powerbar (on the
 102    bottom of the screen) "fills up". The more power you have, the stronger
 103    you will hit the ball (and the higher and longer it will fly). Too much
 104    power could make the ball go into the OUT, so be sure to use it wisely.
 105
 106    CONTROLS
 107
 108    Select the controller you like from the input selection menu. Be sure
 109    to connect gamepads and joysticks BEFORE starting Tennix, so they are
 110    enumerated and detected correctly.
 111
 112    FUNCTION KEYS
 113
 114    F  .... Toggle fullscreen (X11 only)
 115    P  .... Pause game
 116
 117
 118 NETWORK MULTIPLAYER
 119 ===================
 120
 121    This is done using two computers, the first is the faster one and the second
 122    one is the slower one. If both computers are equally powerful, just chose
 123    the faster one randomly.
 124
 125    On the faster computer, use:
 126      ./tennix -m REMOTEHOST
 127
 128    On the slower computer, use:
 129      ./tennix -s REMOTEHOST
 130
 131    So, if your faster computer is called "fast.lan" and the slower computer is
 132    called "slow.lan", you could use the following setup:
 133
 134      user@fast:~$ ./tennix -m slow.lan
 135      user@slow:~$ ./tennix -s fast.lan
 136
 137    You have to configure each opponent in the input device selection screen
 138    using "Network player" as input device. Make sure that you do the reverse
 139    on the opposite computer.
 140
 141
 142 DEVELOPMENT/DEBUGGING
 143 =====================
 144
 145    If you want to compile a debugging version of "tennix", you
 146    have to set the environment variable "DEBUG" to "1", either by
 147    using "DEBUG=1 make" or exporting the environment variable for
 148    the current session, as in "export DEBUG=1" followed by "make".
 149
 150    See the HACKING and TODO files for more development information.
 151
 152
 153 CREDITS
 154 =======
 155
 156    Some sound effects are based on data from the Freesound Project.
 157
 158    Thanks to Esad Hajdarevic and Stefan Doesinger for some optimizations
 159    done during the Effiziente Programme course in January 2009 :)
 160
 161    Public domain artwork (stadium photos) by
 162    http://en.wikipedia.org/wiki/User:Ivan
 163    http://fr.wikipedia.org/wiki/Utilisateur:Arnaud_25
 164    http://en.wikipedia.org/wiki/User:Aleksmot
 165    http://commons.wikimedia.org/wiki/User:Alexisrael
 166    http://commons.wikimedia.org/wiki/User:Vardion
 167
 168    Additional artwork by
 169    Martin Third (http://flickr.com/photos/mthird3rd/471720012/)
 170
 171    This project includes SDL_rotozoom by A. Schiffler
 172
 173    See data/COPYING and credits.h for more information about the data files.
 174
 175 CONTACT
 176 =======
 177
 178     E-Mail: Thomas Perl <m//thp.io>
 179     URL: http://icculus.org/tennix/
 180