home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 18 / amigaformatcd18.iso / -readerstuff- / david_roberts / ias.docs < prev    next >
Text File  |  1997-07-18  |  8KB  |  232 lines
  1.  
  2.                      IAS: Imagine Attribute Searcher
  3.                      -------------------------------
  4.                 © July 1997 by Oovis. Freely Distributable
  5.                               Version 1.06.
  6.                           First Public Release.
  7.  
  8.  
  9. What is it?
  10. -----------
  11.  
  12.  IAS is a small program which will scan an Imagine object file and tell you
  13. what textures and brushes have been applied to the object(s) within that
  14. file.
  15.  IAS will scan all groups and subgroups contained within a file and give the
  16. name of any subpart with textures and/or brushes applied.
  17.  IAS can automatically convert files from PC to Amiga versions or vice-versa
  18.  IAS will scan for TXT2, TXT3 and TXT4, BRS3, BRS4 and BRS5 chunks within the
  19. TDDD object file
  20.  
  21.  
  22. How Do I Use It?
  23. ----------------
  24.  
  25.  Firstly you must copy the program IAS to somewhere in your search path,
  26. e.g. your C directory.
  27.  Secondly you must have a version of Imagine installed on your hard drive,
  28. as installed by the included Installer program. IAS tests for the existence
  29. of textures within the imagine/textures subdirectory.
  30.  
  31.  IAS should work with version 2, 3, 4 and 5 objects. If you find an object on
  32. which IAS misses textures or brushes please send the object to me on disk
  33. and I'll have a look and try to send you a fixed IAS in return (see below).
  34.  
  35.  If the object's texture information contains assigns to partitions or disks
  36. which AmigaDOS cannot find a system requester will appear asking for the
  37. relevent disk. If you do not possess the named disk click CANCEL, otherwise
  38. insert the disk in any drive.
  39.  
  40.  IAS is CLI only at the moment. If there is enough demand I may try to get
  41. my head round intuition and provide a GUI version in the future.
  42.  
  43.  IAS needs input parameters as follows:
  44.  
  45.  IAS {*options} <object> <Home Directory>
  46.  
  47. OPTION
  48. ------
  49.  
  50.  option is as follows:
  51.  
  52.     *p to redirect output to the printer.
  53.     *b to give more detailed information about applied brushes
  54.     *c to convert and re-save PC files as Amiga files
  55.     *u to convert and re-save Amiga files as PC files
  56.  
  57.     These can be combined in the command input as *pbc or *bcp etc.
  58.  
  59.  N.B. *u and *c are mutually exclusive. You cannot use both at the same time.
  60.       If you try this you will get an error message.
  61.       If you do something like *cC you will also get an error message.
  62.         Options can only be specified once each on the command line.
  63.  
  64.       In order to convert files the disk must be write enabled. Therefore
  65. you cannot convert a file straight from a CD-Rom. Copy the file to RAM or
  66. another disk first.
  67.  
  68. OBJECT
  69. ------
  70.  
  71.  object is the name of the object file you wish to examine. It must be in
  72. the current directory.
  73.  
  74. HOME DIRECTORY
  75. --------------
  76.  
  77.  Home Directory is the directory where you have installed Imagine on your
  78. system. You can use assigns if you've set them up.
  79.  
  80.  EXAMPLE:
  81.  
  82.  My copy of Imagine is in a subdirectory called Imagine5 in the tools
  83. directory of dh1:. Therefore my Home Directory is dh1:tools/Imagine5
  84.  
  85.  To test and object called star.ship on df1: I type the following in a
  86. CLI (Shell) window:
  87.  
  88.  cd df1:
  89.  IAS star.ship dh1:tools/Imagine5
  90.  
  91.  The path to Imagine is assigned in my user-startup as Imagine5:, so I could
  92. also use the following
  93.  
  94.  cd df1:
  95.  IAS star.ship Imagine5:
  96.  
  97.  
  98.  A table will then be output something like this:
  99.  
  100. IAS: Imagine Attribute Searcher. Version 1.06. © Oovis 1997
  101. See Documentation for details.  This program is FreeWare.
  102. This version revised 7 July 1997.
  103.  
  104.  Part name               Texture/Brush applied                      Test
  105. ------------------------------------------------------------------------
  106. HULL                     textures/dethstar(.itx)                    OK
  107. PANEL.1                  brushes/name.ilbm                          OK
  108.  
  109.  
  110. # of textures required :  1  # of textures not located :  0
  111. # of brush applications: 1   Number not found: 0
  112.  
  113.  
  114.  The test column will tell you if you have the texture on your harddisk or
  115. not.
  116.  
  117.  Brush details such as size and colour count will only be output if the
  118. *b option is specified.
  119.  
  120.  N.B. 1: I only have the specification for BRS4 brushes, so some application
  121. information from older versions of imagine than V4.00 may not be entirely
  122. correct.
  123.       2: If brushes are not in the directory specified within the TDDD file
  124. they will fail to be found, even though they may be somewhere else on your
  125. hard disk, and Imagine will also fail to find them. You should copy the
  126. brush files to the directory as it appears from IAS in order to use them.
  127.  
  128.  IAS searches as follows:
  129.  1) Search for the texture as its name is saved in the TDDD file using the
  130.      Home Directory as input by the user
  131.  2) Add .itx to the name and search again
  132.  3) Try to find the name as saved without using the Home Directory. This
  133.      enables a search of assign paths, or other disks.
  134.  
  135.  Now, Imagine saves all texture names without the .itx extension. I think
  136. that the .itx versions are used by the floating point version of Imagine and
  137. the non .itx by the Integer versions, and are therefore incompatible. IAS
  138. will add '(.itx)' to the name on the info line if this version has been
  139. found on your hard disk.
  140.  
  141.  If the texture names come out with a \ instead of / they will all fail.
  142. This is because the object is for the PC version of Imagine not the Amiga
  143. version.
  144.  
  145.  The *c option will convert the files and test them at the same time so you
  146. don't have to run IAS twice to convert then test files.
  147.  
  148.  A short info line appears at the bottom of the output table if the object
  149. appears to be a PC type object and *c was not specified.
  150.  
  151.  Redirecting the output
  152.  ----------------------
  153.  
  154.  If you want a hard copy of the output from IAS you can use the standard
  155. redirection technique as follows:
  156.  
  157.  To print the file use
  158.  
  159.     IAS >prt: <object> <Home Directory>
  160.  
  161.  or using the option switch *p
  162.  
  163.     IAS *p <object> <Home Directory>
  164.  
  165.  To save the table as an ASCII file use something like
  166.  
  167.     IAS >Ram:testtable <object> <Home Directory>
  168.  
  169.  
  170. Who wrote this and why?
  171. -----------------------
  172.  
  173.  This program was written by Oovis contactable at
  174.  
  175.  Strand Theatre
  176.  Aldwych
  177.  London
  178.  WC2B 4LD
  179.  ENGLAND
  180.  
  181.  If you want a reply please include correct stamps/money for return mail. I
  182. cannot afford to pay postage out of my own pocket. Sorry.
  183.  
  184.  I am the Chief Electrician and am 28 years old. This is the first bit of
  185. programming I've ever released to the general public. You might never use it,
  186. but I've found it useful.
  187.  
  188.  I wrote this program because many objects have come my way from magazines
  189. and a friend's internet connection which have been either PC format files,
  190. or have needed textures I don't possess (e.g. the Essence II package), and
  191. it's a real pain having to manually search a large grouped object to find
  192. which part is stopping Imagine rendering. Now I can get a printout of an
  193. object's structure and convert the file format at the same time should I
  194. wish to do so.
  195.  
  196.  Is this a useful program? It is for me, and it got me back into assembly
  197. language programming again after a break of a few years, so what the heck.
  198.  
  199.  
  200.   Great Britain only: If you want a copy of the source code for this 
  201. program, send a cheque/postal order for £5 payable to D I Roberts to the
  202. above address and I'll send out a copy on disk within 7 days.
  203.  
  204.               <Proof of posting is not proof of receipt!>
  205.  
  206.  
  207. Finally
  208. -------
  209.  
  210.  Thanks to:
  211.   Dave for the internet cruising
  212.  
  213.   Impulse Inc. for Imagine
  214.  
  215.   All the modellers out there for the great work
  216.  
  217.   Hi-Toro, Commodore and Escom for the Amiga
  218.  
  219.   Gateway 2000 for buying the Amiga technology. Let's hope they can do
  220.    something with it, and not over stretch themselves as Escom did!
  221.  
  222.   Amiga Format for keeping me inspired and enthusiastic
  223.  
  224.   Spoons and Duncan for keeping the ship going when I'm not there
  225.  
  226.  
  227.   All trademarks and copyrights acknowledged.
  228.  
  229.  
  230.  
  231.    Oovis, London 1997.
  232.