Streamline the archive loading mechanism
[tennix.git] / README
blob3c9d759df4d7b6abe13dff593633442e5395f332
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 AND BUILD INSTRUCTIONS
54 ===================================
56    To build tennix, simply run "make" (on Unix-like systems) or 
57    follow the instructions for your platform in the README.* files.
58    Be sure to install all the dependencies listed below and check out the
59    makefile for instructions on what you can enable/disable with the help
60    of environment variables (e.g. USE_PYTHON, NONFREE_LOCATIONS, DEBUG, ...)
62    Tennix is known to build on Debian GNU/Linux 4.0, Ubuntu 8.10, Windows XP
63    and Windows Vista (using MSYS/mingw32 - see README.win32), Mac OS X 10.4
64    and Mac OS X 10.5 (using XCode Tools - see README.MacOSX), the Maemo 4.0
65    and Maemo 4.1 SDKs (Chinook/Diablo - see README.Maemo).
67    Dependencies:
68      · SDL       >= 1.2.13 (www.libsdl.org)
69      · SDL_image >= 1.2.6  (www.libsdl.org/projects/SDL_image)
70      · SDL_mixer >= 1.2.8  (www.libsdl.org/projects/SDL_mixer)
71      · SDL_ttf   >= 2.0.9  (www.libsdl.org/projects/SDL_ttf)
73    (Tennix might compile and work with earlier versions of the respective
74    libraries, but the versions here have been the ones that I've tested it
75    with, so if there are problems, try to use the versions specified here)
77    Optional dependencies:
78      · Python    >=  2.5.x  (www.python.org)
79        => If you don't want to use the Python integration, set the variable
80           USE_PYTHON to a value other than 1 by specifying it on the "make"
81           command line like this:      make USE_PYTHON=0
83    On a Debian-based system, you can get all dependencies with the following
84    command line:
86     aptitude install libsdl1.2-dev libsdl-image1.2-dev libsdl-mixer1.2-dev \
87                      libsdl-ttf2.0-dev python-dev
90 PLAYING TENNIX
91 ==============
93    You can play in either single-player or multi-player mode. You can even
94    let two AI players play against each other. This can be configured in
95    the controls screen.
97    THE POWERBAR
99    You have to keep your "hit" key pressed, so that your powerbar (on the
100    bottom of the screen) "fills up". The more power you have, the stronger
101    you will hit the ball (and the higher and longer it will fly). Too much
102    power could make the ball go into the OUT, so be sure to use it wisely.
104    CONTROLS
106    Select the controller you like from the input selection menu. Be sure
107    to connect gamepads and joysticks BEFORE starting Tennix, so they are
108    enumerated and detected correctly.
110    FUNCTION KEYS
112    Y  .... Make screenshot (save as screenshot.bmp)
113    F  .... Toggle fullscreen (X11 only)
115    Bonus (because you took the time to look at the README file):
116    Obviously, there are some hidden easter eggs that are still not available
117    via the UI, due to the fact that we didn't implement the UI for it yet :)
118    Think about [r]ain and fog (think fog[t], even..). Wind is also available,
119    but it's so broken, you'll have to look up the keys in game.c.
122 DEVELOPMENT/DEBUGGING
123 =====================
125    If you want to compile a debugging version of "tennix", you
126    have to set the environment variable "DEBUG" to "1", either by
127    using "DEBUG=1 make" or exporting the environment variable for
128    the current session, as in "export DEBUG=1" followed by "make".
130    See the HACKING and TODO files for more development information.
133 CREDITS
134 =======
136    Some sound effects are based on data from the Freesound Project.
138    Thanks to Esad Hajdarevic and Stefan Doesinger for some optimizations
139    done during the Effiziente Programme course in January 2009 :)
141    Public domain artwork (stadium photos) by
142    http://en.wikipedia.org/wiki/User:Ivan
143    http://fr.wikipedia.org/wiki/Utilisateur:Arnaud_25
144    http://en.wikipedia.org/wiki/User:Aleksmot
145    http://commons.wikimedia.org/wiki/User:Alexisrael
146    http://commons.wikimedia.org/wiki/User:Vardion
148    Additional artwork by
149    Martin Third (http://flickr.com/photos/mthird3rd/471720012/)
151    This project includes SDL_rotozoom by A. Schiffler
153    See data/COPYING and credits.h for more information about the data files.
155 CONTACT
156 =======
158     E-Mail: Thomas Perl <thp@thpinfo.com>
159     URL: http://icculus.org/tennix/