X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fyoink;a=blobdiff_plain;f=data%2Fyoinkrc;h=36b6e58d5ea9e9e982fc33ced1e2a65b4edbd140;hp=bcb0f0645f040edee3631b1fc865e7c4a16c3427;hb=be9ebc1104574e5e81e19c5caba0c23b54df826d;hpb=ca0f7bdfba63140dca0bd20586d31980f3938eb2

diff --git a/data/yoinkrc b/data/yoinkrc
index bcb0f06..36b6e58 100644
--- a/data/yoinkrc
+++ b/data/yoinkrc
@@ -1,70 +1,82 @@
 
 -- Example Yoink Configuration File
--- vim: ft=lua
+-- vim: ft=lua ts=4
 
-print "loading yoinkrc..."
+print "loading default settings..."
 
 
 -- Set the level of detail to use when drawing scenes.  This can be 1, 2 or
 -- 3, where 1 shows the least amount of detail and 3 draws the scene with
--- the most detail.
+-- the most detail.  Lower levels of detail may improve performance on
+-- slower machines.
 
-detail = 3
+detail			= 3
 
--- Set 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 higher cause the CPU to do less
--- work, but accuracy will suffer.  Errors could be introduced in the game
--- with extremely high values.
+-- Set the number of times each second the physics state will be updated.
+-- The quality of the physics simulation will increase as you increase this
+-- value, but the processor will be taxed more.  Errors could be introduced
+-- in the game with extremely low values.
 
-timestep = 0.01
+timestep		= 80
 
--- Set the maximum number of frames that can be drawn per second.  A value
--- of 50 is pretty good.  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.
+-- Set the target number of frames that should be drawn per second.  The
+-- smoothness of the animation increases as you increase this value.  You
+-- probably want to set this somewhere in the 25-85 range, depending on how
+-- much work you want your computer to do.  For example, if you're on
+-- battery power, you might prefer 25 which is still reasonably smooth and
+-- will decrease battery drain significantly.  You can also set this to a
+-- very high number to effectively draw as many frames as possible, but
+-- your actual framerate might be limited by the refresh rate of your
+-- display--use the swapcontrol setting to enable or disable this behavior.
+-- You can determine your actual framerate with the showfps option.
 
-maxfps = 45
+framerate		= 50
 
--- Set whether or not to print the current actual framerate to the console.
+-- Set this to print the current actual framerate to the console each
+-- second.
 
-printfps = false
+showfps			= false
 
--- Set whether or not the game will run in full-screen mode.  If false, the
--- game will run in a window.
+-- Set this to run the game in full-screen mode.  The default behavior is
+-- to run the game in a window.
 
-fullscreen = false
+fullscreen		= false
 
--- If the game is running in a window, set whether or not the window will
--- be resizable.
+-- If the game is running in a window, set this to also make the window
+-- resizable.  This has no effective if the fullscreen option is true.
 
-resizable = true
+resizable		= true
 
--- Set 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 for a size of
--- 800x600 pixels with millions of colors (the third number is optional).
+-- Set the screen 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.  If the fullscreen option is set, the
+-- default behavior is to pick a native resolution.  Otherwise, the game
+-- window will default to 800x600.
 
-videomode = {1024, 786}
+videomode		= {800, 600}
 
--- Set whether or not the cursor will be visible when you mouse over the
--- display of the game.
+-- Set this to make the cursor remain visible as you mouse over the view of
+-- the game.
 
-showcursor = true
+showcursor		= true
 
--- Set whether or not the drawing should use two buffers.  This results in
--- a higher quality animation.  You should usually leave this as true.
+-- Set this to use double-buffering to improve animation quality.  You
+-- should usually leave this as true.
 
-doublebuffer = true
+doublebuffer	= true
 
--- Set whether or not to sync with the display in order to reduce
--- distortion.
+-- Set this to sync with the refresh rate of your display.  Your framerate
+-- will be limited to the refresh rate, but you may experience fewer ugly
+-- "artifacts" caused by the game animation.
 
-swapcontrol = true
+swapcontrol		= true
+
+-- Set the level of log detail that will be printed to the console.
+-- Possible values are:
+-- 0 print nothing
+-- 1 errors only
+-- 2 include warnings
+-- 3 print everything, including debug messages
+
+loglevel = 2