home *** CD-ROM | disk | FTP | other *** search
/ Between Heaven & Hell 2 / BetweenHeavenHell.cdr / 100 / 41 / agtmacro.arc / AGTMACRO.DOC < prev    next >
Text File  |  1988-05-22  |  9KB  |  316 lines
  1.  
  2.  
  3.                     ADVENTURE GAME TOOLKIT MACROS  1.0
  4.  
  5.  
  6.                  Copyrighted 1988 by:
  7.  
  8.                         David Malmberg
  9.                         43064 Via Moraga
  10.                         Mission San Jose, California 94539
  11.  
  12.  
  13. All rights reserved by David Malmberg.  AGTMACRO may be freely distributed on
  14. BBS's or on SIG and user group disks as long as no fees greater than $8.00 (to
  15. cover the cost of duplication, postage, etc.) are charged for the program and
  16. as long as this notice and the following documentation is also included with
  17. the program.
  18.  
  19.  
  20. INTRODUCTION
  21. ============
  22. AGTMACRO is a specialized Keyboard Macro Processor similar to SUPERKEY or
  23. PROKEY for IBM or compatible computers.  In case you are unfamiliar with
  24. Keyboard Macro Processors, a brief description is appropriate.  A Macro
  25. Processor allows the user to define a series of key stokes and assign them to a
  26. particular key (or combination of keys) -- so that whenever that particular key
  27. is pressed, the sequence of key stokes assigned to it will be "played back" as
  28. if they had been entered from the keyboard one at a time.  Macros like these
  29. allow the user to easily customize software packages (e.g., make your favorite
  30. word processor work like WordStar or vice versa), redefine keyboards (e.g.,
  31. create a Dvorak layout), create boiler plate passages, and serve many other
  32. useful purposes.  AGTMACRO is a special purpose Keyboard Macro Processor in
  33. that it is designed to create templates for frequently used data structures for
  34. the Adventure Game Toolkit or AGT.  Specifically, when AGTMACRO is loaded into
  35. memory it stays resident and causes the combination of the <Alt> key with the
  36. number keys 1 through 7 to create the templates for the following common AGT
  37. data structures:
  38.  
  39.     <Alt>1 -- Rooms
  40.     <Alt>2 -- Nouns
  41.     <Alt>3 -- Creatures
  42.     <Alt>4 -- Other common items in the .DAT file, like INTRO
  43.     <Alt>5 -- Various DESCRiptions, like SPECIAL, PUSH_DESCR, etc
  44.     <Alt>6 -- Meta-commands
  45.     <Alt>7 -- Messages
  46.  
  47. An AGT game developer would normally use AGTMACRO from within his/her favorite
  48. text editor or word processor while creating the various data files that
  49. collectively make up an AGT adventure game.
  50.  
  51. When the user is all done using AGTMACRO to help create the AGT data
  52. structures, it is possible to "unload" AGTMACRO from memory by hitting the
  53. combination of the <Alt> key and the 0 key.
  54.  
  55.  
  56. ROOM TEMPLATES
  57. ==============
  58. The specific ROOM templates created by hitting the <Alt>1 key combination are
  59. as follows:
  60.  
  61.     ROOM <n>
  62.     <Room Name>
  63.     NORTH <n>
  64.     SOUTH <n>
  65.     EAST <n>
  66.     WEST <n>
  67.     NORTHEAST <n>
  68.     NORTHWEST <n>
  69.     SOUTHEAST <n>
  70.     SOUTHWEST <n>
  71.     UP <n>
  72.     DOWN <n>
  73.     ENTER <n>
  74.     EXIT <n>
  75.     SPECIAL <n>
  76.     KEY <n>
  77.     LIGHT 1
  78.     POINTS <n>
  79.     LOCKED_DOOR
  80.     GAME_END
  81.     GAME_WIN
  82.     ROOM_SYNONYMS
  83.     END_ROOM
  84.  
  85.     ROOM_DESCR <n>
  86.     END_ROOM_DESCR
  87.  
  88.     HELP <n>
  89.     END_HELP_DESCR
  90.  
  91. The user would hit the <Alt>1 combination to generate this template, then just
  92. delete the lines that are not desired, and substitute the values appropriate
  93. for the ROOM being defined.  For example, here is an example of a ROOM that
  94. could easily be created from the template:
  95.  
  96.     ROOM 32
  97.     Top of Cliff
  98.     NORTH 33
  99.     SOUTH 34
  100.     WEST 35
  101.     END_ROOM
  102.  
  103.     ROOM_DESCR 32
  104.     You are standing near the edge on the top of a tall cliff.  To the east is
  105.     a sheer drop of several thousand feet.  To the north, south and west are
  106.     paths that lead down the side of the mountain.
  107.     END_ROOM_DESCR
  108.  
  109.     HELP 32
  110.     Be careful, don't get too near the edge!
  111.     END_HELP_DESCR
  112.  
  113. Notice that most of the templates' lines are deleted.  It is easier to delete
  114. these than to type in all of the other stuff that is needed.  Plus, by using
  115. the templates, you can always be assured that your formats are correct for the
  116. various AGT data structures.
  117.  
  118.  
  119. NOUN TEMPLATES
  120. ==============
  121. The specific NOUN templates created by hitting the <Alt>2 key combination are
  122. as follows:
  123.  
  124.     NOUN <n>
  125.     <Name>
  126.     <Adjective>
  127.     <One-line Description>
  128.     SIZE <n>
  129.     WEIGHT <n>
  130.     UNMOVABLE
  131.     LOCATION <n>
  132.     READABLE
  133.     CLOSABLE
  134.     CLOSED
  135.     LOCKABLE
  136.     LOCKED
  137.     KEY <n>
  138.     EDIBLE
  139.     DRINKABLE
  140.     POISONOUS
  141.     ON
  142.     PUSHABLE
  143.     PULLABLE
  144.     PLAYABLE
  145.     TURNABLE
  146.     IS_LIGHT
  147.     POINTS <n>
  148.     GAME_WIN
  149.     CAN_SHOOT
  150.     NUM_SHOTS <n>
  151.     WEARABLE
  152.     POSITION
  153.     PLURAL
  154.     NOUN_SYNONYMS
  155.     END_NOUN
  156.  
  157.     NOUN_DESCR <n>
  158.     END_NOUN_DESCR
  159.  
  160.     TEXT <n>
  161.     END_TEXT
  162.  
  163. Most of the characteristics listed above for the NOUN are NOT the normal
  164. default settings.  For example, the NOUN template has UNMOVABLE, CLOSABLE and
  165. IS_LIGHT while the normal defaults for a NOUN are MOVABLE, UNCLOSABLE and NOT
  166. IS_LIGHT.  To select the default option, just delete the line in the template
  167. that has the non-default option.  For example, to make the NOUN MOVABLE and
  168. SINGULAR, just delete the lines that say UNMOVABLE and PLURAL. 
  169.  
  170. As an illustration, below is a NOUN that could be easily created from the above
  171. templates:
  172.  
  173.     NOUN 232
  174.     Book
  175.     Small
  176.     There is a small book here.
  177.     SIZE 3
  178.     WEIGHT 1
  179.     LOCATION 32
  180.     READABLE
  181.     NOUN_SYNONYMS COVER WRITING TITLE
  182.     END_NOUN
  183.  
  184.     NOUN_DESCR 232
  185.     The small book is quite thin and has a hard cover.  There is writing on
  186.     the book's cover.
  187.     END_NOUN_DESCR
  188.  
  189.     TEXT 232
  190.     The title of the book is "The Wisdom of Ronald Reagan."  The pages are
  191.     all blank.
  192.     END_TEXT
  193.  
  194. Once again, notice that most of the lines of the templates were deleted to
  195. actually create the specific NOUN.
  196.  
  197.  
  198. CREATURE TEMPLATES
  199. ==================
  200. The CREATURE templates created by hitting the <Alt>3 key combination are as
  201. follows:
  202.  
  203.     CREATURE <n>
  204.     <Name>
  205.     <Adjective>
  206.     <One-line description>
  207.     LOCATION <n>
  208.     HOSTILE
  209.     WEAPON <n>
  210.     THRESHOLD <n>
  211.     TIME_THRESH <n>
  212.     POINTS <n>
  213.     GROUPMEMBER
  214.     THING MAN WOMAN
  215.     CREATURE_SYNONYMS
  216.     END_CREATURE
  217.  
  218.     CREATURE_DESCR <n>
  219.     END_CREATURE_DESCR
  220.  
  221. Like the case with the NOUN template, to select the default value for a
  222. CREATURE just delete the line having the non-default value in the template. 
  223. For example, to select the default of a FRIENDLY creature just delete the line
  224. that says HOSTILE.  The only exception is for GENDER, where you should delete
  225. the two values you don't want and leave the value you do want.  For example,
  226. for a FEMALE creature you would delete THING and MAN, but leave FEMALE on the
  227. line.
  228.  
  229.  
  230. OTHER TEMPLATES
  231. ===============
  232. The <Alt>4 key combination creates the following miscellaneous items for the
  233. .DAT file:
  234.  
  235.     INTRODUCTION
  236.     END_INTRO
  237.  
  238.     STARTING_ROOM <n>
  239.  
  240.     TREASURE_ROOM <n>
  241.  
  242.     VERB
  243.     END_VERB
  244.  
  245.     MAXIMUM_SCORE <n>
  246.  
  247. Obviously, the user would delete lines that are not needed.
  248.  
  249.  
  250. DESCR TEMPLATES
  251. ===============
  252. The <Alt>5 key combination creates the following miscellaneous descriptions
  253. templates for the .DAT file:
  254.  
  255.     SPECIAL <n>
  256.     END_SPECIAL
  257.  
  258.     PLAY_DESCR <n>
  259.     END_PLAY_DESCR
  260.  
  261.     PULL_DESCR <n>
  262.     END_PULL_DESCR
  263.  
  264.     TURN_DESCR <n>
  265.     END_TURN_DESCR
  266.  
  267.     PUSH_DESCR <n>
  268.     END_PUSH_DESCR
  269.     
  270.  
  271. META-COMMAND TEMPLATE
  272. =====================
  273. The <Alt>6 key combination creates the following meta-command for the .CMD
  274. file:
  275.  
  276.     COMMAND
  277.     ...
  278.     DoneWithTurn
  279.     END_COMMAND
  280.  
  281.  
  282. MESSAGE TEMPLATE
  283. ================
  284. The <Alt>7 key combination creates the following MESSAGE template for the .MSG
  285. file:
  286.  
  287.     MESSAGE <n>
  288.     END_MESSAGE
  289.  
  290.  
  291. UNLOADING AGTMACRO
  292. ==================
  293. When the user is all done using AGTMACRO to help create the AGT data
  294. structures, it is possible to "unload" AGTMACRO from memory by hitting the
  295. combination of the <Alt> key and the 0 key.
  296.  
  297.  
  298. LIMITATIONS
  299. ===========
  300. AGTMACRO is a very well-behaved TSR program.  To the best of my knowledge, the
  301. only program that it will not work with is SIDEKICK, but AGTMACRO is smart
  302. enough to detect the presence of SIDEKICK and will not allow itself to even get
  303. loaded into memory when SIDEKICK is already loaded.  So, if you are a SIDEKICK
  304. user, you will have to unload it before being able to load and use AGTMACRO.
  305.  
  306.  
  307. ACKNOWLEDGEMENT
  308. ===============
  309. AGTMACRO was written in Turbo Pascal 4.0 using the Turbo Professional 4.0
  310. Toolkit from TurboPower Software.  This package is truly outstanding and made
  311. writing AGTMACRO ridiculously easy!  I can not recommend Turbo Professional
  312. 4.0 too highly.  It is great!  If you are a Turbo Pascal programmer, you can
  313. not afford to be without this package!  Get it!
  314.  
  315.  
  316.