.\"
-.\" Copyright (c) 2009, Charles McGarvey
+.\" Copyright (c) 2009-2010, Charles McGarvey
.\" All rights reserved.
.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions are
-.\" met:
-.\"
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
-.\" IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
-.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-.\" PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.\"
+.\" Distributable under the terms and conditions of the 2-clause BSD
+.\" license; see the file COPYING for a complete text of the license.
.\"
.TH YOINK 6 "July 24, 2009"
.SH NAME
artifacts caused by the animation of the game. Otherwise, a single buffer
will be used. The default value is true.
.TP
-.B fullscreen
-If true, the window will capture the display and render the game in full
-screen splendor. A value of false means the game will run in a window.
-The default value is false.
-.TP
-.B maxfps
-The maximum number of frames to be drawn per second. If your computer is
+.B framerate
+The target number of frames to be drawn per second. If your computer is
really old, you can get away with decreasing this value and still have
reasonably smooth animation. You can set this to a very high number to
effectively render as many frames as is possible, but the actual rate could
be limited by vertical display synchronization, depending on the X11 driver
-and settings used. You should not set this option higher than the point
-where the vertical synchronization effectively limits the draw rate or else
-the game may not be able to update the physics on schedule which could
-actually significantly lower the quality of the animation. The default
-value is 40.
+and settings used. The default value is 50.
.TP
-.B printfps
-If true, the current number of frames being drawn per second will be
-printed to the console. The default value is false.
+.B fullscreen
+If true, the window will capture the display and render the game in full
+screen splendor. A value of false means the game will run in a window.
+The default value is false.
.TP
.B resizable
If true, the window will be resizable by the window manager. This option
is meaningless if the game is drawing to the full screen. The default
option is true.
.TP
+.B showfps
+If true, the current number of frames being drawn per second will be
+printed to the console every second. The default value is false.
+.TP
.B timestep
The number of times per second the simulation state will be updated. A
value of 100 or higher is ideal for a better physical simulation. Values
.SH EXAMPLES
Here are some examples of typical usage:
.TP
-$ yoink maxfps=60
-Cap the allowable frame-rate to 60Hz.
-.TP
-$ yoink fullscreen=true
-Run \fByoink\fP in full-screen mode.
+$ yoink detail=2
+Set the level of detail to 2 so that less stuff is drawn to the screen.
.TP
-$ yoink videomode=\\{1024,768\\}
-Run \fByoink\fP with a resolution of 1024x768. Notice the escapes for the
-curly braces so the shell doesn't parse them.
+$ yoink fullscreen=true videomode=\\{1024,768\\}
+Run \fByoink\fP at full screen with a resolution of 1024x768. Notice the
+escapes for the curly braces so the shell doesn't parse them.
.SH ENVIRONMENT
\fByoink\fP responds to some variables in the environment:
.TP
.I HOME
-If set to a path of a valid directory (presumably a user's home directory),
+If set to a path of a valid directory (presumably your home directory),
\fByoink\fP will look for a file at \fI$HOME/.yoinkrc\fP and load it as a
config file.
.TP
.I USER
-\fByoink\fP uses this variable to guess the user's nickname, for a high
-score entry or whatever.
+\fByoink\fP uses this variable as the user's name, for a high score entry
+or whatever.
.TP
.I YOINK_DATADIR
If set to a path of a valid directory, \fByoink\fP will look in this
.TP
2. Decrease the level of rendering detail.
Use the \fBdetail\fP option. The game world may look sparse or incomplete,
-but that's probably better than choppy animation.
-.TP
-3. Decrease the timestep.
-You can set the \fBtimestep\fP to be as low as the your \fBmaxfps\fP
-option. Remember the trade-off here is decreased simulation accuracy.
+but that's probably better than choppy animation if you can avoid it.
+.TP
+3. Decrease the framerate and/or timestep.
+If your machine can't meet the target framerate, your actual framerate will
+probably vary. You will have a better visual experience if you can reduce
+the \fBframerate\fP to a point such that the actual framerate is basically
+constant. A constant 20fps or 30fps will look better than a sporadic
+40-60fps. You can also decrease the \fBtimestep\fP at the expense of
+decreased simulation accuracy. You'll have to experiment with this value
+to find out acceptable levels.
.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
projects / chaz / yoink / blobdiff