prep for runloop code

[chaz/yoink] / data / yoinkrc

diff --git a/data/yoinkrc b/data/yoinkrc
index de65603a99c3b37ebec77d24b5f1f38805b1bad9..af051b38bd1f83ec366469ee71bdb898e0d107dc 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..."
 
@@ -48,36 +47,39 @@ fullscreen          = false
 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.
+-- with three number elements representing the width, height, and
+-- (optionally) bits per pixel that make up the video mode.
 
---videomode            = {800, 600}
-
--- Set this to make the cursor remain visible as you mouse over the view of
--- the game.
-
-showcursor             = true
+if fullscreen then
+       -- In fullscreen mode, a native resolution will be picked.  You could
+       -- still set videomode if you want to use a different resolution.
+else
+       videomode       = {800, 600}
+end
 
 -- Set this to use double-buffering to improve animation quality.  You
--- should usually leave this as true.
+-- really don't want to turn this off.
 
 doublebuffer   = true
 
 -- 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.
+-- will be limited to the refresh rate, but you may experience less
+-- tearing caused by the display vertical refresh.  On the other hand, you
+-- might experience worse tearing, depending on your setup.  Try it both
+-- ways.
 
 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
+
 
-loglevel = 2
+-- vi:ft=lua ts=4 sw=4 tw=75