further implementing runloop support

[chaz/yoink] / data / yoinkrc

diff --git a/data/yoinkrc b/data/yoinkrc
index f6f362cbeedb0d88403317c000cd0293d70ef0bd..1d58bef8df8a83cab188e51435777995635428cc 100644 (file)
--- a/data/yoinkrc
+++ b/data/yoinkrc
@@ -1,6 +1,5 @@
 
 -- Example Yoink Configuration File
--- ex:ft=lua ts=4 sw=4 tw=75
 
 print "loading default settings..."
 
@@ -17,23 +16,22 @@ detail                      = 3
 -- value, but the processor will be taxed more.  Errors could be introduced
 -- in the game with extremely low values.
 
-timestep               = 80
+timestep               = 100
 
 -- 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
+-- probably want to set this somewhere in the 25-200 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.
+-- will decrease battery drain significantly.  You can also set this to an
+-- arbitrarily 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.
 
-framerate              = 50
+framerate              = timestep
 
--- Set this to print the current actual framerate to the console each
--- second.
+-- Set this to show the current frames per second in the window caption.
 
 showfps                        = false
 
@@ -43,23 +41,17 @@ showfps                     = false
 fullscreen             = false
 
 -- 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.  This has no effective if the fullscreen option is set.
 
 resizable              = true
 
--- 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.  You can use the
--- videomode to override the default resolution.  If the fullscreen option
--- is false, videomode will determine the size of the window.
+-- Set the display resolution or size of the viewing window.  If left at
+-- the default value (a function), the video mode will only be set if we're
+-- not in fullscreen.  That way, a native resolution will be used.
 
---videomode            = {800, 600}
-
--- Set this to make the cursor remain visible as you mouse over the video
--- output of the game.
-
-showcursor             = false
+videomode              = function()
+       if not fullscreen then return {800, 600} end
+end
 
 -- Set this to use double-buffering to improve animation quality.  You
 -- really don't want to turn this off.
@@ -74,12 +66,16 @@ doublebuffer        = true
 
 swapcontrol            = true
 
--- Set the level of log detail that will be printed to the console.
+-- Set the level of log detail that will be output to the console.
 -- Possible values are:
--- 0 print nothing
--- 1 errors only
--- 2 include warnings
--- 3 print everything, including debug messages
+--   0 nothing
+--   1 errors
+--   2 warnings
+--   3 info
+--   4 debug messages
 
 loglevel               = 2
 
+
+-- vi:ft=lua ts=4 sw=4 tw=75
+