Merge pull request #1261 from rhtucker/master

Added all settings that are in settings.cfg but were not yet documented.

docs/source/reference/modding/settings/camera.rst

@@ -48,8 +48,8 @@ This value controls the maximum visible distance (also called the far clipping p
 The constant 8192 is the size of a cell, and 1024 is the threshold distance for loading a new cell. Additionally, the field of view setting also interacts with this setting because the view frustrum end is a plane, so you can see further at the edges of the screen than you should be able to. This can be observed in game by looking at distant objects and rotating the camera so the objects are near the edge of the screen. As a result, this setting should further be reduced by a factor that depends on the field of view setting. In the default configuration this reduction is 7%, hence the factor of 0.93 above. Using this factor, approximate values recommended for other exterior cell load distance settings are:
 
 ======= ========
- Cells	Viewing
- 		Distance
+Cells	Viewing
+        Distance
 =======	========
 2		14285
 3		21903

docs/source/reference/modding/settings/game.rst

@@ -66,3 +66,21 @@ show effect duration
 Show the remaining duration of magic effects and lights if this setting is true. The remaining duration is displayed in the tooltip by hovering over the magical effect.
 
 The default value is false. This setting can only be configured by editing the settings configuration file.
+
+prevent merchant equipping
+--------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+Prevents merchants from equipping items that are sold to them.
+
+followers attack on sight
+-------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+Makes player followers and escorters start combat with enemies who have started combat with them or the player. Otherwise they wait for the enemies or the player to do an attack first.

docs/source/reference/modding/settings/general.rst

@@ -23,13 +23,29 @@ Specify the format for screen shots taken by pressing the screen shot key (bound
 
 The default value is "png". This setting can only be configured by editing the settings configuration file.
 
-texture filtering
------------------
+texture mag filter
+------------------
+
+:Type:		string
+:Range:		nearest, linear
+:Default:	linear
+
+Set the texture magnification filter type.
+
+texture min filter
+------------------
 
 :Type:		string
-:Range:		bilinear, trilinear
-:Default:	trilinear
+:Range:		nearest, linear
+:Default:	linear
+
+Set the texture minification filter type.
 
-Set the isotropic texture filtering mode to bilinear or trilinear. Bilinear filtering is a texture filtering method used to smooth textures when displayed larger or smaller than they actually are. Bilinear filtering is reasonably accurate until the scaling of the texture gets below half or above double the original size of the texture. Trilinear filtering is an extension of the bilinear texture filtering method, which also performs linear interpolation between mipmaps. Both methods use mipmaps in OpenMW, and the corresponding OpenGL modes are LINEAR_MIPMAP_NEAREST and LINEAR_MIPMAP_LINEAR. Trilinear filtering produces better texturing at a minimal cost on modern video cards.
+texture mipmap
+--------------
+
+:Type:		string
+:Range:		none, nearest, linear
+:Default:	nearest
 
-The default value is trilinear. This setting can be changed in game using the Texture filtering pull down in the Detail tab of the Video panel of the Options menu.
+Set the texture mipmap type to control the method mipmaps are created. Mipmapping is a way of reducing the processing power needed during minification by pregenerating a series of smaller textures.

docs/source/reference/modding/settings/index.rst

@@ -2,28 +2,29 @@
 Advanced Settings Configuration
 ###############################
 
-This part of the guide will cover how to make modifications to the more arcane settings in OpenMW, most of which are not available from in-game menus, to optimize or customize your OpenMW experience. If you are familiar with ``.ini`` tweaks in Morrowind or the other games, this will be quite similar. All settings described in this section are changed in ``settings.cfg``, located in your OpenMW user directory. See :doc:`paths` for this location.
+This part of the guide will cover how to make modifications to the more arcane settings in OpenMW, most of which are not available from in-game menus, to optimize or customize your OpenMW experience. If you are familiar with ``.ini`` tweaks in Morrowind or the other games, this will be quite similar. All settings described in this section are changed in ``settings.cfg``, located in your OpenMW user directory. See :doc:`../paths` for this location.
 
 Although this guide attempts to be comprehensive and up to date, you will always be able to find the full list of settings available and their default values in ``settings-default.cfg`` in your main OpenMW installation directory. The ranges I have included with each setting are the physically possible ranges, not recommendations.
 
 .. warning::
-	As the title suggests, these are advanced settings. If digging around plain text files and manually editing settings sounds scary to you, you may want to stear clear of altering these files. That being said, this guide should be plenty clear enough that you can find the setting you want to change and safely edit it.
+	As the title suggests, these are advanced settings. If digging around plain text files and manually editing settings sounds scary to you, you may want to steer clear of altering these files. That being said, this guide should be plenty clear enough that you can find the setting you want to change and safely edit it.
 
 .. toctree::
-   :caption: Table of Contents
-   :maxdepth: 2
+	:caption: Table of Contents
+	:maxdepth: 2
 
-   camera
-   cells
-   map
-   GUI
-   HUD
-   game
-   general
-   input
-   saves
-   sound
-   terrain
-   video
-   water
-   windows
+	camera
+	cells
+	map
+	GUI
+	HUD
+	game
+	general
+	shaders
+	input
+	saves
+	sound
+	terrain
+	video
+	water
+	windows

docs/source/reference/modding/settings/map.rst

@@ -1,8 +1,8 @@
 Map Settings
 ############
 
-global map size
----------------
+global map cell size
+--------------------
 
 :Type:		integer
 :Range:		>= 1
@@ -10,7 +10,8 @@ global map size
 
 This setting adjusts the scale of the world map in the GUI mode map window. The value is the width in pixels of each cell in the map, so larger values result in larger more detailed world maps, while smaller values result in smaller less detailed world maps. However, the native resolution of the map source material appears to be 9 pixels per unexplored cell and approximately 18 pixels per explored cell, so values larger than 36 don't produce much additional detail. Similarly, the size of place markers is currently fixed at 12 pixels, so values smaller than this result in overlapping place markers. Values from 12 to 36 are recommended. For reference, Vvardenfell is approximately 41x36 cells.
 
-Warning: Changing this setting affects saved games. The currently explored area is stored as an image in the save file that's overlayed on the default world map in game. When you increase the resolution of the map, the overlay of earlier saved games will be scaled up on load, and appear blurry. When you visit the cell again, the overlay for that cell is regenerated at the new resolution, so the blurry areas can be corrected by revisiting all the cells you've already visited.
+.. Warning::
+	Changing this setting affects saved games. The currently explored area is stored as an image in the save file that's overlayed on the default world map in game. When you increase the resolution of the map, the overlay of earlier saved games will be scaled up on load, and appear blurry. When you visit the cell again, the overlay for that cell is regenerated at the new resolution, so the blurry areas can be corrected by revisiting all the cells you've already visited.
 
 The default value for this setting is 18. This setting can not be configured except by editing the settings configuration file.
 
@@ -27,6 +28,15 @@ Note that the actual size of the widget is always the same on the screen unless
 
 The default value for this setting is 256. This setting can not be configured except by editing the settings configuration file.
 
+local map hud fog of war
+------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+This setting enables fog of war rendering on the HUD map. Default is Off since with default settings the map is so small that the fog would not obscure anything, just darken the edges slightly.
+
 local map resolution
 --------------------
 
@@ -51,3 +61,12 @@ local map widget size
 This setting controls the canvas size of the GUI mode local map window. Larger values result in a larger physical map size on screen, and typically require more panning to see all available portions of the map. This larger size also enables an overall greater level of detail if the local map resolution setting is also increased.
 
 The default value for this setting is 512. This setting can not be configured except by editing the settings configuration file.
+
+local map cell distance
+-----------------------
+
+:Type:		integer
+:Range:		>= 1
+:Default:	1
+
+Similar to "[Cells] exterior cell load distance", controls how many cells are rendered on the local map. Values higher than the default may result in longer loading times.

docs/source/reference/modding/settings/shaders.rst

@@ -0,0 +1,101 @@
+Shader Settings
+###############
+
+force shaders
+-------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+Force rendering with shaders. By default, only bump-mapped objects will use shaders. Enabling this option may cause slightly different visuals if the "clamp lighting" option is set to false. Otherwise, there should not be a visual difference.
+
+force per pixel lighting
+------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+Force the use of per pixel lighting. By default, only bump mapped objects use per-pixel lighting. Has no effect if the 'force shaders' option is false. Enabling per-pixel lighting can result in visual differences to the original MW engine. It is not recommended to enable this option when using vanilla Morrowind files, because certain lights in Morrowind rely on vertex lighting to look as intended.
+
+clamp lighting
+--------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	True
+
+Restrict the amount of lighting that an object can receive to a maximum of (1,1,1). Only affects objects that render with shaders (see 'force shaders' option). Always affects terrain. Setting this option to 'true' results in fixed-function compatible lighting, but the lighting may appear 'dull' and there might be color shifts. Setting this option to 'false' results in more realistic lighting.
+
+auto use object normal maps
+---------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+If this option is enabled, normal maps are automatically recognized and used if they are named appropriately (see 'normal map pattern', e.g. for a base texture foo.dds, the normal map texture would have to be named foo_n.dds). If this option is disabled, normal maps are only used if they are explicitly listed within the mesh file (.nif or .osg file). Affects objects.
+
+auto use object specular maps
+-----------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+If this option is enabled, specular maps are automatically recognized and used if they are named appropriately (see 'specular map pattern', e.g. for a base texture foo.dds, the specular map texture would have to be named foo_spec.dds). If this option is disabled, normal maps are only used if they are explicitly listed within the mesh file (.osg file, not supported in .nif files). Affects objects.
+
+auto use terrain normal maps
+----------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+See 'auto use object normal maps'. Affects terrain.
+
+auto use terrain specular maps
+------------------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+If a file with pattern 'terrain specular map pattern' exists, use that file as a 'diffuse specular' map. The texture must contain the layer color in the RGB channel (as usual), and a specular multiplier in the alpha channel.
+
+normal map pattern
+------------------
+
+:Type:		string
+:Range:
+:Default:	_n
+
+The filename pattern to probe for when detecting normal maps (see 'auto use object normal maps', 'auto use terrain normal maps')
+
+normal height map pattern
+-------------------------
+
+:Type:		string
+:Range:
+:Default:	_nh
+
+Alternative filename pattern to probe for when detecting normal maps. Files with this pattern are expected to include 'height' in the alpha channel.This height is used for parallax effects. Works for both terrain and objects.
+
+specular map pattern
+--------------------
+
+:Type:		string
+:Range:
+:Default:	_spec
+
+The filename pattern to probe for when detecting object specular maps (see 'auto use object specular maps')
+
+terrain specular map pattern
+----------------------------
+
+:Type:		string
+:Range:
+:Default:	_diffusespec
+
+The filename pattern to probe for when detecting terrain specular maps (see 'auto use terrain specular maps')

docs/source/reference/modding/settings/terrain.rst

@@ -1,5 +1,5 @@
 Terrain Settings
-###############
+################
 
 distant terrain
 ---------------

docs/source/reference/modding/settings/video.rst

@@ -50,7 +50,7 @@ minimize on focus loss
 
 :Type:		boolean
 :Range:		True/False
-:Default:	False
+:Default:	True
 
 Minimize the OpenMW window if it loses cursor focus. This setting is primarily useful for single screen configurations, so that the OpenMW screen in full screen mode can be minimized when the operating system regains control of the mouse and keyboard. On multiple screen configurations, disabling this option makes it easier to switch between screens while playing OpenMW.
 

docs/source/reference/modding/settings/water.rst

@@ -42,6 +42,15 @@ This setting has no effect if the shader setting is false.
 
 The default setting is false. This setting can be toggled with the Refraction button in the Water tab of the Video panel of the Options menu.
 
+reflect actors
+--------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+This setting controls whether or not NPCs and creatures are drawn in water reflections. Setting this to true will enable actors in reflections and increase realism with a likely decrease in performance. This setting is off by default.
+
 small feature culling pixel size
 --------------------------------