games/clonekeen: Added (open source engine for Commander Keen)

1 files changed, 227 insertions, 0 deletions

diff --git a/games/clonekeen/clonekeen.6 b/games/clonekeen/clonekeen.6
new file mode 100644
index 0000000000000..69b5587384dff
--- /dev/null
+++ b/games/clonekeen/clonekeen.6
@@ -0,0 +1,227 @@
+.TH CLONEKEEN 6 "March 25, 2010"
+.SH NAME
+clonekeen \- Clone of id Software's "Commander Keen" game
+.br
+.SH SYNOPSIS
+.B clonekeen
+[\fIwarplevel\fR]
+[\fIOPTIONS\fR]
+.SH DESCRIPTION
+CloneKeen is an almost almost complete open\-source clone of
+the old classic DOS game, \fICommander Keen: Invasion of the
+Vorticons\fR by ID Software. CloneKeen requires the original game
+data files to work. You can play all three episodes of the game
+(but not the later episodes 4 through 6, nor "Keen Dreams").
+.PP
+CloneKeen tries to mostly replicate the original game,
+however there are also a number of improvements,
+including smoother scrolling, better graphic effects
+in some parts of the game, and 2\-player support.
+.PP
+See story.txt for a description of the game's plot.
+.SH OPTIONS
+.TP
+\fBwarplevel\fR
+specify a level number (such as 2) to go directly to that level. This option
+must be given first. Example: \fBclonekeen 1 \-fs\fR to start the game on
+level 1 in fullscreen mode.
+.TP
+\fB\-1player\fR, \fB\-2player\fR
+select number of players (1\-2); defaults to 1. This is local multiplayer,
+with 2 players using the same keyboard (there is no network play).
+.TP
+\fB\-nopk\fR
+do not allow players to kill each other in multiplayer games
+.TP
+\fB\-ep1\fR, \fB\-ep2\fR, \fB\-ep3\fR
+select episode 1, 2, or 3; defaults to 1
+.TP
+\fB\-dtm\fR
+go directly to the world map, bypassing intro and title screen
+.TP
+\fB\-mean\fR
+increase game difficulty
+.TP
+\fB\-cheat\fR
+enable function key cheat/debug codes
+.TP
+\fB\-rec\fR
+record player actions to demo.dat for making a demo
+.TP
+\fB\-eseq\fR
+for the impatient\-\-cut directly to the ending sequence
+.TP
+\fB\-fs\fR
+use fullscreen mode
+.TP
+\fB\-dbl\fR
+zoom image 2x
+.TP
+\fB\-showfps\fR
+show frames/second in upper\-right of screen
+.SH CONTROLS
+.TP
+\fBArrows\fR
+Movement
+.TP
+\fBSpace\fR
+Show inventory and status
+.TP
+\fBControl\fR
+Jump (or on the map screen, enter a level)
+.TP
+\fBAlt\fR
+Pogo stick (if you have it)
+.TP
+\fBCtrl+Alt\fR
+Fire Raygun (if it has charges)
+.TP
+\fBF3\fR
+Save the game
+.TP
+\fBEscape\fR
+At the intro or title screen, quits the game. During gameplay, brings up
+the quit menu (press Escape again to return to the game).
+.TP
+\fBF10\fR
+Switch to fullscreen and enable scale2x mode. Only active during the
+intro screen (blue text on starfield).
+.PP
+In 2\-player games, player 2's controls are:
+.TP
+\fBW\fR
+On the Map stage, move up. On a level, jump.
+.TP
+\fBQ\fR
+Pogo stick (if you have it)
+.TP
+\fBQ+W\fR
+Fire Raygun (if it has charges)
+.TP
+\fBA\fR
+Left
+.TP
+\fBS\fR
+Down
+.TP
+\fBD\fR
+Right
+.SH CHEAT CODES
+There are a full assortment of cheat codes available. Some cheats must first
+be enabled with -cheat or through the options menu. C+T+SPACE and G+O+D will
+always work.
+.TP
+\fBG+O+D\fR
+God \- Toggles GOD mode. You can't protect yourself
+ from dying if you fall off the map though.
+ (Use TAB to revive in this case).
+.TP
+\fBTab\fR
+Noclip/Revive \-
+Turns off clipping, allowing you to walk through
+ walls / Aborts a dying sequence.
+.TP
+\fBC+T+Space\fR
+All Items \- Gives all items, similar to the original.
+.TP
+\fBF2\fR
+Nofall \- Disables gravity, so Keen can walk on air. 
+.TP
+\fBF6\fR
+Debug mode/RADAR \- Press once: enables debug mode, press again,
+ enables radar in upper\-left corner.
+.TP
+\fBF7\fR
+Throttle off \- Disables speed throttle so the game goes really
+ fast.
+.TP
+\fBF8\fR
+Frame\-by\-frame mode \- Just as it sounds, see in\-game instructions.
+.TP
+\fBF9\fR
+Abort level \- Marks level as "done", and returns to the map.
+.TP
+\fBKeypad +\fR
+Force fall \- Allows fall to a platform below the current one.
+ The opposite of F2.
+.SH GAMEPLAY
+(taken/modified from the original game's in\-game help)
+.PP
+When you are on the Mars map, you may be blocked by a city, shrine, or other
+obstacle.  You must enter the city (press Ctrl) and finish it
+before proceeding.
+.PP
+When you enter a city, you can get things by simply running into them.
+.PP
+If you cannot pass through a door, there may be a "keycard" that the door
+requires.  This keycard will be the same color as the door.
+.SH TREASURES
+(taken/modified from the original game's in\-game help)
+.PP
+\fBLollipop\fR \- 100 points
+.br
+\fBSoda\fR \- 200 points
+.br
+\fBPizza\fR \- 500 points
+.br
+\fBBook\fR \- 1000 points
+.br
+\fBTeddy Bear\fR \- 5000 points
+.PP
+You get an extra Keen every 20,000 points.
+.SH FILES
+.TP
+\fB~/.clonekeen\fR
+Per\-user savegames and config data. This directory is created the first
+time you run \fBclonekeen\fR.
+.TP
+\fB~/.clonekeen/defaultargs\fR
+Default arguments to pass to the game. Good candidates are \-fs, \-dbl,
+and/or -cheat. Put the arguments in the file on the same line,
+separated by spaces, e.g.:
+.PP
+\fBecho "-dbl -fs -cheat" > ~/.clonekeen/defaultargs\fR
+.TP
+\fB/usr/share/games/clonekeen/\fR
+System\-wide game data files (including the ones that come with
+the original game). Data files may be named in all\-uppercase or
+all\-lowercase (EGAHEAD.CK1 or egahead.ck1, or even mixed case like
+EGAHEAD.ck1 or egahead.CK1, but not egaHead.ck1)
+.TP
+\fB/usr/games/clonekeen\-bin\fR
+Main game binary. Generally not to be run directly: it expects to find the
+data files in the current dir, and writes config/savegame data in the
+current dir. Use the \fBclonekeen\fR wrapper script instead.
+.TP
+\fB/usr/games/clonekeen\fR
+Wrapper script.  Creates ~/.clonekeen, populates it with symlinks to the
+game data files, runs the main binary.
+.SH BUGS
+Actually not bugs, these are features that were in the original DOS version
+of the game that are not (yet?) implemented in clonekeen:
+.PP
+No way to customize keyboard controls
+.PP
+No support for joystick controls
+.PP
+No support for in\-game help (probably just as well, the help talks about
+joysticks, and customizing keyboard controls...)
+.PP
+Also, the DOS build of clonekeen appears to support up to 4 (or maybe
+only 3) player
+games, but the Linux build only defines enough control keys
+for 2 players.
+.SH AUTHOR
+clonekeen was written by Caitlin Shaw.
+.PP
+This manual page and the wrapper script were written by B. Watson for the SlackBuilds.org project.
+.SH SEE ALSO
+\fB/usr/doc/clonekeen-8.3/readme.txt\fR
+.br
+\fB/usr/doc/clonekeen-8.3/story.txt\fR
+.br
+\fBhttp://clonekeen.sourceforge.net/\fR
+.br
+\fBhttp://www.3drealms.com/tech/keen.html\fR
+.br
+\fBhttp://en.wikipedia.org/wiki/Commander_Keen\fR