Dogcows Code - chaz/yoink/blob - doc/yoinkrc.5.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 YOINKRC 5
  10 .Os
  11 .Sh NAME
  12 .Nm yoinkrc
  13 .Nd user configuration for yoink
  14 .Sh DESCRIPTION
  15 Yoink configuration files are little more than Lua scripts with meaningful
  16 variables.  The syntax for variable assignment is similar to that in other
  17 languages, where the variable name appears on the left side of an equals
  18 \(lq=\(rq character, and the value to be assigned appears on the right
  19 side.  Please refer to the distributed configuration file at
  20 .Pa @pkgdatadir@/yoinkrc
  21 for an example of the syntax.  Here is a list of some of the available
  22 options:
  23 .Bl -tag -width Fl
  24 .It Va detail
  25 The level of detail.  Possible values are 1, 2, or 3 where 1 means the
  26 least amount of detail and 3 means the most.  This effects the number of
  27 objects drawn to the screen.  A high level of detail will draw everything
  28 but could cause poor frame rates if the graphics driver can't keep up with
  29 the load.  Lower levels will omit certain details which aren't crucial for
  30 playing the game with the possible benefit of higher frame rates.  See the
  31 Notes for more ways to increase the game's performance.  The default value
  32 is 3.
  33 .It Va doublebuffer
  34 If true, double-buffering will be used to help minimize distortion and
  35 artifacts caused by the animation of the game.  Otherwise, a single buffer
  36 will be used.  The default value is true.
  37 .It Va framerate
  38 The target number of frames to be drawn per second.  If your computer is
  39 really old, you can get away with decreasing this value and still have
  40 reasonably smooth animation.  You can set this to a very high number to
  41 effectively render as many frames as is possible, but the actual rate could
  42 be limited by vertical display synchronization, depending on the X11 driver
  43 and settings used.  The default value is 50.
  44 .It Va fullscreen
  45 If true, the window will capture the display and render the game in full
  46 screen splendor.  A value of false means the game will run in a window.
  47 The default value is false.
  48 .It Va resizable
  49 If true, the window will be resizable by the window manager.  This option
  50 is meaningless if the game is drawing to the full screen.  The default
  51 option is true.
  52 .It Va showfps
  53 If true, the current number of frames being drawn per second will be
  54 printed to the console every second.  The default value is false.
  55 .It Va timestep
  56 The number of times per second the simulation state will be updated.  A
  57 value of 100 or higher is ideal for a better physical simulation.  Values
  58 that are much lower cause the CPU to do less work, but accuracy will
  59 suffer.  Errors could be introduced in the game with extremely low values.
  60 The default value is 80.
  61 .It Va videomode
  62 The resolution or size of the window.  The value is an array with three
  63 number elements representing the width, height, and bits per pixel that
  64 make up the video mode.  The third number is optional.  The default value
  65 is {800,600}.
  66 .El
  67 .Sh FILES
  68 .Bl -tag -compact
  69 .It Pa @pkgdatadir@/yoinkrc
  70 .It Pa /etc/yoinkrc
  71 .It Pa ~/.yoinkrc
  72 .El
  73 .Sh SEE ALSO
  74 .Xr yoink 6
  75 .Sh AUTHORS
  76 .Bl -tag -width 2i -compact
  77 .It An Charles McGarvey
  78 .Mt chaz@dogcows.com
  79 .El