Documentation for v0.2a completed.

Docs/README.txt

@@ -1,9 +1,3 @@
-TODO: Proof source code
-TODO: if Nik adds MSVC project files, mention that first in compiling section
-TODO: discussion of missing input settings in index: saturation, dead zone, analog/digital sensitivity, etc. All missing now.
-TODO: input stuff to be written in section 12
-TODO: final proof read, then convert all tabs to spaces
-TODO: don't forget to add date to revision history!
  
  
   ####                                                      ###           ###
@@ -373,9 +367,9 @@ configuration file, described elsewhere in this document.
 
 Please keep in mind that MPEG music emulation is preliminary and the decoder is
 buggy.  Periodic squeaks and pops occur on many music tracks.  The Sega Custom
-Sound Processor (SCSP) emulator, used for sound emulation, is an older version
+Sound Processor (SCSP) emulator, used for sound emulation, is also still quite 
-of ElSemi's code and also quite buggy.  Sound glitches are known to occur now
+buggy.  Sound glitches are known to occur now and then, and many sounds and 
-and then, and many sounds and tunes do not sound quite correct yet.
+tunes do not sound quite correct yet.
 
 
 ===============
@@ -590,8 +584,9 @@ Common input-related problems are discussed below.
         Unable to select a particular joysick axis when configuring a mapping.
 
     Solution:
-   		- This may mean that the joystick axis needs calibrating.  This can be done by pressing
+        This may mean that the joystick axis needs calibrating.  This can be
-		  'b' on the configuration screen and following the instructions.
+        done by pressing 'b' on the configuration screen and following the 
+        instructions.
 
     ---------
     
@@ -601,7 +596,7 @@ Common input-related problems are discussed below.
     Solution:
         For some steering wheels where the pedals have been configured in a 
         'split axis' mode (ie. not sharing a combined axis), the values that 
-   		the pedals send are inverted.  This means that without configuration
+        the pedals send are inverted.  This means that without configuration,
         Supermodel will be unable to recognize them.  To fix this, they should
         be calibrated on the calibration screen in the same way as above.
 
@@ -867,11 +862,12 @@ names and their arguments are case sensitive.  They take the form:
     
 Only one setting per line is allowed.  Only two types of arguments are allowed:
 integers and strings.  The choice of which to use is determined by the setting.
-Integers are unsigned and begin at 0.  Strings can contain any characters and 
+Integers can be negative.  Strings can contain any characters and are enclosed
-are enclosed by double quotes.  Examples:
+by double quotes.  Examples:
 
     IntegerSetting1 = 0
     IntegerSetting2 = 65536
+    IntegerSetting3 = -32768
     StringSetting1 = "This is a string."
     StringSetting2 = "123"
     StringSetting3 = "1+1, abc, these are all valid characters!"
@@ -1766,6 +1762,90 @@ All settings are case sensitive.
                     automatically reload (no need to pull the trigger).  Can 
                     only be set in the 'Global' section.
                     
+    ----------------
+    
+    Name:           InputKeySensitivity
+    
+    Argument:       Integer.
+    
+    Description:    The rate at which analog control values increase/decrease
+                    when controlled by a key.  Valid range is 1-100, with 1
+                    being the least sensitive (slowest response).  The default
+                    is 25.  Can only be set in the 'Global' section.
+                    
+    ----------------
+    
+    Name:           InputKeyDecaySpeed
+    
+    Argument:       Integer.
+    
+    Description:    The rate at which analog control values return to their
+                    rest or 'off' position after a key has been released.  The
+                    value is expressed as a percentage of the attack speed,
+                    ranging from 1-200.  The default is 50, meaning analog
+                    controls take twice as long to return to their rest state
+                    as they do to reach their minimum/maximum values.  Can only
+                    be set in the 'Global' section.
+    
+    ----------------
+    
+    Name:           InputMouseXDeadZone
+                    InputMouseYDeadZone
+    
+    Argument:       Integer.
+    
+    Description:    Specifies a rectangular region in the center of the display
+                    within which the mouse is considered inactive.  Expressed
+                    as percentages, from 0-99, of the width and height of the
+                    display.  The default values are 0, which disable this
+                    option.  Can only be set in the 'Global' section.
+                    
+    ----------------
+    
+    Name:           InputJoy**DeadZone
+    
+    Argument:       Integer.
+    
+    Description:    '**' must be the joystick number and axis (eg. '1X', '2RZ',
+                    etc.).  If the joystick number is omitted, the setting will
+                    apply to all joysticks.  Specifies the dead zone as a
+                    percentage, 0-99, of the total range of the axis.  Within
+                    the dead zone, the joystick is inactive.  This is useful
+                    for joysticks that are 'noisy' when at rest.  Can only be
+                    set in the 'Global' section.
+                    
+    ----------------
+    
+    Name:           InputJoy**Saturation
+    
+    Argument:       Integer.
+    
+    Description:    '**' must be the joystick number and axis (eg. '1X', '2RZ',
+                    etc.).  If the joystick number is omitted, the setting will
+                    apply to all joysticks.  Specifies the saturation, the 
+                    position at which the joystick is interpreted as being in
+                    its most extreme position, as a percentage of the total 
+                    range of the axis, from 0-200.  Values exceeding 100% mean
+                    the axis will not use its full range.  A value of 200 means
+                    that the range will be halved (fully pressed will only 
+                    register as 50%).  The default is 100, a 1-to-1 mapping.
+                    Can only be set in the 'Global' section.
+    
+    ----------------
+    
+    Name:           InputJoy**MinVal
+                    InputJoy**MaxVal
+                    InputJoy**OffVal
+    
+    Argument:       Integer.
+    
+    Description:    '**' must be the joystick number and axis (eg. '1X', '2RZ',
+                    etc.).  If the joystick number is omitted, the setting will
+                    apply to all joysticks.  Specifies the maximum, minimum, or
+                    offset value of an axis.  The range is -32768 to 32768.  By
+                    default, MinVal is -32768, OffVal is 0, and MaxVal is 
+                    32767.  Can only be set in the 'Global' section.
+    
 
 =================================
   15. Compiling the Source Code
@@ -1833,8 +1913,9 @@ we would like to thank:
     - Ville Linde, original Supermodel team member and MAMEDev extraordinaire
     - Stefano Teso, original Supermodel team member
     - ElSemi, for all sorts of technical information and insight
+    - R. Belmont, for DSB code and modified Amp library from his music player,
+      M1, and the Mac OS X port
     - Naibo Zhang, for his work on Model 3 graphics
-    - R. Belmont, for all sorts of help and the Mac OS X port
     - krom, for adding in the remaining ROM sets
     - Andrew Lewis (a.k.a. Andy Geezer), for dumping the drive board ROMs and
       providing region codes
@@ -1846,7 +1927,6 @@ we would like to thank:
       thorough play-testers
     - Charles MacDonald, for his helpful description of the System 24 tile 
       generator
-    - And of course, my sister Nicole, for help with web site images
 
 Supermodel includes code from the following projects: