home *** CD-ROM | disk | FTP | other *** search
/ Deathday Collection / dday.bin / utils / modoom10 / modoom.doc < prev    next >
Text File  |  1994-02-28  |  12KB  |  273 lines
  1. ==============================================================================
  2.   MODOOM DOCUMENTATION
  3. ==============================================================================
  4.  
  5. - Doom is a Trademark of ID Software
  6.  
  7. ==============================================================================
  8.  
  9. This program has only been tested on a limited basis.  By using it you accept
  10. full responsibility for any damages it causes.  The program uses standard DOS
  11. and C calls and should function as described below, but this is not
  12. guaranteed.  The author cannot be held responsible for any problems that arise
  13. due to its use.  There is such a wide range of computer systems and so many 
  14. configurations it is hard to tell where this program will end up or how it 
  15. will be used.  It worked as described below during our testing and did not 
  16. cause any problems.
  17.  
  18. ==============================================================================
  19.  
  20. If you find this program useful please distribute everywhere you can think of 
  21. free of charge.  You cannot charge for the program itself but you can charge 
  22. for the cost of the media it is distributed on and/or the labor involved.
  23. All files listed under MODOOM FILES must be included when distributing.
  24.  
  25. ==============================================================================
  26.  
  27. MoDoom is designed to run the Doom game over a modem by connecting two modems
  28. together and then running the SERSETUP.EXE program passing any parameters
  29. present on the MoDoom command line or in the MODOOM.CFG file.  If the config
  30. file is not present, MoDoom uses hard coded defaults that can be viewed by
  31. typing MoDoom /? on the command line.  Any parameters passed to MoDoom on
  32. the command line will override any of the same parameters in the config file.
  33.  
  34. MoDoom was created because the setup program with Doom would not work most of
  35. the time and you had to type in the settings every time you used it.
  36.  
  37.  
  38. ==================== MODOOM FILES ====================
  39.  
  40. MODOOM.DOC  - This file, MoDoom documentation
  41. MODOOM.EXE  - The MoDoom executable program
  42. MODOOM.CFG  - The MoDoom configuration file
  43. FILE_ID.DIZ - MoDoom description file
  44.  
  45.  
  46. ==================== INSTALLATION ====================
  47.  
  48. - Copy MODOOM.EXE and MODOOM.CFG into the directory containing Doom.
  49.  
  50. - Open MODOOM.CFG with any text editor and verify the commands will work with
  51.   your modem.  The settings for the config file are described under 
  52.   MODOOM.CFG SETTINGS.  They work excellent with my USRobotics 14.4 Sportster
  53.   external FAX/Modem and with my friends USRobotics 9600 Sportster internal.
  54.  
  55.  
  56. ==================== MODOOM.CFG SETTINGS ====================
  57.  
  58. - The config file keywords (i.e., ModemComPort) are case-sensitive and must 
  59.   appear exactly as shown below.
  60.  
  61. - The file can contain blank lines and comments as long as the comments do not
  62.   contain keywords.
  63.  
  64. - The following are the defaults for the config file:
  65.    Dial=0
  66.    LoadGame=-1
  67.    Episode=0
  68.    Mode=1
  69.    NoMonsters=0
  70.    Respawn=0
  71.    Skill=4
  72.    Number1=
  73.    ModemDialString=AT&F&N6&K0&M0E1V1X4S11=55S0=0
  74.    ModemAnswerString=AT&F&N6&K0&M0E1V1X4S11=55S0=2
  75.    ModemResetString=ATZ
  76.    ModemDialPrefix=ATDT
  77.    ModemComPort=2
  78.    ModemBaudRate=9600
  79.    ModemParity=0
  80.    ModemDataBits=8
  81.    ModemStopBits=1
  82.  
  83. - ModemDialString
  84.    The string sent to the modem when you will be the one to call another
  85.    Doom player.  This does not need a carriage return character (i.e., ^M or
  86.    ! or |) or pause character (i.e., ~ or a comma), but can contain the pause
  87.    character "~" or the carriage return character "|" if needed.
  88.  
  89. - ModemAnswerString
  90.    The string sent to the modem when you will be the one to answer a call 
  91.    from another Doom player.  This does not need a carriage return character
  92.    (i.e., ^M or ! or |) or pause character (i.e., ~ or a comma), but can
  93.    contain the pause character "~" or the carriage return character "|" if 
  94.    needed.
  95.  
  96. - ModemResetString
  97.    The string sent to the modem to reset to software defaults.  This should 
  98.    take the modem out of Auto-Answer mode and put in Terminal-Ready mode.  
  99.    NOTE: If you have problems with the modem not resetting correctly after 
  100.    exitting Doom, try putting one or two ~ characters right before the 
  101.    ModemResetString (i.e., ModemResetString=~~ATZ).
  102.  
  103. - ModemDialPrefix
  104.    The prefix used before dialing the number of another Doom player.  If you 
  105.    have a pulse line, you should change this to ATDP.
  106.  
  107. - ModemComPort
  108.    The serial port which your modem is on.
  109.    
  110. - ModemBaudRate
  111.    The baud rate which the port will be set to.  This does not initialize the 
  112.    modem any differently, just sets the port to that rate.
  113.    
  114. - ModemParity
  115.    The parity which the serial port will be set to.  0 means no parity. 1 
  116.    means even parity.
  117.    
  118. - ModemDataBits
  119.    The data bits which the serial port will be set to.
  120.  
  121. - ModemStopBits
  122.    The stop bits which the serial port will be set to.
  123.  
  124. - Dial
  125.    If this is set to 0, MoDoom will put your modem into Auto-Answer mode by 
  126.    using the ModemAnswerString.  If this is set to 1 thru 10 MoDoom will dial
  127.    the corresponding Number#= entry in the MODOOM.CFG file.  For example, if 
  128.    you have five numbers in the config file and the fifth reads 
  129.    "Number5=1234567" and you want to dial 1234567 just change "Dial=0" to read
  130.    "Dial=5" or run MoDoom with the /DIAL5 parameter or the /DIALNUM# 
  131.    parameter to dial a specific phone number.
  132.    
  133. - LoadGame
  134.    This entry will call SERSETUP.EXE and pass it whatever game number you have
  135.    specified.  -1 means do not load a game, in other words, don't pass 
  136.    SERSETUP.EXE the -loadgame parameter.  You can also load a game by running 
  137.    MoDoom with the /LG# parameter.
  138.    
  139. - Episode
  140.    This entry is to load a certain Doom Episode.  0 means use defaults and 
  141.    don't pass SERSETUP.EXE the -episode parameter.  For example, to load
  142.    Episode 3 change this line to read "Episode=3" or run MoDoom with the 
  143.    /EPIS3 parameter.
  144.    
  145. - Mode
  146.    This entry is to specify whether to start in cooperative or deathmatch 
  147.    mode.  0 means to use default mode (cooperative) and 1 means to use 
  148.    deathmatch mode.  You can also run MoDoom with the /COOP or /DEATH 
  149.    parameters.
  150.    
  151. - NoMonsters
  152.    This entry is used to activate the no monsters feature.  0 means disabled, 
  153.    1 means enabled.  You can also run MoDoom with the /NOMON parameter.
  154.    
  155. - Respawn
  156.    This entry is used to activate the respawn feature.  0 means disabled, 1 
  157.    means enabled.  You can also run MoDoom with the /RESP parameter.
  158.    
  159. - Skill
  160.    This entry is used to specify what skill level to start at.  0 will use 
  161.    Doom defaults (skill 1) and 1 thru 5 will use that skill level.  You can 
  162.    also run MoDoom with the /SKILL# parameter.
  163.    
  164. - Number#
  165.    These entries are used to specify the numbers of other Doom players.  You 
  166.    can have up to ten in the config file.  These lines should be after the 
  167.    Dial= entry.  Any entries above "Number10=" will be ignored but can be in 
  168.    the config file.  You can also run MoDoom with the /DIAL# parameter to 
  169.    dial an entry in the config file, or you can use the /DIALNUM# to dial a 
  170.    specific phone number.
  171.    
  172.  
  173. ==================== MODEM INITIALIZATION STRING ====================
  174.  
  175. - This seems to be a major problem point among Doom Modem players.  The 
  176.   general idea to get your modem to work with Doom is to disable data 
  177.   compression, disable error control, and set your modem to 9600bps.
  178.  
  179. - The following is a description of the commands appearing in the MODOOM.CFG 
  180.   file:
  181.  
  182.   AT     - Modem attention command
  183.   &F     - Load the read-only (non-programmable) factory settings
  184.   &N6    - Set the data rate to 9600bps
  185.   &K0    - Disable data compression
  186.   &M0    - Disable error control
  187.   E1     - Turn echo on (usually default)
  188.   V1     - Display verbal codes as opposed to numeric (usually default)
  189.   X4     - Use result code set number 4
  190.   S11=55 - Set touch-tone dialing speed to 55 milliseconds
  191.   S0=0   - Disable Auto-Answer mode
  192.   S0=2   - Enable Auto-Answer mode (modem answers after 2 rings)
  193.  
  194. - If for some reason you want to use multiple init strings in the 
  195.   configuration file, you can do so by adding the ~ (pause) character and the
  196.   | (CR/LF) character.  For example, to change the reset string to take the 
  197.   modem out of Auto-Answer mode and reset to the factory settings you would 
  198.   change ModemResetString to read "ModemResetString=ATS0=0|~~~AT&F".
  199.  
  200. - Note that MoDoom automatically puts three ~ characters at the beginning of 
  201.   the init strings and the | character at the end.  The rest of the init 
  202.   string is up to you.
  203.  
  204.  
  205. ==================== RUNNING MODOOM ====================
  206.  
  207. - The easiest way to play Doom over the modem is to call the other Doom 
  208.   player voice and one of you run MoDoom with the Auto-Answer parameters.  
  209.   Then when one of the modems is waiting for a call, hang up and have the 
  210.   other person run MoDoom with the dial parameters using the phone number of
  211.   the other player.
  212.  
  213. - To override any of the parameters in the MODOOM.CFG file, type MODOOM 
  214.   along with any parameters.  To see a list of parameters type MODOOM /? on 
  215.   the command line.
  216.   
  217. - Once MoDoom has started it will send the ModemResetString, then either the 
  218.   ModemDialString or the ModemAnswerString to your modem depending on whether 
  219.   you are the caller or the answerer.  It will then display a prompt that it 
  220.   is waiting for the modems to connect.  To abort the process just hit any key
  221.   and the modem will be reset and Doom will not be run.  Once the modems have 
  222.   connected, MoDoom will detect this, and run the SERSETUP.EXE program.  If 
  223.   either player's screen appears and it is blank or only partially there, wait
  224.   a minute or two.  If the game doesn't begin you should restart the whole 
  225.   process and try to connect again.  This has happened to us several times but
  226.   always worked the second time.  This doesn't appear to be MoDoom's fault.
  227.  
  228. - When you exit from Doom, MoDoom will attempt to reset the modem by sending
  229.   the reset string and dropping DTR.
  230.  
  231.  
  232. ==================== TROUBLE SHOOTING ====================
  233.  
  234. - When Doom runs the screen is blank or only partially there.
  235.  
  236.   If the screen doesn't redraw after a minute or two, hit ESC and quit like 
  237.   you normally do and rerun MoDoom.  Usually the second time works fine.  
  238.   This doesn't appear to be a problem with MoDoom as it happened to me 
  239.   several times before I made this program.
  240.   
  241. - Upon exiting from Doom you receive the "Resetting Modem" message but no 
  242.   modem reset commands appear on the screen and the modem does not reset.
  243.  
  244.   Try adding one or two tildes to the ModemResetString line in MODOOM.CFG.  
  245.   For example, change "ModemResetString=ATZ" to "ModemResetString=~~ATZ".
  246.  
  247. - After exiting from Doom the modem is put into Auto-Answer mode and answers 
  248.   every call.
  249.  
  250.   This happened during testing and was determined to be caused by the modem 
  251.   hardware defaulting to Auto-Answer mode and MoDoom was not dropping DTR so 
  252.   the modem was left in Auto-Answer mode.  If adding the tilde characters as 
  253.   described above doesn't work, try changing the DIP switches on your modem 
  254.   to not default to Auto-Answer mode.
  255.  
  256.  
  257. ==================== MISCELLANEOUS ====================
  258.  
  259. - A fellow Doom player and I worked for several days trying to get Doom to
  260.   work optimally over the modem.  After we created a batch file to echo
  261.   commands to the modem and tested it thoroughly, I made this program so we
  262.   could easily do what we did with the batch file.
  263.  
  264. - Hopefully others can use this program and have as much fun as we did
  265.   playing in deathmatch mode.  But maybe you can get to bed before the next
  266.   day comes.
  267.  
  268.  
  269. ==============================================================================
  270.   END OF MODOOM DOCUMENTATION
  271. ==============================================================================  
  272.  
  273.