.\"
.\" Copyright (c) 2009-2011, Charles McGarvey
.\" All rights reserved.
.\" 
.\" Distributable under the terms and conditions of the 2-clause BSD
.\" license; see the file COPYING for a complete text of the license.
.\"
.Dd July 24, 2009
.Dt YOINK 6
.Os
.Sh NAME
.Nm yoink
.Nd an alien-smashing action game
.Sh SYNOPSIS
.Nm yoink
.Op Fl hi
.Op Ar OPTION=VALUE ...
.Sh DESCRIPTION
Leap tall buildings!  Crush stupid robots beneath your feet!  Wield your
extra-terrestrial powers in the defense of humanity, and send those alien
invaders back from whence they came!
.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 options include:
.Bl -tag -width flag
.It Fl h, -help
Display basic usage information, and exit immediately.
.It Fl i, -info
Display build and environment details, and exit immediately.
.El
.Pp
For a list of the other options available, see
.Xr yoinkrc 5 Ns .
.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
results from swooping in and hitting them from the side.  If you're too
close to attack, try to build up speed by running away and bouncing off a
nearby building!
.Pp
By charging your special alien powers, you can throw fireballs.  The orange
bar at the top of the screen represents your power level--at maximum, you
can destroy almost anything.  Aiming can be tricky, but with a little
practice it's quite easy to launch them in the right direction.  Try doing
a little swoop or circle in the air to line yourself up before releasing
your fireball.
.Pp
The heroine has limited energy, measured by the blue bar at the top of the
screen.  When it runs out, it's game over!  She can regain lost energy by
picking up bonuses dropped by enemies.
.Pp
To complete the current attack wave, you must destroy all the enemies.
Hunt around, especially in the sky, if you can't find the last few.
.Sh FILES
.Bl -tag -width Fl
.It Pa @pkgdatadir@/yoinkrc
The configuration file with the default options.  This file is to be
considered read-only and should be looked to as an example of the file
format (see
.Xr yoinkrc 5 Ns ).
.It Pa /etc/yoinkrc
The system-wide configuration file.
.It Pa ~/.yoinkrc
The user's specialized configuration file.
.El
.Sh ENVIRONMENT
.Bl -tag -width Fl
.It Ev HOME
If set to the path of a valid directory (presumably your home directory),
.Nm
will look for a file at
.Pa $HOME/.yoinkrc
and load it as a config file.
.It Ev USER
.Nm
uses this variable as the user's name, for a high score entry or whatever.
.It Ev YOINK_DATADIR
If set to a path of a valid directory,
.Nm
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.
.It Ev YOINKRC
If set to a path of a valid config file,
.Nm
will load the options from that file, and those options will take
precedence over options loaded from other config files.
.El
.Sh SEE ALSO
.Xr yoinkrc 5
.Sh HISTORY
.Nm Yoink
was originally created for Mac OS X by Neil Carter.  It was a winning entry
in the uDevGames 2003 Mac game development contest.
.Sh AUTHOR
.Bl -tag -width 2i -compact
.It An Charles McGarvey
.Mt @email@
.El
.Sh CAVEATS
.Nm
requires direct rendering.  A software implementation of GL will probably
run to slowly to provide a decent framerate.  If you're stuck without
hardware acceleration, some options may be able to boost framerates
somewhat.  See
.Ar videomode Ns ,
.Ar detail Ns ,
.Ar framerate
and
.Ar timestep
in
.Xr yoinkrc 5
for more information.
.Pp
If you are having audio problems, you may need to upgrade OpenAL.  Some
systems still provide an old, busted version of OpenAL which may result in
stuttering, lag, and other oddities.  See about installing a recent version
of openal-soft, a high-quality software implementation that is still being
maintained.
.Sh BUGS
Submit bug reports and/or patches to:
.Lk http://www.dogcows.com/yoink/newticket "Yoink Bug Tracker"