home *** CD-ROM | disk | FTP | other *** search
/ Amiga Computing 67 / ac067b.adf / Embedder.doc < prev    next >
Text File  |  1978-04-06  |  9KB  |  277 lines
  1.  
  2. *******************************************************************************
  3. **                                         **
  4. **                  Documentation for                          **
  5. **                                         **
  6. **                Embedder V1.0                     **
  7. **                                         **
  8. **           (C) Copyright 1993 by Bigmama of Trash             **
  9. **                 All Rights Reserved                 **
  10. **                                         **
  11. *******************************************************************************
  12.  
  13.  
  14. Embedder and this documentation is NOT Public Domain software and nobody is
  15. permitted to gain profit on it without my permission.
  16. I won't allow any presence of Embedder on neither scene nor commercial releases
  17. in order to promote the concerned release, without my permission.
  18. If you want to talk about commercial distribution the contact at the BBS listed
  19. at the end of this file.
  20.  
  21. NO changes should be made to the "Embedder10.lha" archive, which should consist
  22. of the following files:
  23.  
  24.  
  25. Embedder/
  26.    Docs.info   Utilities.info   Icons.info  WBStartup.info
  27.  
  28. Embedder/Docs/
  29.    Embedder.doc  Embedder.doc.info  EmbedderShort.doc  EmbedderShort.doc.info
  30.  
  31. Embedder/Icons/
  32.    Embedder.info  EmbedderProject.info
  33.  
  34. Embedder/Utilities/
  35.    Embedder  Embedder.info
  36.  
  37. HD:Embedder/WBStartup/
  38.    Embedder  Embedder.info
  39.  
  40.  
  41. If the archive and files are kept exactly like above, or (preferably) only the
  42. original archive is passed on, you can distribute it freely in any electronic
  43. form you like.
  44.  
  45.  
  46. And now let's get to the actual instructions...
  47.  
  48.  
  49.  
  50. *******************************************************************************
  51.  
  52.  
  53.  
  54.  
  55.         1.    The purpose of this utility
  56.  
  57.         2.    Requirements
  58.  
  59.         3.    Actions and configuration
  60.  
  61.         4.    CLI/Shell usage
  62.  
  63.         5.    Workbench usage (Workbench rules supreme!)
  64.  
  65.         6.    Contact me!
  66.  
  67.  
  68.  
  69.  
  70. *******************************************************************************
  71.  
  72.  
  73. 1. The purpose of this utility
  74.  
  75.  
  76. I made this small program because all those intros and small demos that don't
  77. work with AGA and caches annoy me constantly!
  78. If you have played around an A1200/A4000 now and then you surely know what I
  79. mean :-)
  80.  
  81. This utility is capable of resetting the entire display to no output at all and
  82. resetting AGA sprite-resolutions to normal low-res 16 pixel sprites before
  83. executing a demo/intro. This prevents the executed program from showing those
  84. well-known modulo-torn-to-pieces-graphics.
  85.  
  86. Another thing is that on any 68020+ CPU with fastram the exception and interrupt
  87. vectors aren't located at $00000000 but someplace else (in fastram). That's why
  88. some intros work on A1200 but not on A4000 (or A3000/accelerated A2000's for
  89. that matter).
  90. Well, Embedder is capable of resetting these vectors back to $00000000 and set
  91. them back on exit.
  92.  
  93. If some programs have cache-problems, Embedder will also handle these for you.
  94.  
  95. As an extra bonus you will be able to run your favourite intro's from Workbench
  96. if you run them through Embedder and the project icon or use the AppIcon.
  97.  
  98. A few intros/demos causes the system to die on exit. I don't know why yet, but
  99. maybe I'll discover the reason sometime.
  100.  
  101. So with Embedder you should now be capable of embedding your intros in a way,
  102. that they can be run without problems.
  103.  
  104.  
  105.  
  106.  
  107. *******************************************************************************
  108.  
  109.  
  110. 2. Requirements
  111.  
  112.  
  113. Embedder works on all Amiga's with at least Kickstart 2.00. The reason why it
  114. doesn't work on 3.0+ and AGA only, is that some accelerator-owners maybe would
  115. to run some intro's too. Another reason is that you can run intro's from
  116. Workbench.
  117.  
  118. The only action that requires 3.0+ is the SPRITE_RESET action (see below) but
  119. you can specify it safely on 2.0+ aswell.
  120.  
  121.  
  122.  
  123.  
  124. *******************************************************************************
  125.  
  126.  
  127. 3. Actions and configuration
  128.  
  129.  
  130. There are five actions that can be performed by Embedder. They all serve the
  131. purpose of making file intros/demos work on AGA and cache systems.
  132.  
  133.  
  134.     1. VBR_RESET
  135.  
  136.        This action forces the VBR (VectorBaseRegister) to be set to zero
  137.        so the interrupts can be executed correctly. (See above.)
  138.        There's no need to fool around with this if your machine has got
  139.        an MC68000 or no fastram.
  140.  
  141.  
  142.     2. CACHE_DISABLE
  143.  
  144.        Speaks for itself i figure. Anyway...
  145.        All caches will be flushed and disabled as long as your intro/demo
  146.        is running. They will be restored to original state on exit.
  147.        As the VBR_RESET action this of course has no effect on MC68000.
  148.  
  149.  
  150.     3. SPRITE_RESET
  151.  
  152.        Resets the sprites to the standard original chipset size of 16
  153.        pixels with and 140 ns pixel-speed.
  154.        Has no effect on the original Denise, which is normally found in
  155.        A1000's, A500's, A2000A's and A2000B's.
  156.  
  157.  
  158.     4. DISPLAY_RESET
  159.  
  160.        This is for non-AGA machines. If your machine hasn't got AGA then
  161.        don't enable this. You will just get that blank display while
  162.        loading and there's no need for that.
  163.        On AGA this action resets the display to no resolution at all, so
  164.        your intro/demo can start a fresh copperlist.
  165.  
  166.  
  167.     5. APP_ICON
  168.  
  169.        With this action set you can make Embedder add an AppIcon to the
  170.        Workbench list of AppIcons. This way you just drop the icon of the
  171.        program you want to execute on the Embedder AppIcon and it will be
  172.        executed automatically. Note that this action only has effect if
  173.        specified in the Embedder icon.
  174.  
  175.  
  176. So much for the actions. Now I'll explain how to set/unset 'em.
  177. All actions are standard Amiga icon Tool Types and can be altered using
  178. »Information« in the Workbench »Icons« menu or e.g. »IconInfo« in DirectoryOpus.
  179.  
  180. The Tool Types specified in the Embedder icon (the icon for Embedder) form
  181. the basic configuration for Embedder. If the Embedder project icon is installed
  182. on all files you occasionally execute or the AppIcon is used, Embedder's
  183. configuration will be overridden by the configuration in the executed programs
  184. icon.
  185.  
  186. Try using »Information« on the enclosed icons to have a look at how this is
  187. done.
  188.  
  189. Note that if you don't copy the Embedder icon to the same directory as
  190. Embedder and use Embedder from CLI/Shell, no configuration will be available
  191. at all. Then the built-in default configuration is used. It enables VBR_RESET
  192. and DISPLAY_RESET only.
  193.  
  194. A real nice way of using Embedder is to insert the Tool Type »DONOTWAIT«
  195. (a standard Workbench Tool Type) and use the AppIcon. Then you just place
  196. Embedder in your »WBStartup« directory and your environment will start up with
  197. that nice little icon on the left everytime you reboot.
  198. (I use this method myself! :-) 
  199.  
  200. So if you want to control Embedder fully, use Workbench.
  201.  
  202. Note: All Tool Types in parenthesis are ignored by Embedder.
  203.  
  204.  
  205.  
  206.  
  207. *******************************************************************************
  208.  
  209.  
  210. 4. CLI/Shell usage
  211.  
  212.  
  213. If you prefer to use Embedder from CLI/Shell just type »Embedder (file)«
  214. where (file) is the intro/demo/game or whatever you want to execute.
  215.  
  216. Note that if you don't copy the Embedder tool icon to the same directory as
  217. Embedder and use Embedder from CLI/Shell, no configuration will be available
  218. at all. Then the built-in default configuration is used. It enables VBR_RESET
  219. and DISPLAY_RESET only.
  220. Another thing is that the »APP_ICON« action has no effect if Embedder is
  221. executed form CLI/Shell.
  222.  
  223. I therefore recommend that you use Embedder from Workbench :-)
  224.  
  225.  
  226.  
  227.  
  228. *******************************************************************************
  229.  
  230.  
  231. 5. Workbench usage
  232.  
  233.  
  234. From Workbench you can use Embedder in two ways.
  235.  
  236.  
  237.     1. You can (as mentioned above) add the Embedder project icon to every
  238.        program you execute and Embedder will load the program automatically.
  239.        This way every program can have it's own Embedder configuration
  240.        (See "Actions and configuration").
  241.  
  242.     2. Another way is to click the icon of the file you want to run and then
  243.        press and hold shift and finally double-click the Embedder icon.
  244.        If you use this procedure you don't have to add an icon to every
  245.        intro/demo, you just use »show all files« and perform the above
  246.        procedure on the shown standard Workbench icons.
  247.  
  248.     3. If you don't want to mess around with project icons, you can use the
  249.        »APP_ICON« action and just drop your icons at the AppIcon.
  250.        To exit Embedder when using AppIcon just double-click the AppIcon and
  251.        a requester will appear.
  252.  
  253.  
  254.  
  255. *******************************************************************************
  256.  
  257.  
  258. 6. Contact me!
  259.  
  260.  
  261. If you want to suggest improvements or bugs or just want to have a real
  262. »coders chat« then leave me a message at our WHq...
  263.  
  264.  
  265.          >>> /Y\etal Connextion <<<   +45 (0) 7443 5949.
  266.  
  267.  
  268.  
  269.  
  270.                 Greetings to everybody I know,
  271.                 especially Coma/Trash for great encouragement
  272.                 through the dimensions of time and space...
  273.  
  274.  
  275.                                 Bigmama/Trash
  276.  
  277.