Merge pull request #819 from cfcohen/settings_documentation

Settings documentation

files/settings-default.cfg

@@ -1,242 +1,341 @@
-# WARNING: Editing this file might have no effect, as these
+# WARNING: If this file is named settings-default.cfg, then editing
-# settings are overwritten by your user settings file.
+# this file might have no effect, as these settings may be overwritten
+# by your user settings.cfg file (see documentation for its location).
+#
+# This file provides minimal documentation for each setting, and
+# ranges of recommended values.  For detailed explanations of the
+# significance of each setting, interaction with other settings, hard
+# limits on value ranges and more information in general, please read
+# the detailed documentation at the OpenMW Wiki page:
+# 
+#   https://wiki.openmw.org/index.php?title=Settings
+#
 
-[Video]
+[Camera]
-resolution x = 800
-resolution y = 600
 
-fullscreen = false
+# Near clipping plane (>0.0, e.g. 0.01 to 18.0).
-window border = true
+near clip = 5.0
-screen = 0
 
-# Minimize the window if it loses key focus?
+# Cull objects smaller than one pixel.
-minimize on focus loss = true
+small feature culling = true
 
-# Valid values: 0 for no antialiasing, or any power of two
+# Maximum visible distance (e.g. 2000.0 to 6666.0).  Caution: this setting
-antialiasing = 0
+# can dramatically affect performance, see documentation for details.
+viewing distance = 6666.0
 
-vsync = false
+[Cells]
 
-gamma = 1.00
+# Adjacent exterior cells loaded (>0). Caution: this setting can
-contrast = 1.00
+# dramatically affect performance, see documentation for details.
+exterior cell load distance = 1
 
-# Maximum framerate in frames per second, 0 = unlimited
+[Map]
-framerate limit = 0
+
+# Size of each exterior cell in pixels in the world map. (e.g. 12 to 24).
+# Warning: affects explored areas in save files, see documentation.
+global map cell size = 18
+
+# Zoom level in pixels for HUD map widget.  64 is one cell, 128 is 1/4
+# cell, 256 is 1/8 cell.  See documentation for details. (e.g. 64 to 256).
+local map hud widget size = 256
+
+# Resolution of local map in GUI window in pixels.  See documentation
+# for details which may affect cell load performance. (e.g. 128 to 1024).
+local map resolution = 256
+
+# Size of local map in GUI window in pixels.  (e.g. 256 to 1024).
+local map widget size = 512
 
 [GUI]
+
+# Scales GUI window and widget size. (<1.0 is smaller, >1.0 is larger).
 scaling factor = 1.0
 
-# 1 is fully opaque
+# Transparency of GUI windows (0.0 to 1.0, transparent to opaque).
 menu transparency = 0.84
 
-# 0 - instantly, 1 - max. delay
+# Time until tool tip appears when hovering over an object (0.0 is
-tooltip delay = 0
+# instantly, 1.0 is the maximum delay of about 1.5 seconds).
+tooltip delay = 0.0
+
+# Stretch menus, load screens, etc. to the window aspect ratio.
+stretch menu background = false
 
+# Subtitles for NPC spoken dialog and some sound effects.
 subtitles = false
 
+# Red flash visually showing player damage.
 hit fader = true
+
+# Werewolf overlay border around screen or window.
 werewolf overlay = true
 
-stretch menu background = false
+# Color for tool tips and crosshair when owned by an NPC (R G B A).
+color background owned = 0.15 0.0 0.0 1.0
+color crosshair owned = 1.0 0.15 0.15 1.0
 
-# colour definitions (red green blue alpha)
+[HUD]
-color background owned = 0.15 0 0 1
-color crosshair owned = 1 0.15 0.15 1
 
-[General]
+# Displays the crosshair or reticle when not in GUI mode.
-# Camera field of view
+crosshair = true
-field of view = 55
+
+[Game]
+
+# Color crosshair and tool tip when object is owned by an NPC. (O is
+# no color, 1 is tool tip only, 2 is crosshair only, and 3 is both).
+show owned = 0
 
-# Texture filtering mode. valid values:
+# Always use the best mode of attack: e.g. chop, slash or thrust.
-# bilinear
+best attack = false
-# trilinear
+
-texture filtering =
+# Difficulty.  Expressed as damage dealt and received. (e.g. -100 to 100).
+difficulty = 0
+
+# Show duration of magic effect and lights in the spells window.
+show effect duration = false
+
+[General]
 
+# Anisotropy reduces distortion in textures at low angles (e.g. 0 to 16).
 anisotropy = 4
 
+# Camera field of view in degrees (e.g. 30.0 to 110.0).
+field of view = 55.0
+
+# File format for screenshots.  (jpg, png, tga, and possibly more).
 screenshot format = png
 
