Dogcows Code - chaz/yoink/blob - doc/yoink.6.in

   1 .\"
   2 .\" Copyright (c) 2009-2011, Charles McGarvey
   3 .\" All rights reserved.
   4 .\"
   5 .\" Distributable under the terms and conditions of the 2-clause BSD
   6 .\" license; see the file COPYING for a complete text of the license.
   7 .\"
   8 .Dd July 24, 2009
   9 .Dt YOINK 6
  10 .Os
  11 .Sh NAME
  12 .Nm yoink
  13 .Nd an alien-smashing action game
  14 .Sh SYNOPSIS
  15 .Nm yoink
  16 .Op Fl hi
  17 .Op Ar OPTION=VALUE ...
  18 .Sh DESCRIPTION
  19 Leap tall buildings!  Crush stupid robots beneath your feet!  Wield your
  20 extra-terrestrial powers in the defense of humanity, and send those alien
  21 invaders back from whence they came!
  22 .Pp
  23 You play the part of a flying alien heroine who must defend her home on
  24 Earth from other airborne alien invaders.  The game draws inspiration from
  25 classic arcade games like Joust, Bombjack, Rampage, and Defender--simple,
  26 fast-moving action.  Basic options include:
  27 .Bl -tag -width flag
  28 .It Fl h, -help
  29 Display basic usage information, and exit immediately.
  30 .It Fl i, -info
  31 Display build and environment details, and exit immediately.
  32 .El
  33 .Pp
  34 For a list of the other options available, see
  35 .Xr yoinkrc 5 Ns .
  36 .Pp
  37 To attack, you must dive on the enemy at high speed.  If you're going too
  38 slowly, you'll just drift harmlessly by.  Diving from above gives different
  39 results from swooping in and hitting them from the side.  If you're too
  40 close to attack, try to build up speed by running away and bouncing off a
  41 nearby building!
  42 .Pp
  43 By charging your special alien powers, you can throw fireballs.  The orange
  44 bar at the top of the screen represents your power level--at maximum, you
  45 can destroy almost anything.  Aiming can be tricky, but with a little
  46 practice it's quite easy to launch them in the right direction.  Try doing
  47 a little swoop or circle in the air to line yourself up before releasing
  48 your fireball.
  49 .Pp
  50 The heroine has limited energy, measured by the blue bar at the top of the
  51 screen.  When it runs out, it's game over!  She can regain lost energy by
  52 picking up bonuses dropped by enemies.
  53 .Pp
  54 To complete the current attack wave, you must destroy all the enemies.
  55 Hunt around, especially in the sky, if you can't find the last few.
  56 .Sh FILES
  57 .Bl -tag -width Fl
  58 .It Pa @pkgdatadir@/yoinkrc
  59 The configuration file with the default options.  This file is to be
  60 considered read-only and should be looked to as an example of the file
  61 format (see
  62 .Xr yoinkrc 5 Ns ).
  63 .It Pa /etc/yoinkrc
  64 The system-wide configuration file.
  65 .It Pa ~/.yoinkrc
  66 The user's specialized configuration file.
  67 .El
  68 .Sh ENVIRONMENT
  69 .Bl -tag -width Fl
  70 .It Ev HOME
  71 If set to the path of a valid directory (presumably your home directory),
  72 .Nm
  73 will look for a file at
  74 .Pa $HOME/.yoinkrc
  75 and load it as a config file.
  76 .It Ev USER
  77 .Nm
  78 uses this variable as the user's name, for a high score entry or whatever.
  79 .It Ev YOINK_DATADIR
  80 If set to a path of a valid directory,
  81 .Nm
  82 will look in this directory first when it is loading game assets.  Set this
  83 variable if you move the game's assets to another directory or perhaps want
  84 to load your own custom assets rather than the defaults.
  85 .It Ev YOINKRC
  86 If set to a path of a valid config file,
  87 .Nm
  88 will load the options from that file, and those options will take
  89 precedence over options loaded from other config files.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr yoinkrc 5
  93 .Sh HISTORY
  94 .Nm Yoink
  95 was originally created for Mac OS X by Neil Carter.  It was a winning entry
  96 in the uDevGames 2003 Mac game development contest.
  97 .Sh AUTHOR
  98 .Bl -tag -width 2i -compact
  99 .It An Charles McGarvey
 100 .Mt @email@
 101 .El
 102 .Sh CAVEATS
 103 .Nm
 104 requires direct rendering.  A software implementation of GL will probably
 105 run to slowly to provide a decent framerate.  If you're stuck without
 106 hardware acceleration, some options may be able to boost framerates
 107 somewhat.  See
 108 .Ar videomode Ns ,
 109 .Ar detail Ns ,
 110 .Ar framerate
 111 and
 112 .Ar timestep
 113 in
 114 .Xr yoinkrc 5
 115 for more information.
 116 .Pp
 117 If you are having audio problems, you may need to upgrade OpenAL.  Some
 118 systems still provide an old, busted version of OpenAL which may result in
 119 stuttering, lag, and other oddities.  See about installing a recent version
 120 of openal-soft, a high-quality software implementation that is still being
 121 maintained.
 122 .Sh BUGS
 123 Submit bug reports and/or patches to:
 124 .Lk http://www.dogcows.com/yoink/newticket "Yoink Bug Tracker"