From 1612c7475d200e9b7c1ac781d2720d01d62faf7d Mon Sep 17 00:00:00 2001 From: FunkyFr3sh Date: Mon, 10 Dec 2018 12:07:43 +0100 Subject: [PATCH] try to make the settings file easier to understand --- src/settings.c | 72 ++++++++++++++++++++++++++++---------------------- 1 file changed, 41 insertions(+), 31 deletions(-) diff --git a/src/settings.c b/src/settings.c index 4bfaf3e..15cb99c 100644 --- a/src/settings.c +++ b/src/settings.c @@ -195,67 +195,72 @@ static void CreateSettingsIni() "; cnc-ddraw - https://github.com/CnCNet/cnc-ddraw - https://cncnet.org\n" "\n" "[ddraw]\n" + "; ### Optional settings ###\n" + "; Use the following settings to adjust the look and feel to your liking\n" + "\n" + "\n" "; Stretch to custom resolution, 0 = defaults to the size game requests\n" "width=0\n" "height=0\n" "\n" - "; Override width/height and always stretch to fullscreen\n" + "; Override the width/height settings shown above and always stretch to fullscreen\n" "; Note: Can be combined with 'windowed=true' to get windowed-fullscreen aka borderless mode\n" "fullscreen=false\n" "\n" - "; Bits per pixel, possible values: 16, 24 and 32, 0 = auto\n" - "bpp=0\n" - "\n" "; Run in windowed mode rather than going fullscreen\n" - "; Note: Can be combined with 'fullscreen=true' to get windowed-fullscreen aka borderless mode\n" "windowed=false\n" "\n" - "; Show window borders in windowed mode\n" - "border=true\n" - "\n" - "; Maintain aspect ratio\n" - "; Note: Works only for games that support 'handlemouse=true' (Windowed mode is an exception)\n" + "; Maintain aspect ratio - (Requires 'handlemouse=true')\n" "maintas=false\n" "\n" - "; Windowboxing / Integer Scaling\n" - "; Note: Works only for games that support 'handlemouse=true'\n" + "; Windowboxing / Integer Scaling - (Requires 'handlemouse=true')\n" "boxing=false\n" "\n" "; Real rendering rate, -1 = screen rate, 0 = unlimited, n = cap\n" + "; Note: Does not have an impact on the game speed, to limit your game speed use 'maxgameticks='\n" "maxfps=125\n" "\n" - "; Vertical synchronization, enable if you get tearing (OpenGL / Direct3D only)\n" + "; Vertical synchronization, enable if you get tearing - (Requires 'renderer=auto/opengl/direct3d9')\n" "vsync=false\n" "\n" - "; Automatic mouse sensitivity scaling\n" + "; Automatic mouse sensitivity scaling - (Requires 'handlemouse=true')\n" "; Note: Only works if stretching is enabled. Sensitivity will be adjusted according to the size of the window\n" - "; Note: Works only for games that support 'handlemouse=true'\n" "adjmouse=false\n" "\n" - "; Enable C&C video resize hack - Stretches C&C cutscenes to fullscreen\n" - "vhack=false\n" - "\n" - "; auto, opengl, gdi, direct3d9 (auto = try opengl/direct3d9, fallback = gdi)\n" - "renderer=auto\n" - "\n" - "; Force CPU0 affinity, avoids crashes/freezing, *might* have a performance impact\n" - "singlecpu=true\n" + "; Preliminary libretro shader support - (Requires 'renderer=opengl') https://github.com/libretro/glsl-shaders\n" + "; Example: shader=Shaders\\crt-lottes-fast-no-warp.glsl\n" + "shader=\n" "\n" "; Window position, -32000 = center to screen\n" "posX=-32000\n" "posY=-32000\n" "\n" - "; Hide WM_ACTIVATEAPP messages to prevent problems on alt+tab\n" - "noactivateapp=false\n" + "; Renderer, possible values: auto, opengl, gdi, direct3d9 (auto = try direct3d9/opengl, fallback = gdi)\n" + "renderer=auto\n" "\n" "; Developer mode (don't lock the cursor)\n" "devmode=false\n" "\n" - "; Preliminary libretro shader support (OpenGL only) https://github.com/libretro/glsl-shaders\n" - "; Example: shader=Shaders\\crt-lottes-fast-no-warp.glsl\n" - "shader=\n" + "; Show window borders in windowed mode\n" + "border=true\n" "\n" - "; Max game ticks per second, possible values: 0-1000 (Can be used to slow down a too fast running game)\n" + "; Bits per pixel, possible values: 16, 24 and 32, 0 = auto\n" + "bpp=0\n" + "\n" + "; Enable C&C video resize hack - Stretches C&C cutscenes to fullscreen\n" + "vhack=false\n" + "\n" + "\n" + "\n" + "; ### Compatibility settings ###\n" + "; Use the following settings in case there are any issues with the game\n" + "\n" + "\n" + "; Hide WM_ACTIVATEAPP messages to prevent problems on alt+tab\n" + "noactivateapp=false\n" + "\n" + "; Max game ticks per second, possible values: 0-1000\n" + "; Note: Can be used to slow down a too fast running game, fix flickering or too fast animations\n" "maxgameticks=0\n" "\n" "; Gives cnc-ddraw full control over the mouse cursor (required for adjmouse/boxing/maintas)\n" @@ -263,12 +268,17 @@ static void CreateSettingsIni() "handlemouse=true\n" "\n" "; Use Waitable Timer Objects rather than timeGetTime+Sleep to limit FPS/Ticks/Flip\n" - "; Note: Can introduce a different type of tearing and stuttering in windowed mode\n" "; Note: To workaround tearing/stuttering problems, set maxfps 1 lower than screen refresh rate (59 for flip games)\n" "accuratetimers=false\n" "\n" + "; Force CPU0 affinity, avoids crashes/freezing, *might* have a performance impact\n" + "singlecpu=true\n" + "\n" + "\n" + "\n" + "; ### Game specific settings ###\n" + "; The following settings override all settings shown above, section name = executable name\n" "\n" - "; Game specific settings - The following settings override all settings above, section name = executable name\n" "\n" "; Carmageddon\n" "[CARMA95]\n"