update video methods

[chaz/yoink] / data / yoinkrc

diff --git a/data/yoinkrc b/data/yoinkrc
index 102848be7ada9c71c84c191eed8c0bd18bbd4841..6698018a1805cf76d9fef29b595a9c19c86c6bb7 100644 (file)
--- a/data/yoinkrc
+++ b/data/yoinkrc
@@ -1,16 +1,87 @@
-/* C-style comments are allowed. */
-{
-       "video.fullscreen": false,
-       "video.resizable": true,
-       "video.mode": [800, 600],
-       "video.colorbuffers": [8, 8, 8, 8],
-       "video.multisamplebuffers": 6,
-       "video.multisamplesamples": 6,
-       "video.cursor": true,
-       "input.grab": false,
-       "video.doublebuffer": true,
-       "video.swapcontrol": true,
-       "video.maxfps": 45,
-       "video.printfps": true,
-       "engine.timestep": 0.01
-}
+
+-- Example Yoink Configuration File
+
+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.  Lower levels of detail may improve performance on slower
+-- machines.
+
+detail         = 3
+
+-- 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       = 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-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 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      = 60
+
+-- Set this to show the current frames per second in the window caption.
+
+showfps                = false
+
+-- Set this to run the game in full-screen mode.  The default behavior is to
+-- run the game in a window.
+
+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 set.
+
+resizable      = true
+
+-- 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      = 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.
+
+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 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    = false
+
+-- Set this to the number of FSAA samples to perform.  This will smooth out
+-- jagged lines but may reduce framerates on slow hardware.  Possible values
+-- depend on your video card and drivers, but typical values include 1, 2, 4,
+-- and higher powers of two.  Set to 0 to disable FSAA.
+
+multisamples   = 0
+
+-- Set the level of log detail that will be output to the console.  Possible
+-- values are:
+--   0 nothing
+--   1 errors
+--   2 warnings
+--   3 info
+--   4 debug messages
+
+loglevel       = 2
+
+
+-- vi:ft=lua
+