Merge pull request #2974 from Capostrophic/documentation

Update documentation

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

@@ -148,7 +148,8 @@ color topic enable
 :Range:		True/False
 :Default:	False
 
-Control wether additionnal formatting will be applied to dialogs topic. See 'color topic specific' and 'color topic exhausted' for details.
+This setting controls whether the topics available in the dialogue topic list are coloured according to their state.
+See 'color topic specific' and 'color topic exhausted' for details.
 
 color topic specific
 --------------------
@@ -157,11 +158,11 @@ color topic specific
 :Range:		0.0 to 1.0
 :Default:	empty
 
-This setting overrides the color of keywords in the dialogue topic window.
+This setting overrides the colour of dialogue topics that have a response unique to the actors speaking.
 The value is composed of four floating point values representing the red, green, blue and alpha channels.
 The alpha value is currently ignored.
 
-The color is overriden if the actor is about to give an answer that is unique to him (that is, dialogue with their object ID in the Actor field) that wasn't seen yet.
+A topic response is considered unique if its Actor filter field contains the speaking actor's object ID and hasn't yet been read.
 
 color topic exhausted
 ---------------------
@@ -170,8 +171,8 @@ color topic exhausted
 :Range:		0.0 to 1.0
 :Default:	empty
 
-This setting overrides the color of keywords in the dialogue topic window.
+This setting overrides the colour of dialogue topics which have been "exhausted" by the player.
 The value is composed of four floating point values representing the red, green, blue and alpha channels.
 The alpha value is currently ignored.
 
-The color is overridden if the next actor responses to the topic keyword has already been seen by the player.
+A topic is considered "exhausted" if the response the player is about to see has already been seen.

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

@@ -0,0 +1,115 @@
+Fog Settings
+############
+
+use distant fog
+---------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+This setting overhauls the behavior of fog calculations.
+
+Normally the fog start and end distance are proportional to the viewing distance
+and use the fog depth set in the fallback settings.
+
+Enabling this setting separates the fog distance from the viewing distance and fallback settings and makes fog distance
+and apparent density dependent on the weather and the current location according to the settings below.
+
+Unfortunately specific weather-dependent fog factor and offset parameters are currently hard-coded.
+They are based off the default settings of MGE XE.
+
++--------------+------------+--------+
+| Weather Type | Fog Factor | Offset |
++==============+============+========+
+| Clear        | 1.0        | 0.0    |
++--------------+------------+--------+
+| Cloudy       | 0.9        | 0.0    |
++--------------+------------+--------+
+| Foggy        | 0.2        | 0.3    |
++--------------+------------+--------+
+| Overcast     | 0.7        | 0.0    |
++--------------+------------+--------+
+| Rain         | 0.5        | 0.1    |
++--------------+------------+--------+
+| Thunderstorm | 0.5        | 0.2    |
++--------------+------------+--------+
+| Ashstorm     | 0.2        | 0.5    |
++--------------+------------+--------+
+| Blight       | 0.2        | 0.6    |
++--------------+------------+--------+
+| Snow         | 0.5        | 0.4    |
++--------------+------------+--------+
+| Blizzard     | 0.16       | 0.7    |
++--------------+------------+--------+
+
+Non-underwater fog start and end distance are calculated like this according to these parameters::
+
+	fog start distance = fog factor * (base fog start distance - fog offset * base fog end distance)
+	fog end distance = fog factor * (1.0 - fog offset) * base fog end distance
+
+Underwater fog distance is used as-is.
+
+A negative fog start distance means that the fog starts behind the camera
+so the entirety of the scene will be at least partially fogged.
+
+A negative fog end distance means that the fog ends behind the camera
+so the entirety of the scene will be completely submerged in the fog.
+
+Fog end distance should be larger than the fog start distance.
+
+This setting and all further settings can only be configured by editing the settings configuration file.
+
+distant land fog start
+----------------------
+
+:Type:		floating point
+:Range:		The whole range of 32-bit floating point
+:Default:	16384 (2 cells)
+
+This is the base fog start distance used for distant fog calculations in exterior locations.
+
+distant land fog end
+--------------------
+
+:Type:		floating point
+:Range:		The whole range of 32-bit floating point
+:Default:	40960 (5 cells)
+
+This is the base fog end distance used for distant fog calculations in exterior locations.
+
+distant underwater fog start
+----------------------------
+
+:Type:		floating point
+:Range:		The whole range of 32-bit floating point
+:Default:	-4096
+
+This is the base fog start distance used for distant fog calculations in underwater locations.
+
+distant underwater fog end
+--------------------------
+
+:Type:		floating point
+:Range:		The whole range of 32-bit floating point
+:Default:	2457.6
+
+This is the base fog end distance used for distant fog calculations in underwater locations.
+
+distant interior fog start
+--------------------------
+
+:Type:		floating point
+:Range:		The whole range of 32-bit floating point
+:Default:	0
+
+This is the base fog start distance used for distant fog calculations in interior locations.
+
+distant interior fog end
+------------------------
+
+:Type:		floating point
+:Range:		The whole range of 32-bit floating point
+:Default:	16384 (2 cells)
+
+This is the base fog end distance used for distant fog calculations in interior locations.

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

@@ -29,7 +29,7 @@ Specify the format for screen shots taken by pressing the screen shot key (bound
 This setting should be the file extension commonly associated with the desired format.
 The formats supported will be determined at compilation, but "jpg", "png", and "tga" should be allowed.
 
-This setting can only be configured by editing the settings configuration file.
+This setting can be configured in Advanced tab of the launcher.
 
 texture mag filter
 ------------------
@@ -58,4 +58,4 @@ texture mipmap
 
 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.
+by pregenerating a series of smaller textures.

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

@@ -41,6 +41,7 @@ The ranges included with each setting are the physically possible ranges, not re
 
 	camera
 	cells
+	fog
 	map
 	GUI
 	HUD