-[Shadows]
+# Isotropic texture filtering.  (bilinear or trilinear).
-# Shadows are only supported when object shaders are on!
+texture filtering = trilinear
-enabled = false
 
-# Split the shadow maps, allows for a larger shadow distance
+[Input]
-split = false
 
-# Increasing shadow distance will lower the shadow quality.
+# Capture control of the cursor prevent movement outside the window.
-# Uses "shadow distance" or "split shadow distance" depending on "split" setting.
+grab cursor = true
-shadow distance = 1300
-# This one shouldn't be too low, otherwise you'll see artifacts. Use at least 2x max viewing distance.
-split shadow distance = 14000
 
-# Size of the shadow textures, higher means higher quality
+# Key controlling sneak toggles setting instead of being held down.
-texture size = 1024
+toggle sneak = false
 
-# Turn on/off various shadow casters
+# Player is running by default.
-actor shadows = true
+always run = false
-misc shadows = true
-statics shadows = true
-terrain shadows = true
 
-# Fraction of the total shadow distance after which the shadow starts to fade out
+# Zoom in and out from player in third person view with mouse wheel.
-fade start = 0.8
+allow third person zoom = false
 
-debug = false
+# Camera sensitivity when not in GUI mode. (>0.0, e.g. 0.1 to 5.0).
+camera sensitivity = 1.0
 
-[HUD]
+# Vertical camera sensitivity multiplier when not in GUI mode.
-crosshair = true
+# (>0.0, Because it's a multiplier values should be near 1.0)
+camera y multiplier = 1.0
 
-[Objects]
+# Invert the vertical axis while not in GUI mode.
-shaders = true
+invert y axis = false
 
-[Map]
+[Saves]
-# Adjusts the scale of the global map
-global map cell size = 18
 
-local map resolution = 256
+# Name of last character played, and default for loading save files.
+character =
 
-local map widget size = 512
+# Automatically save the game whenever the player rests.
-local map hud widget size = 256
+autosave = true
 
-[Cells]
+# Display the time played on each save file in the load menu.
-exterior cell load distance = 1
+timeplayed = false
 
-[Camera]
+[Sound]
-near clip = 5
 
-# The maximum distance with no pop-in will be: (see RenderingManager::configureFog)
+# Name of audio device file.  Blank means use the default device.
-# viewing distance * view frustum factor <= cell size (8192) - loading threshold (1024)
+device =
-# view frustum factor takes into account that the view frustum end is a plane, so at the edges of the screen you can see further than you should be able to.
-# exact factor would depend on FOV
-viewing distance = 6666
 
-# Culling of objects smaller than a pixel
+# Volumes are 0.0 for silent and 1.0 for the maximum volume.
-small feature culling = true
 
-[Terrain]
+# Master volume.  Controls all other volumes.
-distant land = false
+master volume = 1.0
 
-shader = true
+# Footsteps volume.
+footsteps volume = 0.2
+
+# Music tracks volume.
+music volume = 0.5
+
+# Sound effects volume.
+sfx volume = 1.0
+
+# Voice dialog volume.
+voice volume = 0.8
+
+[Video]
+
+# Resolution of the OpenMW window or screen.
+resolution x = 800
+resolution y = 600
+
+# OpenMW takes complete control of the screen.
+fullscreen = false
+
+# Determines which screen OpenMW is on.  (>=0).
+screen = 0
+
+# Minimize OpenMW if it loses cursor or keyboard focus.
+minimize on focus loss = true
+
+# An operating system border is drawn around the OpenMW window.
+window border = true
+
+# Anti-aliasing reduces texture distortion.  (0, 2, 4, 8, 16).
+antialiasing = 0
+
+# Enable vertical syncing to reduce tearing defects.
+vsync = false
+
+# Maximum frames per second. 0.0 is unlimited, or >0.0 to limit.
+framerate limit = 0.0
+
+# Game video contrast.  (>0.0).  No effect in Linux.
+contrast = 1.0
+
+# Video gamma setting.  (>0.0).  No effect in Linux.
+gamma = 1.0
 
 [Water]
+
+# Enable water shader with reflections and optionally refraction.
 shader = false
 
+# Reflection and refraction texture size in pixels. (512, 1024, 2048).
+rtt size = 512
+
+# Enable refraction which affects visibility through water plane.
 refraction = false
 
-rtt size = 512
+[Objects]
 
-[Sound]
+# Enable shaders for objects other than water. Unused.
-# Device name. Blank means default
+shaders = true
-device =
 
-# Volumes. master volume affects all other volumes.
+[Terrain]
-master volume = 1.0
-sfx volume = 1.0
-music volume = 0.5
-footsteps volume = 0.2
-voice volume = 0.8
 
+# Use shaders for terrain?  Unused.
+shader = true
 
-[Input]
+# Distant land is rendered?  Unused.
+distant land = false
 
