.SH NAME
Yoink \- An alien-smashing action game.
.SH SYNOPSIS
-.B yoink [-h|--help] [-v|--version] [OPTION=VALUE]...
+.B yoink [-h|--help] [OPTION=VALUE]...
.br
.SH DESCRIPTION
.PP
Leap tall buildings! Crush stupid robots beneath your feet! Wield your
extra-terrestrial powers in the defence of humanity, and send those alien
-invaders back from whence they came! Do all these things (apart from the last
-one at the moment) in Yoink! You play the part of a flying alien heroine who
-must defend her home on Earth from other airborne alien invaders. The game
-draws inspiration from classic arcade games like Joust, Bombjack, Rampage, and
-Defender--simple, fast-moving action.
+invaders back from whence they came! This is Yoink.
.PP
+You play the part of a flying alien heroine who must defend her home on Earth
+from other airborne alien invaders. The game draws inspiration from classic
+arcade games like Joust, Bombjack, Rampage, and Defender--simple, fast-moving
+action. Basic arguments include:
.TP
.B -h, --help
display this help and exit
-.TP
-.B -v, --version
-output version information and exit
+.br
+.SH TIPS
.PP
To attack, you must dive on the enemy at high speed. If you're going too
slowly, you'll just drift harmlessly by. Diving from above gives different
prior configuration files taking precedence over the same options if they exist
in multiple configuration files:
.TP
-1. $YOINK_CONFIGFILE
-This is an optional environment variable.
+1. $YOINKRC
+This is an optional environment variable you can set to point to a configuration
+file.
.TP
2. $HOME/.yoinkrc
-This is a specific user's configuration file.
+This is a specific user's personal configuration file.
.TP
3. /etc/yoinkrc
-This is a system-wide configuration file.
+This is the system-wide configuration file. Not available on Windows.
.TP
-4. @datadir@/yoinkrc
+4. @DATADIR@/yoinkrc
This is the base configuration file which should be considered read-only. Look
to this file as an example of the format used for configuration files.
.PP
the configuration file(s). This mechanism is good for running the game with a
temporary setting which you do not intend to retain. Keep in mind that if you
edit and save options in-game, any options you have passed as arguments during
-the invocation of the game will be saved to the $HOME/.yoinkrc configuration
-file. You may have to go into that file and remove any options you didn't
-intend to set. When passing options as arguments, you must use the fully
-qualified name of the option if it exists in a subgroup. For example:
+the invocation of the game will be saved to the
+.I $HOME/.yoinkrc
+configuration file. If this is not what you intended, you may have to go into
+that file and remove any options you didn't intend to set. When passing options
+as arguments, you must use the fully qualified name of the option if it exists
+in a subgroup. For example:
.PP
.TP
yoink video.fullscreen=true
-Set the option video.fullscreen to true. This will run the game in full-screen
-mode.
+Set the option
+.I video.fullscreen
+to true. This will run the game in full-screen mode.
.TP
yoink video.maxfps=60
-Set the option video.maxfps to 60. This will cap the display rate at 60Hz.
+Set the option
+.I video.maxfps
+to 60. This will cap the display rate at 60Hz.
.PP
-You can also set options with array values. Arrays can be passed on the
-command line by surrounding all the parts with square brackets and separating
-each part by a comma. For example:
+You can also set options with array values. Arrays can be passed on the command
+line by surrounding all the parts with square brackets and separating each part
+by a comma. For example:
.TP
yoink video.mode=[1024,768]
-Set the option video.mode to an array with numbers 1024 and 768. The video size
-will be 1024x768.
+Set the option
+.I video.mode
+to an array with numbers 1024 and 768. The video size will be 1024x768.
.PP
Here is a list of some of the options available:
.TP
+.B engine.rngseed
+The number value used as a seed for the random number generator. Set this to
+make the game more predictable. This is typically only useful for debugging.
+.TP
.B engine.timestep
The amount of time in seconds between each update of the physics state. A value
of 0.01 or lower is ideal for accurate physics approximations. Values that are
-much lower may introduce errors in the game.
+much higher cause the CPU to do less work, but accuracy will suffer. Errors
+could be introduced in the game with extremely high values.
+.TP
+.B game.detail
+The level of detail. Possible values are high, medium, and low. This effects
+the number of objects drawn to the screen. A high level of detail will draw
+everything but could cause poor frame rates if the graphics driver can't keep up
+with the load. Lower levels will omit certain details which aren't crucial for
+playing the game with the benefit of higher frame rates. See the Notes for more
+ways to get good performance.
.TP
.B input.grab
Takes a boolean (true or false). If true, the cursor pointer will be "stuck"
use for red, green, blue, and the alpha channel. This is a low-level option of
limited usefulness. The default value is almost always preferable.
.TP
-.B video.cursor
+.B video.showcursor
This option effects the visibility of the cursor while it is "hovering" over the
window. If the value is true, the cursor will be visible. Otherwise, the
cursor will be hidden.
.B video.mode
The resolution or size of the window. The value is an array with three number
elements representing the width, height, and bits per pixel that make up the
-video mode.. A typical value is [800,600,32] for a size of 800x600 pixels with
-millions of colors.
+video mode. A typical value is [800,600] for a size of 800x600 pixels with
+millions of colors (the third number is optional).
.TP
.B video.multisamplebuffers
The number of multisample buffers used.
HOME
If set to a path of a valid directory (presumably a user's home directory),
.B yoink
-will load options from the configuration file at $HOME/.yoinkrc, if it exists.
-Saving options within the game will cause this file to be over-written with the
-new options.
+will look for a file at
+.I $HOME/.yoinkrc
+and load it as a configuration file. Saving options within the game will cause
+this file to be over-written with the new options, unless the
+.I YOINKRC
+variable is set.
.TP
USER
.B yoink
uses this variable to guess the user's nickname, for a high score entry or
whatever.
.TP
-YOINK_CONFIGFILE
+YOINK_DATADIR
+If set to a path of a valid directory,
+.B yoink
+will look in this directory first when it is loading game assets. Set this
+variable if you move the game's assets to another directory or perhaps want to
+load your own custom assets rather than the defaults.
+.TP
+YOINKRC
If set to a path of a valid configuration file,
.B yoink
will load the options from that file, and those options will take precedence
over options loaded from other configuration files. Any in-game saving will
-cause this file to be over-written by the new options rather than the file at
-$HOME/.yoinkrc.
+cause this file to be over-written by the new options rather than the
+.I $HOME/.yoinkrc
+config file.
+.br
+.SH NOTES
+.PP
+Yoink may or may not be playable with acceptable frame rates without a hardware
+accelerated OpenGL driver installed and working, depending on how fast your CPU
+is. Yoink is really not all that heavy on graphics, but it doesn't take much to
+overload a software implementation. If you're stuck without hardware
+acceleration, there are some things you can do to get better frame rates:
+.PP
+1. Decrease the resolution with the
+.I video.mode
+option. Due to the nature of the graphics in the game, you can go as low as
+320x240 and not notice a large reduction in image quality. You can take
+advantage of this by decreasing the resolution and running full-screen (so the
+window is not so itty bitty on your monitor). This will help out a lot. Try
+this:
.TP
-YOINK_DATADIR
-If set to a path of a valid directory,
+yoink video.mode=[320,240] video.fullscreen=true
+.PP
+2. Decrease the level of detail with the
+.I game.detail
+option.
+.PP
+On the other hand, if you already get high frame rates, you may also want to cap
+the rate so that your computer doesn't do more work than it really needs to.
+This may be useful when you run
.B yoink
-will look in this directory first when it is loading game assets. Set this
-variable if you move the game's assets to another directory or want to load your
-own assets.
+on your production server at work. You can get reasonably smooth animation at
+around 30fps, but you can probably tell a difference between that and a higher
+rate like 50fps. The latter will look noticeably smoother and nice, while the
+former is just "acceptable." See the
+.I video.maxfps
+option.
.br
.SH BUGS
.PP
-The pixelated graphics are actually intentional. It adds to the charm of the
-game, don't you think?
+Although the pixelated graphics are intentional, there are some unintended
+artifacts which are more obvious on certain OpenGL implementations.
.PP
-Send bug reports and patches to:
+Send bug reports, patches, and love notes to:
.br
-Charles McGarvey <onefriedrice@brokenzipper.com>
+Charles McGarvey <@PACKAGE_BUGREPORT@>
.SH AUTHOR
.PP
Neil Carter was the original creator of Yoink, his winning entry in the
-uDevGames 2003 Mac game development contest. Charles McGarvey rewrote the game
-with SDL and is the current maintainer.
+uDevGames 2003 Mac game development contest. Charles McGarvey restored the game
+and is the current maintainer.
projects / chaz / yoink / blobdiff