home *** CD-ROM | disk | FTP | other *** search
/ Aminet 18 / aminetcdnumber181997.iso / Aminet / game / text / AGiliTy.readme < prev    next >
Encoding:
Text File  |  1997-03-02  |  9.6 KB  |  224 lines
  1. Short:    AGiliTy v0.3 - AGT game interpreter
  2. Author:   Robert Masenten (masenten@math.upenn.edu)
  3. Uploader: Bill Hoggett (mas.supplies@easynet.co.uk)
  4. Version:  0.3 beta
  5. Type:     game/text
  6.  
  7. =================================================
  8. AGILITY: THE (MOSTLY) UNIVERSAL AGT INTERPRETER
  9. Version 0.3 (beta)
  10. =================================================
  11.  
  12.   This is an interpreter for game files created with Malmberg and
  13. Welch's _Adventure Game Toolkit_. AGiliTy is universal in the sense
  14. that it understands and interprets most of the many versions of the
  15. AGT game file format (unlike the original interpreters which were
  16. only intended to run the game file format associated with them) and
  17. also in that it is written in ANSI C and so should be straightforward
  18. to port to other systems.
  19.  
  20.   It is *not* a port of the original interpreters but rather a
  21. completely new interpreter built around the game file format; while it
  22. follows the original interpreters on most things, there are some
  23. differences which are described below.
  24.  
  25.    This software is copyright 1996 by Robert Masenten but may be
  26. freely distributed and used for non-commercial purposes so long as
  27. this file (and hence this copyright notice) is included
  28. unaltered. Since this is a beta version, I ask that this not be placed
  29. on FTP sites or BBSs other than the Interactive Fiction archive at
  30. ftp.gmd.de and its mirrors.
  31.   Since this is free software, it has NO WARRANTY of any kind.
  32.  
  33.   For information on compiling and porting this program, see the file
  34. 'agility.doc'. A list of known bugs is in the file 'buglist' and a
  35. list of changes from earlier versions is in 'changes.txt'. (If this is
  36. with a binary and not the source version, some of these files may not
  37. be present).
  38.  
  39.    Send comments and bug reports to Robert Masenten at:
  40.         masenten@math.upenn.edu.
  41.  
  42.  
  43. -----------------
  44. ACKNOWLEDGMENTS
  45. -----------------
  46. Thanks to the following people:
  47.  *David Kinder (responsible for the Amiga port and a source of much
  48. valuble feedback)
  49.  *Jay Goemmer (who has contributed several ideas for improvements)
  50.  *Robert Pelak (who suggested the name "AGiliTy") 
  51.  *All of the other people on rai-f who suggested names for my interpreter.
  52.  
  53.  
  54. -----------------------
  55. AGT VERSIONS SUPPORTED
  56. -----------------------
  57.   AGiliTy is known to understand the following versions of AGT (which
  58. include almost every AGT game at ftp.gmd.de):
  59.   --1.18
  60.   --the early 'Classic AGT': e.g. 1.19, 1.2, 1.21 
  61.   --"Classic AGT", both big and small: e.g. 1.3, 1.32, 1.35, 1.5, 1.7
  62.   --the "Even Bigger 1.32" used by _Cosmoserve_
  63.   --the "Chemically Altered 1.32" used by _Shades of Gray_, 
  64.   --Menichelli's 1.82 and 1.83 (only minimally tested)
  65.   --Both known "pre-Master's" 1.5 variants
  66.   --The "Master's Edition", versions 1.0, 1.55, and 1.56/1.6. 
  67.  
  68.   AGiliTy can't currently read version 1.0 games as these use an earlier
  69. form of the opcode encoding scheme that I haven't finished
  70. deciphering. AFAIK the only game on ftp.gmd.de affected by this is _The
  71. Spatent Obstruction_.
  72.    _Klaustrophobia_ is technically supported but is written in multiple
  73. chapters; while AGiliTy can be used to play the first chapter, the
  74. game depends on DOS programs to switch between chapters (apparently by
  75. doing some magic with save files). 
  76.  
  77.    _The Pyrmaids of Mars_ and _Cliff Diver_ require configuration
  78. options to be set since they use variant interpreters that
  79. are supported but can't be detected by the interpreter.
  80.   _Pyramids_ needs the ALT_ANY option to be set and _Cliff Diver_
  81. requires the IRUN option.
  82.  
  83.  
  84. -----------------------------------------------------------
  85. DIFFERENCES BETWEEN AGILITY AND THE ORIGINAL INTERPRETERS
  86. -----------------------------------------------------------
  87.  --Disambiguation is done on the normal command entry line rather than
  88. having a special prompt.
  89.  --LISTEXIT ON, LISTEXIT OFF will turn automatic listing of exits on or
  90. off (in AGT there is a LIST EXITS command, so some AGT games fail to
  91. list exits to a room).
  92.  --OOPS, UNDO, and RESTART are supported (at least on systems with
  93. enough memory).
  94.  --Adjective-only matches are accepted by the parser.
  95.  --Some more multiple word verbs are automatically recognized (for
  96. example, GET IN is automatically translated into ENTER).
  97.  --Some built-in verbs have additional synonyms. (In particular,
  98. standard one-letter abbreviations are supported: X for EXAMINE, Z for
  99. WAIT)
  100.  --The standard error messages are different than the original (except
  101. in Master's Edition games where most of the standard error messages
  102. are included in the game file)
  103.  --SCRIPT output is sent to a file rather than to the printer.
  104.  --AGiliTy has an extended AGILDEBUG debugging verb and supports more
  105. detailed metacommand debugging output.  
  106.  --AGiliTy uses a different save file format.  
  107.  --COLORS is not supported, although on some systems equivilant
  108. functionality may be supported in the configuration file. 
  109.  --Graphics, sound, and fonts are not supported (although the remaining
  110. Master's Edition language extensions are).
  111.  
  112.  
  113. ----------------------
  114. LIST OF SPECIAL VERBS
  115. ----------------------
  116. These are all of the special verbs recognized by the interpreter:
  117. SCORE   Print out your score.
  118. NOTIFY  Turn score notification on and off
  119. BRIEF   Don't print room descriptions for rooms you've seen.
  120. VERBOSE Print room descriptions even  for rooms you've already seen.
  121. LIST EXITS List the exits from a room.
  122. LISTEXIT ON,OFF  Turn on/off automatic listing of exits.
  123. SCRIPT  Start sending a transcript to a file.
  124. UNSCRIPT  Stop creating a transcript.
  125. LOG     Start sending all of your commands to a file.
  126. REPLAY <number>  Replay your commands from a file, one every <number>
  127.         seconds.
  128. REPLAY STEP  Replay your commands from a file, one for every keypress.
  129. AGILDEBUG  Access debugging commands.
  130. MENU    Toggle menu mode on or off.
  131. OOPS    Correct a word you just mistyped; must be the first command on
  132.         a line.
  133. UNDO    Undo your last move; must be the first command on a line.
  134. SAVE    Save the game.
  135. RESTORE Restore the game.
  136. RESTART Restart the game.
  137. QUIT    Quit 
  138.  
  139.  
  140. --------------------
  141. CONFIGURATION FILES
  142. --------------------
  143.  The following configuration options are supported on all platforms.
  144. Other options may be supported on your particular system; see any
  145. platform-specific notes for information.
  146.   Each option should be on a separate line in the configuration file.
  147. Lines starting with '#' will be treated as comments and ignored.
  148. Options can be negated by prefixing them with 'NO_' so that, for
  149. example, DEBUG would become NO_DEBUG.
  150.  
  151. General options:
  152.   VERBOSE  Start the game in VERBOSE mode
  153.   DEBUG Allow the use of AGILDEBUG for pre-Master's games
  154.   PATH  Gives a space-separated search path for AGT games. (not
  155.         implemented yet)
  156.   TONE  Enables the *tone* action token, which allows games to make annoying
  157.         beeps on some platforms.  The only game I would recommend
  158.         enabling this for is  _CosmoServe_ which has some interesting
  159.         sound effects.  Not all platforms support this command.
  160.   INPUT_BOLD  Makes the input line bold. (This doesn't work on all 
  161.         platforms yet)
  162.   
  163.  
  164. Game specific options
  165.   ROOMTITLE  Print the room title in bold before the room  description 
  166.         in pre-Master's games. (Master's Edition games do this 
  167.         automatically)
  168.   IRUN  Print error messages in first person. This should be set for 
  169.         _Cliff Diver_.
  170.   CONST_TIME  Increment time at a constant rate instead of randomly.  
  171.   SLASH_BOLD  If set the slash character toggles bold on and off.
  172.         (This is set automatically for 1.8x games)
  173.   PRONOUN_SUBS  Do $you$-style substitutions even in  game-author 
  174.         defined messages. 
  175.   ALT_ANY This scans the ANY metacommands *with* the <verb>
  176.         metacommands rather than before them.  Should be set for
  177.         _Pyramids of Mars_. 
  178.  
  179. Technical options: These are fine tuning.
  180.   FIX_METAVERB  Don't run ANY metacommands when executing a metaverb.
  181.   FIX_MULTINOUN   Only advance one turn when manipulating multiple nouns,
  182.         rather than a turn for each noun.
  183.   PURE_ANSWER   Require AND-connected answers to be in the right order.
  184.         (The ME documentation claims order shouldn't matter, but in 
  185.         the actual interpreters it does.)
  186.  
  187.         
  188. Parse Options: These are all pretty technical.
  189.   PURE_DUMMY   Allow dummy verbs to be run by typing "dummy_verb3"
  190.   PURE_SUBNAME Allow subroutines to be run by typing "subroutine3"
  191.   PURE_SYNONYM Treat synonyms exactly as nouns.
  192.   ADJ_NOUN     Don't pick noun matches over adjective-only matches.
  193.   
  194.  
  195. -------------------
  196. DEBUGGING OPTIONS
  197. -------------------
  198.   With AGILDEBUG you can access various debugging commands.  You can
  199. move objects around; change the values of flags, variables and
  200. counters; list objects in the game; examine and edit objects; and turn
  201. metacommand debugging on or off.
  202.   When metacommand debugging is on, every metacommand that is run will
  203. be displayed. 
  204.  
  205.  
  206.  
  207. ============================= Archive contents =============================
  208.  
  209. Original  Packed Ratio    Date     Time    Name
  210. -------- ------- ----- --------- --------  -------------
  211.   136812   64538 52.8% 01-Nov-96 00:05:22 +AGiliTy
  212.      532     209 60.7% 01-Nov-96 00:05:50 +AGiliTy.info
  213.   131136   61853 52.8% 01-Nov-96 00:05:26 +AGiliTyStdIO
  214.      639     371 41.9% 01-Nov-96 00:03:14 +Amiga.txt
  215.      840     319 62.0% 01-Nov-96 00:06:02 +Amiga.txt.info
  216.     8574    3855 55.0% 23-Oct-96 20:52:20 +ReadMe.AGiliTy
  217.      840     320 61.9% 01-Nov-96 00:05:58 +ReadMe.AGiliTy.info
  218.    22910    8419 63.2% 25-Oct-96 20:19:04 +agtread.h
  219.      628     266 57.6% 01-Nov-96 00:05:50  AGiliTy.info
  220.     8942    3956 55.7% 17-Jan-97 21:22:24  AGiliTy.readme
  221.    14015    4499 67.8% 31-Oct-96 23:53:56 +os_amiga.c
  222. -------- ------- ----- --------- --------
  223.   325868  148605 54.3% 18-Jan-97 04:05:30   11 files
  224.