From 9b92a7bc14bc6699310b0876ae19bfc3021e4b3d Mon Sep 17 00:00:00 2001
From: Jonas Kulla <Nyocurio@gmail.com>
Date: Wed, 15 Jan 2014 03:20:05 +0100
Subject: [PATCH] Documentation: Move mkxp.conf description into sample conf

---
 README.md        |  21 +-------
 mkxp.conf.sample | 128 ++++++++++++++++++++++++++++++++++++++++++-----
 2 files changed, 116 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index fd2ecb1..9e6f12e 100644
--- a/README.md
+++ b/README.md
@@ -63,26 +63,7 @@ To run mkxp, you should have a graphics card capable of at least **OpenGL 2.0**
 
 ## Configuration
 
-mkxp reads configuration data from the file "mkxp.conf" contained in the current directory. The format is ini-style. Do *not* use quotes around file paths (spaces won't break). Lines starting with '#' are comments. Following entries are interpreted:
-
-| Key              | Type   | Default | Description                                                                     |
-| ---------------- | ------ | ------- | ------------------------------------------------------------------------------- |
-| debugMode        | bool   | false   | Log OpenGL debug information to the console                                     |
-| winResizable     | bool   | false   | Game window is resizable                                                        |
-| fullscreen       | bool   | false   | Start game in fullscreen (this can always be toggled with Alt-Enter at runtime) |
-| fixedAspectRatio | bool   | true    | Don't stretch the game screen to fit the window size                            |
-| smoothScaling    | bool   | false   | Apply linear interpolation when game screen is stretched                        |
-| vsync            | bool   | false   | Sync screen redraws to the monitor refresh rate                                 |
-| defScreenW       | int    | 640     | Width the game window starts in (this is **not** the game resolution)           |
-| defScreenH       | int    | 480     | Height the game window starts in                                                |
-| fixedFramerate   | int    | 0       | FPS will be fixed to this amount. Ignored if 0.                                 |
-| frameSkip        | bool   | true    | Skip frames to catch up (useful to disable eg. with Valgrind)                   |
-| solidFonts       | bool   | false   | Don't use alpha blending for fonts                                              |
-| gameFolder       | string | "."     | mkxp will look for all game related files here                                  |
-| allowSymlinks    | bool   | false   | Allow symlinks to be followed in the game folder.                               |
-| pathCache        | bool   | true    | Scan and cache asset paths at startup. Allows for case insensitive paths.       |
-| customScript     | string | ""      | Execute a raw ruby script file instead of an RPG Maker game.                    |
-| RTP              | string | ""      | Path to a Run Time Package to be used. Can be specified multiple times.         |
+mkxp reads configuration data from the file "mkxp.conf" contained in the current directory. The format is ini-style. Do *not* use quotes around file paths (spaces won't break). Lines starting with '#' are comments. See 'mkxp.conf.sample' for a list of accepted entries.
 
 ## RTPs
 
diff --git a/mkxp.conf.sample b/mkxp.conf.sample
index dbf9f5d..11fb146 100644
--- a/mkxp.conf.sample
+++ b/mkxp.conf.sample
@@ -1,13 +1,115 @@
-# This is a comment
-debugMode=false
-winResizable=false
-fullscreen=false
-fixedAspectRatio=true
-smoothScaling=false
-vsync=false
-defScreenW=640
-defScreenH=480
-solidFonts=false
-gameFolder=.
-customScript=
-RTPs=
+# Lines starting with '#' are comments
+
+# Create a debug context and log
+# OpenGL debug information to the console
+# (default: disabled)
+#
+# debugMode=false
+
+
+# Game window is resizable
+# (default: disabled)
+#
+# winResizable=false
+
+
+# Start game in fullscreen (this can
+# always be toggled with Alt-Enter at runtime)
+# (default: disabled)
+#
+# fullscreen=false
+
+
+# Preserve game screen aspect ratio,
+# as opposed to stretch-to-fill
+# (default: enabled)
+#
+# fixedAspectRatio=true
+
+
+# Apply linear interpolation when game screen
+# is upscaled
+# (default: disabled)
+#
+# smoothScaling=false
+
+
+# Sync screen redraws to the monitor refresh rate
+# (default: disabled)
+#
+# vsync=false
+
+
+# Create the window with 640 in width at startup
+#
+# defScreenW=640
+
+
+# Create the window with 480 in height at startup
+#
+# defScreenH=480
+
+
+# Enforce a static frame rate
+# (0 = disabled)
+#
+# fixedFramerate=0
+
+
+# Skip (don't draw) frames when behind
+# (default: enabled)
+#
+# frameSkip=true
+
+
+# Don't use alpha blending when rendering text
+# (default: disabled)
+#
+# solidFonts=false
+
+
+# Set the base path of the game to '/path/to/game'
+# (default: executable directory)
+#
+# gameFolder=/path/to/game
+
+
+# Use either right or left Alt + Enter to toggle
+# fullscreen
+# (default: disabled)
+# 
+# anyAltToggleFS=false
+
+
+# Allow symlinks for game assets to be followed
+# (default: disabled)
+#
+# allowSymlinks=false
+
+
+# Set the game window icon to 'path/to/icon.png'
+# (default: none)
+#
+# iconPath=/path/to/icon.png
+
+
+# Instead of playing an RPG Maker game,
+# execute a single plain text script instead
+# (default: none)
+#
+# customScript=/path/to/script.rb
+
+
+# Index all accesible assets via their lower case path
+# (emulates windows case insensitivity)
+# (default: enabled)
+#
+# pathCache=true
+
+# Add 'rtp1', 'rtp2.zip' and 'game.rgssad' to the
+# asset search path (multiple allowed)
+# (default: none)
+#
+# RTP=/path/to/rtp1
+# RTP=/path/to/rtp2.zip
+# RTP=/path/to/game.rgssad