home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / ffc2v100.zip / SYSOP.DOC < prev   
Text File  |  1995-04-27  |  49KB  |  976 lines
  1.                       FICTION FACTORY Version 1.00
  2.                     (C)opyright 1995, Joel W. Downer
  3.  
  4.           Support BBS:  Fido 1:202/704, 619-462-8406/462-7146
  5.                    Inquiries:  joel@dreamcty.cts.com
  6.  
  7.                                 CONTENTS
  8.  
  9. This documentation file includes the following sections:
  10.  
  11. SUMMARY                          What this door is and why you want it!
  12. EVALUATION VERSION               Shareware notice; evaluation terms
  13. COMPATIBILITY/REQUIREMENTS       What you need to run this program
  14. GETTING STARTED                  How to take a quick look at this door
  15. INSTALLING FICTION FACTORY       How to get up and running
  16. COMMAND-LINE ARGUMENTS           List of options accepted by the program
  17. MULTINODE SETUP                  Special issues for multinode sysops
  18. COMMON PROBLEMS                  Please read *before* calling me at 3 AM <g>
  19. GETTING THINGS GOING             Hints for encouraging participation
  20. CONFIGURING FICTION FACTORY      Customizing your FICTFACT.CFG file
  21. MAINTAINING FICTION FACTORY      Information on special sysop options
  22. ERRORLEVELS                      Information for tech geek sysops <g>
  23. LICENSE/REG. INFORMATION         How to register your copy of FictFact!
  24. ADDITIONAL LICENSE INFO          Info on distributing/licensing this door
  25. SUPPORT                          Where to get more help!
  26. OTHER SOFTWARE BY JOEL DOWNER    If you like Fiction Factory....
  27. DISCLAIMER                       Boilerplate courtesy of legal dept. <g>
  28. ACKNOWLEDGEMENTS                 The names of a few heroes/heroines
  29.  
  30.                                 SUMMARY
  31.  
  32. Fiction Factory is a BBS external program (door) that allows your users
  33. to work together to build stories.  Many users can interact over days,
  34. weeks, or even months to write stories that may be funny, exciting,
  35. scary, silly, or all of the above.  While "never-ending story" doors are
  36. nothing new in the BBS world, Fiction Factory has professional-quality
  37. features available in no other story door:
  38.  
  39. * A full-screen, scrolling, ANSI text editor with full support for ANSI
  40.   and Doorway cursor keystrokes.
  41. * A context-sensitive, popup help system available at virtually every
  42.   point in the program.
  43. * A windowed story reader with the ability to scroll forward and back
  44.   and the ability to switch back and forth between editor and reader!
  45. * A sophisticated, text-windowed interface with popup menus.
  46. * Snazzy RIPScrip graphics, including windows and screen save/restore.
  47. * Full (optional) support for local RIPScrip graphics!  (DOS-only for now.)
  48. * Multinode support, with real-time multinode messaging and chat.
  49. * Automatic detection and timeslicing under OS/2, DESQview, and Windows.
  50. * A 32-bit, multithreaded, native OS/2 version available!
  51. * Support for up to 1,000 nodes, 255 users, and 255 active stories.
  52. * Support for password-protected stories and automatic password
  53.   expiration to prevent "orphan stories."
  54. * Support for anonymous story entries (sysop's option).
  55. * Five "pre-started" stories to help spark your users' imagination.
  56. * "High-water" marks so users can review just the new text in stories.
  57.  
  58. If you like to attract creative, interactive users with a good sense of
  59. humor to your system, you'll want Fiction Factory on your door menu!
  60.  
  61.                           EVALUATION VERSION
  62.  
  63. Fiction Factory is distributed in an evaluation version, intended for
  64. you to try out for thirty days.  The evaluation version of Fiction
  65. Factory has two limitations:  it allows only fifteen stories at a time,
  66. and limits story length to 150 lines, or a few weeks' worth of entries
  67. on the average BBS.  (The registered version allows 255 stories of
  68. virtually unlimited length.)
  69.  
  70. If you like FictFact and wish to continue using it after thirty days,
  71. please see "LICENSING/REGISTRATION INFORMATION," below, for details on
  72. how to register.  Thanks for evaluating Fiction Factory!
  73.  
  74.                        COMPATIBILITY/REQUIREMENTS
  75.  
  76. The DOS version of Fiction Factory requires about 335k of memory to run
  77. in text mode, and about 410k to run in graphics mode.  (Having more
  78. memory, and some EMS memory available, will make it run faster.)
  79. Running Fiction Factory in graphics mode (with the /LRIP parameter)
  80. requires a monitor with EGA or better graphics support.  The game will
  81. work fine on any sort of monitor running without the /LRIP parameter.
  82. Local graphics will work under DESQview and other DOS multitaskers, but
  83. using graphics on multinode systems is not recommended.  In particular,
  84. having two or more sessions on one machine trying to do local graphics
  85. at the same time is a bad idea.
  86.  
  87. Fiction Factory (for DOS or OS/2) requires a minimum of a megabyte of
  88. disk space.  When running with local graphics, it may consume another
  89. 200-350k of space for temporary icon storage.  A hard disk is required.
  90.  
  91. Fiction Factory for DOS runs under (and gives up timeslices to)
  92. DESQview, Windows, and OS/2.  (If you're running OS/2, though, you'll
  93. probably want Fiction Factory for OS/2.)
  94.  
  95. Fiction Factory for DOS includes internal comm routines, with support
  96. for non-standard IRQ's and for rates of up to 115Kbps, as well as
  97. support for a FOSSIL driver.  Support for some specialized requirements
  98. (DigiBoards, shared IRQ's) is provided in the DOS version through the
  99. FOSSIL standard.  Recent versions of several popular FOSSIL drivers are
  100. available through the distribution sites.  If you're running the OS/2
  101. version of the door, don't worry about any of these issues:  your device
  102. driver will take care of them.
  103.  
  104. Fiction Factory requires that the remote user (your caller) have ANSI,
  105. AVATAR, or RIPScrip graphics, but does not require any special drivers
  106. on the sysop end.
  107.  
  108.                             GETTING STARTED
  109.  
  110. Fiction Factory obviously needs multiple users to be much better than
  111. your average text editor. <g>  However, if you like to get acquainted
  112. with a door before installing it, taking a "test drive" of FictFact is
  113. easy.  Just decompress the game into its own directory, create a default
  114. configuration file by typing
  115.  
  116.    C:\FICTFACT>COPY SAMPLE.CFG FICTFACT.CFG
  117.  
  118. and then run the game by typing
  119.  
  120.    C:\FICTFACT>FICTFACT -LOCAL
  121.  
  122. If you're running the DOS version of Fiction Factory and you have an EGA
  123. monitor or better, you can run in graphics mode by using this
  124. command-line instead:
  125.  
  126.    C:\FICTFACT>FICTFACT -LOCAL -LRIP
  127.  
  128.                        INSTALLING FICTION FACTORY
  129.  
  130. If you've gotten this far, I assume that you liked what you saw when you
  131. followed the "GETTING STARTED" instructions.  Great!  Now, let's get
  132. Fiction Factory working as a door on your BBS.
  133.  
  134. Don't be intimidated that this section is long!  The reason is that
  135. Fiction Factory works on three radically different kinds of BBS system.
  136. Only about a third of this information will apply to you (less if you're
  137. running a plain-vanilla DOS system).
  138.  
  139. This section includes three subsections:  instructions on how to install
  140. the DOS version, instructions on installing the OS/2 version for a
  141. native OS/2 BBS, and instructions on installing the OS/2 version for a
  142. DOS BBS running in the OS/2 DOS box.  Make sure you understand which
  143. situation applies to you and that you have the right version for your
  144. operating system, because the differences are important.
  145.  
  146.    Installing Fiction Factory for DOS:
  147.  
  148. Here are the key steps to installing Fiction Factory for DOS:
  149.  
  150. 1. Decompress the Fiction Factory archive into a door directory.  The
  151.    examples in this file assume you're using C:\DOOR\FICTFACT, but any
  152.    directory name will do.
  153.  
  154. 2. Type "COPY SAMPLE.CFG FICTFACT.CFG" to create a configuration file.
  155.    If you want to customize your configuration, you can edit
  156.    FICTFACT.CFG with your favorite text editor.  (The comments in the
  157.    file will explain most options; more information is available in this
  158.    document under "CONFIGURING FICTION FACTORY.")
  159.  
  160. 3. Create a batch file your BBS can use to start the door.  If you don't
  161.    want local graphics, the batch file will probably look like this:
  162.  
  163.    C:\DOOR\FICTFACT\FICTFACT.EXE
  164.  
  165.    If you do want local graphics, it'll look more like this:
  166.  
  167.    C:\DOOR\FICTFACT\FICTFACT.EXE -LRIP
  168.  
  169.    If you are running a multinode DORINFOx.DEF BBS, you will need to use
  170.    the /N: command-line argument to tell Fiction Factory the correct
  171.    node number.  If your BBS doesn't launch door execution from the same
  172.    directory where it creates dropfiles (Maximus often doesn't), you
  173.    will need to use the [pathname] argument to tell Fiction Factory
  174.    where to look.  If you're using a non-standard comm port under DOS
  175.    and aren't running a FOSSIL driver, you'll need to use the /I and /P
  176.    parameters to tell FictFact about it.  Documentation and examples
  177.    appear under "COMMAND-LINE ARGUMENTS," below.
  178.  
  179.    Advice:  Keep it simple.  Assume that you don't need to use extra
  180.    command-line arguments unless you have special reason to think
  181.    otherwise.  The above one-line batchfile will work for a vast
  182.    majority of systems, and making things more complex (copying the
  183.    dropfile to the game directory, changing directories, etc.) will
  184.    often introduce problems instead of fixing them.
  185.  
  186. That's all it takes!  You're ready to add FictFact to your door menu and
  187. get rolling!
  188.  
  189.    Installing Fiction Factory for OS/2 for a Native OS/2 BBS:
  190.  
  191. Here are the key steps to installing Fiction Factory for OS/2:
  192.  
  193. 1. Decompress the Fiction Factory archive into a door directory.  The
  194.    examples in this file assume you're using C:\DOOR\FICTFACT, but any
  195.    directory name will do.
  196.  
  197. 2. Type "COPY SAMPLE.CFG FICTFACT.CFG" to create a configuration file.
  198.    If you want to customize your configuration, you can edit
  199.    FICTFACT.CFG with your favorite text editor.  (The comments in the
  200.    file will explain most options; more information is available in this
  201.    document under "CONFIGURING FICTION FACTORY.")
  202.  
  203. 3. Copy the file DRS2V5B4.DLL to a directory on the LIBPATH defined in
  204.    your CONFIG.SYS.  On a typical system, the \OS2\DLL directory on your
  205.    boot drive works fine.
  206.  
  207. 4. Create a batchfile or script to run the game.  If you're running
  208.    Maximus or a similar BBS system, no batchfile is necessary:  you can
  209.    add a script directly to your MENUS.CTL file.
  210.  
  211. Here's a script that will work fine on a single-node system using the
  212. default DORINFO.MEC script that comes with Maximus:
  213.  
  214.       Display_File   C:\Max\Misc\Dorinfo           Normal "FictFact"
  215. NoDsp Xtern_Dos      C:\Door\FictFact\FictFact.exe Normal "F"
  216.  
  217. Important question:  Have you changed your DORINFO.MEC script to write
  218. the name of the correct comm port to the dropfile instead of the number
  219. of an open comm handle?  (Many OS/2 sysops who run DOS doors have done
  220. this.)  If so, your script should look like this:
  221.  
  222.       Display_File   C:\Max\Misc\Dorinfo                  Normal "FictFact"
  223. NoDsp Xtern_Dos      C:\Door\FictFact\FictFact.exe_/PORT  Normal "F"
  224.  
  225. Note:  If you get errors accessing the port with this configuration,
  226. make sure you have your serial driver configured to allow a comm port to
  227. be shared across sessions (with SIO, you would need to use the "-"
  228. parameter, described in the section on running from a VDM).
  229.  
  230. Are you running multinode?  If so, copy the script file that comes with
  231. FictFact/2, MLTINODE.MEC, to your scripts directory, and use the
  232. following commands to run FictFact/2:
  233.  
  234. Display_File   Misc\MltiNode                       Normal "FictFact"
  235. NoDsp Xtern_Dos \Door\FictFact\FF.cmd_%k           Normal "F"
  236.  
  237. FF.CMD should look like this:
  238.  
  239. C:\DOOR\FICTFACT\FICTFACT.EXE /N:%1 C:\MAX\MISC\%1\
  240.  
  241. Note:  For this setup to work, you will need to create node work
  242. directories under \MAX\MISC\ for each node, like so:
  243.  
  244. C:\MAX\MISC\1\ (for node 1)
  245. C:\MAX\MISC\2\ (for node 2), and so forth.
  246.  
  247. Another note:  Depending on the configuration of your system, you may
  248. wish to try using the /NICE parameter.  See the section on command-line
  249. arguments, below.  You should only need to consider using the /NASTY
  250. parameter if you run a multinode BBS and your users spend a lot of time
  251. in ill-behaved DOS doors.
  252.  
  253.    Installing Fiction Factory for OS/2 for a DOS BBS in a VDM:
  254.  
  255. If you are running a DOS BBS under OS/2, you should be able to take
  256. advantage of the enhanced features and performance of FictFact for OS/2.
  257. My BBS regularly bounces back between OS/2 and DOS, so the highest
  258. possible degree of compatibility was a big priority for me in designing
  259. my OS/2 door library.
  260.  
  261. The following approach is not guaranteed to work on your system, much
  262. less to generate responsive performance on heavily loaded multinode
  263. systems.  On one hand, if you run a single-node DOS BBS system under
  264. OS/2, and you're concerned about CPU load -- say, because you run other
  265. tasks on the same machine, and the BBS makes things sluggish -- you may
  266. find yourself rooting for people to go into FF/2 so you can get some
  267. work done. <g>
  268.  
  269. On the other hand, if you run a multinode system with tons of
  270. non-timeslicing DOS doors, you may find that you have to run FictFact in
  271. /NASTY mode and that you don't get the same benefits you would if FF had
  272. better-behaved "neighbors" and you could run it in /NICE mode.
  273.  
  274. To run FF/2 from a DOS BBS, you must be using Ray Gwinn's SIO or
  275. compatible drivers (COMM.SYS/VCOMM.SYS will not work).  Recent versions
  276. of SIO, working with OS/2 2.1x and above, will allow OS/2 and DOS
  277. sessions to share a comm port.  SIO must be loaded with the "-"
  278. parameter, which allows port-sharing, and you must have the "Share comm
  279. port with OS/2 Sessions" option turned on in the DOS Sessions Settings
  280. for the session in which you run your BBS.
  281.  
  282. To spawn OS/2 sessions from your DOS BBS, you will need OS2EXEC or a
  283. similar utility.  OS2EXEC creates OS/2 sessions that wait on commands
  284. from DOS sessions; you run the door by telling OS2EXEC to execute
  285. FICTFACT.EXE.
  286.  
  287. Both OS2EXEC and SIO are available for FREQ and download from my BBS;
  288. see the section on "SUPPORT," below.
  289.  
  290. So, with requirements and caveats stated, let's get to batch files and
  291. configuration information.  First of all, I have a startup .CMD file as
  292. follows:
  293.  
  294. REM Start "Daemon" sessions for each of my three BBS nodes
  295. START /FS OS2EXECD
  296. START /FS OS2EXECD
  297. START /FS OS2EXECD
  298. REM End of startup .CMD
  299.  
  300. My Wildcat! batch file is very straightforward:
  301.  
  302. OS2EXEC C:\DOOR\FICTFACT\FICTFACT.EXE /PORT
  303.  
  304. If you are running a DORINFO system, you may need to use the /N
  305. parameter.  If FF has trouble finding your dropfile, you may need to
  306. specify it on the command line.  See the general installation
  307. instructions, above, and the information on command-line arguments,
  308. below.
  309.  
  310. If you run a multinode system with high-speed lines and/or
  311. non-timeslicing comm software (in other words, if there are other tasks
  312. that eat up lots of CPU time when players will be in Fiction Factory)
  313. you may need to try the /NASTY parameter.  See the section on
  314. command-line parameters, below.
  315.  
  316.                          COMMAND-LINE ARGUMENTS
  317.  
  318. Fiction Factory supports a number of command-line parameters.  If the
  319. documentation for any of these makes your eyes glaze over, your best bet
  320. is to skip over to the next one.  Chances are that if you don't
  321. understand it, you also don't need it.
  322.  
  323. /ACCEPT      This option tells Fiction Factory not to mess with the
  324.              communications parameters currently set for your comm port
  325.              -- to open the port (or the FOSSIL driver, if appropriate)
  326.              as it stands.  It is intended to help people whose systems
  327.              do not respond correctly when a door program attempts to
  328.              reset communications parameters.  Advice:  Assume you
  329.              *DON'T* need this option unless the game doesn't work
  330.              without it.  (Note:  This option has no effect under OS/2.)
  331.  
  332. /EDIT        This option activates the Sysop menu, which will allow you
  333.              to delete, export, and rename stories.  WARNING:  This
  334.              option is *NOT* keyed to security level!  You should
  335.              generally only use it when you're running FictFact for
  336.              maintenance purposes from the command-line, or in the batch
  337.              file for a local-only node.
  338.  
  339. /LOCAL       This option tells Fiction Factory to run in local mode, and
  340.              not to access the comm ports or look for a BBS dropfile.
  341.              By default, when running in local mode, FF assumes it is
  342.              running on node 0.  If you are running a multinode system
  343.              and want to run on a different node number, use the /N
  344.              option documented below.
  345.  
  346. /LOCK        This option allows you to lock the bps rate Fiction Factory
  347.              uses to communicate with your modem to a speed other than
  348.              the one specified in your door information file.  Example:
  349.  
  350.              FICTFACT /LOCK:19200
  351.  
  352.              This option is only effective if you are using the internal
  353.              comm system (port-locking for FOSSIL drivers should be
  354.              controlled through FOSSIL driver setup).  (Note:  This
  355.              option has no effect under OS/2.)
  356.  
  357. /LRIP        This option tells Fiction Factory to run in graphics mode
  358.              using the same RIPScrip graphics a caller will see if
  359.              he/she logs in using a RIP terminal (like RIPTerm or
  360.              QMPro).  Notes:
  361.  
  362.              (a) Local graphics are currently not supported in the OS/2
  363.                  version of FictFact.  (They are a possibility for an
  364.                  upcoming version.)
  365.  
  366.              (b) When you're not running in local mode (i.e., you aren't
  367.                  using the /LOCAL parameter), the game will only run
  368.                  with local graphics when the remote user (the caller)
  369.                  also has RIP graphics.  In other words, if the caller
  370.                  only has ANSI, you see ANSI whether you specify /LRIP
  371.                  or not.
  372.  
  373.              (c) If you run more than one node under a multitasker like
  374.                  DESQview, you will probably want to ensure that only
  375.                  one copy of Fiction Factory is running in /LRIP mode at
  376.                  a time.  If multiple instances of the game try to
  377.                  access the graphics display at once, screen corruption
  378.                  can result.
  379.  
  380. /N:          This option allows you to indicate the current node number
  381.              when the game is run on a multinode system.  Example:
  382.  
  383.              FICTFACT /N:3
  384.  
  385.              Note:  On most systems, the node number is included in the
  386.              door drop file and *THIS OPTION IS NOT NEEDED*.  The most
  387.              common systems where you *will* want to use this option are
  388.              DORINFO BBS packages like RemoteAccess.
  389.  
  390. /NASTY       Systems running OS/2 BBS'es can be gentle and friendly
  391.              places where all software cooperates and shares the CPU;
  392.              others can be war zones where CPU-hungry DOS doors starve
  393.              the rest of the system. The /NASTY parameter warns Fiction
  394.              Factory that it's running in one of those "war zones," and
  395.              that it needs to set its thread priorities very high to
  396.              compete with the "bullies."
  397.  
  398.              You should probably not use this parameter unless you get
  399.              complaints about FictFact running very slowly and/or you
  400.              know you run lots of non-timeslicing DOS doors.
  401.  
  402.              (Note:  This option has no effect in the DOS version.)
  403.  
  404. /NICE        The /NICE parameter is the natural counterpart of the
  405.              /NASTY parameter, documented above.  Using the /NICE
  406.              parameter indicates to FictFact that it's running in a
  407.              friendly environment and that it can rely on CPU idle time
  408.              to do things like refresh the screen and dump output to the
  409.              comm driver.
  410.  
  411.              On all-native systems or single-node systems with a light
  412.              CPU load, using /NICE should make for better performance
  413.              with substantially less CPU load.  This option is almost
  414.              guaranteed, however, to provide miserable performance on
  415.              multinode systems running DOS BBS software and/or
  416.              non-timeslicing DOS doors.
  417.  
  418.              Note:  By default, Fiction Factory is neither /NICE nor
  419.              /NASTY:  it uses moderate thread priorities.  Many sysops
  420.              will need neither the /NICE nor the /NASTY parameter; the
  421.              parameters are included to give sysops more control over
  422.              game performance.
  423.  
  424.              (Note:  This option has no effect in the DOS version.)
  425.  
  426. /NOFIFO      Some Western Digital 16550 cards have a bug that causes
  427.              them to lock up when their FIFO buffers are used.  This
  428.              flag tells FictFact to disable its use of FIFO buffers.
  429.              Note:  If you've never heard of this FIFO bug before,
  430.              assume it *DOESN'T* apply to you and do not use this
  431.              option!  If you had the problem, you'd know by now. <g>
  432.  
  433.              (Note:  This option has no effect under OS/2.)
  434.  
  435. /NOFOSSIL    If you *have* a FOSSIL driver, but do *not* wish to use it,
  436.              this flag will tell the game to ignore the driver and use
  437.              internal comm instead.  This option may be useful if you
  438.              are having problems with Fiction Factory's FOSSIL support.
  439.              Note:  If you do not have a FOSSIL, you do not need this
  440.              option -- Fiction Factory will automatically default to
  441.              internal comm if it does not find a FOSSIL.  (Note:  This
  442.              option has no effect under OS/2.)
  443.  
  444. /P, /I       These options allow you to set the hexadecimal base address
  445.              and the IRQ number for a non-standard serial port.  Example:
  446.  
  447.              FICTFACT /P:3F8 /I:4
  448.  
  449.              indicates that the game should use base address 3F8h, and
  450.              IRQ4 for serial I/O.  These arguments are *ONLY* needed if
  451.              you are using internal serial support; they are ignored if
  452.              you have a FOSSIL installed and have not used the /NOFOSSIL
  453.              argument.  Note:  The AT IRQ lines (9-15) are *NOT*
  454.              supported using these arguments.  Support for the AT IRQ's
  455.              is only available through a FOSSIL driver.
  456.  
  457.              (Note:  This option has no effect under OS/2.)
  458.  
  459. [pathname]   By default, Fiction Factory looks for a door drop file in
  460.              the current directory -- it expects to be run from the node
  461.              work directory, as described above.  Also by default, it
  462.              will autodetect which dropfile to use by checking the
  463.              directory for the most current dropfile it supports (i.e.,
  464.              it does freshness-testing to avoid using stray dropfiles).
  465.  
  466.              You can specify the path where Fiction Factory should look
  467.              for its dropfile and (if necessary) the name of the
  468.              dropfile to use.  Thus:
  469.  
  470.              C:\DOOR\FICTFACT\FICTFACT.EXE C:\WC30\WCWORK\NODE1\
  471.  
  472.              or, alternatively
  473.  
  474.              C:\DOOR\FICTFACT\FICTFACT.EXE C:\QBBS\DORINFO3.DEF
  475.  
  476.              Note:  This command-line option is usually not necessary.
  477.  
  478.                          MULTINODE SETUP
  479.  
  480. Fiction Factory was written and tested from the ground up to run
  481. multinode.  In general, multinode setup is *identical* to single-node
  482. setup:  All nodes can use the same configuration file, and (for the most
  483. part) they can use the same batch file, too.  Because the program
  484. supports FOSSIL drivers under DOS and uses the standard device driver
  485. model under OS/2, it can handle issues like non-standard IRQ's
  486. *completely automatically* -- no need to treat individual nodes
  487. specially on FOSSIL or OS/2 systems.
  488.  
  489. Multiple players can use this door at the same time; Fiction Factory
  490. handles all file locking internally.  (Note:  The file-locking system
  491. supports node numbers up to about 1,000 -- if you need higher ones,
  492. contact me and I'm sure we can work something out. <g>)  The only
  493. requirement for running the game multinode is that you must be running
  494. DOS SHARE or some equivalent (like the built-in file-sharing in OS/2 or
  495. the file-sharing facilities on LANs).  If you're running multinode
  496. *without* such a utility, now would be a good time to start.
  497.  
  498. To set up the door for multinode use, create batch files for each node
  499. like those in the single-node instructions, above.  The only times
  500. different nodes will need *different* batch files are
  501.  
  502. (a) when the game is run across a LAN on which the drive letter for the
  503.     game directory is different for different nodes, and
  504.  
  505. (b) when you are running nodes with non-standard IRQ's under DOS and you
  506.     are *NOT* using a FOSSIL driver.
  507.  
  508. If you have a local node and you like to play the game with RIP
  509. graphics, you may want to have a special batch file for the local node
  510. to bring up the game with the /LRIP parameter.
  511.  
  512. (If you are running a multiline system where the node number is not
  513. included in the door information file, like RemoteAccess with
  514. DORINFO1.DEF, you will either need to use multiple batch files or use an
  515. environment variable to specify the node number with the /N option.  See
  516. "COMMAND-LINE ARGUMENTS," above.)
  517.  
  518. Fiction Factory includes a multinode chat/messaging system.  By default,
  519. FictFact looks for up to ten nodes on your system.  If you have more
  520. nodes than that (or if you have considerably fewer, and you want to save
  521. your CPU a little work) you can edit your FICTFACT.CFG and set the
  522. MaxNodes option.  More information on FICTFACT.CFG appears below.
  523.  
  524. One more thing for DOS users:  Because of a bug with either Borland's
  525. run-time libraries or with Quarterdeck's products (who's to blame for
  526. the bug depends on whether you ask Borland or Quarterdeck <g>), you may
  527. find that you need to flag your FICTFACT.EXE executable file read-only
  528. to avoid sharing violations when running multinode under DESQview or
  529. QEMM.  To do this, just use the command ATTRIB FICTFACT.EXE +R after
  530. unpacking the game into your door directory.  If you ever need to
  531. uninstall Fiction Factory, you can use the command ATTRIB FICTFACT.EXE -R
  532. to "unflag" the file.  This issue does not come up under OS/2.
  533.  
  534. That's all it takes!  Fiction Factory uses lock files to control
  535. simultaneous use of files, so resources may remain locked if the system
  536. crashes while someone is in the door.  However, each node will clear all
  537. of its locks every time it enters or exits the door normally, so
  538. "lingering locks" will be cleared automatically shortly after they
  539. arise.  If you ever need to clear the lockfiles manually, you can do so
  540. by typing "DEL C:\DOOR\FICTFACT\*.L*" (though this will delete your
  541. Fiction Factory logfiles, too).
  542.  
  543.                             COMMON PROBLEMS
  544.  
  545. 1. My BBS makes one of the dropfiles the door supports, but the game
  546.    keeps telling me it can't find a dropfile!
  547.  
  548.    This game assumes that you are running it from the directory where
  549.    your BBS dropfile is located.  If you aren't, include the directory
  550.    where your dropfile is located on the command line, thus:
  551.  
  552.    C:\DOOR\FICTFACT\FICTFACT.EXE C:\WC30\WCWORK\NODE1\
  553.  
  554.    If you're running a DORINFO system, specifying the node number on the
  555.    command line might also be useful:
  556.  
  557.    C:\DOOR\FICTFACT\FICTFACT.EXE /N:3 C:\QBBS\
  558.  
  559. 2. The game works fine locally, but doesn't work over a modem!
  560.  
  561.    If you're running under DOS and you're having trouble getting serial
  562.    support to work, one good solution is to try a FOSSIL driver.  FOSSIL
  563.    drivers are an excellent choice for high-performance communications,
  564.    and can (if you wish) be loaded and unloaded from the batch file that
  565.    executes Fiction Factory.  If you do not have a FOSSIL driver, they
  566.    are available from my system (listed under "Support," below), and
  567.    many other places as well.
  568.  
  569.    If you don't wish to use a FOSSIL, or if you're already *using* a
  570.    FOSSIL and are still having problems, the /ACCEPT, /LOCK, /P and /I
  571.    options explained in the section on command-line arguments may help
  572.    with the problem.  If not, feel free to contact me for further
  573.    assistance.
  574.  
  575. 3. I'm running FictFact for OS/2, and I keep getting a "critical error
  576.    setting DCB" or something like that whenever the game tries to run
  577.    across a modem!
  578.  
  579.    Usually, this error means that FictFact is trying to open the wrong
  580.    comm port or a comm port that doesn't exist.  There are two common
  581.    causes for this:
  582.  
  583.    (a) you're using the /PORT parameter when you shouldn't be or not
  584.        using it when you should be, or
  585.  
  586.    (b) the door is finding the wrong dropfile.
  587.  
  588.    If you're running a DOS BBS in a VDM, you need to use the /PORT
  589.    parameter.  If you're running a native OS/2 BBS, you may or may not
  590.    need it:  try removing it/adding it.  If fixing your /PORT setting
  591.    doesn't address the problem, try specifying the location/name of the
  592.    door dropfile on the command line.
  593.  
  594. 4. I'm running the DOS version of the game.  The game runs fine
  595.    single-node, but if two people try to go in at once, I get a sharing
  596.    violation!
  597.  
  598.    As I say in the section on multinode setup, either my compiler or
  599.    Quarterdeck's products have a bug that causes sharing violations when
  600.    you try to run an overlaid program multinode.  The work-around for
  601.    this problem is to flag your FICTFACT.EXE file read-only using the
  602.    command ATTRIB FICTFACT.EXE +R.  Even if you aren't using a
  603.    Quarterdeck product like DESQview or QEMM, give this solution a try:
  604.    Odds are good it'll correct the problem completely.
  605.  
  606. 5. The game is getting confused about what node it's running on!
  607.  
  608.    FictFact is designed to figure out the node ID on which it's running
  609.    from the BBS drop file.  On some systems, however, determining the
  610.    node ID from the drop file is not possible.  See the documentation
  611.    for the "/N" command-line parameter, above.  If you're using /N and
  612.    Fiction Factory is *still* getting confused, chances are that FF is
  613.    finding a stray dropfile.  Try specifying the name and location of
  614.    the dropfile on the command-line (as described above).
  615.  
  616. 6. I run under DOS, and I'm getting some weird message about SHARE not
  617.    being loaded!
  618.  
  619.    If you're running FictFact multinode, you need to have SHARE (or an
  620.    equivalent utility) loaded.  Consult your operating system manual for
  621.    information on using SHARE.
  622.  
  623.    If you're not running multinode, you shouldn't need to have SHARE
  624.    loaded on your system.  However, *if* you don't have SHARE loaded
  625.    *and* you use more than one node number on your system, you may get
  626.    an error message about loading SHARE (even though only one node is
  627.    using the game at a time).
  628.  
  629.    To correct this problem, edit your FICTFACT.CFG file and replace the
  630.    line that specifies MaxNodes with the following line:
  631.  
  632.    MaxNodes 0
  633.  
  634.    This line disables multinode messaging and eliminates the need for
  635.    SHARE to be loaded.
  636.  
  637. 7. When I run the program in RIP mode, sometimes windows don't get
  638.    erased right -- part of them stays on the screen.
  639.  
  640.    This problem usually indicates that the program doesn't have enough
  641.    memory available to save the screen.  If possible, make more memory
  642.    available when FictFact runs (e.g., increase the size of the DESQview
  643.    window, load more drivers high).  In general, you should be O.K. with
  644.    around 400k of memory free, but you may need more on some machines.
  645.  
  646.    If you just plain can't get that much memory free at the command
  647.    line, you may have to run the door without local RIP.  Bummer.
  648.  
  649.                           GETTING THINGS GOING
  650.  
  651. The "starter" stories that are included with Fiction Factory are taken
  652. from materials that I could use without worries about copyright
  653. infringement -- mostly material I've written or books by long-dead
  654. authors.  While I like my own story <g>, and all of the books I used are
  655. excellent, more "up-to-date" excerpts might do a better job of
  656. stimulating your callers' imagination.  If you think of something you'd
  657. rather use, remember that you can always delete some or all of the
  658. default "starter stories" and/or add your own.
  659.  
  660. I can't include Star Trek (tm) stories, or excerpts from _The Hobbit_
  661. and _Lord of the Rings_, or passages from Michael Moorcock's Elric
  662. stories, or material from H.P. Lovecraft or Stephen King stories in my
  663. door.  However, as far as I know, there's nothing illegal about *your*
  664. typing in a paragraph or two from one of those works as a "starter
  665. story" for noncommercial use by you and your callers.  Just make sure
  666. that you acknowledge the author and that you only use a short passage.
  667.  
  668. (P.S.  I am not a lawyer, and the above is not a legal opinion about the
  669. "fair use" clause of copyright law.  I said "as far as I know," so if
  670. I'm wrong, don't sue me.)
  671.  
  672.                       CONFIGURING FICTION FACTORY
  673.  
  674. Fiction Factory looks for configuration information in a file called
  675. FICTFACT.CFG, which must be located in the game directory (the same
  676. directory where FICTFACT.EXE is located).  FICTFACT.CFG is a normal
  677. ASCII text file, so you can edit it with your favorite text editor or
  678. word processor.  (Note:  If you use a word processor, make sure to
  679. select the option to "save as ASCII" when you save the file.  Most word
  680. processors save in special binary formats that FictFact can't read.)
  681.  
  682. The FictFact distribution archive contains a file called SAMPLE.CFG,
  683. which contains quick documentation of the basic configuration options
  684. for the game.  Here is more complete information about your options:
  685.  
  686.       Door/Interface Configuration
  687.  
  688. Keyword     Default           Function
  689.  
  690. MaxNodes       10       Fiction Factory has a messaging system that allows
  691.                         internode messages and multiplayer chat.  This
  692.                         system works for nodes on a single machine and
  693.                         for nodes distributed across a LAN.
  694.  
  695.                         By default, FictFact tests for ten active nodes.
  696.                         If you have more than ten nodes, you should set
  697.                         this value to your highest node number. If you
  698.                         have fewer, lowering this value will improve
  699.                         performance and save memory.  To disable
  700.                         messaging, set this value to zero.
  701.  
  702. NoLog         FALSE     This option allows you to disable the game's
  703.                         automatic logging feature, which records basic
  704.                         game events and errors in one or more files
  705.                         called STRY????.LOG (where the question marks
  706.                         are replaced by the node number).  Turning off
  707.                         logging can save some disk space, but it can
  708.                         also make problem-solving more difficult.
  709.                         Recommended setting is FALSE (does not disable
  710.                         the log).
  711.  
  712.                         Note:  If you allow anonymous entries, the door
  713.                         logs may be the only way to track "bad users"
  714.                         who leave inappropriate story entries.
  715.  
  716. PipeName                By default, each FictFact/2 node will create a
  717.                         named pipe for each node using the format
  718.                         "\PIPES\MSGPIPE" and the node number (thus, Node
  719.                         One would create "\PIPES\MSGPIPE.1").  If you
  720.                         are running your system across an OS/2 LAN, you
  721.                         will need to adjust this path to include the
  722.                         name of your server.  For example, if your
  723.                         server is named BBSSERV, you should enter:
  724.  
  725.                         \BBSSERV\PIPES\MSGPIPE
  726.  
  727.                         as the format for creating pipes.  If you are
  728.                         not running a LAN, you should only adjust this
  729.                         value on the very unlikely possibility that some
  730.                         other program is trying to create pipes with the
  731.                         same names.  (Note:  This option has no effect
  732.                         under DOS.)
  733.  
  734. Timeout       360       This keyword determines the amount of time, in
  735.                         seconds, that the game will wait between keystrokes
  736.                         before it decides that a user is "sleeping at
  737.                         the keyboard" and boots him/her out.  Users
  738.                         sometimes have to go looking for a thesaurus, so
  739.                         substantially reducing this number is not
  740.                         recommended.  Note:  Timeout is automatically
  741.                         disabled when the game is run in local mode.
  742.  
  743.       Game/Playability Options
  744.  
  745. AnonAllowed    TRUE     This keyword determines whether users are
  746.                         allowed to make anonymous additions to stories.
  747.                         This option may be helpful to people who are shy
  748.                         about contributing, but it may also force you to
  749.                         deduce who is responsible from the logs if
  750.                         someone is posting inappropriate stories.
  751.  
  752. IdleHours      72       This keyword determines how long a password-
  753.                         protected story may remain idle before the
  754.                         password is voided and the story is opened for
  755.                         anyone to contribute.  Depending how busy your
  756.                         BBS is, values anywhere from 24 hours to 336
  757.                         hours (two weeks) might be appropriate.
  758.  
  759. StartStories  TRUE      This keyword determines whether players are
  760.                         allowed to begin new stories.  If you want to
  761.                         have a small running list of stories on topics
  762.                         of your choosing, you might want to set this to
  763.                         "FALSE."  Otherwise, the default of "TRUE" is
  764.                         recommended.
  765.  
  766.       Registration Options
  767.  
  768. Keyword     Default           Function
  769.  
  770. BBSName   Unregistered  This keyword determines the system name that
  771.                         will be used when the game describes the BBS to
  772.                         which it is registered.  See "SysopName," below.
  773.  
  774. CourtesyOf   (blank)    When the door is registered, you may wish to
  775.                         give credit to the person(s) who donated to
  776.                         register the door.  If you put a name or other
  777.                         phrase here, it will be displayed on the main
  778.                         menu screen along with your name and the name of
  779.                         your BBS.  See "SysopName," below.
  780.  
  781. RegCode      (blank)    This is where you would insert the key code,
  782.                         available from the author, that will activate the
  783.                         "registered-only" features of the game.  See
  784.                         "LICENSING/REGISTRATION INFORMATION," below.
  785.  
  786. SysopName    No One     This keyword determines the name that will be
  787.                         used when the game describes who it belongs to.
  788.                         If you decide to register this game, you will
  789.                         need to enter your name here exactly as it
  790.                         appears in your registration letter.  This
  791.                         keyword is ignored in unregistered games.
  792.  
  793.                       MAINTAINING FICTION FACTORY
  794.  
  795. In general, Fiction Factory is self-maintaining and should be no trouble
  796. to you once it's added to your door menu.  You do have several options
  797. to maintain and control the use of the program, though.
  798.  
  799. To activate the sysop menu, run FictFact with the /EDIT option, e.g.:
  800.  
  801.    FICTFACT /LOCAL /EDIT /LRIP
  802.  
  803. This flag will make (S)ysop Options appear as a choice on the main menu.
  804. The Sysop Options menu will allow you to delete or rename any story, or
  805. to export a story as an ASCII text file (so you can declare it complete
  806. and presumably add it to your file area or your text bulletin menu).
  807.  
  808. If you should need to edit the actual text of a story (say, because a
  809. user uses profanity or abusive language), you can load up any of the
  810. story files (STY*.DAT) and change them using an ASCII text editor.  You
  811. can also edit the text of the warning about profanity that appears on
  812. entry to the door by modifying the BBSRULE.TXT file in your Fiction
  813. Factory directory.
  814.  
  815.                               ERRORLEVELS
  816.  
  817. In case your BBS software reads and uses errorlevels on door exit, here
  818. are the errorlevels Fiction Factory returns:
  819.  
  820.      0   -   Critical error has occurred!
  821.      1   -   The user has dropped carrier.
  822.      2   -   The sysop has terminated the call; user off-line.
  823.      3   -   User time has expired; still on-line.
  824.      4   -   Keyboard inactivity timeout; user off-line.
  825.      10  -   Normal exit; user on-line.
  826.     255  -   Program integrity problem; please check log and contact me!
  827.  
  828.                     LICENSE/REGISTRATION INFORMATION
  829.  
  830. This program is copyrighted shareware.  You are licensed to try this
  831. program for up to 30 days.  After 30 days, if you elect to continue
  832. using Fiction Factory, you must register.
  833.  
  834. The game costs only $15.  If you wish to register using a credit card,
  835. you can use your modem to call 619-462-8406 or 619-462-7146 to obtain
  836. your registration key *INSTANTLY* using online registration.  If you
  837. prefer to use conventional mail and a check or money order, see
  838. REGISTER.FRM for information on shipping and delivery options.
  839.  
  840. The registered version of Fiction Factory includes the following
  841. enhanced features:
  842.  
  843. 1. UNLIMITED STORY LENGTH:  In the unregistered version, each story is
  844.    limited to 150 lines.  In the registered version, the limit is about
  845.    33,000 lines (roughly 600 pages) or available disk space. <g>
  846.  
  847. 2. MORE STORIES:  In the unregistered version, only fifteen stories may
  848.    be active at a time.  In the registered version, up to 255 stories
  849.    are supported.
  850.  
  851.                        ADDITIONAL LICENSE INFO
  852.  
  853. You are allowed (and encouraged) to distribute unmodified copies of
  854. Fiction Factory so long as you distribute the complete archive with all
  855. files intact.  You may include unmodified, complete archive versions of
  856. the shareware edition of Fiction Factory in software collections (e.g.,
  857. CD-ROMs) so long as the documentation for the collection clearly
  858. indicates that it contains shareware products and that the purchase of
  859. the collection does not constitute a license for the use of said
  860. products.
  861.  
  862. Registration of this product entitles you to a unique registration code
  863. keyed to your name and the name of your BBS.  This key will allow you
  864. and your system's users to access the registered-only features of the
  865. program, and will deactivate all messages to the effect that the program
  866. is an "Unregistered Evaluation Copy."  Your registration is good for all
  867. future releases of Fiction Factory for DOS and OS/2:  If I should ever
  868. need to change the key system, you as a registered user will be entitled
  869. to receive a working new key via U.S. Mail or electronic mail.
  870.  
  871. Registrations are non-transferable without my direct permission.
  872.  
  873.                               SUPPORT
  874.  
  875. I am anxious for your feedback and ideas.  If you have problems getting
  876. Fiction Factory to run, please feel free to contact me.
  877.  
  878. I can be reached via crashmail or routed netmail at Fidonet address
  879. 1:202/704.  I am also reachable via the Internet as
  880. joel@dreamcty.cts.com.  I poll my Internet feed, so crashmail is faster.
  881.  
  882. The support BBS for Fiction Factory, and for all software by Joel
  883. Downer, is The Dreaming City.  The Dreaming City has two lines:
  884.  
  885. Node 1:  USR Courier "V.Everything" 28.8 (619) 462-8406
  886. Node 2:  ZyXEL 16.8 v.32bis              (619) 462-7146
  887.  
  888. I am moderator of the Fidonet IRONOX echo, which is distributed via the
  889. Zone 1 echomail backbone.  Discussion of all Joel Downer doors
  890. (including Fiction Factory) is currently on-topic there.  I also
  891. moderate the OS2DOORS echo, which as of 4/95 has applied for backbone
  892. status.  This echo is specifically for the discussion of OS/2 doors like
  893. Fiction Factory for OS/2 and Iron Ox/2.
  894.  
  895. I also monitor the Fidonet DOORWARE, DOORGAMES and ON_LINE_GAMES
  896. conferences for *personal* mail (please address it to "JOEL DOWNER" if
  897. you want a reply from me!).  I will attempt to reply promptly to echo
  898. messages, netmail/e-mail messages, and messages in the General Mail
  899. conference on my BBS.
  900.  
  901. The latest version of Fiction Factory for DOS and for OS/2 is available
  902. for download on my BBS, for FREQ (magic names:  FICTFACT for the DOS
  903. version, FF2 for the OS/2 version) from either of my Fido nodes, and for
  904. anonymous ftp from ftp.cts.com, in the /pub/joeld directory.
  905.  
  906.                     OTHER SOFTWARE BY JOEL W. DOWNER
  907.  
  908. Iron Ox        Iron Ox is a multiplayer science fiction strategy
  909.                doorgame about the colonization of an alien world.
  910.                Develop land, steal, sabotage, trade with other players,
  911.                cut a deal with the evil luxite pirates... the game
  912.                includes dozens of exciting options!  Your callers can
  913.                play against each other and/or against rather devious and
  914.                nasty computer-controlled characters, on four different
  915.                levels of difficulty.
  916.  
  917.                File:  OXV201.ZIP (DOS Version), Magic Name:  IRONOX
  918.                File:  OX2V201.ZIP (OS/2 Version), Magic Name:  OX2
  919.  
  920. Doors/2        Doors/2 is a complete toolkit for developing C/C++ doors
  921.                for OS/2.  It's based on the OpenDoors API, and allows
  922.                you to port a DOS door written for OpenDoors with little
  923.                more than a recompile!  Features include 32-bit,
  924.                multithreaded performance, full support for a wide range
  925.                of BBS'es/dropfiles, built-in multinode messaging and
  926.                chat, full-screen editing capabilities, and more!
  927.  
  928.                File:  DRS2V5B3.ZIP, Magic Name:  DOORS2
  929.  
  930.                              DISCLAIMER
  931.  
  932. I make no warranty of any kind regarding the usefulness, reliability,
  933. merchantability, or fitness of this software and documentation for any
  934. purpose whatsoever.  While I have tested this program thoroughly, I
  935. cannot and will not make any promises that the program will run well or
  936. safely on your hardware or with your particular software configuration.
  937. This software is guaranteed only to take up disk space, and I make no
  938. absolute guarantee that it will do a reliable job of that. <g>
  939.  
  940. Your use of Fiction Factory and/or any companion material constitutes
  941. your acceptance of these terms.
  942.  
  943.                           ACKNOWLEDGEMENTS
  944.  
  945. Fiction Factory started out as a "quick-'n-dirty" door intended to fill
  946. a need on my BBS -- I couldn't find a decent story door that would work
  947. under DESQview or OS/2 -- and it blossomed into much more.  Excellent
  948. feedback by my testers, Paul Sidorsky, Mike Aleksiuk, Nancy Porter, and
  949. Mike Burgett was a big help.  Several of my BBS callers (Sue Redding,
  950. Jeff Hobbs, Eric Gallina, and Carl Arndt) also helped by pounding on the
  951. program with considerable determination. :-)
  952.  
  953. As always, thanks to Evvie Vincow for love, encouragement, help with
  954. documentation, and iced tea.
  955.  
  956. Fiction Factory's support for RIP uses a C RIP library that is (loosely)
  957. based on Tom Morgan's Pascal RIPLink library.  Thanks to Tom, and to the
  958. maintainers of DDPlus -- Steve Lorenz and Bob Dalton -- for making
  959. RIPLink and the DDPlus tookit, in which RIPLink is now contained,
  960. available in source form to door authors everywhere!
  961.  
  962. The DOS version of this door also uses the OpenDoors C development
  963. system by Brian Pirie.  That system has saved me countless worries about
  964. the details of talking to the modem, reading dropfiles, etc., and I'd
  965. highly recommend it to any C programmer writing a door.  The OS/2
  966. version uses my own Doors/2 port of OpenDoors; see "OTHER SOFTWARE BY
  967. JOEL W. DOWNER" for more information.
  968.  
  969. Finally, thanks to J.R.R. Tolkien, Michael Moorcock, Robert Heinlein,
  970. Frank Herbert, Robert Silverberg, Fyodor Dostoevsky, Kurt Vonnegut,
  971. Orson Scott Card, Stephen R. Donaldson, and Ursula LeGuin for inspiring
  972. my love of fiction and good writing.  If you've never heard of one or
  973. more of the writers on that list, do yourself a favor and drop by a
  974. local bookstore soon. <g>
  975.  
  976.