-grab cursor = true
+[Shadows]
 
-invert y axis = false
+# Enable shadows. Other shadow settings disabled if false. Unused.
+enabled = false
 
-camera sensitivity = 1.0
+# Size of the shadow textures in pixels.  Unused.  (e.g. 256 to 2048).
+texture size = 1024
 
-camera y multiplier = 1.0
+# Actors cast shadows.  Unused.
+actor shadows = true
 
-always run = false
+# Static objects cast shadows.  Unused.
+statics shadows = true
 
-allow third person zoom = false
+# Terrain cast shadows.  Unused.
+terrain shadows = true
 
-toggle sneak = false
+# Miscellaneous objects cast shadows.  Unused.
+misc shadows = true
 
-[Game]
+# Debugging of shadows.  Unused.
-# Always use the most powerful attack when striking with a weapon (chop, slash or thrust)
+debug = false
-best attack = false
 
-difficulty = 0
+# Fraction of distance after which shadow starts to fade out.  Unused.
+fade start = 0.8
 
-# Change crosshair/toolTip color when pointing on owned object
+# Split shadow maps, allowing for a larger shadow distance.  Unused.
-#0: nothing changed
+split = false
-#1: tint toolTip
-#2: tint crosshair
-#3: both
-show owned = 0
-# Show the remaining duration of magic effects and lights
-show effect duration = false
 
-[Saves]
+# Distance for shadows if not split.  Smaller is poorer. Unused.
-character =
+shadow distance = 1300
-# Save when resting
+
-autosave = true
+# Distance for shadows if split.  Unused.
-# display time played
+split shadow distance = 14000
-timeplayed = false
 
 [Windows]
-inventory x = 0
+
+# Location and sizes of windows as a fraction of the OpenMW window or
+# screen size. (0.0 to 1.0).  X & Y, Width & Height.
+
+# Stats window displaying level, race, class, skills and stats.
+stats x = 0.0
+stats y = 0.0
+stats w = 0.375
+stats h = 0.4275
+
+# Spells window displaying powers, spells, and magical items.
+spells x = 0.625
+spells y = 0.5725
+spells w = 0.375
+spells h = 0.4275
+
+# Local and world map window.
+map x = 0.625
+map y = 0.0
+map w = 0.375
+map h = 0.5725
+
+# Dialog window for talking with NPCs.
+dialogue x = 0.095
+dialogue y = 0.095
+dialogue w = 0.810
+dialogue h = 0.810
+
+# Alchemy window for crafting potions.
+alchemy x = 0.25
+alchemy y = 0.25
+alchemy w = 0.5
+alchemy h = 0.5
+
+# Console command window for debugging commands.
+console x = 0.0
+console y = 0.0
+console w = 1.0
+console h = 0.5
+
+# Player inventory window when explicitly opened.
+inventory x = 0.0
 inventory y = 0.4275
 inventory w = 0.6225
 inventory h = 0.5725
 
-inventory container x = 0
+# Player inventory window when searching a container.
+inventory container x = 0.0
 inventory container y = 0.4275
 inventory container w = 0.6225
 inventory container h = 0.5725
 
-inventory barter x = 0
+# Player inventory window when bartering with a shopkeeper.
+inventory barter x = 0.0
 inventory barter y = 0.4275
 inventory barter w = 0.6225
 inventory barter h = 0.5725
 
-inventory companion x = 0
+# Player inventory window when trading with a companion.
+inventory companion x = 0.0
 inventory companion y = 0.4275
 inventory companion w = 0.6225
 inventory companion h = 0.5725
 
+# Container inventory when searching a container.
 container x = 0.25
-container y = 0
+container y = 0.0
 container w = 0.75
 container h = 0.375
 
-companion x = 0.25
+# NPC inventory window when bartering with a shopkeeper.
-companion y = 0
-companion w = 0.75
-companion h = 0.375
-
-map x = 0.625
-map y = 0
-map w = 0.375
-map h = 0.5725
-
 barter x = 0.25
-barter y = 0
+barter y = 0.0
 barter w = 0.75
 barter h = 0.375
 
-alchemy x = 0.25
+# NPC inventory window when trading with a companion.
-alchemy y = 0.25
+companion x = 0.25
-alchemy w = 0.5
+companion y = 0.0
-alchemy h = 0.5
+companion w = 0.75
-
+companion h = 0.375
-stats x = 0
-stats y = 0
-stats w = 0.375
-stats h = 0.4275
-
-spells x = 0.625
-spells y = 0.5725
-spells w = 0.375
-spells h = 0.4275
-
-console x = 0
-console y = 0
-console w = 1
-console h = 0.5
-
-dialogue h = 0.810
-dialogue w = 0.810
-dialogue x = 0.095
-dialogue y = 0.095