home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbsdoor / hangmn11.zip / INSTALL.DOC < prev    next >
Text File  |  1993-02-28  |  18KB  |  477 lines
  1. This document is effective 12/15/92
  2. INSTALL - BOI 2.00
  3.  
  4. For use with POKERDOR and HANGMAN...
  5.  
  6.     BBS Onliner Interface
  7.     Copyright (C) 1990,1992 Andrew J. Mead
  8.     All Rights Reserved.
  9.  
  10. Introduction
  11.  
  12.     This document is a basic installation guide to doors written with
  13.     the BBS Onliner Interface.  A basic synopsis of the command line
  14.     arguments is given (please see SYSOP.DOC), and examples (if
  15.     available) of installations under various BBS software are also
  16.     given.  You should also read any door specific documentation as
  17.     well since this only covers the options of the BOI.
  18.  
  19.       Sections
  20.  
  21.       Command Line Directives
  22.         Again Play                  /A
  23.         Player Name                 /N
  24.         Quiet Local Console         /Q
  25.         Limit Hall Of Fame          /X
  26.         Redirect Hall Of Fame       /Y
  27.         Maximum Time Limit          /Z
  28.         Communications Directives
  29.           Locked Com Port           /B
  30.  
  31.       Specific BBS Installation Examples and Notes
  32.         Generic Installation
  33.           Batch File Example
  34.         Generic Installation
  35.           Command Line Example
  36.         2 A.M.
  37.         Auntie
  38.         DoorWay to Unlimited Doors
  39.         EIS-PC
  40.         Force
  41.         FoReM
  42.         Forum
  43.         GAP
  44.         Genesis
  45.         GT
  46.         Maximus
  47.         ModuleX
  48.         OLEcom
  49.         Opus 1.13
  50.         Opus 1.14
  51.         PCBoard 12.x
  52.         PCBoard 14.x
  53.         Phoenix
  54.         ProBoard
  55.         QuickBBS
  56.         RBBS (batch /R)
  57.         Remote Access
  58.         RyBBS
  59.         Sapphire
  60.         Searchlight
  61.           Command Line Example (/9)
  62.         Simplex
  63.         Spitfire
  64.         TAG
  65.         Telegard
  66.         TPBoard
  67.         Virtual (batch /4, /S, or /Rn)
  68.         WildCat!
  69.         WWIV (batch /4)
  70.  
  71.       Other Notes
  72.         DESQview
  73.         Windows
  74.         OS/2 and other multitaskers
  75.         File Sharing/Locking
  76.  
  77.       What Went Wrong??? (or "Jane, how do I turn this thing off?")
  78.         Error messages
  79.  
  80. BBS Onliner Interface - Command Line Directives
  81.     Be sure to check out the door specific documentation about any
  82.     other command line directives that may be available.
  83.  
  84.     Again Play (/A:x)
  85.         This option will allow players to play multiple games at one
  86.         sitting as long as they have as muchtime.  If they have more
  87.         "x" minutes left (/a:x).  This option carries no recommendation.
  88.  
  89.     Player Name (/N:User_Name)
  90.         This switch is usually only necessary if the user information
  91.         is passed via command line instead of through a drop file (ie:
  92.         Searchlight BBS).  It can also be used for at home play with a
  93.         batch file to make things simple.
  94.  
  95.     Quiet Local Console (/Q)
  96.         This will keep the bell from beeping on the host computer.  This
  97.         lets the SysOp to spleep at night, and it is highly recommended.
  98.  
  99.     Limit Hall Of Fame (/X:n)
  100.         This options the player to a maximum of "n" appearences in the
  101.         Hall of Fame.  I recommend /x:2 as this keeps one or two rabid
  102.         players from monopolizing the Hall of Fame.
  103.  
  104.     Redirect Hall Of Fame (/Y:<path/filespec>
  105.         I heartily recommend using the text Hall of Fames as online
  106.         bulletins.  The BBSs around here that use the bulletins tend
  107.         to have 5 to 10 times the play as the BBSs that don't.  This
  108.         option is fully explained in SYSOP.DOC.
  109.  
  110.     Maximum Time Limit (/Z:x)
  111.         The BOI normally limits users to the amount of time specified
  112.         in the drop file.  This option allows SysOps to set a maximum
  113.         upper limit.  The game will execute an inactivity time-out at
  114.         approximately two minutes.  It will beep at the halfway point
  115.         and then again when it returns control to the BBS.
  116.  
  117.     Communications Directives (/C /I /K /L F)
  118.         Communications directives are beyond the scope of this
  119.         document.  They are fully explained in SYSOP.DOC.
  120.  
  121.         Locked Com Ports (/B)
  122.             The BOI (when not using FOSSIL), uses RTS (UART Ready To
  123.             Send) handshaking.  When you lock the DTE-DTC rate (your
  124.             computer to your modem) higher than the possible connect
  125.             rate between your modem and the remote (DTC-DTC rate), RTS
  126.             handshaking is insufficient, and may result in modem buffer
  127.             overruns and loss of data.  Adding this switch implements
  128.             RTS/CTS (Modem Clear To Send) handshaking.
  129.             This switch is strongly RECOMMENDED if you do not use F+.
  130.  
  131.  
  132. BBS Onliner Interface - Specific BBS Installation Examples and Notes
  133.  
  134.     This is where you can help.  I need samples.  Please send me your
  135.     setup.
  136.  
  137.     Generic Installation
  138.         Batch File Example
  139.             Until more examples arrive please check WWIV example.
  140.  
  141.         Command Line Example
  142.             Until more examples arrive please check Searchlight example.
  143.  
  144.     2 A.M. BBS
  145.         The /2 option reads JUMPER.DAT.  Installation example not
  146.         available.
  147.  
  148.     Auntie BBS
  149.         The /7 option reads a file called AUNTIE.SYS.  My information
  150.         on Auntie BBS is extremely limited, and you will also need to
  151.         supply the door with the communications information (/C or /I).
  152.         Installation example not available.
  153.  
  154.     DoorWay to Unlimited Doors
  155.         The /S options reads the "short" DOOR.SYS file.  Installation
  156.         example is not available.
  157.  
  158.     EIS-PC
  159.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  160.         available.
  161.  
  162.     Force
  163.         The /S options reads the "long" DOOR.SYS file.  This is a
  164.         proposed standard format for drop files.  Installation example
  165.         is not available.
  166.  
  167.     FoReM
  168.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  169.         available.
  170.  
  171.     Forum
  172.         The /F option reads USERINFO.TXT.  Installation example not
  173.         available.
  174.  
  175.     GAP
  176.         The /S options reads the "long" DOOR.SYS file.  This is a
  177.         proposed standard format for drop files.  Installation example
  178.         is not available.
  179.  
  180.     Genesis
  181.         The support for Genesis' CALLINFO.BBS is untested.  If you try
  182.         this /G option, please let me know whether or not it works.
  183.  
  184.     GT
  185.         The /S options reads the "short" DOOR.SYS file.  Installation
  186.         example is not available.
  187.  
  188.     Maximus
  189.         The BOI is able to read many of the various drop files that
  190.         Maximus can create.  I would really appreciate it if I could
  191.         get hold of a few installation examples.
  192.  
  193.     ModuleX
  194.         The /M option reads NUMBER.TXT.  Installation example not
  195.         available.
  196.  
  197.     OLEcom
  198.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  199.         available.
  200.  
  201.     Opus-CBCS 1.13
  202.         My documentation on Opus 1.13's drop file(s) is incomplete.  I'd
  203.         appreciate any help.
  204.  
  205.     Opus-CBCS 1.14
  206.         The /Oxx option reads LASTUSxx.DAT (where xx is the Opus task
  207.         number in hexadecimal, if xx is not present the door looks for
  208.         a file called LASTUSER.DAT.).  Example:
  209.  
  210.         doorgame /o0e:c:\opus\
  211.  
  212.         the c:\opus\ tells it to look for LASTUS0E.DAT in the C:\OPUS\
  213.         directory.  Complete installation example is not available.
  214.  
  215.     PCBoard 12.x
  216.         The /1 option reads PCBOARD.SYS.  My documentation on this file
  217.         is incomplete, and I'd appreciate any additional information.
  218.         Installation example not available.
  219.  
  220.     PCBoard 14.x
  221.         The /P option reads PCBOARD.SYS.  As per PCBoard specifications
  222.         the BOI will blank out most of this file if the user drops
  223.         carrier while in the door.  Installation example not available.
  224.  
  225.     Phoenix
  226.         The /H option reads INFO.BBS.  Installation example not
  227.         available.
  228.  
  229.     ProBoard
  230.         I would really appreciate any information about dropfiles that
  231.         ProBoard creates.  Installation examples would also be nice.
  232.  
  233.     QuickBBS
  234.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  235.         available.
  236.  
  237.     RBBS
  238.         The /Rx option reads DORINFOx.DAT.  The follow installation
  239.         example is courtesy of Arnold Robinson.
  240.  
  241.         RBBS directory        -> C:\RBBS
  242.         batch file directory  -> C:\RBBS
  243.         batch file            -> DOORGAME.BAT
  244.         doorgame directory    -> C:\RBBS\DOOR
  245.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  246.         bulletins directory   -> C:\RBBS\BULLETIN
  247.  
  248.         RBBS config parm 109  -> DOORS.DEF
  249.  
  250.         Put this line in C:\RBBS\DOORS.DEF
  251.         "DOORGAME",10,,D,"DOORGAME.BAT",N,,30
  252.  
  253.         what the values mean (most are optional), the values ar not
  254.         necessarily recommendation, merely what Arnold uses.
  255.             "DOORGAME"     - name of door
  256.             10             - securitly level
  257.             (blank)        - questionaire to execute
  258.             D              - "D"rop or "S"hell to door
  259.             "DOORGAME.BAT" - batch file to run
  260.             N              - ask for password on return (Y/N)
  261.             (blank)        - file to display on return
  262.             30             - max time allowed in door
  263.  
  264.         C:\RBBS\DOORGAME.BAT listing
  265.             @echo off
  266.             cd c:\rbbs\door
  267.             doorgame /r1c:\rbbs\ /yc:\rbbs\bulletin\ /q /x:2 /a /b
  268.             cd c:\rbbs
  269.  
  270.     Remote Access
  271.         Remote Access can run doors in several different ways (Type 7,
  272.         Type 15, command line).  The BOI should be able to handle all
  273.         of those using either DORINFOx.DAT or DOOR.SYS.  I would
  274.         appreciate any installation examples.  The /Rx option reads
  275.         DORINFOx.DAT.
  276.  
  277.     RyBBS
  278.         The /5 option reads CURRUSER.BBS.  Installation example not
  279.         available.
  280.  
  281.     Sapphire
  282.         My documentation on Sapphire's SAPPHIRE.DAT is incomplete. I
  283.         would appreciate any further information on what dropfiles that
  284.         Sapphire creates.
  285.  
  286.     Searchlight
  287.         I do not have any information regarding any drop files that
  288.         Searchlight creates.
  289.  
  290.         Command Line Example
  291.             The BOI allows BBSes to pass information to it via command
  292.             line.  This bypasses the need for batch files.  By using the
  293.             /9 switch, the BOI knows to get the information it needs
  294.             from the command line.  The /9 tells the BOI where to find
  295.             the door and its associated files.  For example
  296.  
  297.                 c:\slbbs\games\doorgame /9
  298.  
  299.             This command tells the BOI that all extra files (data files,
  300.             hall of fames, etc...) should be kept in c:\slbbs\games\.
  301.             You will also need to tell the BOI the user's name, the
  302.             amount of time the user has left, and the commport.  You
  303.             might try the following:
  304.  
  305.                c:\slbbs\games\doorgame /9 /n%U /z%M (...)
  306.  
  307.             HOWEVER, you cannot use %M. (As of version 1.7 of pokerdor.)
  308.             You must hardcode the minutes by putting in the number:
  309.  
  310.                c:\slbbs\games\doorgame /9 /n%U /z%15 (...)
  311.  
  312.             The %U passes the door the users name (Andrew_Mead), 
  313.             The elipses (...) just represents the other switches 
  314.             you might choose to use.
  315.  
  316.     Simplex
  317.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  318.         available.
  319.  
  320.     Spitfire
  321.         The /6 option reads SFDOORS.DAT.  Installation example is not
  322.         available.
  323.  
  324.     TAG
  325.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  326.         available.
  327.  
  328.     Telegard
  329.         I believe that Telegard creates CHAIN.TXT, and installation is
  330.         probably similiar to that of WWIV.
  331.  
  332.     TPBoard
  333.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  334.         available.
  335.  
  336.     Virtual
  337.         Virtual BBS can create several different drop files.
  338.         Here is an example (courtesy Patrick Murray).  I recommend using
  339.         the /4 (CHAIN.TXT) command, as it shows both user name and
  340.         handle.  You can also use /Rn (DORINFOn.DEF) and /S (long
  341.         DOOR.SYS).
  342.  
  343.         CHAIN.TXT directory   -> C:\VBBS
  344.         batch file directory  -> C:\VBBS\GAMES
  345.         batch file            -> DOOR.BAT
  346.         doorgame directory    -> C:\VBBS\GAMES\DOOR
  347.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  348.         bulletins directory   -> C:\VBBS\GAMES\HOF
  349.  
  350.         VConfig / Doors settings
  351.             1. Program Name: DoorGame (ANSI)
  352.             2. Command Line: C:\VBBS\GAMES\DOOR.BAT
  353.  
  354.         C:\WWIV\GAMES\DOOR.BAT listing
  355.             @echo off
  356.             cd c:\vbbs\games\door
  357.             doorgame /4c:\vbbs\ /yc:\vbbs\games\hof\ /q /x:2 /a /b
  358.             cd c:\vbbs
  359.  
  360.     WildCat!
  361.         The /W option reads CALLINFO.BBS.  Installation example is not
  362.         available.
  363.  
  364.     WWIV
  365.         The /4 option reads CHAIN.TXT.  This is the setting that I use
  366.         on my BBS (The Infinite Improbability BBS, @9952 WWIVnet). The
  367.         sample is for DOORGAME.EXE
  368.  
  369.         CHAIN.TXT directory   -> C:\WWIV
  370.         batch file directory  -> C:\WWIV\GAMES
  371.         batch file            -> door.bat
  372.         doorgame directory    -> C:\WWIV\GAMES\DOOR
  373.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  374.         bulletins directory   -> C:\WWIV\GFILES\HOFSDIR
  375.  
  376.         //CHAINEDIT settings
  377.             A. Description  : DoorGame (ANSI)
  378.             B. Filename     : C:\WWIV\GAMES\DOOR.BAT
  379.             E. ANSI         : Required                <--- Optional
  380.             F. DOS Interrupt: NOT Used                <--- You need this
  381.             G. 300 Baud     : NOT Allowed             <--- Recommended
  382.             H. Shrink       : No                      <--- loads faster
  383.  
  384.         C:\WWIV\GAMES\DOOR.BAT listing
  385.             @echo off
  386.             cd c:\wwiv\games\door
  387.             doorgame /4c:\wwiv\ /yc:\wwiv\gfiles\hofsdir\ /q /x:2 /a /b
  388.             cd c:\wwiv
  389.  
  390. BBS Onliner Interface - Other Notes
  391.  
  392.     DESQview
  393.         The BBS Onliner Interface is DESQview aware.  It will give up
  394.         time to other applications while waiting for input.  If the
  395.         internal async routines are active, it will also alert DESQview
  396.         when it is in a critical state.
  397.  
  398.         Some notes are filtering in about QEMM complaining about the
  399.         command line.  One user stated he got the door working by
  400.         removing the extraneous colons from the command line.
  401.  
  402.                    /sc:\bbs\   instead of   /s:c:\bbs\
  403.  
  404.         I do not understand any of this, but it might help you out.  If
  405.         anyone can document any problems with QEMM or DESQview please
  406.         contact me.
  407.  
  408.     Windows, OS/2 and other DOS multitaskers
  409.         The BBS Onliner Interface will give up time slices to all DOS
  410.         based multitaskers that play by DOSes rules.  I have verified
  411.         reports that since this capability was added, Windows sessions
  412.         in other windows are now much, much faster.
  413.  
  414.     File Sharing/Locking
  415.         The BBS Onliner Interface now supports rudimentary file sharing
  416.         and locking.  If the author of the doors has used the built in
  417.         file handling routines, then the door should run well in multi-
  418.         node environments.
  419.  
  420.     What Went Wrong??? (or "Jane, how do I turn this thing off?")
  421.         Program Crashes at end of game.
  422.             You probably have a corrupted Hall of Fame data file.
  423.             Check the door specific documentation as to what files
  424.             might be involved.
  425.  
  426.         Error messages
  427.             Currently defined error messages that you will find in
  428.             BOIERR.LOG, their causes, and possible solutions.
  429.  
  430.             error  explained
  431.                2   Unkown or incorrect argument on command line.
  432.                3   Unsupported file format.  Please send me any and all
  433.                    information you might have on your BBS software's
  434.                    drop file, and I'll add support for it.
  435.                4   Unable to find file.
  436.                5   Error in file.  This means that file does not match
  437.                    the structure that I have for it.  If you are using
  438.                    a DOOR.SYS drop file, try using the other one (/S /D)
  439.                7   Duplicate directives.
  440.                8   Path/Filename for Hall of Fame is not valid.  You
  441.                    have given the /Y switch an invalid path/filespec.
  442.                9   Path not valid.
  443.               11   Invalid or missing number in /X:nn switch.
  444.               12   /X:nn value out of range.  This must be between 1-19.
  445.               13   Invalid or missing value in /C:n.  "n" must be a
  446.                    valid port number.  1 to 4 if you are not using a
  447.                    FOSSIL driver, and 1 to 8 if you are.
  448.               16   /L can not be used with either /C or /I.
  449.               17   Invald format in /I:i:nnnn.  The nnnn must use all
  450.                    four spaces.
  451.               18   Invald hexadecimal in /I:i:nnnn.
  452.               19   Invalid numeric in /A:x.
  453.               20   /A:x time value must be at least 5 minutes.
  454.               31   Unable to find/initialize FOSSIL driver.  Please
  455.                    notify me, and check your setup.  This switch should
  456.                    only occur if you use the F+ switch.
  457.  
  458.  
  459. BBS Onliner Interface
  460. Copyright (C) 1990, 1992 Andrew J. Mead
  461. All Rights Reserved.
  462.  
  463. Contact:
  464.     Andrew J. Mead
  465.     PO BOX 1155
  466.     Chapel Hill, NC 27514-1155
  467.     USA
  468.  
  469.     1@9952 WWIVnet
  470.     1@9395 VirtualNet
  471.     1:3641/417 FidoNet
  472.     75:7919/417 DoorNet
  473.  
  474.     +919 489 9446 - PCP:NCRTP - V32BIS - 24HRS
  475.  
  476. END INSTALL.DOC
  477.