home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 17 / amigaformatcd17.iso / -screenplay- / shareware / graal / original_archives / graal2a.readme < prev    next >
Text File  |  1997-06-29  |  21KB  |  669 lines
  1. Short:    Graphic Adventure Authoring Language 2.2
  2. Author:   pethu@hotmail.com
  3. Uploader: pethu@hotmail.com
  4. Type:     game/role
  5. Replaces: Graal2a.lha
  6.  
  7.  
  8.  
  9.  
  10.                               ============
  11.                                GRAAL  2.2
  12.                               ============
  13.  
  14.  
  15.                           Contents:
  16.  
  17.                           INTRODUCTION
  18.                           DISTRIBUTION
  19.                           COPYRIGHT NOTICE
  20.                           GRAAL REGISTRATION
  21.                           RELEASE NOTES
  22.                           QUICK-START FOR OLD USERS
  23.                           BUG FIXES AND NEW FEATURES
  24.  
  25.  
  26.  
  27.                               INTRODUCTION
  28.                               ============
  29.  
  30. GRAAL is a script-based Graphic Adventure Authoring Language, delivered to
  31. your electronic doorstep complete with an editor and other development
  32. tools, a demo adventure, and more documentation than you can shake a
  33. pair of strong eye-glasses at.
  34.  
  35.  
  36.  
  37.                               DISTRIBUTION
  38.                               ============
  39.  
  40. GRAAL 2.2 is delivered on 4 disks.
  41.  
  42. The GRAAL aminet archives should be unpacked to a common drawer on
  43. HD or in RAM, or to floppies named as follows:
  44.  
  45.   Graal2a.lha --> "GRAAL 2.2 - Disk A"
  46.   Graal2b.lha --> "GRAAL 2.2 - Disk B"
  47.   Graal2c.lha --> "GRAAL 2.2 - Disk C"
  48.   Graal2d.lha --> "GRAAL 2.2 - Disk D"
  49.  
  50. Anyone equipped with the C= installer program can then use the "HD_Install"
  51. icon found on Disk A to install the system to hard disk, or to update an
  52. existing development directory.
  53.  
  54.  
  55.  
  56.                             COPYRIGHT NOTICE
  57.                             ================
  58.  
  59. GRAAL 2.2 is shareware. Copyright (c) 1997 Per Thulin.
  60.  
  61. This package may be freely distributed, as long as nothing except
  62. distribution costs are charged. All files must be kept together, either
  63. in the original, unaltered archives, or as a full hard disk installation
  64. done with the installer.
  65.  
  66. The GRAAL_2 driver program may be distributed on its own and for free
  67. as part of your own adventure, even commercially. There is no license
  68. fee - however, you should register (see below).
  69.  
  70. The registered user's personal key file, graal.key, must no longer be copied
  71. or re-distributed in any way. (This is a change from earlier versions, 
  72. which required the keyfile to be delivered as part of an encrypted game.
  73. This is no longer necessary.)
  74.  
  75. You are specifically forbidden to use any of the example material -
  76. characters, story, graphics or sound - in your own adventures.
  77.  
  78. I take no responsibility for any loss or damage that may result from the
  79. use of this software.
  80.  
  81.  
  82.  
  83.  
  84.                            GRAAL REGISTRATION
  85.                            ==================
  86.  
  87. The shareware version of GRAAL is not crippled in any way.
  88.  
  89. However, if you want to distribute your adventures, you will probably
  90. want the following:
  91.  
  92. * A way to copy the delivery files to a test directory for final tests.
  93.  
  94. * A way to compress the data to be able to put more on each floppy.
  95.  
  96. * A way to encrypt all scripts, graphics, and sound files to prevent
  97.   people from finding the solution to the game too easily.
  98.  
  99. If you register, you will receive a personal keyfile which enables you
  100. to use the GPRO program to do all of the above. It also enables you to
  101. switch off certain developer functions in the version of GRAAL you
  102. distribute to make it even safer - and harder to crack.
  103.  
  104. As an added bonus, your name appears in lights on the loading screen, 
  105. from which it cannot be removed - an extra copyright protection, you
  106. might say.
  107.  
  108. The keyfile will continue to work with any new versions uploaded
  109. to the Aminet. Updates are thus easily accessible and free of charge.
  110.  
  111. You are also put on a mailing list, and will receive an e-mail GRAAL
  112. newsletter from time to time (provided you are connected to the 'net).
  113.  
  114. Registering is as easy as sending 150 SEK (swedish crowns), or the
  115. equivalent of £ 15 (British pounds), in cash to me:
  116.  
  117.  
  118.                             Per Thulin
  119.                             Malmtorgsgatan 18
  120.                             S-653 40  KARLSTAD
  121.                             SWEDEN
  122.  
  123.      ---------------------------------------------------------------
  124.  
  125.      So, print out the file "registration.form" NOW and get mailin'!
  126.  
  127.      ---------------------------------------------------------------
  128.  
  129.  
  130.  
  131.  
  132.                           SPECIAL MANUAL OFFER
  133.                           ====================
  134.  
  135. Now there is a 100-page, laser-printed, indexed and illustrated version of
  136. the newly revised manual available. Already registered users are hereby
  137. offered to buy this manual in a convenient and terribly inexpensive way:
  138. Just send me five (5) empty, 3.5" DD diskettes along with your complete
  139. name and address, and the manual will be along shortly.
  140.  
  141. (Non-registered users can not get the manual separately, but must pay the
  142. higher shareware fee as stated on the shareware registration form.)
  143.  
  144.  
  145.  
  146.  
  147.                               RELEASE NOTES
  148.                               =============
  149.  
  150.  
  151. This version has been tested on:
  152.  
  153. * A1200 68030/50/50MHz, 16+2 MB RAM, Workbench 3.0
  154. * A600 68000/7MHz, 2+2MB RAM, Workbench 2.05
  155. * UAE/WIN Amiga Emulator 0.6.8 running under Windows 95 on a
  156.   Pentium 133MHz PC (Workbench 2.05).
  157.  
  158.  
  159.  
  160.  
  161.                         QUICK-START FOR OLD USERS
  162.                         =========================
  163.  
  164. Due to all the new features, some of which puts extra straing on the
  165. grahics handling, it is probably wise to recommend a minimum of 2MB RAM
  166. for running GRAAL adventures in the future.
  167.  
  168. Just want to update and go on typing on your own adventure? OK. As usual, 
  169. I've kept the script changes needed to a minimum:
  170.  
  171. 1)  Copy the new GRAAL_2, GRAAL_Editor, GRAAL.guide, GPRO, GREP, and GDC
  172.     to your development directory.
  173.  
  174.     If you have Commodore's installer program, use the HD_Install
  175.     script supplied on disk A to do this!
  176.  
  177.     Delete any old, renamed GRAAL driver programs floating around...
  178.  
  179.  
  180.  
  181. New statement syntax means you have to make small additions to a
  182. couple of statements in graal.main.
  183.  
  184. If you use the values suggested below, the game will behave exactly the
  185. same as before.
  186.  
  187. 2)  Just below the MAX_DACT: statement, put a
  188.  
  189.     MAX_ACTION: 120
  190.  
  191.     statement. This defines the maximum number of ACTION: statements that
  192.     can be used in room and section scripts.
  193.  
  194.  
  195. 3)  Add 10 to the current value of you N_GLOBALBOBS: statement. (The concept
  196.     of the first 10 images being reserved for "system BOBs" is no more...) So,
  197.  
  198.  
  199.  
  200. 4)  Put the following at the end of your COMMAND_AREA: statement:
  201.  
  202.     ;NORMAL
  203.  
  204.  
  205. 5)  Put the following at the end of each VERB_ZONE: statement:
  206.  
  207.     ;0;0; 
  208.  
  209.     (Yes, that's right - don't put anything but a blank after the last ";"
  210.     until you've read about what's supposed to be there!)
  211.  
  212.  
  213. 6)  Change all REMOVE commmands to PUT - they're exactly the same, but
  214.     PUT is what it does, and so is less confusing. (The REMOVE command will
  215.     still be accepted by the driver, but it is spotted by the syntax checker
  216.     in the Editor.)
  217.  
  218.  
  219. 7)  Change all BG_IFF: statements to BACKDROP: for the same reason.
  220.     (The BG_IFF: statement will still be accepted by the driver, but
  221.     it is spotted by the syntax checker in the Editor.)
  222.  
  223.  
  224. 8)  IF you want to use the new 3D scaling features, you MUST put a CHAR:
  225.     and an OBJECT: statement in graal.main for your main character.
  226.  
  227.  
  228. 9)  If you have CHAR: statements, read about the new parameters in the
  229.     on-line reference, and set the height, width, etc. for each to the
  230.     same values as those specified in your  CHARACTER_HEIGHT:, 
  231.     CHARACTER_WIDTH:, CHARACTER_COL:, and WALK_SPEED: statements. Once
  232.     you have done that, you can delete those four statements.
  233.  
  234.  
  235. 10) Examine the second last parameter of your DLG_LAYOUT: statement, and
  236.     add the same value as an additional, last parameter. For example, if
  237.     the DLG_LAYOUT: statement currently ends with:
  238.  
  239.     ...;8;3
  240.  
  241.     it should now end
  242.  
  243.     ...;8;3;8
  244.  
  245.  
  246. 11) The player interface of the demo adventure has been revamped using all
  247.     the latest goodies, so I strongly suggest you install it and have a
  248.     look. (Then go ahead and steal the techniques ;)
  249.  
  250.  
  251.  
  252.  
  253.                         ==========================
  254.                         BUG FIXES AND NEW FEATURES
  255.                         ==========================
  256.  
  257.  
  258. Editor
  259. ======
  260.  
  261.  
  262. * "Array Subscript out of range" message when trying to edit a line in a
  263.   PATH: statement directly after creating it from the "Insert statement?"
  264.   list fixed. (Phew!)
  265.  
  266.  
  267.  
  268. * Bug in syntax check of IFEXISTS condition fixed.
  269.  
  270.  
  271.  
  272. * Bug in syntax check fixed: Editor crashed in extremely small scripts.
  273.  
  274.  
  275.  
  276. * Bug in script template creation fixed: Change counter is now set to number
  277.   of rows in template, so it can be saved with the "Save" command immediately
  278.   upon creation.
  279.  
  280.  
  281.  
  282. * Vertical and horisontal scroll buttons added.
  283.  
  284.  
  285.  
  286. * The window display is now continually updated to show new portions of the
  287.   file as you drag the scroll gadgets.
  288.  
  289.  
  290.  
  291. * New "File" button [F7] added to the parameter editor window. Depending on
  292.   the statement or command, different filters are used in the file requester
  293.   to make it easier to find the file you want to include. Alter the filter
  294.   tooltypes as described above to suit your file naming standards.
  295.  
  296.  
  297.  
  298. * New "3D" button [F8] also added to edit the 3D scaling zones of the 3D:
  299.   statement.
  300.  
  301.  
  302.  
  303. * New <RUN> button (the one with the small GRAAL icon) [F1] starts GRAAL_2
  304.   if it is found in the same directory as the editor. You can specify another
  305.   name for GRAAL_2 using the tooltypes - see below.
  306.  
  307.  
  308.  
  309. * Function key shortcuts added to the "quick locate" buttons:
  310.  
  311.   <OBJECT:>       [F2]
  312.   <DACT:>         [F3]
  313.   <ACTION:>       [F4]
  314.   <LINE:>         [F5]
  315.  
  316.  
  317.  
  318. * New "Create Report" menu item [Amiga]+[G] starts GREP and then loads the
  319.   resulting graal.report file into a new window.
  320.  
  321.  
  322.  
  323. * <Continue> button in the syntax error message box allows you to step
  324.   through, view and count the errors in a script file in one go.
  325.  
  326.  
  327.  
  328. * Selecting and placing images in the parameter editor now also handles
  329.   flipped still images (prefixed with "//") correctly. Still can't help
  330.   you with animations, though - not surprising :)
  331.  
  332.  
  333.  
  334. * When editing the character position relative a new object, the object
  335.   itself is now shown on screen directly - previously, you had to save
  336.   the script and go back into the parameter editor a second time for the
  337.   object to show up.
  338.  
  339.  
  340.  
  341. * Floors and paths are now shown when editing exit points.
  342.  
  343.  
  344.  
  345. * When the Editor gets confused about which room file to use when loading
  346.   graphics, it will now use the "load room" requester. So now you can select
  347.   the correct room with the aid of the room description instead of just
  348.   the file name.
  349.  
  350.  
  351.  
  352. * Various "graphical editing" functions have been updated. An online helptext
  353.   also appears when editing graphics to tell you about the keys and features
  354.   available.
  355.  
  356.  
  357.  
  358. * Tooltypes!!!
  359.  
  360.   SCREEN=WB|NTSC|PAL  WB     (or WORKBENCH) screen opens in same mode as
  361.                              Workbench screen (AGA only)
  362.  
  363.                       NTSC   screen opens in NTSC 640x200 mode regardless
  364.                              of Workbench etc. (AGA only)
  365.  
  366.                       PAL    screen opens in PAL 640x256 mode regardless
  367.                              of Workbench (AGA only)
  368.  
  369.   GRAAL=name          The name of the GRAAL driver program started with
  370.                       the <RUN!> button or the "Run GRAAL" command in the
  371.                       GRAAL menu.
  372.  
  373.   IMAGEFILTER=filter  The filter pattern used when selecting an image file
  374.                       using the <File> button in the parameter editor.
  375.                       Default: #?.pic|#?.iff|#?.i16|#?.i32|#?.i64
  376.  
  377.   TRACKFILTER=filter  The filter pattern used when selecting a tracker module
  378.                       using the <File> button in the parameter editor.
  379.                       Default: #?.trk|#?.track|#?.mod|#?.sng
  380.  
  381.   SAMPLEFILTER=filter The filter pattern used when selecting a sample file
  382.                       using the <File> button in the parameter editor.
  383.                       Default: #?.snd|#?.raw|#?.8svx
  384.  
  385.   Note: do not surround the alternatives in the filter specifications
  386.   with brackets - these will be added by the Editor.
  387.  
  388.   CHECKONSAVE=YES|NO  If this switch is set to YES, script files will be
  389.                       checked with the syntax checker before they are saved.
  390.                       If the syntax error message box appears and you press
  391.                       the <Cancel> button, the file will not be saved. If
  392.                       you ignore any errors by pressing the <Continue> button
  393.                       instead, the file will be saved with the errors still
  394.                       there.
  395.  
  396.   PAINTAPP=paintprog  This sets the path, name and command line arguments of
  397.                       a paint application that can then be launched from the
  398.                       Editor's GRAAL menu. If you use a paint program that
  399.                       allows you to specify a file name as an argument on
  400.                       the command line, you can put "{f}" in this tooltype.
  401.                       This will open a file requester, allowing you to select
  402.                       the picture to be edited, before the paint program is
  403.                       started.
  404.  
  405.                       Example: To start DPaint from GRAAL, use a tooltype
  406.                       similar to this:
  407.  
  408.                       PAINTAPP=path:DPaint C W N U LOAD={f}
  409.  
  410.  
  411.  
  412. Driver
  413. ======
  414.  
  415. * Finally got rid of that ugly white dot in the middle of the cursor.
  416.   If you still want a dot, design your own cursor - with a dot in it...
  417.  
  418.  
  419.  
  420. * ANIM: statement now accepts PTRN specification.
  421.  
  422.  
  423.  
  424. * Bug in OMOVE with a PTRN specification fixed.
  425.  
  426.  
  427.  
  428. * HIDEEXIT works now! (Didn't anybody notice it didn't???)
  429.  
  430.  
  431.  
  432. * Minor bug fixes to the sentence box display for inventory object names
  433.   and direct command names.
  434.  
  435.  
  436.  
  437. * Verb zones can now be highlighted when the cursor moves over them and/or
  438.   when the player clicks them. (VERB_ZONE: statement addition.)
  439.  
  440.  
  441.  
  442. * You can assign keyboard shortcut keys to verbs. When the player presses
  443.   the keyboard key, GRAAL acts as if the verb zone had been clicked.
  444.   (VERB_ZONE statement addition.) Note that any definitions made override
  445.   the default developer and player shortcut keys ([G], [Q], [S], and so on), 
  446.   so think about what key is assigned to what task.
  447.  
  448.  
  449.  
  450. * The command area screen can (optionally) be double buffered to avoid
  451.   flickering when using graphics in the command area. (COMMAND_AREA:
  452.   statement addition.)
  453.  
  454.  
  455.  
  456. * Images can be pasted onto the command area (COMGR command).
  457.  
  458.  
  459.  
  460. * The walking speed can be changed temporarily (WALK_SPEED command).
  461.  
  462.  
  463.  
  464. * Font handling routines have changed completely. This means FONTS: is no
  465.   longer re-assigned to RAM:Fonts, so all your normal fonts are available
  466.   for other applications while the GRAAL driver is running.
  467.  
  468.  
  469.  
  470. * Bug in SAMLOAD command fixed: Didn't reload the same sample after SAM NO
  471.   had been executed in between. Also, there was a "glitch" in the playing
  472.   of tracker modules while using the SAMLOAD command - not anymore.
  473.  
  474.  
  475.  
  476. * Character offset from an object can now be made to include the character's
  477.   width into the calculation. (Previously, the CHARACTER_WIDTH: parameter
  478.   wasn't used for anything at all!)
  479.  
  480.  
  481.  
  482. * The different controllable characters in multiple-character games can now
  483.   have their own heights, widths, speeds, and text offsets. (CHAR: statement
  484.   addition.)
  485.  
  486.  
  487.  
  488. * Controllable characters can be automatically scaled down to 25% of the
  489.   original size (half the height) to match the perspective of the backdrop
  490.   pictures. The scaling zones used can be set per room. (3D: statement.)
  491.  
  492.  
  493.  
  494. * The mouse cursor can be stopped from disappearing during the execution of
  495.   timed events (TCURS command).
  496.  
  497.  
  498.  
  499. * You can enter your own help text with a
  500.  
  501.   SYSTEM_TEXT: 0;"Help text\second line of help text..."
  502.  
  503.   statement. The text appears in the scene area when the player presses the
  504.   [Help] key.
  505.  
  506.  
  507.  
  508. * The dialogue area can be set up so that the line currently under the
  509.   mouse cursor is highlighted. (DLG_LAYOUT: statement addition.)
  510.  
  511.  
  512.  
  513. * You can decide whether the currently controlled character will be spotted
  514.   by the mouse cursor or not (SELECT_CHAR: statement).
  515.  
  516.  
  517.  
  518. * TITLE command now accepts hires and laced screens. (Still no AGA -
  519.   you'll have to make do with good ol' HAM6.)
  520.  
  521.  
  522.  
  523. * HAM6 TITLE screens now fade to black in a nicer way. (They still can't
  524.   be faded in FROM black, though.)
  525.  
  526.  
  527.  
  528. * 2.1 bug in display of LINE: $... fixed.
  529.  
  530.  
  531.  
  532. * COMAREA ON|OFF command lets you switch the display of the command area
  533.   on and off in an easy way.
  534.  
  535.  
  536.  
  537. * You can now start and end a dialogue (DSET, EDLG) while the command
  538.   area is invisible (that is, between COMAREA OFF and COMAREA ON).
  539.  
  540.  
  541.  
  542. * Bugfix in cutscene indicator routine fixed: Cutscene indicator should
  543.   be OK regardless of its position in the command area now.
  544.  
  545.  
  546.  
  547. * It is now possible to construct games where the player can save the came
  548.   from any position - witin a dialogue, or from a room without a visible
  549.   command area. The new demo shows how to do this with a customised
  550.   save/load room. With the built-in requester, it's even simpler.
  551.  
  552.  
  553.  
  554. * Bug in IFCBOB with multiple characters fixed. When testing character
  555.   bob numbers with IFCBOB, you should always use the image numbers used by
  556.   character number 1. For example, if image 14 "belongs" to character 1, 
  557.   doing a CBOB 14 with character 2 active should show the corresponding
  558.   image for character 2, and IFCBOB 14 should subsequently be TRUE.
  559.   Well, in 2.1 it wasn't.
  560.  
  561.  
  562. * New MAX_ACTION: statement allows you to define the number of ACTION:
  563.   statements that can be used in .section and .room scripts.
  564.  
  565.  
  566.  
  567. gpro
  568. ====
  569.  
  570. * When using an alternate diskinfo file (called something other than
  571.   diskinfo.graal), marked with the "no encryption" asterisk, the wrong
  572.   diskinfo file was copied to the test directory. Now fixed.
  573.  
  574.  
  575.  
  576. gdc
  577. ===
  578.  
  579. * If you exceed the space available on a disk - that is, define too many
  580.   files for that disk in diskinfo.graal - the meters now show by how
  581.   much. (The "critical line" is shown in red. If the files on the disk
  582.   are mainly large ones, you MAY get away with one or two "nudges" in the
  583.   red - but no more than that!)
  584.  
  585.  
  586. * Pauses between disk swaps and at the end of the copying procedure has
  587.   been added. This is to prevent people from responding to the prompts
  588.   too soon, removing the diskettes while the drive is in fact still busy.
  589.  
  590.  
  591.  
  592. GREP - GRAAL Report Tool
  593. ========================
  594.  
  595. * This program checks through your adventure, cross-references files and
  596.   diskinfo.graal, and provides you with a lot of useful information. It
  597.   can be run as a stand-alone utility from a CLI shell, but is also
  598.   integrated into the Editor.
  599.  
  600.  
  601.  
  602. Demo adventure
  603. ==============
  604.  
  605. The demo adventure has been updated to show off the command area graphic
  606. features, customised save/load screens, and sound effects.
  607.  
  608.  
  609.  
  610. Documentation
  611. =============
  612.  
  613. The documentation has been updated - again. These points are especially
  614. important:
  615.  
  616.  
  617.  
  618. * DO NOT DISPLAY ORIGINAL AND FLIPPED VERSIONS OF THE SAME IMAGE AT THE
  619.   SAME TIME. The collision detection, screen updating and so on will become
  620.   unpredictable. If you NEED the two orientations simultaneously, you have
  621.   to make each a proper image and store them in the image bank using BOBS:
  622.   statements in the normal way.
  623.  
  624.  
  625.  
  626. * The text for the FOLLOW command stated that you may have to place a
  627.   character that was following the main character inside a floor before you
  628.   SWITCH to it. This problem was eliminated in 2.1 already - don't worry
  629.   about it!
  630.  
  631.  
  632.  
  633. * The width and height in the parameters of ...BOBS: statements and commands
  634.   is actually the true width+1 and the true height+1, respectively. The
  635.   parameter editor gives you the proper values automatically. Those of you
  636.   who specify images manually may have been puzzled by this.
  637.  
  638.  
  639.  
  640. * A description of the syntax of pattern files has been added to the manual, 
  641.   along with loads of other information to make it a more complete source of
  642.   information on the capabilities of GRAAL.
  643.  
  644.  
  645.  
  646. KNOWN BUGS
  647. ==========
  648.  
  649. * I have encountered exactly 1 (one) sample file that doesn't compress
  650.   correctly in gpro. Nothing much I can do about it, and it's no big deal -
  651.   if a sound sample in a compressed game sounds awful, just mark it with
  652.   an * in the diskinfo.graal file to stop it from being compressed.
  653.  
  654. * There is a bug in the tracker player commands I switched to in release 2.1, 
  655.   which means the "stop song" command 0FFE does no longer work. When the tune
  656.   starts over, it may also have a strange tempo. One way of working around
  657.   this and make the song play only once is to put an empty block last in the
  658.   song, and have that block repeat by jumping to itself with a 0B "jump"
  659.   command instead.
  660.  
  661. * If you have a 68030 processor or better, you may have to issue a
  662.  
  663.   > CPU NOCACHE NOBURST
  664.  
  665.   command from a CLI shell before using the editor. Otherwise, graphics
  666.   may become garbled when you use the graphical editing functions -
  667.   Occasionally, not all parts of your images will be shown correctly.
  668.   ( Boy, did I have a hard time figuring out the cause of this one!!! :| )
  669.