home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / BBS / DOORS / BIO110.ZIP / BIO.DOC < prev    next >
Encoding:
Text File  |  1991-05-31  |  17.9 KB  |  480 lines
  1.  
  2.                                   Bio.doc
  3.  
  4.  
  5.                               BioGuide ver 1.0
  6.  
  7.                               by Kent D. Ogle
  8.  
  9.  
  10.  
  11.  
  12.      For serial communications routines, I use a product called "BOI",
  13.  
  14.   which stands for "BBS Onliner Interface", written by Andrew J. Mead.
  15.  
  16.      BOI is a library of Turbo Pascal functions and procedures that help
  17.  
  18.   door authors with development of their products, including redirecting
  19.  
  20.   the I/O serially. If you program in Turbo Pascal, and are interested in
  21.  
  22.   developing your own doors, I suggest BOI.
  23.  
  24.      However, BOI should NOT be confused with the command to evoke my door,
  25.  
  26.   "bio". Bioguide is a Door that will prompt a user for their birthday the
  27.  
  28.   first time they enter, and will display the next week's biorhythm chart.
  29.  
  30.  
  31.   QUICK INSTALLATION:
  32.  
  33.      I'm not the greatest documentation writer in the world, and some
  34.  
  35.   have even gone so far as to complain (imagine that!) about being
  36.  
  37.   confused while trying to install my doors, so I will make this as pain-
  38.  
  39.   less as possible. Here are the steps you need to take to get BIOGUIDE
  40.  
  41.   up and running:
  42.  
  43.           1. What type of BBS software runs the doors?
  44.  
  45.           2. What comport are you using?
  46.  
  47.           3. Recognize the uses of the four files associated with bioguide:
  48.  
  49.              Bio.exe   the executable file
  50.              bio.ros   the roster file of users
  51.              bio.doc   this file
  52.              bio.ctl   control file! Very important!
  53.  
  54.              Next to the command line parameters, this is the most important
  55.  
  56.              part of a successfull installation. A sample is included with
  57.  
  58.              the zipfile, but you MUST change it to reflect your info. The
  59.  
  60.              file looks like this:
  61.  
  62.              SYSOPFIRST Scott
  63.              SYSOPLAST Stuart
  64.              BBSNAME PC-Depot
  65.  
  66.              You can put whatever information you want in this file, but it
  67.  
  68.              MUST follow certain conventions to work correctly!
  69.  
  70.              One space between the label and the data, and a carriage
  71.  
  72.              return at the end of each line. In fact,the labels don't even
  73.  
  74.              need to be there, so long as the data begins at column 12 for
  75.  
  76.              the sysop first name, column 11 for sysop last name, and
  77.  
  78.              column 9 for the board name.
  79.  
  80.           4. Decide which command line parameters you need. This is tricky,
  81.  
  82.              and has caused more than one sysop to pull his hair out. The
  83.  
  84.              BOI is versatile and powerful, and can run on upwards of 40
  85.  
  86.              different BBS's software. (See below to find params)
  87.  
  88.           Once you have done these four things, you will be able to BIOGUIDE
  89.  
  90.           to run. If you have any difficulties, please feel free to contact
  91.  
  92.           me via fidonet at 1:286/777, which is the support board for Bio
  93.  
  94.           and Camptown Races, an animated horse race door (try it out!!).
  95.  
  96.           if you can't do fido, you can use the ever-reliable US Mail.
  97.  
  98.           My address: (you'll need it for registering, too! <grin>)
  99.  
  100.           Kent D. Ogle
  101.           909 West 1st
  102.           Webb City, Mo 64870
  103.  
  104.           Oh, yeah....speaking of registering, I understand the economy is
  105.  
  106.           sluggish and all that, so I'm only asking a measly 5 dollars for
  107.  
  108.           registration. In fact, I think your users ought to pay for it. If
  109.  
  110.           you evaluate this program for a resonable amount of time, I'm sure
  111.  
  112.           someone will become hooked enough to want to help on registration.
  113.  
  114.           'Course if they think it's worth thousands, I'll split it with ya!
  115.  
  116.           The differences between registered and non-registered versions:
  117.  
  118.             1) Message at opening screen
  119.             2) Message at closing screen
  120.             3) User cannot continue until after the 3rd 'EKG blip', whereas
  121.                registered versions allow user to continue after the first.
  122.                This amounts to about a 10 second delay.
  123.  
  124.  
  125.  
  126.      To help you determine which command line parameters to use, I am
  127.  
  128.   including the following text, written by Andrew J. Mead, and used with
  129.  
  130.   his permission.
  131.  
  132.  
  133.      Any comments of my own will appear within "{/// My comments \\\}".
  134.  
  135.  
  136.  
  137.  
  138.   This document is effective 5/16/91
  139.   BBSNOTES
  140.  
  141.  
  142.                  BBS Onliner Interface  version 1.20
  143.                   Copyright (C) 1990 Andrew J. Mead
  144.                          All Rights Reserved.
  145.  
  146.                   Contact:
  147.                        Andrew J. Mead
  148.                        POB 1155
  149.                        Chapel Hill, NC 27514-1155.
  150.                                    or
  151.                        #98 @9968 WWIVnet
  152.                        1:151/223 FidoNet
  153.  
  154.                    Sections (in order of appearance)
  155.  
  156.      General info                -  what this file is
  157.  
  158.      Command Line Directives     -  what options to use
  159.                                     /n Name switch
  160.                                     /q Quiet mode switch
  161.                                     /z Time Limit switch
  162.                                     /i IRQ/PortAddress Customization switch
  163.                                     /l Force Local Mode switch
  164.                                     /c Communication Port Override switch
  165.                                     /b Locked Baud Rate RTS/CTS switch
  166.                                     /k Carrier Detect Override switch
  167.  
  168.      SysOp Control               -  who's playing this game anyway
  169.                                     Current User Line
  170.                                     F-10 SysOp Abort Key
  171.                                     F-9 Line Noise Disconnect Key
  172.  
  173.      Specific BBS Installation
  174.  
  175.      2 A.M. BBS Notes            -  /2  Jumper.Dat installation
  176.      Auntie BBS Notes            -  /7  Auntie.Sys installation
  177.      Force, GAP Notes            -  /S  Door.Sys (long) installation
  178.      Forum Notes                 -  /F  UserInfo.Txt installation
  179.      Genesis Notes               -  /G  CallInfo.BBS installation
  180.      GT, DoorWay Notes           -  /D  Door.Sys (short) installation
  181.      ModuleX Notes               -  /M  Number.Txt installation
  182.      Opus-CBCS 1.13 Notes        -  /3  LastUser.BBS installation
  183.      Opus-CBCS 1.14 Notes        -  /O  LastUsXX.Dat installation
  184.      PCBoard 12.x Notes          -  /1  PCBoard.Sys installation
  185.      PCBoard 14.x Notes          -  /P  PCBoard.Sys installation
  186.      Phoenix Notes               -  /H  Info.BBS installation
  187.      RyBBS Notes                 -  /5  CurrUser.BBS installation
  188.      Sapphire Notes              -  /8  Sapphire.Dat installation
  189.      Search Light Notes          -  /9  Search Light installation
  190.      Spitfire Notes              -  /6  SFDoors.Dat installation
  191.      WildCat Notes               -  /W  CallInfo.BBS installation
  192.      WWIV Notes                  -  /4  Chain.Txt installation
  193.  
  194.      DoorInfo Notes              -  /R# DorInfo#.Def Installation:
  195.  
  196.                                     EIS-PC, FoReM, OLEcom, QuickBBS,
  197.                                     RBBS, Remote Access, TAG, TP-Board
  198.  
  199.  
  200.                            -  General Info  -
  201.  
  202.    This file includes specific notes and examples for most BBS systems
  203.    that this game runs under.  A few basic recomendations:
  204.  
  205.  
  206.                       -  Command Line Directives  -
  207.  
  208.  
  209.    /n this switch is only necessary for use with the /9 SearchLight switch
  210.       or other BBS systems that run the game with command line directives
  211.       instead of using drop files.  It also can be used if you run the
  212.       game locally from DOS.
  213.  
  214.    /q will keep the game from beeping on the host computer.  This enables
  215.       the SysOp to get a good nights sleep.
  216.  
  217.  
  218.    /z sets a maximum time limit.  Normally the game will allow the player
  219.       as much time as he has left to play.  This allows the SysOp to
  220.       encourage players not to fall asleep during games.
  221.  
  222.       The game will execute an inactivity time-out at approximately 2
  223.       minutes.  It will beep at the halfway point and then again when
  224.       it returns control to the BBS.
  225.  
  226.    The game will auto-detect local play, so you can safely play the same
  227.    door locally that the remote users play.
  228.  
  229.    /i allows for customization of your serial communications.  If you are
  230.       using a PS/2 on Com3 or above, or if you are using any non-standard
  231.       IRQ/port address set-up, this option will allow you to get the game
  232.       playing.  This option will not interfere with the game auto-detecting
  233.       local play.  This option (or the /c or /l options) should not be used
  234.       unless absolutely necessary.
  235.  
  236.    NOTE : If you think the game is being forced into local play, check the
  237.    following.  If a remote user is playing the game, the bottom line of the
  238.    host computer will say 'Current User : User's Name or Alias here'.  If
  239.    the line is there, then the game is not locked into local mode.  In local
  240.    mode, the game never displays the 'Current User' line.
  241.  
  242.    /b - Locked BAUD Rate : These programs use RTS handshaking.  If you are
  243.    using a modem with the baud rate locked, then you will want to use this
  244.    switch.  '/B' implements RTS/CTS handshaking, and prevents the game from
  245.    overrunning the modems internal buffer.
  246.  
  247.    /k turns of the games carrier detect routines.  This option is a 'last
  248.        resort' option.  If your modem does not properly maintain a Carrier
  249.        Detect' signal, the game will automatically abort.  This option
  250.        supresses this activity.  If the user does drop carrier, the game
  251.        will still do an inactivity timeout after 2 minutes.  If you are
  252.        forced to use this option, you probably are having hardware problems
  253.        with the modem or RS-232 connector (bad pin or broken wire).
  254.  
  255.  
  256.                            -  SysOp Control  -
  257.  
  258.    Current User Line - The bottom line (line 25) on the BBSs monitor will
  259.        display the name of the player currently logged on.  This will not
  260.        display if the game is being played locally.
  261.  
  262.    F-10 - SysOp abort.  Pressing this key on the host keyboard will abort
  263.        the game in progress, and return control to the batch file, or BBS.
  264.        The user will be notified that the SysOp has terminated the session.
  265.  
  266.    F-9 - Line Noise.  Pressing this key on the host keyboard will simulate
  267.        line noise, then hang up the phone.  It will appear to the user as
  268.        if the connection was trashed.
  269.  
  270.  
  271.                           -  2 A.M. BBS Notes  -
  272.  
  273.    - The /2 option reads a 'Jumper.Dat' file.  For actual installation,
  274.      follow the WWIV example.
  275.  
  276.  
  277.                           -  Auntie BBS Notes  -
  278.  
  279.    - This option is currently in the BETA stage.
  280.    - The /7 option reads a 'Auntie.Sys' file.  You will need to include the
  281.      /c or /i directive with this set-up.  Auntie.Sys does not tell which
  282.      communications port is being used.
  283.    For actual installation,
  284.      follow the WWIV example.  If you have documentation on this file, or
  285.      possibly other files that Auntie BBS creates, please let me know.
  286.  
  287.  
  288.                           -  Force, Gap Notes  -
  289.  
  290.    - The /S option reads a 'Door.Sys' file.  This is the new proposed
  291.      standard for doors.  This format is currently used by Force and GAP.
  292.      For actual installation, follow the WWIV example.
  293.  
  294.  
  295.                              -  Forum Notes  -
  296.  
  297.    - The /F option reads a 'UserInfo.Txt' file.  For actual installation,
  298.      follow the WWIV example.
  299.  
  300.  
  301.                             -  Genesis Notes  -
  302.  
  303.    - The /G option does not currently work.  I do not have sufficient
  304.      information on Genesis' CallInfo.BBS.  It seems to match WildCat's
  305.      upto line 28.  Line 29 should contain communication port information.
  306.      If it does, use the /W directive instead.  I would really appreciate
  307.      some more complete documentation on Genesis.
  308.  
  309.  
  310.                           -  GT, DoorWay Notes  -
  311.  
  312.    - The /D option reads a 'Door.Sys' file.  This is the same Door.Sys that
  313.      is used by Marshall Dudley's DoorWay to Unlimited Doors Program.
  314.      For actual installation, follow the WWIV example.
  315.  
  316.  
  317.                             -  ModuleX Notes  -
  318.  
  319.    - The /M option reads a 'Number.Txt' file.  For actual installation,
  320.      follow the WWIV example.
  321.  
  322.  
  323.                          -  OPUS-CBCS 1.13 Notes  -
  324.  
  325.    - This option does not currently work.
  326.    - The /3 option reads a 'LastUser.BBS' file.  For actual installation,
  327.      follow the WWIV example.  If you have documentation on this file,
  328.      please let me (Andrew J. Mead, address below) know.
  329.  
  330.  
  331.                          -  OPUS-CBCS 1.14 Notes  -
  332.  
  333.    - The /OXX option reads a 'LastUsXX.Dat' file.  The 'XX' is the OPUS
  334.      task number; if it is absent the program will attempt to read a file
  335.      called 'LastUser.Dat'.  an example with a task number (hexadecimal)
  336.      of 'e' would be
  337.  
  338.      Camptown /o0e:c:\opus\   ...
  339.  
  340.      the c:\opus\ tells it to look for 'LastUs0E.Dat' in the C:\OPUS\
  341.      directory.  The '...' is the other command line options (check the
  342.      WWIV example for a more thorough example).
  343.  
  344.  
  345.                           -  PCBoard 12.x Notes  -
  346.  
  347.    - This option is currently in the BETA stage..
  348.    - The /1 option reads a 'PCBoard.Sys' file.  For actual installation,
  349.      follow the WWIV example.  If you have documentation on this file,
  350.      please send it to me.
  351.  
  352.  
  353.                           -  PCBoard 14.x Notes  -
  354.  
  355.    - The /P option reads a 'PCBoard.Sys' file.  For actual installation,
  356.      follow the WWIV example.
  357.  
  358.  
  359.                             -  Phoenix Notes  -
  360.  
  361.    - The /H option reads a 'Info.BBS' file.  For actual installation,
  362.      follow the WWIV example.
  363.  
  364.  
  365.                              -  RyBBS Notes  -
  366.  
  367.    - The /5 option reads a 'CurrUser.BBS' file.  For actual installation,
  368.      follow the WWIV example.
  369.  
  370.  
  371.                             -  Sapphire Notes  -
  372.  
  373.    - This option does not currently work.
  374.    - The /8 option reads a 'Sapphire.Dat' file.  For actual installation,
  375.      follow the WWIV example.  If you have documentation on this file, or
  376.      possibly other files that Sapphire BBS creates, please let me know.
  377.  
  378.  
  379.                           -  Search Light Notes  -
  380.  
  381.    - The /9 option is the reverse of the rest of these BBS switches. Since
  382.      the program is being run directly by SLBBS instead of from a batch file,
  383.      the current directory is the same as the BBS's directory.  /9 will tell
  384.      the game to get the path from the command line.
  385.  
  386.                       c:\slbbs\games\stars\starsbbs /9
  387.  
  388.      This will tell the game to get 'c:\slbbs\games\stars\' from memory.
  389.      You will need to pass more information to make the game run.  I have
  390.      added a /n switch to read the users name.  You should use the %U switch
  391.      so that SearchLight passes the complete name like Andy_Mead.  It
  392.      should look something like /n:%U or /n%U.  The next switch you should
  393.      use is the /z directive to get the user's time remaining.  I believe
  394.      the SL switch is %M, so you should have /z:%M or optionally you can
  395.      set a specific time limit (i.e. /z:20).  The final piece of information
  396.      need is communication port.  My games use /c and SL uses %P.  Therefore
  397.      /c:%P should fit the bill.  A final example (check elsewhere for
  398.      description of /q ) would be
  399.  
  400.            c:\slbbs\games\mad\madness /9 /n:%U /c:%P /z:%M /q
  401.  
  402.      The spaces between switches is mandatory!
  403.  
  404.  
  405.                            -  Spitfire Notes  -
  406.  
  407.    - The /6 option reads a 'SFDoors.Dat' file.  For actual installation,
  408.      follow the WWIV example.
  409.  
  410.  
  411.  
  412.                             -  WWIV Notes  -
  413.  
  414.    - sample WWIV installation
  415.      WWIV,chain.txt directory  - C:\WWIV
  416.      batch file                - bio.bat
  417.      stars.bat directory       - C:\WWIV\GAMES
  418.      starsbbs.exe directory    - C:\WWIV\GAMES\CAMP
  419.  
  420.      bio.bat listing
  421.        echo off
  422.        cd c:\wwiv\games\bio
  423.        camptown /4:c:\wwiv\ /q /z:20
  424.        cd c:\wwiv
  425.  
  426.      chainedit setting
  427.        file - c:\wwiv\games\bio.bat
  428.        dos interrupts - off, this game handles it's own communications
  429.        shrink - doesn't matter - recommend NO
  430.        ansi - required
  431.        allow 300 bps users - recommend NO
  432.  
  433.    - If you are NOT using WWIV then substitute your BBSs switch for '/4'.
  434.  
  435.    - In WWIV mode, the current user line will also display user's
  436.      number and real name.
  437.  
  438.  
  439.                           -  DoorInfo Notes  -
  440.  
  441.    - EIS-PC, FoReM, Professional OLEcom, QuickBBS, RBBS, Remote Access,
  442.      TAG, and TP-Board.
  443.  
  444.    - If you use RBBS (or another DorInfo generating BBS), you will need
  445.      to let the program know what node the program is on.  If you use
  446.      /R by itself, the program will look for a file called DoorInfo.Def.
  447.      /R1 will look for DorInfo1.Def, /R2 will look for DorInfo2.Def, etc...
  448.  
  449.      A sample command line for node 1 would be:
  450.  
  451.      bio /r1:c:\rbbs\ /z:35 /q
  452.  
  453.      where the program looks for DorInfo1.Def in c:\rbbs.
  454.  
  455. {/// I suggest copying the drop file to the bio subdirectory, and
  456.       then deleting it at the end of the game. I have had mixed reports
  457.       with setting the search path in the command line, although I know
  458.       of several boards being able to utilize it, it CAN BE a difficult
  459.       process to implement. If you have trouble getting Camptown up
  460.       and running, try this.  K Ogle \\\}
  461.  
  462.  
  463.  
  464.  
  465.                          BBS Onliner Interface
  466.         Copyright (C) 1990 Andrew J. Mead - All Rights Reserved.
  467.               The Mad Programmer - Brown & Mead Consulting
  468.                   POB 1155 Chapel Hill, NC 27514-1155
  469.  
  470.  
  471.                                BioGuide
  472.                  Copyright (C) 1991 by Kent D. Ogle
  473.                             909 West 1st
  474.                          Webb City, Mo 64870
  475.            Support Board : The PC-Depot, Scott Stuart, sysop
  476.                           fidonet 1:286/777
  477.                   (417)624-3815  HST Dual Standard
  478.                           (please register!)
  479.  
  480.