From 4cf79f9cb999ba7904dfa67e12544c710cdc0052 Mon Sep 17 00:00:00 2001 From: Thomas Perl Date: Tue, 24 Feb 2009 11:21:08 +0100 Subject: [PATCH] Updated documentation (README, manpage, etc..) --- HACKING | 26 ++++++++++++++++++++++++++ README | 55 +++++++++++++++++++++++++++++++++++-------------------- README.MacOSX | 4 ++++ README.win32 | 8 ++++++-- TODO | 5 +---- tennix.6 | 30 +++++------------------------- 6 files changed, 77 insertions(+), 51 deletions(-) create mode 100644 HACKING diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..0ccd562 --- /dev/null +++ b/HACKING @@ -0,0 +1,26 @@ +If you want get your hands onto Tennix and improve / fix it, please have +a look at the TODO file first and see if there is anything that you can +contribute. + +You can send patches to me; contact information is at http://thpinfo.com/about + +Helpful hints: + * Adding graphics is done by adding a new constant to the "enum" block in + graphics.h (where GR_CURSOR, GR_BACK, etc.. are defined) - but BEFORE the + GR_COUNT constant (this is used to "count" how many graphcs there are); + after adding to graphics.h, add the filename of the desired image to the + same position to "static const char* graphics[]" in graphics.c (you'll get + the idea after comparing the variable and the enum - there's a system ;) + * Adding sounds is analog to adding graphics, but be sure to update the + LAST_SOUNDEFFECT_ID macro (it should point to the last non-voice effect + * Use the same coding style as the surrounding code (might be different for + different source files) + * Use C-style comments (/* ... */) and not C++-style comments (// ...) + * You can get a list of #defines that we currently use by running this command + in the source tree: grep -hr "^#ifdef" *.c *.h | sort | uniq + * Global configuration and #defines should go into tennix.h; where all other + modules can access it + * You can extract the contents of a ".tnx" file by compiling the standalone + version of the "archive" tool and renaming it to "extract" + +-- Thomas Perl, 2009-02-24 diff --git a/README b/README index 7403a62..7dc5bfc 100644 --- a/README +++ b/README @@ -1,13 +1,13 @@ - ###### ##### ## ## ## ## ## ## ## - ## ## ### ## ### ## ## ### ### - ## #### ## # ## ## # ## ## ### + thpinfo.com presents + ****** ***** ** ** ** ** ** ** ** + ** ** *** ** *** ** ** *** *** + == ==== == = == == = == == === ## ## ## ### ## ### ## ### ### ## ##### ## ## ## ## ## ## ## - - SDL Port + 2009 World Tennix Championship Tour Copyright (C) 2003, 2007, 2008, 2009 Thomas Perl @@ -66,33 +66,33 @@ INSTALLATION PLAYING TENNIX ============== - You can play in either single-player or multi-player mode. - For single player, Player 1 will play against the computer - and for multi player, Player 1 will play against Player 2. + You can play in either single-player or multi-player mode. You can even + let two AI players play against each other. This can be configured in + the controls screen. - CONTROLS + THE POWERBAR - Player 1 | Player 2 - --------------------------- - Move up W O - Move down S L - Swing racket D K - --------------------------- + You have to keep your "hit" key pressed, so that your powerbar (on the + bottom of the screen) "fills up". The more power you have, the stronger + you will hit the ball (and the higher and longer it will fly). Too much + power could make the ball go into the OUT, so be sure to use it wisely. + + CONTROLS - See the manpage, tennix(6) for more controls (especially alternative - keyboard controls and mouse control, which is new since 0.6.0). + Select the controller you like from the input selection menu. Be sure + to connect gamepads and joysticks BEFORE starting Tennix, so they are + enumerated and detected correctly. FUNCTION KEYS Y .... Make screenshot (save as screenshot.bmp) F .... Toggle fullscreen (X11 only) - C .... Switch type of court (grass, clay, etc..) Bonus (because you took the time to look at the README file): Obviously, there are some hidden easter eggs that are still not available via the UI, due to the fact that we didn't implement the UI for it yet :) - Think about [n]ight, [r]ain and fog (think fog[t], even..). Wind is also - available, but it's so broken, you'll have to look up the keys in game.c. + Think about [r]ain and fog (think fog[t], even..). Wind is also available, + but it's so broken, you'll have to look up the keys in game.c. DEVELOPMENT/DEBUGGING @@ -103,6 +103,8 @@ DEVELOPMENT/DEBUGGING using "DEBUG=1 make" or exporting the environment variable for the current session, as in "export DEBUG=1" followed by "make". + See the HACKING and TODO files for more development information. + CREDITS ======= @@ -112,6 +114,19 @@ CREDITS Thanks to Esad Hajdarevic and Stefan Doesinger for some optimizations done during the Effiziente Programme course in January 2009 :) + Public domain artwork (stadium photos) by + http://en.wikipedia.org/wiki/User:Ivan + http://fr.wikipedia.org/wiki/Utilisateur:Arnaud_25 + http://en.wikipedia.org/wiki/User:Aleksmot + http://commons.wikimedia.org/wiki/User:Alexisrael + http://commons.wikimedia.org/wiki/User:Vardion + + Additional artwork by + Martin Third (http://flickr.com/photos/mthird3rd/471720012/) + + This project includes SDL_rotozoom by A. Schiffler + + See data/COPYING and credits.h for more information about the data files. CONTACT ======= diff --git a/README.MacOSX b/README.MacOSX index 82c78d9..c281357 100644 --- a/README.MacOSX +++ b/README.MacOSX @@ -6,6 +6,7 @@ from www.libsdl.org: http://www.libsdl.org/ http://www.libsdl.org/projects/SDL_mixer/ http://www.libsdl.org/projects/SDL_image/ +http://www.libsdl.org/projects/SDL_ttf/ At the time of writing, the files you need are: SDL-1.2.11.dmg @@ -26,3 +27,6 @@ The resulting binary will be called Tennix.app. Enjoy, thp 2007-05-17 + +Updated: 2009-02-24 + diff --git a/README.win32 b/README.win32 index 6f2d546..18a6748 100644 --- a/README.win32 +++ b/README.win32 @@ -7,12 +7,13 @@ Cross-compiling on a Debian System (untested!) http://wiki.njh.eu/MinGW-Cross-Compiling_mit_SDL You also need the win32 development packages of -SDL_mixer and SDL_image, these can be found here: +SDL_mixer, SDL_image and SDL_ttf, these can be found here: http://www.libsdl.org/projects/SDL_mixer/ http://www.libsdl.org/projects/SDL_image/ +http://www.libsdl.org/projects/SDL_ttf/ -For SDL_mixer and SDL_image, copy the *.h files +For these libraries, copy the *.h files to c:\mingw\include\SDL\ and the *.lib files to c:\mingw\lib\. The .dll files have to be copied to the tennix source folder, so they can be @@ -69,3 +70,6 @@ Thomas Perl , 2007-11-21 Enjoy, thp 2007-05-12 + +Updated: 2009-02-24 + diff --git a/TODO b/TODO index d24ae43..207b80a 100644 --- a/TODO +++ b/TODO @@ -1,10 +1,7 @@ Todo and Idea List for Tennix ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Tennix 2009 Edition (2.0) -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Target release date: 19.02.2009 +See the file "HACKING" for help finding your way around the tennix source. HIGH-PRIORITY diff --git a/tennix.6 b/tennix.6 index 6c4827a..4e1be6d 100644 --- a/tennix.6 +++ b/tennix.6 @@ -1,4 +1,4 @@ -.TH "TENNIX" "6" "February 2009" "tennix 0.7.0" +.TH "TENNIX" "6" "February 2009" "Tennix 2009 Edition" .SH "NAME" tennix \(em A funny 2D tennis game @@ -13,28 +13,14 @@ tennix \(em A funny 2D tennis game features a two-player game mode and a single-player mode against the computer. .PP -Joystick can be used instead of the keyboard. See \fBOPTIONS\fR on how to -set up the game for joysticks. -.PP This is the SDL port of a DOS game written in 2003. The original game can still be found on the web at http://thpinfo.com/2003/tennix/ .SH "CONTROLS" -.TP -.I W, S, D -Player 1: Move up, down and swing the racket -.TP -.I Up, Down, Spacebar -Player 1 (alternative): Move up, down and swing the racket -.TP -.I Mouse, Left mouse button -Player 1 (alternative): Move while left button pressed, swing racket when left button released -.TP -.I O, L, K -Player 2: Move up, down and swing the racket -.TP -.I C -Change the type of court (grass, hard, clay) +.PP +You can select the controls directly in the menu. Usually, in two-player +game mode, player 1 plays using W, S, D, E, F and player 2 plays using +O, L, K, I, J. You can also play using mouse, gamepad or Joystick. .TP .I P (Un)pause the game @@ -48,12 +34,6 @@ Start the game in fullscreen mode .TP .I \-h, \-\-help Show summary of options -.TP -.I \-J, \-\-list-joysticks -Shows a list of joysticks and how to use them -.TP -.I \-j, \-\-joystick \fBName\fP -Choose the joystick to be used to control Player 1 .SH "HOMEPAGE" .PP http://icculus.org/tennix/ -- 2.11.4.GIT