home *** CD-ROM | disk | FTP | other *** search
/ Fatal Distractions! / fataldistractions.bin / appndxa / masters / pophint.doc < prev    next >
Text File  |  1992-10-26  |  16KB  |  427 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                           POPHINT
  11.  
  12.  
  13.                                 A Pop-Up Hint System for IBM
  14.  
  15.                                 Text Adventure Game Players
  16.  
  17.  
  18.                                  Version 2.0 -- October 1992
  19.  
  20.  
  21.                                              By
  22.  
  23.  
  24.                                        David Malmberg
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.                                        Distributed by
  36.                                          Softworks
  37.                                       43064 Via Moraga
  38.                              Mission San Jose, California 94539
  39.                                        (510) 659-0533
  40.  
  41.  
  42.                                          _______
  43.                                     ____|__     |               (tm)
  44.                                  --|       |    |-------------------
  45.                                    |   ____|__  |  Association of
  46.                                    |  |       |_|  Shareware
  47.                                    |__|   o   |    Professionals
  48.                                  -----|   |   |---------------------
  49.                                       |___|___|    MEMBER
  50.  
  51.  
  52.  
  53.  
  54.                             Copyrighted 1992 -- All Rights Reserved
  55.                                        By David Malmberg
  56.  
  57.      JUST WHAT IS POPHINT?
  58.  
  59.  
  60.      POPHINT is a system to enable you to create and use "pop-up" or
  61.      "TSR" or "ram-resident" hint systems for any Text Adventure Game
  62.      that can be played on the IBM.  POPHINT only requires 6K of memory
  63.      (in normal operation).
  64.  
  65.      POPHINT is similar in purpose to UHS, the Universal Hint System,
  66.      available for IBM as well as most other computer systems.  POPHINT
  67.      differs from UHS in that (1) it creates hints that can "pop-up"
  68.      while you are playing the game, (2) it is easier to use, and (3) it
  69.      is only available for IBM and compatibles.
  70.  
  71.      The POPHINT system contains the following files:
  72.  
  73.             POPHINT.DOC   -  The documentation file you are reading now.
  74.             MAKEHINT.EXE  -  A program that "Compiles" your Hints into an
  75.                              encrypted file.
  76.             POPHINT.EXE   -  A TSR that "pops-up" your compiled,
  77.                              encrypted Hint file whenever you hit Alt-H.
  78.                              POPHINT takes as little as 6K of RAM memory
  79.                              (at your option).
  80.             LGOP.TXT      -  A sample Hint file for the Infocom Text
  81.                              Adventure Game "Leather Goddesses of
  82.                              Phobos".
  83.             CAVEHINT.TXT  -  A sample Hint file for the HUMONGOUS CAVE game.
  84.  
  85.  
  86.      COPYRIGHT, ETC.
  87.  
  88.      POPHINT is NOT in the public domain.  It is a copyrighted work and
  89.      the author retains all rights.
  90.  
  91.      However, POPHINT is being distributed free of any royalty.  POPHINT
  92.      can not be sold -- other than a modest disk duplicating fee ($ 7 or
  93.      less) charged by disk vendors like PC-SIG.
  94.  
  95.      Operators of electronic bulletin boards (Sysops) are encouraged to
  96.      post POPHINT and related HINT files for downloading by their users.
  97.  
  98.      The POPHINT documentation may not be modified by users.  The program
  99.      may not be separated from the documentation when distributed.
  100.      Printed or "Xeroxed" copies of the POPHINT documentation (i.e., this
  101.      "manual") may not be distributed or sold without the written
  102.      permission of Softworks.
  103.  
  104.      While, the author has tried very hard to assure that POPHINT works
  105.      correctly and is free of "bugs", no guarantees or warranties of any
  106.      kind are expressed or implied.  Anyone who uses POPHINT, does so at
  107.      his/her own risk.
  108.  
  109.      CREATING A HINT FILE
  110.  
  111.  
  112.      The best way to understand how a hint file is structured is to study
  113.      the following example (which is an excerpt from the "Leather
  114.      Goddesses of Phobos" hint file included as part of the POPHINT
  115.      package):
  116.  
  117.      ;  Leather Goddesses of Phobos HELP
  118.      ;
  119.      ;  Based on UHS help file for LGOP and LGOP.FUN -- both files
  120.      ;  from the ADVENTURE file area of GAMERS forum on CompuServe
  121.      ;*************************************************************
  122.      ;
  123.      TOPIC 1 The Bar
  124.        QUESTION 1 What do I do here?
  125.          ANSWER 1 1.  Order another drink.
  126.          ANSWER 2 2.  What does your bladder want to do?
  127.          ANSWER 3 3.  Go to the appropriate bathroom.
  128.          ANSWER 4 4.  Use it.
  129.          ANSWER 5 5.  Now just wait for a couple of turns.
  130.      ;*************************************************************
  131.      ;
  132.      TOPIC 2 The Prison
  133.        QUESTION 1 How do I get out of my cell?
  134.          ANSWER 1 The guards are really dumb!  They are always forgetting
  135.                   things.  If you examine things carefully, you will
  136.                   discover that they forgot to lock the cell door.  So,
  137.                   just open it by giving the command OPEN DOOR.
  138.        QUESTION 2 What should I do about Trent/Tiffany?
  139.          ANSWER 1 1.  You'll need him/her later in the game.
  140.          ANSWER 2 2.  Just ask him/her to follow you.
  141.        QUESTION 3 How do I decode that piece of paper?
  142.          ANSWER 1 1.  What do jumbled letters usually mean in gaming
  143.                       circles?
  144.          ANSWER 2 2.  Word searches.
  145.          ANSWER 3 3.  You can try to find the words with no list; or,
  146.                       wait until Trent/Tiffany hands you something.
  147.          ANSWER 4 4.  Like a matchbook.
  148.          ANSWER 5 5.  The parts to the weapon are identified by solving
  149.                       the puzzle on the matchbook.
  150.      ;*************************************************************
  151.      TOPIC 3 Venusian Jungle
  152.        QUESTION 1 What can I do about the flytrap?
  153.          ANSWER 1 1.  Have you seen the matrix in Trent/Tiffany's cell?
  154.          ANSWER 2 2.  Have you deciphered the message?  If you haven't,
  155.                       do so.
  156.          ANSWER 3 3.  Hiss at it.
  157.        QUESTION 2 What is an alternate solution?
  158.          ANSWER 1 1.  Go to Cleveland.
  159.          ANSWER 2 2.  Remember that trap in the jungle with a hole in the
  160.                       ground?
  161.  
  162.      Etc., Etc., Etc....
  163.  
  164.      The Hint file has several different kinds of lines:
  165.  
  166.  
  167.      COMMENT LINES:
  168.  
  169.      Any line in the hint file that begins with an ";" is a comment
  170.      line.  Comment lines are ignored by both MAKEHINT and POPHINT.
  171.  
  172.  
  173.      TOPIC LINES:
  174.  
  175.      Each separate hint topic must be signified by being put on a TOPIC
  176.      line.  For example, the in the sample given above, there are three
  177.      separate topics: (1) The Bar, (2) The Prison, and (3) Venusian
  178.      Jungle.  Each TOPIC line must begin with the word "TOPIC" and be
  179.      followed by a number.  These topic numbers must be unique and in
  180.      increasing order within the hint file, i.e., 1, 2, 3 and so on.  The
  181.      various TOPIC "names" (i.e., "The Bar", "The Prison", etc.) will
  182.      appear on the "main choice menu" when POPHINT first pops-up the hint
  183.      file.
  184.  
  185.  
  186.      QUESTION LINES:
  187.  
  188.      Each topic must have one or more QUESTIONS.  For example, in the
  189.      sample above, TOPIC 1 has one QUESTION (specifically, "What do I do
  190.      here?"); TOPIC 2 has three QUESTIONS, and TOPIC 3 has two QUESTIONS.
  191.      Within a TOPIC, the QUESTIONS are numbered and must be in increasing
  192.      order being with number 1.  These QUESTIONS will appear on
  193.      "sub-menus" after the user has selected the TOPIC to which the
  194.      QUESTION applies.
  195.  
  196.  
  197.      ANSWER LINES:
  198.  
  199.      Each question must have one or more ANSWERS.  For example, QUESTION
  200.      1 of TOPIC 1 has five ANSWERS, numbered from 1 to 5.  These answers
  201.      will be revealed sequentially as the user of POPHINT repeatedly hits
  202.      the PgDn key.  ANSWERS may extend over several lines within the hint
  203.      file.  For example, ANSWER 1 for QUESTION 1 of TOPIC 2 is four lines
  204.      long, i.e.:
  205.  
  206.          ANSWER 1 The guards are really dumb!  They are always forgetting
  207.                   things.  If you examine things carefully, you will
  208.                   discover that they forgot to lock the cell door.  So,
  209.                   just open it by giving the command OPEN DOOR.
  210.  
  211.      Notice, that the text for lines 2 thru 4 of this ANSWER must be
  212.      indented under the appropriate text in line 1 of the ANSWER.  If you
  213.      don't indent these follow-on lines, POPHINT will truncate these
  214.      lines where the indentation should take place -- and create and
  215.      display "garbage".  So, don't forget to indent your continued ANSWER
  216.      lines!!
  217.  
  218.      COMPILING YOUR HINT FILE
  219.  
  220.  
  221.      The program MAKEHINT is used to compile your hint file.  This
  222.      compilation process creates an encrypted hint file (with an .HNT
  223.      extension) and then creates the various indices that POPHELP needs
  224.      to pop-up the correct hints, questions, and answers based on the
  225.      user's choices.
  226.  
  227.      The compilation process is invoked by giving the following command
  228.      at the DOS prompt:
  229.  
  230.           MAKEHINT InFile [OutFile]
  231.                            ^
  232.                            |
  233.                            optional
  234.  
  235.      An extension of .TXT is assumed for the InFile.  If OutFile is not
  236.      specified, MAKEHINT creates its encrypted hint file and names it
  237.      InFile.HNT.
  238.  
  239.      For example, both:
  240.  
  241.           MAKEHINT LGOP
  242.  
  243.         and
  244.  
  245.           MAKEHINT LGOP.TXT
  246.  
  247.      will compile the LGOP.TXT hint file and create the encrypted hint
  248.      file LGOP.HNT.
  249.  
  250.      WARNING:  When MAKEHINT is creating an encrypted hint file, it
  251.      creates a temporary file on the disk.  After the encrypted file has
  252.      been created successfully, MAKEHINT erases the temporary file.
  253.      However, in order for everything to work properly, you must have
  254.      enough free disk space to hold both the temporary and the final
  255.      compiled file.  If you don't have enough disk space, MAKEHINT will
  256.      give you an error message and quit processing.
  257.  
  258.      INSTALLING THE POP-UP HINT FILE
  259.  
  260.  
  261.      After you have created the encrypted hint file by running the
  262.      program MAKEHINT, you are ready to install the pop-up hint file.  To
  263.      do this, you give the command:
  264.  
  265.           POPHINT  HintFile [Options]
  266.  
  267.      HintFile is the pathname to the hint file you wish to use.  So, it
  268.      is possible to have the POPHINT program and the hint file on one
  269.      disk and/or directory while the adventure game you are playing is on
  270.      another disk and/or directory.
  271.  
  272.      The following options may be specified on the command line:
  273.  
  274.              /B         Force use of black and white.
  275.              /C         Force use of BIOS rather than direct screen
  276.                         writes.
  277.              /E         Force the use of EMS memory (if available).
  278.              /H HotKey  Specify alternate hot key for accessing hints.
  279.              /M         Disable message appearing while POPHINT swaps to
  280.                         or from disk.
  281.              /N         Force entire POPHINT to remain in memory (no
  282.                         swapping).
  283.              /S Path    Specify drive and/or directory for disk swapping.
  284.              /U         Unload the pop-up hint program from memory.
  285.  
  286.  
  287.      /B OPTION
  288.  
  289.      POPHINT normally auto-selects either mono or color based on what you
  290.      computer can display.  Occasionally, you may want to use mono - even
  291.      on a color monitor.  The /B option can be used to force the use of
  292.      black and white.  You might wish to use this option if POPHINT's
  293.      normal color scheme does not have enough contrast when compared with
  294.      the colors used in the game you are playing.
  295.  
  296.  
  297.      /C OPTION
  298.  
  299.      The option forces POPHINT to use the BIOS rather than to write
  300.      directly to the screen.  The option is useful if you are using
  301.      DesqView or some other product that wants the applications running
  302.      under it to be "well-behaved".
  303.  
  304.  
  305.      /E OPTION
  306.  
  307.      This option forces POPHINT to use EMS memory if it is available.
  308.      POPHINT's normal mode of operation is to swap itself in and out of
  309.      memory as required and to store most of its program on disk.  This
  310.      limits POPHINT's memory requirements to only 6K of conventional
  311.      memory, but it does result in slower operation than if the all of
  312.  
  313.      the program were in memory and the disk swapping were unnecessary.
  314.      If you have EMS memory available, you can use the /E option
  315.      to get POPHINT to run faster.
  316.  
  317.      When not swapping to disk, POPHINT needs about 110K of memory --
  318.      either conventional or EMS memory.
  319.  
  320.  
  321.      /H OPTION
  322.  
  323.      Using this option allows you to specify an alternate hot key for
  324.      popping-up POPHINT and accessing the hints.  A hexadecimal value
  325.      specifying the HotKey you wish to use must follow the /H option on
  326.      the command line.  For example,
  327.  
  328.           /H 021E
  329.  
  330.      would tell POPHINT to use the combination of the left-shift and the
  331.      "A" keys to pop-up the hints.
  332.  
  333.      The hexadecimal value is made up of two parts of two characters
  334.      each.  The first part which is made up by the first two characters
  335.      specifies the shift key(s) to be pressed and must be non-zero.  The
  336.      second part which is made up from the last two characters specifies
  337.      the scan code for the hot key.
  338.  
  339.      Scan key codes (in Hexadecimal):
  340.  
  341.           Alt - 08
  342.           Ctrl - 04
  343.           Left Shift - 02
  344.           Right Shift - 01
  345.  
  346.           A - 1E     N - 31     0 - 0B     F1 - 3B     [ - 1A
  347.           B - 30     O - 18     1 - 02     F2 - 3C     ; - 27
  348.           C - 2E     P - 19     2 - 03     F3 - 3D     , - 33
  349.           D - 20     Q - 10     3 - 04     F4 - 3E     / - 35
  350.           E - 12     R - 13     4 - 05     F5 - 3F     \ - 2B
  351.           F - 21     S - 1F     5 - 06     F6 - 40     ] - 1B
  352.           G - 22     T - 14     6 - 07     F7 - 41     ' - 28
  353.           H - 23     U - 16     7 - 08     F8 - 42     . - 34
  354.           I - 17     V - 2F     8 - 09     F10 - 43
  355.           J - 24     W - 11     9 - 0A     F11 - 57
  356.           K - 25     X - 2D                F12 - 58
  357.           L - 26     Y - 15
  358.           M - 32     Z - 2C
  359.  
  360.      For example: /H 083F pops up hints when <Alt><F5> is pressed.
  361.  
  362.      Unless modified, POPHINT responds to the following hot key:
  363.  
  364.           <Alt><H>  which pops up the hint system
  365.  
  366.      Once the hint system has popped up, you may use the cursor keys and
  367.      the Pg-Up and Pg-Dn keys to move around.  In addition, you may use
  368.      the following hot keys within the hint system:
  369.  
  370.           <F1>       Takes you to the Topic Menu
  371.           <Alt><F1>  Takes you to the previous selection
  372.  
  373.  
  374.      /M OPTION
  375.  
  376.      This option disables the "Swapping" message appearing while POPHINT
  377.      swaps itself in and out of memory and to/from the disk.
  378.  
  379.  
  380.      /N OPTION
  381.  
  382.      This option force the entire POPHINT program to remain in "normal"
  383.      memory (with no disk swapping).  This option is like the /E option
  384.      in that it causes POPHINT to operate faster, but the trade-off is
  385.      that POPHINT requires more memory.
  386.  
  387.      When not swapping to disk, POPHINT needs about 110K of memory --
  388.      either conventional or EMS memory.
  389.  
  390.  
  391.      /S OPTION
  392.  
  393.      This option enables the user to specify the drive and directory for
  394.      disk swapping for the POPHINT program.  Normally, POPHINT uses the
  395.      "default" directory to store its "swap" files.  If you wish to
  396.      change this to another drive and/or directory, use the /S option.
  397.  
  398.  
  399.      /U OPTION
  400.  
  401.      When you are done playing the adventure game and no longer need
  402.      POPHINT, you should use the /U option to unload POPHINT from memory.
  403.      This option also erases POPHINT's swap files from your disk.  These
  404.      files are "hidden" so they can not be seen when you do a DIR -- but
  405.      they are there and they do take up disk space -- so it is important
  406.      to erase them!
  407.  
  408.      ALWAYS USE THE /U OPTION TO UNLOAD POPHINT FROM MEMORY AND TO ERASE
  409.      THE SWAP FILES FROM YOU DISK WHEN YOU NO LONGER NEED THE HINTS!!
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.