home *** CD-ROM | disk | FTP | other *** search
/ The Complete Doom Accessory Pack 2 / TheCompleteDoomAccessoryPackVolumeII.iso / miscutil / rmssetup / readme.255 next >
Text File  |  1994-06-23  |  10KB  |  309 lines
  1. -----------------------------------
  2. Readme file for RMSSetup 2.5.5 BETA
  3. -----------------------------------
  4.  
  5. 23th June 1994
  6.  
  7.  
  8. ==  Notice.
  9.  
  10. RMSSetup is copyright (c) 1994 by Antony Suter.
  11.  
  12. RMSSetup is free of charge and may be freely distributed.
  13.  
  14. RMSSetup was built with the help of source code supplied free non gratis
  15. by ID Software for their serial and network drivers for DooM.
  16.  
  17. This software is written for a specific purpose, to play multiplayer DooM,
  18. and contains no code to attempt to modify or otherwise cause harm to your
  19. machine. I can not be held responsible for your machine seeming to break
  20. by your using this software.
  21.  
  22. The principals used in this software could easily be modified for use with any
  23. game or other software.
  24.  
  25.  
  26. ==  Intro.
  27.  
  28. Greetings. This is a Beta release of a driver that will allow anywhere from
  29. 2 to 4 players playing DooM over serial lines. It has been proven to work
  30. and now works well.
  31.  
  32. Current version of RMSSetup is 2.5.5 BETA.
  33.  
  34.  
  35. ==  Files.
  36.  
  37. RMSSETUP.EXE    is the program and is 2.5.5 BETA.
  38. README.255        is this file.
  39.  
  40.  
  41. ==  What does it do?  (When would I use it?)
  42.  
  43. Allows 3 or 4 players (or 2) to play DooM by just using serial cables.
  44.  
  45. As noted, you can play with just 2 players using RMSSetup, however, I
  46. recommend using the DooM serial device driver by David Nugent, currently at
  47. version 1.2.6. Look for "BNUDM126.zip" at your nearest ftp site.
  48.  
  49.  
  50. ==  What do you need?
  51.  
  52. You need a machine for each player, up to a maximum of four.
  53.  
  54. You also need a a minimum of a cable for each player except one. These cables
  55. are standard NULL modem cables. Fully shielded and grounded cables are
  56. preferable (to reliably use higher speeds).
  57.  
  58. Two machines need one serial port each, the remaining machines need two
  59. serial ports each.
  60.  
  61. Each machine needs to use RMSSetup, currently of the same version.
  62.  
  63. Having 16550A serial chips is a definite and serious plus, they will be used
  64. automatically.
  65.  
  66.  
  67. ==  How do I set it up?
  68.  
  69. Chain the machines together with the two slowest machines at the end of the
  70. chain.
  71.  
  72. eg. The first setup I ever tested with was:-
  73.  
  74.  
  75.       +------+                   +------+                   +------+
  76.       |386-40| <-----cable-----> |486-66| <-----cable-----> |486-40|
  77.       +------+                   +------+                   +------+
  78.             port 1           port 1    port 2           port 1
  79.  
  80.  
  81. ==  RMSSetup command line options.
  82.  
  83. These are fairly simple at the moment. Note that a 16550A FIFO will be used
  84. automatically and transmits 16 characters and receives 8 characters at a
  85. time. Most parameters are currently fixed, eg. buffer size.
  86.  
  87. Note that RMSSETUP will pass through to DOOM all parameters that you put
  88. on the command line.
  89.  
  90.  
  91. -rmsnode <pn> <tp>
  92.  
  93.     eg. "-rmsnode 1 3" for node 1 out of 3.
  94.  
  95.     <pn> is the node number from 1 to 4.
  96.     <tp> is the total number of nodes from 2 to 4.
  97.  
  98.     This parameter is needed. Each machine must be a different node
  99.     number to work properly. Each machine must have the same total number
  100.     of nodes to work properly.
  101.  
  102.     4 is the current maximum number of nodes handled by RMSSETUP. DooM allows
  103.     for 8 nodes but only 4 players, as of DooM version 1.2.
  104.  
  105.  
  106. -rmsline <port>
  107.  
  108.     eg. "-rmsline 2" for COM2.
  109.     eg. "-rmsline 2 speed 19200" for COM2 with speed 19200.
  110.     eg. "-rmsline com2" for COM2.
  111.  
  112.     eg. "-rmsline addr 0x678" for non standard port at address 0x678.
  113.     eg. "-rmsline addr 0x678 irq 15" for non standard port at address
  114.         0x678 with irq 15.
  115.     eg. "-rmsline addr 0x678 irq 15 speed 57600" for non standard port at
  116.         address 0x678 with irq 15 and speed 57600.
  117.  
  118.     This parameter has changed a lot since the last release. There is now
  119.     support for nonstandard addresses and IRQ numbers.
  120.  
  121.     -    If <port> is a number from 1 to 4 it will open the standard com port
  122.         of that number.
  123.  
  124.     -    If <port> is a word from "com1" to "com4" it will open the standard
  125.         com port specified.
  126.  
  127.     -    If <port> is the keyword "addr" then the next parameter is the base
  128.         address of the com port in decimal (eg. "1000") or hex. (eg. "0x3E8").
  129.  
  130.         -    If the keyword "irq" is specified after the base address, then
  131.             the parameter after the keyword "irq" is the IRQ number(*) of the
  132.             com port in decimal (eg. "11") or hex. (eg. "0xB").
  133.  
  134.             * The IRQ number may be anywhere from 0 to 15 (decimal).
  135.  
  136.         -    Otherwise if the keyword "irq" is not specified, the IRQ number
  137.             will be autodetected.
  138.  
  139.  
  140.     speed <bps>
  141.  
  142.     -    After the port is specified, the keyword "speed" may be specified.
  143.         The next parameter is the speed in bps to use.  Current speeds
  144.         allowed are 9600, 14400, 19200, 23040, 28800, 38400, 57600, 115200.
  145.  
  146.     -    Otherwise if the keyword "speed" is not specified, a default speed
  147.         of 9600 will be used.
  148.  
  149.     
  150.     Notes:
  151.  
  152.     *    Each keyword in line configuration needs to be in order.
  153.     *    Each port must have a different IRQ, ie. use ports 1&2 or 1&4 or 2&3
  154.         or 3&4 or nonstandard ports.
  155.  
  156.     *    One line is needed for each machine on the end of the chain.
  157.         Two lines are needed for each machine within the chain.
  158.         For multiple lines, use multiple "-rmsline" options.
  159.  
  160.     *    To get real results from DooM you need to up the speed of your lines.
  161.         Use the highest speed that gives you smooth operation.
  162.  
  163.     *    See section on "Testing so far".
  164.  
  165.  
  166. -vector <vectn>
  167.  
  168.     Supported as like standard DooM multiplayer drivers.
  169.  
  170.     Has been modified to accept a vector number in decimal (eg. "100") or
  171.     hex. (eg. "0x64").
  172.  
  173.  
  174. ==  Testing so far.
  175.  
  176. Some of the time, not all of the machines will start up, ie. initial RMSSetup
  177. handshaking works fine but one DooM machine (node 1) doesn't get past "sending
  178. network info?. This problem is being worked on. I have a line on this problem.
  179. The vital sent-once-only startup packet is being lost in the rush to get
  180. started. The temporary "fix" is to keep re-starting the machines until
  181. successful. It has been statistically proven that yelling "WORK" a few times
  182. at the crucial moment helps greatly. Also lowering the speeds can help.
  183.  
  184. After talking with the guys at ID, they say it is a DOOM 1.2 problem that
  185. will be fixed in 1.4. Apparently the packet resend relies on the VGA scan
  186. rate time and is incorrectly reported by some VGA BIOSes. They plan to use
  187. the standard DOOM frame timer in 1.4.
  188.  
  189. The only config tested with so far is the one shown in "How do I set it up?"
  190.  
  191. It worked fine with both lines operating at 19200, but was slow and somewhat
  192. jerky. We had great success with one line at 38400 and another line at 23040
  193. and later at 28800. At these speeds play with three machines was smooth.
  194.  
  195. To work out the effective speed down the whole chain do this:-
  196. -> Sum the inverses of each line speed, and then invert the sum.
  197. ie. With two lines at 19200 our overall speed was:-
  198.     1 / (1 / 19200 + 1 / 19200) = 9600
  199. With one line at 38400 and the other at 23040 our overall speed was:-
  200.     1 / (1 / 38400 + 1 / 23040) = 14400
  201. With one line at 38400 and the other at 28800 our overall speed was:-
  202.     1 / (1 / 38400 + 1 / 28800) = 16457
  203. With three lines at 38400 (for four machines) you would get:-
  204.     1 / (1 / 38400 + 1 / 38400 + 1 / 38400) = 12800
  205.  
  206.  
  207. ==  Miscellaneous and technical notes.
  208.  
  209. This software is written for a specific purpose, to play multiplayer DooM,
  210. and contains no code to attempt to modify or otherwise cause harm to your
  211. machine. I can not be held responsible for your machine seeming to break
  212. by your using this software.
  213.  
  214. There is no serial handshaking support, hardware or software. (The current
  215. version might swallow XON/XOFF characters.)
  216.  
  217. There is no modem support, currently, but RMSSetup will not hangup DTR when
  218. it exits so you could get it working by dialing with your favorite comms
  219. program.
  220.  
  221. All input from technical and experienced types very welcome.
  222.  
  223. RMSSetup needs to packetise data and simulate a little network for proper
  224. operation.
  225.  
  226. RMSSetup might write a file on exit called "RMSSETUP.DBG" with packet
  227. statistics, and may or may not include a dump of the first 31K of serial
  228. traffic.
  229.  
  230.  
  231. ==  The to do list.
  232.  
  233. Add support for more direct serial lines between machines using whatever
  234. spare ports are availiable to speed up operation. This will relieve some
  235. burden on some machines but will not increase the burden of any.
  236.  
  237. Add support for reading config info from a file in addition to the
  238. command line.
  239.  
  240. Change the packet format for RMSSETUP version 3.0.0 to reduce the number of
  241. times the data is copied around to increase RMSSETUP throughput.
  242.  
  243. Add new Fudge(TM) technology to solve DOOM startup problems.
  244.  
  245. Add new Fudge2(TM) technology to reduce the number of redundant DOOM packets
  246. traveling around.
  247.  
  248. I will probably increase the number of lines per machine from 2 to 3 or 4.
  249.  
  250. I will also probably write code to allow multiple lines to use the one IRQ.
  251. This might not be very useful on an ISA or VESA machine, but a serial setup
  252. on a PCI machine could use this (Viva la DooM on 100MHz Pentium and PCI bus
  253. everything!).
  254.  
  255.  
  256. ==  The changed list.
  257.  
  258. 2.5.5
  259.     -    New configuration options for nonstandard serial ports.
  260.     -    Now compiling with Borland C 4.0 with full optimization.
  261.     -    Wasn't going to be released but there were problems reported with
  262.         the current (2.4.9) zip file on infant2.
  263.  
  264. 2.4.9
  265.     -    Solved serial lockups.
  266.  
  267. 2.2.4    
  268.     -    Ye original. Had serial lockups.
  269.  
  270.  
  271. ==  What do I want?
  272.  
  273. Please send to me (by email please) all bug reports being as explicit as
  274. possible about the faults that you find. I am aware of some but send yours
  275. anyway - just dont resend it several days later because you think i'm not
  276. listening to you. I might not respond to all email.
  277.  
  278.  
  279. ==  What else do I want?
  280.  
  281. Send me a postcard (or postcard email)...  RMSSetup is free, but by all
  282. means send me international cheques in Australian dollars (AUD) for any
  283. amount you choose (eg. AUD $30)!
  284.  
  285. I also want ID Software to modify DooM to use higher resolutions on SVGA
  286. video cards. Perhaps use VESA modes or a few standard chipsets, maybe using
  287. accelerators. (S3!)
  288.  
  289.  
  290. ==  Who am I?
  291.  
  292.     Antony Suter
  293.  
  294. Email:
  295.  
  296.     antony@werple.apana.org.au
  297.     [s871780@yallara.cs.rmit.edu.au]
  298.  
  299. Snail:
  300.  
  301.     167 York Rd
  302.     Mt Evelyn, 3796
  303.     Victoria
  304.     AUSTRALIA
  305.  
  306.  
  307. ==  This readme file will self destruct in 5 seconds...
  308.  
  309.