home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / OX2V112.ZIP / OS2SYSOP.DOC < prev    next >
Text File  |  1994-08-11  |  48KB  |  951 lines

  1.                      IRON OX Version 1.12 for OS/2
  2.                      (C)opyright 1994, Joel Downer
  3.  
  4.                                SUMMARY
  5.  
  6. Iron Ox is an interactive, multiuser strategy game for 3-8 players.  The 
  7. game concept is the development of an outer space colony world:  Players
  8. claim land, produce goods, buy, sell, and steal from one another, and 
  9. prospect for luxite, the precious mineral that allows interstellar travel.  
  10. The door supports up to 255 simultaneous games involving up to 255 active 
  11. players.  
  12.  
  13. Iron Ox for OS/2 is self-maintaining (no nightly maintenance event), and
  14. is a multithreaded, 32-bit OS/2 text mode executable, with the following
  15. "sysop-friendly" features:
  16.  
  17. * Built-in multinode support (so several people can play at one time).
  18. * A sophisticated internode messaging/chat system (currently only
  19.   available in Iron Ox for OS/2, not Iron Ox for DOS).
  20. * The ability to use a comm handle or a port name.
  21. * The ability to run from DOS bulletin board systems running in the OS/2
  22.   DOS box (as well as from native OS/2 BBS software).
  23. * Complete data file compatibility with Iron Ox for DOS.
  24. * Support for a wide variety of door drop files (including DOOR.SYS,
  25.   DORINFO?.DEF, EXITINFO.BBS, CHAIN.TXT, CALLINFO.BBS, and SFDOORS.DAT).
  26. * Comprehensive high-score and record listing with optional ANSI, ASCII,
  27.   and WC-code bulletins.
  28. * "Nice" and "Nasty" modes to ensure good behavior on all-native systems
  29.   and decent performance on systems that run DOS comm software and
  30.   non-timeslicing doors.
  31.  
  32. The game includes lighthearted humor -- for example, the colony sponsors
  33. "cultural contests" in which players can write bad poetry or disgusting
  34. recipes -- but it also supports complex strategy and intense
  35. competition.  The door requires that players have ANSI terminals, but
  36. does not require a color monitor.
  37.  
  38.                           EVALUATION VERSION
  39.  
  40. Iron Ox is distributed in an evaluation version, intended for you to try 
  41. out for thirty days.  The evaluation version of Iron Ox is a complete 
  42. and (I hope) enjoyable game.  If you like Iron Ox and wish to continue 
  43. using it after thirty days, please see "LICENSING/REGISTRATION 
  44. INFORMATION," below, for details on how to register.  A registration key 
  45. for Iron Ox will enable additional features that will make the game even 
  46. more exciting for your users!
  47.  
  48.                            GETTING STARTED
  49.  
  50. Iron Ox is a game that requires multiple players, so you won't be able
  51. to take a very thorough "test drive" without putting it up for play on
  52. your BBS.  If you want to take a look at the door before installing it,
  53. though, you can run the program just by copying the file called
  54. SAMPLE.CFG to the name IRONOX.CFG and typing IRONOX -LOCAL from the
  55. directory where you have unpacked the archive.
  56.  
  57.                               REQUIREMENTS
  58.  
  59. Iron Ox for OS/2 requires a minimum of 750K free disk space; depending
  60. on the number of active games, it may take up as much as 1,500K of hard
  61. disk space.  In case you haven't guessed, it requires OS/2. <g>  It has
  62. been tested extensively with version 2.10 and 2.11 (both OS/2 original
  63. edition and OS/2 Special Edition for Windows).  Compatibility with
  64. previous versions is not guaranteed.
  65.  
  66. Ox/2 requires that serial device support be installed on the host
  67. computer.  If you wish to run Ox/2 from a DOS BBS in the OS/2 DOS box,
  68. you must be using SIO/VSIO or another driver that allows serial ports to
  69. be shared between OS/2 and DOS sessions (COM.SYS and VCOM.SYS do not).
  70. (See RUNNING FROM A DOS BBS, below, for more information.)
  71.  
  72. Even if you are running all native OS/2 software, a high-performance
  73. serial driver (like SIO) is recommended for optimal performance.
  74. Drivers for Digiboards or other specialized hardware should work fine so
  75. long as they're API-compatible with COM.SYS.
  76.  
  77. Ox/2 does not need or use FOSSIL drivers, MAXCOMM.DLL, or other serial
  78. service packages.
  79.  
  80.                            INSTALLING IRON OX
  81.  
  82. Instructions for installing Iron Ox are divided into two parts -- general
  83. directions (which apply to all systems), and specific installation notes
  84. for three different categories of bulletin board system:  native OS/2
  85. boards that write comm handles to dropfiles, native OS/2 boards that
  86. write port names, and DOS boards running under OS/2.  If you're
  87. confused, read on and the way should become clear.
  88.  
  89.                            GENERAL DIRECTIONS
  90.  
  91. 1. Decompress the Ox/2 archive into a door directory.  The examples in
  92.    this file and the sample batch file assume that you have used the
  93.    directory C:\DOOR\IRONOX\, but any directory will do.
  94.  
  95. 2. Create a configuration file.  If you're running a single-node board,
  96.    the game is unregistered, and you don't care about creating
  97.    ASCII/ANSI bulletins, just rename the file SAMPLE.CFG to the name
  98.    IRONOX.CFG.  Otherwise, run the program called OXCONFIG.EXE to create
  99.    a configuration file.  IMPORTANT:  If you're running multinode and
  100.    you want to make multinode messages and chat available to your users,
  101.    you should run OXConfig and visit the "Multinode Options Menu."
  102.  
  103. 3. Create a batch file or command script by which your BBS can start
  104.    Iron Ox.  Most of the time, this script will include only one line:
  105.  
  106.    C:\DOOR\IRONOX\IRONOX.EXE
  107.     
  108.    (Note:  Substitute the path where you have installed the game for
  109.    C:\DOOR\IRONOX\ in the above example.)
  110.  
  111.    The game supports several command-line arguments, but you are likely
  112.    only to need those arguments if:
  113.  
  114.    (a) you are running multinode with BBS software that doesn't include
  115.        the node number in the door information file,
  116.  
  117.    (b) you use a number of different door drop files, and you want to
  118.        tell Iron Ox which one to use, or
  119.  
  120.    (c) you wish to tune the performance of Ox on your system using the
  121.        /NICE or /NASTY parameters.
  122.  
  123.    In general, the considerations listed under (a) and (b) don't come up
  124.    for systems using DOOR.SYS, SFDOORS.DAT, CHAIN.TXT, or CALLINFO.BBS.
  125.    They are most likely to be issues for people running DORINFO systems.
  126.  
  127.               NOTES FOR MAXIMUS-STYLE NATIVE OS/2 SYSTEMS
  128.  
  129. One important distinction among OS/2 BBS'es is between systems (like
  130. Max/2) that trade in comm handles and systems (like Lora) that trade in
  131. port names.  By default, Iron Ox/2 assumes that it is running on a
  132. Maximus-style system.
  133.  
  134. Here is a sample menu entry for running Ox on a single-node Maximus
  135. system:
  136.  
  137. From Menus.Ctl
  138.  
  139.             Display_File   C:\Max\Misc\Dorinfo       Normal "Run Iron Ox/2"
  140.       NoDsp Xtern_Dos      C:\Door\IronOx\IronOx.exe Normal "R"
  141.  
  142. No batch/script file is required.  The Dorinfo script included with
  143. Max/2 works fine.
  144.  
  145. Here are sample command files for running Ox/2 on a multinode Maximus
  146. system, courtesy of Nancy Porter, sysop of Land of the Gypsy's BBS:
  147.  
  148. DORINFO.MEC
  149.  
  150. (This script is the same as the sample script that comes with Max,
  151. except that it writes unique dropfiles based on the node number.  It
  152. requires that you create a node work directory for each of your node
  153. numbers, e.g. "C:\Max\Misc\1", "C:\Max\Misc\2", and so forth.)
  154.  
  155. [delete]C:\Max\Misc\%k\Dorinfo%k.Def
  156. [open]C:\Max\Misc\%k\Dorinfo%k.Def
  157. [write]%N[ comment           Write the BBS name             ]
  158. [write]%S[ comment           Write the SysOp's first name   ]
  159. [write]%s[ comment           Write the SysOp's last name    ]
  160. [islocal write]COM0[ comment          Write the COM port    ]
  161. [isremote write]COM%P[comment       (local is always COM0)  ]
  162. [write]%b BAUD,N,8,1[comment Write the baud rate            ]
  163. [write] 0[ comment           Say that we're not networked   ]
  164. [write]%A[ comment           Write the user's first name    ]
  165. [write]%B[ comment           Write the user's last name     ]
  166. [write]%c[ comment           Write the user's city          ]
  167. [write]%g[ comment           Write the user's graphics      ]
  168. [sequal  write]100[ comment  Write the user's security level]
  169. [sxclude write]50[ comment             Ditto                ]
  170. [write]%t[ comment           Write the user's time remaining]
  171. [write]-1[ comment           Say that we're using a FOSSIL  ]
  172. [quit      comment           And we're done!                ]
  173.  
  174. From Menus.Ctl:
  175.  
  176.         Display_File  Misc\Dorinfo                         Normal "Iron Ox"
  177.         NoDsp xtern_dos \Games\Ironox\ox.cmd_%k_%A_%B      Normal "I"
  178.  
  179.  
  180. IRONOX.CMD:
  181.  
  182. C:\MAX\IPC-2 %1 "%2 %3" "Playing IronOx for OS/2"
  183. C:\GAMES\IRONOX\IRONOX.EXE C:\MAX\MISC\%1\
  184.  
  185. Note:  Depending on the configuration of your system, you may wish to
  186. try using the /NICE parameter.  See the section on command-line
  187. arguments, below.  You should only need to consider using the /NASTY
  188. parameter if your users spend a lot of time in ill-behaved DOS doors.
  189.  
  190.                NOTES FOR OS/2 BOARDS THAT USE PORT NAMES
  191.  
  192. I don't know much about the OS/2 BBS package Lora, but my understanding
  193. from one of my beta sites is that it (like DOS BBS systems) writes the
  194. name of the correct port to a dropfile rather than the number
  195. corresponding to a comm handle.  If this is true of your BBS software,
  196. you will need to use the command-line argument /PORT to indicate to Iron
  197. Ox that it will need to open a serial port.  Thus:
  198.  
  199. C:\DOOR\IRONOX\IRONOX.EXE /PORT
  200.  
  201. If you are sure your BBS software writes a port name to its dropfiles,
  202. you use the /PORT command-line option, *and* Iron Ox has trouble opening
  203. the comm port anyway, be sure that you have your serial driver
  204. configured to allow sharing of comm ports between sessions (with SIO,
  205. you would need to use the "-" parameter, described in the section
  206. below).  I have trouble believing that a BBS package would write a port
  207. name without closing the port before spawning doors, but it's a strange
  208. world. <g>
  209.  
  210. The Maximus examples above should provide general information on batch
  211. files and menu configuration.  If you have more specific advice and/or
  212. an example configuration and you'd like to contribute it, I would be
  213. happy to "beef up" this section for future versions.
  214.  
  215. Note:  Depending on the configuration of your system, you may wish to
  216. try using the /NICE parameter.  See the section on command-line
  217. arguments, below.  You should only need to consider using the /NASTY
  218. parameter if your users spend a lot of time in ill-behaved DOS doors.
  219.  
  220.            NOTES FOR RUNNING AN OS/2 DOOR FROM A DOS BBS (!)
  221.  
  222. If you are running a DOS BBS under OS/2, you should be able to take
  223. advantage of the enhanced features and performance of Iron Ox for OS/2.
  224. My BBS regularly bounces back between OS/2 and DOS, so the highest
  225. possible degree of compatibility was a big priority for me in designing
  226. the OS/2 version of this game.
  227.  
  228. The following approach is not guaranteed to work on your system, much
  229. less to generate responsive performance on heavily loaded multinode
  230. systems.  On one hand, if you run a single-node DOS BBS system under
  231. OS/2, and you're concerned about CPU load -- say, because you run other
  232. tasks on the same machine, and the BBS makes things sluggish -- you may
  233. find yourself rooting for people to go into Ox/2 so you can get some
  234. work done. <g>
  235.  
  236. On the other hand, if you run a multinode system with tons of
  237. non-timeslicing DOS doors, you may find that you have to run Ox in
  238. /NASTY mode and that you don't get the same benefits you would if Ox had
  239. better-behaved "neighbors" and you could run it in /NICE mode.
  240.  
  241. To run Ox/2 from a DOS BBS, you must be using Ray Gwinn's SIO or
  242. compatible drivers (COMM.SYS/VCOMM.SYS will not work).  Recent versions
  243. of SIO, working with OS/2 2.1x, will allow OS/2 and DOS sessions to
  244. share a comm port.  SIO must be loaded with the "-" parameter, which
  245. allows port-sharing, and you must have the "Share comm port with OS/2
  246. Sessions" option turned on in the DOS Sessions Settings for the session
  247. in which you run your BBS.
  248.  
  249. To spawn OS/2 sessions from your DOS BBS, you will need OS2EXEC or a
  250. similar utility.  OS2EXEC creates OS/2 sessions that wait on commands
  251. from DOS sessions; you run the door by telling OS2EXEC to execute
  252. IRONOX.EXE.
  253.  
  254. Both OS2EXEC and SIO are available for FREQ and download from any of the
  255. sites listed in "IRON OX DISTRIBUTION SITES," below.
  256.  
  257. So, with requirements and caveats stated, let's get to batch files and
  258. configuration information.  First of all, I have a startup .CMD file as
  259. follows:
  260.  
  261. REM Start "Daemon" sessions for each of my three BBS nodes
  262. START /FS OS2EXECD
  263. START /FS OS2EXECD
  264. START /FS OS2EXECD
  265. REM End of startup .CMD
  266.  
  267. My Wildcat! batch file is very straightforward:
  268.  
  269. OS2EXEC C:\DOOR\IRONOX\IRONOX.EXE /PORT
  270.  
  271. If you are running a DORINFO system, you may need to use the /N
  272. parameter.  If Ox has trouble finding your dropfile, you may need to
  273. specify it on the command line.  See the general installation
  274. instructions, above, and the information on command-line arguments,
  275. below.
  276.  
  277. If you run a multinode system with high-speed lines and/or
  278. non-timeslicing comm software (in other words, if there are other tasks
  279. that eat up lots of CPU time when players will be in Iron Ox) you may
  280. need to try the /NASTY parameter.  See the section on command-line
  281. parameters, below.
  282.       
  283.                          MULTINODE SETUP
  284.  
  285. Ox/2 has a rich set of multinode options, including internode messages
  286. and chat.  The internode communication system takes advantage of named
  287. pipes, a powerful OS/2 inter-process communication mechanism.
  288.  
  289. To configure the game for optimum performance on your system, you may
  290. need to run OXConfig and access the multinode options menu.  If you are
  291. running more than ten nodes, you will need to tell Ox your highest node
  292. number so that it knows how many pipes to look for.  If you are running
  293. an OS/2 LAN, you will need to tell Ox the name of your server so that it
  294. can create the named pipes over the network.  See the online
  295. documentation for (H)ighest Node Number and (P)ipe Name, or the
  296. appropriate sections under "CONFIGURING IRON OX," below.
  297.  
  298. Iron Ox was written and tested from the ground up to run multinode.
  299. Except as explained above, multinode setup is *identical* to single-node
  300. setup:  All nodes can use the same configuration file, and (for the most
  301. part) they can use the same batch file, too.  Thanks to the robust
  302. device driver model under OS/2, the operating system takes care of
  303. issues like non-standard IRQ's.
  304.  
  305. Multiple players can use this door at the same time; Iron Ox handles all 
  306. file locking internally.  (Note:  The file-locking system supports node
  307. numbers up to about 1,000 -- if you need higher ones, contact me and I'm
  308. sure we can work *something* out. <g>)
  309.  
  310. To set up the game for multinode play, create batch files or command
  311. scripts for each node along the lines in the single-node instructions.
  312. The only time different nodes will need *different* batch files is when
  313. the game is run across a LAN on which the drive letter for the game
  314. directory is different for different nodes.
  315.  
  316. (If you are running a multiline system where the node number is not
  317. included in the door information file, like RemoteAccess with
  318. DORINFO1.DEF, you will either need to use multiple batch files or use an
  319. environment variable to specify the node number with the /N option.  See
  320. "COMMAND-LINE ARGUMENTS," below.)
  321.  
  322. That's all it takes!  Iron Ox uses lock files to control simultaneous 
  323. use of files, so resources may remain locked if the system crashes while 
  324. someone is in the door.  However, each node will clear all of its locks 
  325. every time it enters or exits the door normally, so "lingering locks" 
  326. will be cleared automatically shortly after they arise.  If you have a 
  327. system that crashes frequently, adding a line like "DEL C:\DOOR\IRONOX\*.L*" 
  328. to your AUTOEXEC.BAT file will clear all locks immediately when the 
  329. computer reboots.
  330.  
  331.                          COMMAND-LINE ARGUMENTS
  332.  
  333. Iron Ox/2 supports the following command-line arguments:
  334.  
  335. /EDIT        This option activates the Game Editor subsystem, so that
  336.              games may be (E)dited as well as (S)tarted, (J)oined, and
  337.              (P)layed.  See "THE EDITOR," below.  WARNING:  This option
  338.              is *NOT* keyed to security level!  Do not use this option
  339.              for your normal door batch files unless your goal is to set
  340.              up a "Fantasy Game" or "Workshop" rather than a real game.
  341.  
  342. /LOCAL       This argument indicates that Iron Ox should run in local
  343.              mode and prompt for user name instead of looking for a
  344.              dropfile.  In general, the /LOCAL parameter is just for
  345.              "test-driving" the game when it is not installed on a BBS.
  346.              When you are running from your BBS (even from a local
  347.              node), you will want to use a dropfile rather than the
  348.              /LOCAL parameter.  If you do choose to use the /LOCAL flag
  349.              on a local node of your BBS, be aware that a copy of the
  350.              game loaded with /LOCAL defaults to node 1.  Unless your
  351.              local node happens to be node 1 on your BBS, you will need
  352.              to use the /N parameter to specify the correct node.
  353.  
  354. /NASTY       I learned during beta testing that systems running OS/2
  355.              BBS'es can be gentle and friendly places where all software
  356.              cooperates and shares the CPU; others can be war zones
  357.              where CPU-hungry DOS doors starve the rest of the system.
  358.              The /NASTY parameter warns Iron Ox that it's running in one
  359.              of those "war zones," and that it needs to set its thread
  360.              priorities very high to compete with the "bullies."
  361.  
  362.              You should probably not use this parameter unless you get
  363.              complaints about Ox running very slowly and/or you know you
  364.              run lots of non-timeslicing DOS doors.
  365.  
  366. /NICE        The /NICE parameter is the natural counterpart of the
  367.              /NASTY parameter, documented above.  Using the /NICE
  368.              parameter indicates to Ox that it's running in a friendly
  369.              environment and that it can rely on CPU idle time to do
  370.              things like refresh the screen and dump output to the comm
  371.              driver.
  372.  
  373.              On all-native systems or single-node systems with a light
  374.              CPU load, using /NICE should make for better performance
  375.              with substantially less CPU load.  This option is almost
  376.              guaranteed, however, to provide miserable performance on
  377.              multinode systems running DOS BBS software and/or
  378.              non-timeslicing DOS doors.
  379.  
  380.              Note:  By default, Iron Ox is neither /NICE nor /NASTY:  it
  381.              uses moderate thread priorities.  Many sysops will need
  382.              neither the /NICE nor the /NASTY parameter; the parameters
  383.              are included to give sysops more control over game
  384.              performance.
  385.  
  386. /N:          This option allows you to indicate the current node number
  387.              when the game is run on a multinode system.  Example:
  388.  
  389.              IRONOX /N:3
  390.  
  391.              Note:  On most systems, the node number is included in the
  392.              door drop file and this option is not needed.  The most
  393.              common systems where you *will* want to use this option are
  394.              DORINFO1.DEF BBS packages like RemoteAccess.
  395.  
  396. [pathname]   By default, Iron Ox looks for a door drop file in the
  397.              current directory -- it expects to be run from the node
  398.              work directory, as described above.  Also by default, it
  399.              will autodetect which dropfile to use by checking the
  400.              directory for the most current dropfile it supports (i.e.,
  401.              it does freshness-testing to avoid using stray dropfiles).
  402.  
  403.              You can specify the path where Iron Ox should look for its
  404.              dropfile and (if necessary) the name of the dropfile to
  405.              use.  Thus:
  406.  
  407.              C:\DOOR\IRONOX\IRONOX.EXE C:\WC30\WCWORK\NODE1\
  408.  
  409.              or, alternatively
  410.  
  411.              C:\DOOR\IRONOX\IRONOX.EXE C:\QBBS\DORINFO3.DEF
  412.  
  413.              Note:  This command-line option is usually not necessary.
  414.  
  415. /PORT        By default, Ox/2 expects to find a Max/2-style comm handle
  416.              in its door information file.  If you're running a BBS
  417.              program that places the comm port name in the dropfile
  418.              (like any DOS BBS and some OS/2 BBS systems), you will need
  419.              to include this parameter.
  420.  
  421.                   COMMON INSTALLATION PROBLEMS
  422.  
  423. The most common mistake sysops make installing this program is trying 
  424. to get too fancy.  Don't copy your door information file to the game 
  425. directory.  Don't specify the dropfile path on the command line for 
  426. the game unless the game doesn't work without it.  Don't add a line to
  427. your batch file that changes to the game directory before execution.
  428. Don't add the game to your path.  Just create a batch file that looks
  429. like the one in "INSTALLING IRON OX," above.  Keep it simple.
  430.  
  431. Here are some installation problems that might come up:
  432.  
  433. 1. The game says it can't find my door dropfile!
  434.  
  435.    This game assumes that you are running it from the directory where 
  436.    your BBS dropfile is located.  If you're not, you'll need to specify
  437.    the dropfile directory on the command line.
  438.  
  439. 2. The game works fine locally, but doesn't work over a modem!
  440.  
  441.    If you're using the /PORT parameter, try removing it.  If you're not
  442.    using it, give it a try.  Next, try the advice in (1), above -- the
  443.    real problem may be that the program is finding the wrong dropfile
  444.    and trying to open the wrong port.  If none of the above helps,
  445.    contact me and we'll see what we can figure out.
  446.  
  447. 5. The game is getting confused about what node it's running on!
  448.  
  449.    Iron Ox is designed to figure out the node ID on which it's running 
  450.    from the BBS drop file.  On some systems, however, determining the 
  451.    node ID from the drop file is not possible.  See the documentation
  452.    for the "/N" command-line parameter, above.
  453.  
  454.                            USING THE EDITOR
  455.  
  456. Iron Ox comes with a complete, built-in editor for general game
  457. statistics, players, the map, the general store, and contest entries.
  458. To simplify your remote maintenance tasks, this editor is coded to work
  459. through a modem as well as in local mode.  In the unregistered version
  460. of the game, the editor is "read-only"; in the registered version, you
  461. will be able to modify any of the information listed above.
  462.  
  463. To activate the editor, all you need to do is load the game with the
  464. /EDIT command-line flag.  The option to (E)dit a game will show up
  465. alongside the options to join, start, and play games.
  466.  
  467. IMPORTANT NOTE:  The option to edit games is *NOT* keyed to security
  468. level!  Therefore, you would not normally want to configure your batch
  469. files to load Iron Ox with the /EDIT parameter.  The only time you would
  470. want to make the editor available to players is if you were running some
  471. sort of a practice door or fantasy game.
  472.  
  473. The recommended use for the editor is to set it up as a separate menu
  474. option, and to key this menu option to an access level that will make it
  475. unavailable to anyone but you.  The editor uses the same file locking
  476. conventions as the game, so using the editor while someone else is
  477. online will not cause problems.
  478.  
  479. For the most part, the options in the editor are self-explanatory.  Here
  480. are a few notes about features that may not be:
  481.  
  482.                             Global Settings
  483.  
  484. Game Month         The game will not allow you to use this option to
  485.                    force a game to begin (i.e., when it is waiting for
  486.                    players) unless the game already has at least three
  487.                    players.
  488.  
  489.                               Map Editor
  490.  
  491. Volume of Luxite   This value determines the highest amount of luxite
  492.                    that can normally be produced by the plot in a given
  493.                    month (in other words, if the value is 5, the range
  494.                    will be 0 - 5).  Setting the value over 18 or so will
  495.                    probably make for silly production values.  Setting
  496.                    it over 25 will seriously imbalance the game in favor
  497.                    of the owner of the plot (if not a Rubblemuncher <g>).
  498.  
  499. "For sale"         This option is for corrective maintenance -- i.e., if
  500.                    the game won't let a player sell land because it
  501.                    thinks the land is already for sale.  I can think of
  502.                    no good reason to use this option at other times.
  503.  
  504.                              Player Editor
  505.  
  506. Is Character Dead  This option provides a quick-'n-handy way to kill or
  507.                    resurrect characters.  Be forewarned, however, that
  508.                    when when a character dies, all of his/her property
  509.                    is seized; resurrecting the character doesn't restore
  510.                    the property.  Please use this feature judiciously.
  511.  
  512. Last Turn Played   This value, combined with the game month, determines
  513.                    whether a player will be allowed into the game.  If
  514.                    you need to reset a player's session, the normal way
  515.                    to do so would be to adjust this value and set the
  516.                    "Claimed Land" variable to FALSE.
  517.  
  518.                           CONFIGURING IRON OX
  519.  
  520. The easiest way to fine-tune the configuration for your Iron Ox game is
  521. to run the utility called OXCONFIG.EXE, included in your IRONOX
  522. distribution archive.  OXCONFIG will let you adjust all options,
  523. explaining the function, default, and recommended value for each option.
  524.  
  525. OXCONFIG produces a file called IRONOX.CFG, which resides in the same
  526. directory as IRONOX.EXE.  In case you prefer using an ASCII text editor
  527. to fiddling with configuration programs, the following section documents
  528. the variables that appear in IRONOX.CFG and outlines how to modify them
  529. to change your configuration manually.
  530.  
  531. Keyword     Default           Function
  532.  
  533. SysopName    No One     This keyword determines the name that will be 
  534.                         used when the game describes who it belongs to.  
  535.                         If you decide to register this game, you will 
  536.                         need to enter your name here exactly as it 
  537.                         appears in your registration letter.  This 
  538.                         keyword is ignored in unregistered games.
  539.  
  540. BBSName   Unregistered  This keyword determines the system name that 
  541.                         will be used when the game describes the BBS to 
  542.                         which it is registered.  See "SysopName," above.
  543.  
  544. RegCode      (blank)    This is where you would insert the key code, 
  545.                         available from the author, that will activate the 
  546.                         "registered-only" features of the game.  See 
  547.                         "LICENSING/REGISTRATION INFORMATION," below.
  548.  
  549. Timeout       360       This keyword determines the amount of time, in 
  550.                         seconds, that the game will wait between keystrokes 
  551.                         before it decides that a user is "sleeping at the 
  552.                         keyboard" and boots him/her out.  This game can 
  553.                         require thought, so substantially reducing this 
  554.                         number is not recommended.  Note:  Timeout is 
  555.                         automatically disabled when the game is run in 
  556.                         local mode.
  557.  
  558. MaxGames       3        This keyword determines the maximum number of 
  559.                         games a player can participate in at one time.  
  560.                         Allowing players to participate in multiple 
  561.                         games will increase interest, but setting this 
  562.                         value too high would give high-speed callers a 
  563.                         big advantage in the monthly standings.  Note:  
  564.                         This keyword is ignored (hardcoded to 3) in the
  565.                         evaluation version of the game.
  566.  
  567. MinGameLength    14     In the registered version of Iron Ox, players
  568. MaxGameLength    14     may select games shorter or longer than 14
  569.                         turns.  These variables set bounds on game
  570.                         length.
  571.  
  572.                         Because all-time records are less meaningful
  573.                         when the door is configured to allow very long
  574.                         games, and the game can less entertaining if it
  575.                         continues long after all land is claimed, 14
  576.                         turns is recommended both for Minimum Length and
  577.                         Maximum Length.  Allowing games shorter than ten
  578.                         or longer than eighteen turns is discouraged.
  579.  
  580. MaxNodes         10     By default, the Iron Ox messaging system will
  581.                         look for up to ten active nodes (including the
  582.                         node on which the game is running) when it is
  583.                         searching for other players in the game.  This
  584.                         option allows you to specify more or fewer
  585.                         nodes, or to disable messaging altogether.
  586.  
  587.                         If you are running substantially fewer than ten
  588.                         nodes, specifying the correct number can save a
  589.                         few clock cycles and a very small amount of
  590.                         memory when Ox initializes.  If you are running
  591.                         more than ten nodes, you will need to specify
  592.                         the correct number for Ox to send messages
  593.                         correctly.  If you wish to disable internode
  594.                         messaging (e.g., because it's not behaving
  595.                         properly, or because you never have more than
  596.                         one node in the game at a time), set this value
  597.                         to zero.
  598.  
  599. PipeName                By default, each Iron Ox node will create a
  600.                         named pipe for each node using the format
  601.                         "\PIPES\OXPIPE" and the node number (thus, Node
  602.                         One would create "\PIPES\OXPIPE.1").  If you are
  603.                         running your system across an OS/2 LAN, you will
  604.                         need to adjust this path to include the name of
  605.                         your server.  For example, if your server is
  606.                         named BBSSERV, you should enter:
  607.  
  608.                         \BBSSERV\PIPES\OXPIPE
  609.  
  610.                         as the format for creating pipes.  If you are
  611.                         not running a LAN, you should only adjust this
  612.                         value on the very unlikely possibility that some
  613.                         other program is trying to create pipes with the
  614.                         same names.
  615.  
  616. ResetType               The allowed values for this variable are
  617.                         RESET_MONTHLY, RESET_DAYS, and RESET_DATE.  By
  618.                         default, the cumulative high scores for Iron Ox
  619.                         reset on the first of each month (i.e.,
  620.                         RESET_MONTHLY).  Choosing RESET_DAYS will cause
  621.                         the scores to reset every specified number of
  622.                         days.  Choosing RESET_DATE will cause the scores
  623.                         to reset on a fixed date.  These alternative
  624.                         options are most useful for organizing
  625.                         tournaments.  See the variables "ResetDays" and
  626.                         "ResetDate," below.  Note:  This option only
  627.                         affects cumulative scores.  The actual ongoing
  628.                         games never need to be reset or interrupted.
  629.  
  630. ResetDays               If you chose to reset every fixed number of days
  631.                         (see ResetType, above), this variable controls
  632.                         the number of days between score resets.  The
  633.                         value entered should be a positive whole number,
  634.                         e.g., 30 or 90.
  635.  
  636. ResetDate               If you chose to reset on a fixed date, this
  637.                         field controls the day for score reset.  Enter
  638.                         full month name, followed by day and year, thus:
  639.  
  640.                         January 1, 1995
  641.  
  642.                         This option is excellent for managing
  643.                         tournaments, because the reset date is displayed
  644.                         prominently in the high score screen.
  645.  
  646. StartGames    TRUE      This keyword determines whether players are 
  647.                         allowed to begin new games.  The only time you 
  648.                         would be likely to set this value to FALSE would 
  649.                         be if you were winding down a tournament with a 
  650.                         fixed duration.
  651.  
  652. Secure        FALSE     If you (the sysop) are playing in games, you 
  653.                         might not want to watch as other people play 
  654.                         their turns in the games in which you're 
  655.                         involved -- you could see something that would 
  656.                         give you an unfair advantage.  Setting Secure to 
  657.                         TRUE will cause the game to blank the local screen 
  658.                         when a remote player is playing in a game in 
  659.                         which zero-baud (local) players are involved.
  660.  
  661. NoLog         FALSE     This option allows you to disable the game's 
  662.                         automatic logging feature, which records basic 
  663.                         game events and errors in one or more files 
  664.                         called OX????.LOG (where the question marks are
  665.                         replaced by the node number).  Turning off 
  666.                         logging can save some disk space, but it can 
  667.                         also make problem-solving more difficult.  
  668.                         Recommended setting is FALSE (does not disable 
  669.                         the log).
  670.  
  671. ANSI_Score    (blank)   This keyword determines the name and path of the 
  672.                         ANSI Score bulletin the game will create.  Leaving 
  673.                         the space after the keyword blank, as it is in the 
  674.                         sample configuration file, indicates that you 
  675.                         want the game to create *NO* ANSI score bulletin.
  676.  
  677. ASCII_Score   (blank)   Name and path of the ASCII high score bulletin.
  678.  
  679. WC_Score      (blank)   Name and path of score bulletin using Wildcat!-
  680.                         style @ codes.
  681.  
  682. ANSI_Records  (blank)   Name and path of the ANSI all-time-records bulletin.
  683.  
  684. ASCII_Records (blank)   Name and path of the ASCII records bulletin.
  685.  
  686. WC_Records    (blank)   Name and path of the WC-style records bulletin.
  687.  
  688. DailyPrize       0      You may configure the game to award a daily, weekly, 
  689.                         and/or monthly time prize to the current leader in 
  690.                         the standings.  A value of 0 disables time prizes.  
  691.                         Time prizes are disabled in the unregistered version 
  692.                         of Iron Ox.
  693.  
  694.                         Here are some guidelines on prizes:  the prizes
  695.                         should go from very small (daily) to fairly
  696.                         generous (monthly).  Values of five minutes for
  697.                         daily, ten for weekly, and thirty for monthly
  698.                         might be reasonable.
  699.  
  700.                         Note:  Time prizes only work on systems that reread
  701.                         their door dropfiles on return from a door to 
  702.                         determine remaining time, like Wildcat! 3.x, 
  703.                         RemoteAccess, and so forth.
  704.  
  705. WeeklyPrize      0      See DailyPrize, above.
  706.  
  707. MonthlyPrize     0      See DailyPrize, above.
  708.  
  709. Note:  if you leave the name of any particular bulletin blank, or do not 
  710. include the keyword for it in the configuration file, that bulletin will 
  711. not be created.
  712.  
  713.                               ERRORLEVELS
  714.  
  715. In case your BBS software reads and uses errorlevels on door exit, here 
  716. are the errorlevels Iron Ox returns:
  717.  
  718.      0   -   Critical Error has occurred!
  719.      1   -   The user has dropped carrier.
  720.      2   -   The sysop has terminated the call; user off-line.
  721.      3   -   User time has expired; still on-line.
  722.      4   -   Keyboard inactivity timeout; user off-line.
  723.      10  -   Normal exit; user on-line.
  724.     255  -   Program integrity problem; please check log and contact me!
  725.  
  726.                     LICENSE/REGISTRATION INFORMATION
  727.  
  728. This program is copyrighted shareware.  You are licensed to try this 
  729. program for up to thirty days.  After 30 days, if you elect to continue 
  730. using Iron Ox, you must register.  The game costs only $20 (see 
  731. REGISTER.FRM for information on shipping and delivery options).  
  732.  
  733. Note:  If your registration for Iron Ox is postmarked *BEFORE SEPTEMBER 1,
  734. 1994*, you will receive a five-dollar discount on your registration!
  735.  
  736. The registered version of Iron Ox includes the following enhanced features:
  737.  
  738. 1. OX FACTORY:  Your colonies will no longer have to rely on the supply 
  739.    of oxen provided at the beginning of the game.  The game will use 
  740.    ore from the store to make more.
  741.  
  742. 2. EXTRA RACES:  In registered versions of the game, three extra,
  743.    specialized races are available to players:  the Photovore, a
  744.    sunlight-eating alien who specializes in plants and energy-making,
  745.    the Rubblemuncher, an amazing ore-miner who's allergic to luxite, and
  746.    the Metamorph, a creature who can actually *change shape* and assume
  747.    the abilities of different races during the course of the game.
  748.  
  749. 3. MORE GAMES PER PLAYER:  In the evaluation version, players are
  750.    allowed to play in three games at a time.  In the registered version,
  751.    you may set this value as low or as high as you like.
  752.  
  753. 4. TIME PRIZES:  If you own the registered version and use BBS software 
  754.    that "reads back messages" from doors, you can set (totally optional) 
  755.    daily, weekly, and/or monthly time prizes for the leaders in the 
  756.    standings!  This feature works on Wildcat!, RemoteAccess, Apex, 
  757.    QuickBBS, and many other systems.
  758.  
  759. 5. FULLY ACTIVE EDITOR:  In the unregistered version, the editor is
  760.    "read-only."  Registration allows you to adjust values as well as
  761.    view them.
  762.  
  763. 6. CONFIGURABLE GAME LENGTH:  In the registered version, your players
  764.    can choose games shorter or longer than 14 turns (you set the bounds
  765.    for the shortest and longest games allowed).  Great for boards where
  766.    users want to "play to the death." <g>
  767.  
  768. 7. TROJAN OXEN:  Trojan Oxen are a valuable defense against sabotage:
  769.    They look like ordinary oxen, but *fight back* if attacked.  Very
  770.    helpful in cutthroat games.
  771.  
  772. Please see REGISTER.FRM to find out how to register your copy of Iron
  773. Ox.  Iron Ox for DOS is the product of over a thousand hours of work.
  774. Porting Ox to OS/2 has consumed hundreds more, and I have the
  775. feeling that this will be a "never-ending" project. <g>  I am committed
  776. to supporting and improving Iron Ox (see "Future Plans" for some
  777. indication of what I have in mind), but I need your help to continue
  778. developing enhancements and new features.
  779.  
  780.                        ADDITIONAL LICENSE INFO
  781.  
  782. You are allowed (and encouraged) to distribute unmodified copies of 
  783. Iron Ox so long as you distribute the complete archive with all files 
  784. intact.  You may include unmodified, complete archive versions of the 
  785. shareware edition of Iron Ox in software collections (e.g., CD-ROMs) 
  786. so long as the documentation for the collection clearly indicates that 
  787. it contains shareware products and that the purchase of the collection 
  788. does not constitute a license for the use of said products.
  789.  
  790. Registration of this product entitles you to a unique registration code
  791. keyed to your name and the name of your BBS.  This key will allow you
  792. and your system's users to access the registered-only features of the
  793. program, and will deactivate all messages to the effect that the program
  794. is an "Unregistered Evaluation Copy."  Your registration entitles you to
  795. use both Iron Ox for DOS and Iron Ox for OS/2, and is good for all
  796. future releases of Iron Ox; if I should ever need to change the key
  797. system, you as a registered user will be entitled to receive a new key
  798. via U.S. Mail or electronic mail.  Registrations are non-transferable
  799. without my direct permission.
  800.  
  801.                               SUPPORT
  802.  
  803. I am anxious for your feedback and ideas.  If you have problems getting 
  804. Iron Ox to run, please feel free to contact me.
  805.  
  806. I can be reached via crashmail or routed netmail at Fidonet address 
  807. 1:202/704 and DoorNet address 75:7619/7.
  808.  
  809. The support BBS for Iron Ox, and for all games by Joel Downer and 
  810. Meerkat Software Concepts, is The Dreaming City.  The Dreaming City 
  811. has two lines:
  812.  
  813. Node 1:  USR Dual HST 14.4/ v.32 9600    (619) 462-8406
  814. Node 2:  ZyXEL 16.8 v.32bis              (619) 462-7146
  815.  
  816. I monitor the Fidonet DOORWARE, DOORGAMES and ON_LINE_GAMES conferences,
  817. and the San Diego NET202_IRONOX echo.  I will attempt to reply promptly
  818. to echo messages, netmail messages, and messages in the IRONOX support
  819. conference on my BBS.
  820.  
  821. As of 6/27/94, the IRONOX echo has just been approved for addition to
  822. the FidoNet backbone.  By the time you read this, if you are a Fido
  823. sysop, you should be able to request IRONOX from your Fidonet echomail
  824. hub for what I hope will be an excellent source of support and a great
  825. place for players to exchange information about the game.
  826.  
  827. I can be reached via the Internet as joel@dreamcty.jd.com.  For those
  828. with Internet access, this approach may provide the fastest and most
  829. reliable method of reporting problems or providing feedback except
  830. Fidonet crashmail.
  831.  
  832.                      IRON OX DISTRIBUTION SITES
  833.  
  834. The following bulletin board systems are official distribution sites 
  835. for Iron Ox and any necessary companion programs.  Note:  This
  836. information was compiled in May, 1994; some of these telephone numbers
  837. will change over time.  If you find that the numbers listed for systems
  838. in your area are no longer accurate, you may be able to find up-to-date
  839. information in a current FidoNet nodelist.
  840.  
  841. BBS System         Fido Addr   Telephone     Modem        Where
  842.  
  843. The Dreaming City  1:202/704   619-462-8406  USR Dual     La Mesa, CA
  844. TDC 2              1:202/705   619-462-7146  16.8 V.32bis La Mesa, CA
  845. Alien Biker Kat    1:202/1010  619-277-4140  V.32bis      San Diego, CA
  846. Common Sense       1:161/705   510-713-7336  V.32bis      Newark, CA
  847. Comp. Connection   1:157/574   216-671-2574  21.6 Dual    Cleveland, OH
  848. The Harry Beast    1:343/102   206-859-6157  16.8 V.32bis Kent, WA
  849. Hole in the Wall   1:104/651   303-841-5515  16.8K Dual   Parker, CO
  850. Holston River Vlly 1:3615/42   615-932-1490  16.8 Dual    Knoxville, TN
  851. Holston 2          1:3615/43   615-932-1492  16.8 Dual    Knoxville, TN
  852. Land of Gypsy's    1:105/18    503-297-0626  V.32bis      Portland, OR
  853. Mayberry BBS       1:3663/302  910-789-8183  28.8 Hayes   Mt. Airy, NC 
  854. Programming Link   1:301/3     505-822-8944  V.32bis      Albuquerque, NM
  855. SHC Editor's       1:202/1819  619-563-1598  16.8 Dual    San Diego, CA
  856. The Sperm Bank     1:2604/203  201-847-0797  28.8 Zoom    Wyckoff, NJ
  857. Test Pattern BBS   1:259/524   905-890-2531  USR Dual     Ontario, Canada
  858. Unknown Gateway    1:318/7     505-784-3275  V.32bis      Clovis, NM
  859. Ruby's Joint       1:135/373   305-856-4897  28.8 Hayes   Miami, Florida
  860.  
  861. The following files will be available for download, and for FREQ using
  862. the magic names listed, from all of the distribution sites.  The sites
  863. will carry the latest version of Iron Ox and any support programs by
  864. Joel Downer.  Versions of support programs by other authors will be
  865. recent but are not guaranteed to be the latest.
  866.  
  867. Magic Name       Description
  868.  
  869. IRONOX           The latest version of Iron Ox for DOS.
  870. OX2              The latest version of Iron Ox for OS/2.
  871. OS2EXEC          A recent version of OS2EXEC (Needed for Ox/2 w/ DOS BBS).
  872. X00              A recent version of the X00 FOSSIL driver.
  873. BNU              A recent version of the BNU FOSSIL driver.
  874. SIO              A recent version of Ray Gwinn's FOSSIL for OS/2.
  875.  
  876.                             FUTURE PLANS
  877.  
  878. I am committed to supporting this program.  When and if I receive 
  879. reports of bugs, I will do my best to fix them and release updates 
  880. in a timely fashion.
  881.  
  882. I also am planning to add new features and enhancements to the game -- 
  883. which and how many depending on the feedback and level of enthusiasm 
  884. I encounter in the BBS community.  Here are some examples of additions 
  885. that I am *considering* for future versions:
  886.  
  887. 1. The option to steal from the Bank or the General Store.
  888.  
  889. 2. Sysop-editable, variable messages for common game events (Received
  890.    from the Colony Physician:  "If you need to spew, spew into this!").
  891.  
  892. 3. A "depletion" feature by which players can exhaust the ore and/or
  893.    luxite in mining squares.
  894.  
  895. 4. Full RIP graphics support, including a graphics-mode map with icons
  896.    and mousable game menus.
  897.  
  898. 5. Support for multi-BBS "tournament mode."
  899.  
  900. 6. Computer-controlled players with configurable levels of skill.
  901.  
  902. Your feedback will help to determine which and how many of these 
  903. features (and which features that *aren't* listed here) appear in future 
  904. versions of Iron Ox.  Needless to say, your support will also make it 
  905. possible for me to continue work on this program.
  906.  
  907.                              DISCLAIMER
  908.  
  909. I make no warranty of any kind regarding the usefulness, reliability,
  910. merchantability, or fitness of this software and documentation for any
  911. purpose whatsoever.  While I have tested this program thoroughly, I
  912. cannot and will not make any promises that the program will run well or
  913. safely on your hardware or with your particular software configuration.
  914. This software is guaranteed only to take up disk space, and I make no
  915. absolute guarantee that it will even do a reliable job of that. <g>
  916.  
  917. Your use of Iron Ox and/or any companion material constitutes your 
  918. acceptance of these terms.
  919.  
  920.                           ACKNOWLEDGEMENTS
  921.  
  922. Porting a doorgame consisting of more than 50,000 lines of code is quite
  923. probably not the easiest way to learn OS/2 programming. <g>  This first
  924. development cycle has been an adventure and (sometimes) an ordeal, for
  925. me and for my beta sites.  I have to single out Nancy Porter, whose BBS
  926. has taken the brunt of several of my ugliest mistakes, but warm thanks
  927. go to all of my beta testers, including Mike Burgett, Micheal Cody, Wes
  928. Landaker, Pete Link, Jerry McBride, and Scott Wilkos.
  929.  
  930. Special thanks go to Craig Swanson, a widely-recognized OS/2 guru whose
  931. patient, persuasive arguments got me interested in OS/2 in the first
  932. place and whose advice has really helped this project along.  Thanks
  933. also to Peter Fitzsimmons, who provided some excellent suggestions on
  934. video optimization in the FidoNet OS2PROG echo.
  935.  
  936. For version 1.12, I owe special thanks to Brad Jackson, Paul Sidorsky,
  937. Scott Kuntzelman, Greg Rumple, and Pete Norloff for bug reports and
  938. feedback.
  939.  
  940. I always owe appreciation to Evvie Vincow for support and an arbitrarily
  941. large number of glasses of iced tea.  On The Dreaming City, Andrew
  942. Crispen, Greg Allen, Sandy Jones, and Buck Jones have provided excellent
  943. feedback on my work.
  944.  
  945. Thanks also to the original authors of the Commodore 64 game, M.U.L.E.
  946. -- part of the basic design of Iron Ox was inspired by that excellent
  947. game.
  948.  
  949. Iron Ox for DOS uses the OpenDoors C development system by Brian Pirie.
  950. Iron Ox for OS/2 uses a multithreaded port of this code.
  951.