settings subsystem now using lua

[chaz/yoink] / data / yoinkrc

diff --git a/data/yoinkrc b/data/yoinkrc
index 2faf40dc6bf0d0f2313f1bbaa35405f9cb88331d..bcb0f0645f040edee3631b1fc865e7c4a16c3427 100644 (file)
--- a/data/yoinkrc
+++ b/data/yoinkrc
@@ -1,16 +1,70 @@
-/* C-style comments are allowed. */
-{
-       "engine.timestep": 0.01,
-       "input.grab": false,
-       "video.colorbuffers": [8, 8, 8, 8],
-       "video.cursor": true,
-       "video.doublebuffer": true,
-       "video.fullscreen": false,
-       "video.maxfps": 45,
-       "video.mode": [800, 600],
-       "video.multisamplebuffers": 6,
-       "video.multisamplesamples": 6,
-       "video.resizable": true,
-       //"video.printfps": true,
-       "video.swapcontrol": true
-}
+
+-- Example Yoink Configuration File
+-- vim: ft=lua
+
+print "loading yoinkrc..."
+
+
+-- 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.
+
+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.
+
+timestep = 0.01
+
+-- 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.
+
+maxfps = 45
+
+-- Set whether or not to print the current actual framerate to the console.
+
+printfps = false
+
+-- Set whether or not the game will run in full-screen mode.  If false, the
+-- game will run in a window.
+
+fullscreen = false
+
+-- If the game is running in a window, set whether or not the window will
+-- be resizable.
+
+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).
+
+videomode = {1024, 786}
+
+-- Set whether or not the cursor will be visible when you mouse over the
+-- display of the game.
+
+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.
+
+doublebuffer = true
+
+-- Set whether or not to sync with the display in order to reduce
+-- distortion.
+
+swapcontrol = true
+