home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 8 / amigaformatcd08.iso / screenplay / utilities / graal / prod.text < prev    next >
Text File  |  1996-10-15  |  9KB  |  273 lines
  1.  
  2.  
  3. THE PRODUCTION PROGRAMS - GPRO AND GDC
  4. ======================================
  5.  
  6. Finally, a little documentation for the "production" programs
  7. GPRO and GDC.
  8.  
  9.  
  10.  
  11. The Diskinfo File
  12. =================
  13.  
  14. The programs rely on a "diskinfo" file to tell them which files
  15. should be copied. A diskinfo file must contain the following:
  16.  
  17. On line 2 (and nowhere else): The common part of the delivery diskette
  18. volume name, for example
  19.  
  20.   MYADVENTURE_DISK
  21.  
  22. When GDC does its stuff later, the diskettes will then be labelled
  23.  
  24.   MYADVENTURE_DISK A
  25.   MYADVENTURE_DISK B
  26.  
  27. and so on.
  28.  
  29.  
  30. Below line 3: The names of all the files, grouped according to delivery
  31. diskette. Each filename is on its own line, preceeded by the diskette
  32. suffix and a space. For example:
  33.  
  34. A 1.room
  35.  
  36. means the file 1.room is delivered on MYADVENTURE_DISK_A.
  37.  
  38. Remember: The files should be grouped according to volume, and the groups
  39. should be sorted alphabetically, starting with everything on diskette A.
  40.  
  41. You may have as many comment lines and empty lines in between the file
  42. entries as you like.
  43.  
  44. The following stuff should ALWAYS be on diskette A:
  45.  
  46. 1)  GRAAL_2
  47.  
  48.     The main program. It does not have to be called GRAAL_2 - rename
  49.     it to anything you want your adventure called.
  50.  
  51. 2)  FONTS
  52.  
  53.     A special entry which copies the entire fonts: drawer in your
  54.     development directory.
  55.  
  56. 3)  graal.main
  57.  
  58.     The graal.main file
  59.  
  60. 4)  The picture files for the command and dialogue areas (if you don't
  61.     specify DEFAULT, in which case the graphics included in the GRAAL_2
  62.     program itself are used).
  63.  
  64. 5)  The resource file for requesters (suffix .rsb). If you use the
  65.     DEFAULT, no entry is needed - it's already in the GRAAL_2 program
  66.     itself.
  67.  
  68.  
  69.  
  70.  
  71.  
  72. GPRO
  73. ====
  74.  
  75. The GPRO program is used for copying the files that make up your
  76. adventure (the ones that should go on the delivery diskette) from the
  77. development directory (which can be a right old mess) to a test directory, 
  78. containing only what is needed to run the adventure.
  79.  
  80. You should test the adventure thoroughly in the test directory, making sure
  81. everything is included, before making the delivery diskettes.
  82.  
  83. This program is only available to registered users (in other words, it needs
  84. the personal keyfile to work). Unregistered users are confined to copying
  85. the game files directly onto the delivery diskettes from the development
  86. directory using GDC, and then testing the diskettes.
  87.  
  88.  
  89. Starting GPRO
  90. -------------
  91.  
  92. GPRO runs from CLI only. Open a shell, and switch to your development
  93. directory. Then type GPRO.
  94.  
  95.  
  96. The user interface is as follows:
  97.  
  98.  
  99.  
  100.        +------------------------------------------------+
  101.        |                                                |
  102.        |   Encrypt: < > Yes < > No   Simulation: < >    |
  103.        |                                                |
  104.        |                                                |
  105.        |   Diskinfo:    [ diskinfo file name          ] |
  106.        |                                                |
  107.        |                                                |
  108.        |   Destination: [ destination directory name  ] |
  109.        |                                                |
  110.        |                                                |
  111.        ! ============================================== |
  112.        |                                                |
  113.        |                                                |
  114.        | [ message field                              ] |
  115.        |                                                |
  116.        |                                                |
  117.        |                              ( Copy ) ( Exit ) |
  118.        |                                                |
  119.        +------------------------------------------------+
  120.  
  121.  
  122. Encrypt:
  123.  
  124. Click "Yes" if the script files should be encrypted, and the
  125. comments removed, when copying the files. Do this only in the very
  126. last run when you are certain everything is OK.
  127.  
  128. Note that encrypted games ALWAYS require the keyfile to run, so
  129. include an entry for the keyfile (on diskette A) in the diskinfo
  130. file when you produce the final, encrypted master diskettes.
  131.  
  132.  
  133. Simulation:
  134.  
  135. Click this if you just want to test the contents of the
  136. diskinfo file. The Copy function will just "go through the motions", 
  137. showing what would happen if you had been copying for real.
  138.  
  139.  
  140. Diskinfo:
  141.  
  142. You can choose the name of the diskinfo file to use here.
  143. You can, for example, have one diskinfo file for demo versions and
  144. one for "live" versions in your development directory. (I use this
  145. facility to produce a GRAAL delivery from the "Olaf" development
  146. directory, which normally produces only the "Olaf" game itself.)
  147.  
  148. Note that the selected file is renamed "diskinfo.graal" (the default name)
  149. in the destination directory, and therefore, "diskinfo.graal" is the name
  150. that should ALWAYS be used when referring to the diskinfo file IN the
  151. diskinfo file!
  152.  
  153.  
  154. Destination:
  155.  
  156. The name of a hard disk directory, which, by the way, must exist already.
  157.  
  158. GPRO saves the names of the last diskinfo file and destination directory
  159. in a file, and so remembers the settings until the next time it is used.
  160.  
  161.  
  162. Status bar:
  163.  
  164. A green stripe shows how far the copying has progressed.
  165.  
  166.  
  167. Message field:
  168.  
  169. A text shows what is currently going on during the copy operation.
  170.  
  171.  
  172. Copy and Exit:
  173.  
  174. Really... you'll just have to find out for yourself!
  175.  
  176.  
  177.  
  178.  
  179. GDC
  180. ===
  181.  
  182. GDC is the program that copies the game files to the final delivery
  183. diskettes. You MUST use this program to prepare the diskettes.
  184.  
  185. However, GDC is not intended for making copies of the game. Just
  186. use GDC to make the "master diskettes", and then use some proper diskette
  187. copying software for the copies.
  188.  
  189.  
  190. If you have run GPRO, the GDC program was copied to the test directory
  191. automatically, and you should run it from there.
  192.  
  193. If you don't have access to GPRO, you run GDC directly from the development
  194. directory.
  195.  
  196. GDC runs from CLI only. Open a shell, and switch to the appropriate
  197. directory. Then type GDC.
  198.  
  199.  
  200. The user interface is as follows:
  201.  
  202.  
  203.        +------------------------------------------------+
  204.        |                                                |
  205.        |   Format: < > Quick < > Normal  ( Check Sizes) |
  206.        |                                                |
  207.        |                                                |
  208.        |  | | | | | | | | | | | | | | | | | |           |
  209.        |  | | | | | | | | | | | | | | | | | |           |
  210.        |  | | | | | | | | | | | | | | | | | |           |
  211.        |  | | | | | | | | | | | | | | | | | |           |
  212.        |  | | | | | | | | | | | | | | | | | |           |
  213.        |  A B C D E F G H I J K L M N O P Q R           |
  214.        |                                                |
  215.        ! ============================================== |
  216.        |                                                |
  217.        |                                                |
  218.        | [ message field                              ] |
  219.        |                                                |
  220.        |                                                |
  221.        |                              ( Copy ) ( Exit ) |
  222.        |                                                |
  223.        +------------------------------------------------+
  224.  
  225.  
  226. Format:
  227.  
  228. To prepare the diskettes, and label them properly, GDC first
  229. formats each diskette. This can be done quickly, if the diskette has
  230. been pre-formatted, or in the normal fashion, in which case the previous
  231. formatting status of the disk is not important.
  232.  
  233.  
  234. Check Sizes:
  235.  
  236. This is normally done automatically when you start GDC.
  237.  
  238. The "gauges" or "meters" labelled A, B, and so on, are updated to
  239. show how much space is used on each disk. If you have specified
  240. too much for a certain volume in the diskinfo file, that meter turns red
  241. to show you must edit the diskinfo file and re-distribute the files to
  242. make it all fit. (We're talking standard DD 880K diskettes here, of course.)
  243. If you have left GDC running while editing the file, you could use the
  244. button to re-calculate the space requirements.
  245.  
  246. (On the other hand, it might be a good idea to exit the program, make d*mn
  247. sure you update the right file in the right place, and only then re-run
  248. GDC...)
  249.  
  250.  
  251. Status bar:
  252.  
  253. When you press Copy, each diskette meter in turn is gradually
  254. emptied, and this line starts growing instead to show how far the copy
  255. operation has progressed.
  256.  
  257.  
  258. Message field:
  259.  
  260. If anything goes wrong, this is where you should get told.
  261.  
  262. ( Copy ) and ( Exit ): Once more, pretty obvious...
  263.  
  264.  
  265. You don't need more than 18 diskettes, do you? Please! Tell me you don't!
  266.  
  267.  
  268.  
  269. EXTREMELY NICE TIP: It's good practice to keep the diskinof.graal file
  270. updated during development, and start GDC now and then to see if the
  271. distribution of files seem about right with respect to the space
  272. requirements...
  273.