home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 021 / ooat11.zip / OOIITERM.DOC < prev    next >
Text File  |  1994-09-22  |  19KB  |  394 lines

  1.  
  2.  
  3.                               ▄  ▄   ▄
  4.                    ▄▀▀▄ ▄▀▀▄▀ ▄  ▄  ▀█▀  ▄▀▀▄ ▄█▀▄ ▄▀▄▀▄
  5.                    █  █ █  █  █  █   █ ▄ █▀▀▀  █   █   █
  6.                     ▀▀   ▀▀  ▄▀  ▀▄  ▀▀   ▀▀▀  ▀   ▀   ▀ ▄
  7.                                    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  8.                                Version 1.10
  9.  
  10.             The Ansiterm program for Operation: Overkill v1.10
  11.  
  12.  
  13.  
  14.    [  TERMS AND CONDITIONS  ]
  15.       ~~~~~~~~~~~~~~~~~~~~
  16.  
  17.  This product is completely copyrighted by Dustin Nulf.  Ideas and actual
  18.  mechanics based on the concept of Operation: Overkill II (which include
  19.  the main scenario, the Complex layout, the Infrared Scanner, Action
  20.  Combat, combat descriptions, all text files, and self-evident ideas) are
  21.  fully copyrighted and registered with the Library of Congress.
  22.  
  23.  In no way should the object code be modified and redistributed.  This
  24.  could result in an abnormal function with the program, in which the
  25.  authors bear no responsibility from the Sysops.
  26.  
  27.  No exterior programs should interfere with the normal registration
  28.  process.
  29.  
  30.  This program is presented on an "as is" basis with no guarantee to the
  31.  system operator or liability against the authors.
  32.  
  33.  
  34.  
  35.    [  WHAT IS A TERM PROGRAM?  ]
  36.       ~~~~~~~~~~~~~~~~~~~~~~~
  37.  
  38.  Introducing with the Operation: Overkill v1.00/1.10 version, a "drop-to-DOS"
  39.  color terminal program, OOIITERM.
  40.  
  41.  What is a "term" program exactly?  In Overkill's case, OOIITERM is a
  42.  separate program that can be used by remote players over the modem when
  43.  they are playing Overkill on a BBS.  OOIITERM is called a "terminal"
  44.  program because of its ability to communicate with the modem and acts in
  45.  a similar fashion to other packaged terminal/communications programs
  46.  (Qmodem, Telix, Telemate, etc).  However, OOIITERM doesn't have all of
  47.  the fancy gadgets that the full-fledged communication programs do.
  48.  Instead, OOIITERM simply communicates through the modem and interprets
  49.  any special commands that the Overkill game sends out.
  50.  
  51.  The main reason a remote player would want to use this OOIITERM program
  52.  when playing Overkill is for speed.  2400 baud callers, for instance,
  53.  will benefit highly from this term program.  At 2400 baud, the text from
  54.  the Overkill game scrolls down the remote player's side at a seemingly
  55.  slow rate; 240 characters per second maximum.  What OOIITERM does is
  56.  speed up this process by over 1000%; faster than 6000 characters per
  57.  second in some cases.  In a blink of an eye, the OOIITERM displays text
  58.  screens that would otherwise take 5-10 seconds to display at 2400 baud.
  59.  Even for the new standard of 14,400 callers, OOIITERM is just as fast.
  60.  
  61.  This package should be available for all of users where an Overkill game
  62.  on a BBS is found.  It also might be beneficial for Sysops to post a
  63.  message in an Overkill game (NEWS.ASC or in the Communications Post)
  64.  directing them to the files section where OOAT11.ZIP/OOAT11SB.ZIP is
  65.  available.
  66.  
  67.  Please note that there are two different versions of the Overkill Ansiterm
  68.  available.  The standard package is called OOAT11.ZIP, and this is the
  69.  basic Ansiterm that has everything but sound.  The other package is called
  70.  OOAT11SB.ZIP and is exactly the same as OOAT11SB.ZIP except that it has
  71.  sound files added to the .ZIP file.  The OOAT11SB.ZIP package supports
  72.  Soundblaster and Soundblaster compatible cards.  Music and sound effects
  73.  can be heard when using the Ansiterm while playing Overkill 1.00/1.10.
  74.  There is more information about the Soundblaster FX in a section below
  75.  about the editing the configuration file, OOIITERM.CFG.
  76.  
  77.  Also, please note that the Overkill Ansiterm can not be used for local
  78.  mode play.  The Ansiterm only works remotely from a player's system.
  79.  For local players, the Overkill program automatically interprets the
  80.  text in Ansiterm mode (even though no remote caller is conneted) for
  81.  for increased speed and local sound.
  82.  
  83.  
  84.    [  SETTING UP OOIITERM  ]
  85.       ~~~~~~~~~~~~~~~~~~~
  86.  
  87.  If you're an Overkill fan and an avid player, you are probably reading
  88.  this portion of the document file after skipping the above sections! <g>
  89.  
  90.  To set up OOIITERM, create a new directory off of your communications
  91.  program directory.  For simplicity, the main term program that I use is
  92.  Qmodem, and the directory that it's in is C:\QMODEM.  So, I would make a
  93.  directory from the Qmodem directory, and I'll call it "OOIITERM".  So
  94.  type in from the DOS prompt of your Qmodem directory:
  95.  
  96.  C:\QMODEM\MD OOIITERM
  97.  
  98.  ...this will make a directory (MD), "OOIITERM", from your Qmodem
  99.  directory.
  100.  
  101.  All of you DOS wizards are smiling right now from the simplicity of the
  102.  making a subdirectory, but just to be sure, all the steps will be
  103.  discussed so that DOS users of all caliber will catch on the first time!
  104.  
  105.  Next, unzip the OOAT11.ZIP/OOAT11SB.ZIP package into this new directory,
  106.  using PKUNZIP.
  107.  
  108.  C:\QMODEM\PKUNZIP OOAT11.ZIP C:\QMODEM\OOIITERM
  109.  
  110.  ...this step will unzip the contents of OOAT11.ZIP into the new
  111.  directory that we previously created.  Now, switch to the new OOIITERM
  112.  directory by typing in:
  113.  
  114.  C:\QMODEM\CD OOIITERM
  115.  
  116.  ...and the prompt should look like:
  117.  
  118.  C:\QMODEM\OOIITERM\
  119.  
  120.  Perform a listing of this directory by typing in "DIR".  A list of
  121.  several files should scroll down your screen.  If this is not the case,
  122.  something went wrong in the above steps in unzipping the OOAT11.ZIP
  123.  package into this directory.
  124.  
  125.  If all is a go, you'll notice a OOIITERM.CFG file in this directory.
  126.  Load up your favorite text editor and edit this ascii file.  You should
  127.  see:
  128.  
  129.  ─[ OOIITERM.CFG ]───────────────────────────────────────────────────────
  130.  
  131. 2           | Modem Com Port     (com port  1,2,3,4)
  132. 4           | Modem IRQ Address  (irq addr  4,3,4,3)
  133. 38400       | Baudrate  (1200,2400,4800,9600,19200,38400,57600,115000
  134. ATZ         | Modem Init String
  135. N           | Activate Sound Effects (Soundblaster/SB Compatible required)
  136.  
  137.  ────────────────────────────────────────────────────────────────────────
  138.  
  139.  The first line of the file is the communications port for your computer
  140.  that your modem is connected to.  Most likely this value is either a 1 or
  141.  2, but can be expanded to 3 and 4.  If you assign the wrong comport to
  142.  this value, you may experience lockups when trying to run OOIITERM.
  143.  
  144.  The second line is the IRQ address that your modem is currently set for.
  145.  Usually, the default values are related to the comports: com 1/irq 4;
  146.  com 2/irq 3; com 3/irq 4; com 4/irq 3.  Of course, your setup maybe
  147.  different for your system.
  148.  
  149.  The third line is the baudrate at which your modem will try to connect
  150.  at.  The majority of the time this field will never change unless you
  151.  change your modem hardware.  For high speed modems, you can set this
  152.  value to 9600, 14400, 19200, or 38400.  Set this option to the rate at
  153.  which you dial out to BBS's.  If you don't have a high speed modem, set
  154.  this rate to 2400 or 1200 baud.  If you experience problems with the
  155.  Ansiterm getting "garbage" or "junk" on the screen, change this line in
  156.  OOIITERM.CFG until you get the correct baudrate value.  Persons with 14.4k
  157.  modems can set this value to 38400 or 19200 baud.
  158.  
  159.  The next line is to be used to initalize your modem when no carrier is
  160.  present upon loadup.  Most modems are already set or have had their
  161.  configuration written to ROM, so an "ATZ" is all that is required.  Refer
  162.  to your modem manual for an exact initialization string if the default
  163.  does not work correctly.
  164.  
  165.  The next line is a toggle to activate the Soundblaster capabilities that
  166.  are built into the Ansiterm.  If you have a Soundblaster card or compatible
  167.  card in your system, and if you have downloaded the OOAT11SB.ZIP package,
  168.  you can set this line to 'Y'.  If you only have the OOAT11.ZIP package,
  169.  which doesn't include the sound FX files, this Soundblaster option will
  170.  not work.  If this is the case, set it to 'N'.
  171.  
  172.  
  173.  To check to see if your sound card is compatible with the Overkill Ansiterm,
  174.  load up the term in local mode.  Type in:
  175.  
  176.  "OOIITERM"
  177.  
  178.  ...at the DOS prompt in your Ansiterm directory.  Press <enter> to bypass
  179.  the "modem not responding" since we're only in local mode.  If you do not
  180.  see any text on the screen that warns you about an incompatible sound
  181.  card or interrupt conflict, your card will more than likely work with
  182.  the Ansiterm.  Next, press F10 to activate a sound.  You should hear:
  183.  
  184.  "Welcome to Operation: Overkill!"
  185.  
  186.  If you don't hear anything, make sure that the volume on your sound card
  187.  is turned up.  If you press F10 again and still don't hear anything, your
  188.  sound card may not be compatible with the Ansiterm.
  189.  
  190.  
  191.  
  192.    [  LOADING OOIITERM  ]
  193.       ~~~~~~~~~~~~~~~~
  194.  
  195.  You can load up OOIITERM in many different ways.  The most simplistic way
  196.  to load the AnsiTerm is to type in "OOIITERM" from DOS, in a directory
  197.  that the term is in (C:\QMODEM\OOIITERM).
  198.  
  199.  To automate this procedure, it would be ideal to have the Ansiterm load
  200.  up with a touch of a button from your communications program.  In most
  201.  terminal programs, there are two ways to automatically load up batch
  202.  files; the first being with "macros" (or sometimes called "hot keys"),
  203.  and the second method dealing with "self-defined download protocols".
  204.  Macros and download protocols save you the time of shelling to DOS,
  205.  changing to the OOIITERM directory, and then executing OOIITERM.
  206.  
  207.  
  208.    I. Macros
  209.  
  210.  Since I use Qmodem, I'll discuss the steps in setting up macros for this
  211.  particular communications program.  However, since not everyone uses
  212.  Qmodem, the macro concepts should work for most communication programs.
  213.  
  214.  With my version of Qmodem, the ALT-J key lets me edit the current macro
  215.  settings.  The macro keys available to me are standard function keys (the
  216.  F1 through F10 keys), Shift-F1..F10, and ALT-F1..F10.  I want to select
  217.  the ALT-F10 key as my "OOIITERM button", meaning that when I press ALT-
  218.  F10, the OOIITERM will automatically load up.  Select ALT-F10 as your
  219.  OOIITERM macro (or the macro keys of your desire), and you should be able
  220.  to type in your macro text.  For Qmodem, there is a neat little function
  221.  that will automatically shell to DOS: "@SHELL".  Other communication
  222.  programs might have a similar command, so press 'F1' for online help if
  223.  its available.
  224.  
  225.  In conjunction with this, we want our macro key to load up a batch file
  226.  that automatically switches to the OOIITERM directory and activate the
  227.  term program.  Let's say the name of the batch file we want to use (we
  228.  haven't created the batch file yet, but we will after this step) is
  229.  "TERM.BAT".  Now in your macro text, type in:
  230.  
  231.  "@SHELL TERM.BAT" (...minus the quotations of course)
  232.  
  233.  After doing this, save that macro and exit back to DOS.  In the main
  234.  directory of your communications program, load up your favorite text
  235.  editor and let's create the TERM.BAT file.  It's contents are simple:
  236.  
  237.  ─[ TERM.BAT ]───────────────────────────────────────────────────────────
  238.  
  239.  cd\qmodem\ooiiterm       'Switch to the directory OOIITERM is in
  240.  ooiiterm                 'Load up OOIITERM
  241.  cd\qmodem                'After OOIITERM exits, return to main directory
  242.  exit                     'Return to the communications program
  243.  
  244.  ────────────────────────────────────────────────────────────────────────
  245.  
  246.  When you are signed onto a BBS and are about to play Overkill version
  247.  1.00/1.10, press your newly created "OOIITERM button" macro key (ALT-F10
  248.  in my case).  Your terminal program should then drop to DOS, execute the
  249.  TERM.BAT file, which in turn loads up OOIITERM.  If this doesn't occur,
  250.  you may need to check your macro text to make sure that it's correct and
  251.  that the macro keys allow for a shell command.
  252.  
  253.  
  254.   II. Self-Defined Download Protocols
  255.  
  256.  With most communications programs, you can also define "external download
  257.  protocols".  These self-defined protocols can be set up in your terminal
  258.  program to load up when you want to download a file.  The external
  259.  protocol program is loaded up with a batch file, which explains how
  260.  OOIITERM can be activated even though we're not really downloading a
  261.  file.  Although using the external download protocols as a means to load
  262.  up OOIITERM, this method is not as efficient as a macro key is.  However,
  263.  if your macro keys do not offer a shelling command, this might be your
  264.  only route.
  265.  
  266.  The first step is to load up your communications program and look for a
  267.  feature that you may edit/alter the protocols.  If you find a section
  268.  that allows you to edit the download protocols and can specify whether
  269.  the protocol is internal or external, you've found the correct section.
  270.  If your program does not have the ability to edit external download
  271.  protocols, don't fret.  You can load up OOIITERM the old fashion way by
  272.  using the "drop-to-DOS" key, switching to the OOIITERM directory, and
  273.  typing in "OOIITERM" manually.
  274.  
  275.  In Qmodem, you fortunately do have the ability to edit external download
  276.  protocols.  Go into this section and add a new protocol field to edit.
  277.  Select a letter that hasn't been used yet in your current list of
  278.  protocols, such as 'O', or 'T', or possibly another key that you know is
  279.  not being used.  Type in a name for the selected protocol, like
  280.  "OOIITERM" or whatever you wish to call it.  Next, you'll probably be
  281.  asked the name of the batch file to invoke.  Type in "TERM.BAT" or
  282.  another name that you'd like associated with the OOIITERM program.  We
  283.  haven't created this file yet, but we will shortly.  The rest of the
  284.  information in the protocol field can be left blank or unedited since
  285.  that's all we need to edit.  Save that information and exit your
  286.  communications program.  Now, we'll create the "TERM.BAT" file that will
  287.  be invoked.  It should look similar to this:
  288.  
  289.  ─[ TERM.BAT ]───────────────────────────────────────────────────────────
  290.  
  291.  cd\qmodem\ooiiterm       'Switch to the directory OOIITERM is in
  292.  ooiiterm                 'Load up OOIITERM
  293.  cd\qmodem                'After OOIITERM exits, return to main directory
  294.  exit                     'Return to the communications program
  295.  
  296.  ────────────────────────────────────────────────────────────────────────
  297.  
  298.  (Note that there is no difference between this batch file and the batch
  299.   file used for the macro keys setup.)
  300.  
  301.  When you are signed onto a BBS and are about to play Overkill version
  302.  1.00/1.10, press the download key (most likely the PGDN key) of your
  303.  communications program.  You should see a listing of available protocols
  304.  for you to choose from.  Press the key that correlates with your new
  305.  OOIITERM protocol.  Your terminal program should then drop to DOS,
  306.  execute the TERM.BAT file, which in turn loads up OOIITERM.  If this
  307.  doesn't occur, you may need to tinker with the download protocol that you
  308.  created and check your TERM.BAT file to make sure that it is in the
  309.  correct directory.
  310.  
  311.  
  312.  
  313.    [  OOIITERM COMMANDS  ]
  314.       ~~~~~~~~~~~~~~~~~
  315.  
  316.  To load up OOIITERM from the DOS prompt, type in "OOIITERM".  The program
  317.  will then attempt to hook into the current modem connection, if any.  If
  318.  your modem is currently connected to another modem, press <ENTER> or '?'
  319.  to see if you get a response.  If you don't get a response for a while,
  320.  the term program may be locked up due to a com port conflict or an
  321.  incompatible baud rate.  In this case, you'll need to exit OOIITERM by
  322.  hitting ALT-X and then edit the configuration file OOIITERM.CFG to make
  323.  the necessary changes.
  324.  
  325.  If you want to test out the program to make sure it is working first, you
  326.  can type in "OOIITERM LOCAL".  Pressing 'F1' will display this help screen:
  327.  
  328.       ┌─────────────────────────────────────────────────────────┐
  329.       │  Operation: Overkill BBS Door Game Ansi-Terminal v1.1a  │
  330.       ┌─────────────────────────────────────────────────────────┐
  331.       │           F1        Θ     Available options             │
  332.       │           F10       Θ     Local sound test              │
  333.       │           ALT-B     Θ     Change baudrate               │
  334.       │           ALT-C     Θ     Clear the screen              │
  335.       │           ALT-D     Θ     Dial a number                 │
  336.       │           ALT-H     Θ     Hangup/Drop carrier           │
  337.       │           ALT-P     Θ     Change comport                │
  338.       │           ALT-S     Θ     Shell to DOS                  │
  339.       │           ALT-X     Θ     Exit Ansiterm                 │
  340.       └─────────────────────────────────────────────────────────┘
  341.  
  342.  
  343.    [  ACTIVATING OOIITERM  ]
  344.       ~~~~~~~~~~~~~~~~~~~
  345.  
  346.  Now that you know how to load up the Overkill Ansiterm, a good question
  347.  would be "So when do I load it up?"
  348.  
  349.  You can load up the Ansiterm any time after you log onto the BBS that
  350.  hosts an Overkill 1.00/1.10 game.  Generally, you'll want to load up the
  351.  Ansiterm before you press the key to enter Overkill on a BBS.  This way,
  352.  you'll be able to see the maintenance information that Overkill displays
  353.  before the actual game part loads up.
  354.  
  355.  
  356.    [  MEMORY REQUIREMENTS  ]
  357.       ~~~~~~~~~~~~~~~~~~~
  358.  The Overkill Soundblaster Ansiterm package (OOAT11SB.ZIP) requires
  359.  more memory than the regular Ansiterm (OOAT11.ZIP).  If you receive any
  360.  runtime errors when Ansiterm is loaded, it is most likely because of
  361.  memory restrictions.  So, when you load up the Ansiterm, make sure that
  362.  you have plenty of conventional memory (640k) available.  If you can
  363.  swap memory to disk when dropping to DOS from your communications
  364.  program, this saves a lot of memory for the Ansiterm.  Also, reduce
  365.  the number of any TSR programs that may be loaded up if you experience
  366.  any runtime errors.
  367.  
  368.  EMM386, QEMM, or some type of memory manager may be required to load the
  369.  ansiterm.  Check your CONFIG.SYS file in the root directory to see if
  370.  a memory manager has been installed.
  371.  
  372.  
  373.    [  TIME CLOCKS/BUFFERS ]
  374.       ~~~~~~~~~~~~~~~~~~~
  375.  Before you run the Ansiterm, your computer must have a functioning internal
  376.  clock.  All new IBMs/compatibles have internal clocks, but some older
  377.  computers may not.  The date and time must also be set correctly.
  378.  
  379.  Some people may experience a "Soundblaster I/O not initialized" error
  380.  when you are not even using the OOAT11SB package and have the configuration
  381.  file set to 'N' for Soundblaster.  If this happens, try raising your
  382.  BUFFERS line of your computer's CONFIG.SYS file (found in the root
  383.  directory).  A value of 25 or 30 should be sufficient.  If problems
  384.  still persist, make sure you have a memory manager present in the
  385.  CONFIG.SYS file in your root directory (for example, EMM386 or QEMM).
  386.  
  387.  
  388.  Please spread this file around as much as possible, and I hope you
  389.  enjoy the Overkill Ansiterm!
  390.  
  391.  Operation: Overkill and the Overkill Ansiterm are copyrights and licenses
  392.  of Dustin Nulf.
  393.  
  394.