home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / IntroMaker.lzx / IntroMaker / IM1.3.doc < prev    next >
Encoding:
Text File  |  1995-04-04  |  18.1 KB  |  340 lines

  1. ***************************************************************************
  2. *                                                                         *
  3. *                   IntroMaker v1.3 by Per-Olof Yliniemi                  *
  4. *                                                                         *
  5. *            Copyright © 1993 - All Rights Reserved World Wide            *
  6. *                                                                         *
  7. ***************************************************************************
  8. *                                                                         *
  9. * DISCLAIMER: No responsibility can be taken on the part of the author    *
  10. *        for any consequences that may occur as a result of using this    *
  11. *        program. Every part of the program has been thoroughly tested    *
  12. *        to its specified limits and any known specific limitations of    *
  13. *        the program are stated within this documentation.                *
  14. *                                                                         *
  15. ***************************************************************************
  16. *                                                                         *
  17. *  This program is ShareWare. If you like it and use it (more than once), *
  18. *  or if you want to get the source code for this program, please send me *
  19. *  $10 as a registration fee, $10 extra for the source code, and if you   *
  20. *  want to use a cheque (not recommended) as payment add $7 to the above. *
  21. *                                                                         *
  22. *  For users in Sweden, Finland and Norway:                               *
  23. *    Sending an equal amount in your own currency is better than go to    *
  24. *    the bank to get your money changed into US dollars.                  *
  25. *                                                                         *
  26. ***************************************************************************
  27. *                                                                         *
  28. *  The program and the documentation may NOT be modified in ANY way. An   *
  29. *  exception may be to correct some typing errors in this documentation.  *
  30. *  This documentation MUST always be distributed with the IntroMaker      *
  31. *  program.                                                               *
  32. *                                                                         *
  33. *  This program may not be used as a part of any commercial packages      *
  34. *  without my permission. The source code may not be reproduced by        *
  35. *  disassembling the program. The source code you can order from me has   *
  36. *  lots of comments and additional documentation is available.            *
  37. *                                                                         *
  38. ***************************************************************************
  39.  
  40. What is IntroMaker ?
  41.  
  42.  How many times have you tried to get one intro to run from the bootblock ?
  43.  I've  made too  many tries  with utilities  such as  BootLeg,  Boot'Em and
  44.  MultiBoot (the best of the three named above), but I  missed some features
  45.  in these programs such as the  possibility to  have more than one intro to
  46.  load from the bootblock, be compatible with DOS (FFS and OFS) and so on.
  47.  
  48.  This program have some of the missed functions that I want to have in such
  49.  a program. Here is a list of all (if I remember all of them) functions:
  50.  
  51.     * Intuition interface makes it easy to use. Gadgets have 3D-look,
  52.       even if not running under v2.0 or higher of the operating system.
  53.       Uses standard gadtools gadgets, but without using the library :-)
  54.  
  55.     * Requires NO extra files to run, but uses the ReqTools or the ASL (2.0)
  56.       library for the file requester if available. Full support for the
  57.       ARQ requester replacement utility (I've tried to use the right words
  58.       in the requesters to get the right animations).
  59.  
  60.     * You can TEST the intros before writing them to the disk. If one intro
  61.       doesn't seem to work with the default addresses, change them (if you
  62.       know what you are doing), and test the demo again. The test function
  63.       should NOT crash the system, unless the intro doesn't trash other
  64.       memory that it hasn't allocated. The intro is loaded at the load
  65.       address and the program is started at the jump address :-)
  66.  
  67.     * You have full control over the loader routines. You can select the
  68.       load and jump addresses by yourself if you want to. The defaults seem
  69.       to work with the most of the intros and demos.
  70.  
  71.     * You can decide whitch drive you want to write to (DF0: to DF3:)
  72.  
  73.     * Up to 56 intros can be loaded from the bootblock. Loader code is
  74.       only 120 bytes. The disk limits the actual number of intros :-)
  75.  
  76.     * Allocates used blocks in the bitmap. This prevents DOS from
  77.       overwriting your intro and crash the system.
  78.  
  79.     * Checks for free blocks on the disk rather than overwriting the files.
  80.  
  81.     * Works with both FFS and OFS disks. The storage capacity is the same
  82.       with both FFS and OFS for IntroMaker, but DOS will give you some
  83.       extra space for your files (837k with OFS, 879k with FFS ;-).
  84.  
  85.     * The size of the file to write to the disk is only limited by memory
  86.       and the disk size (2 files * 439k with MCADOS, 1 file * 878.5k with
  87.       MCATRK). If you have v2.0 of the OS and some fast memory, then the
  88.       program will use the fast memory as disk buffer. This allows machines
  89.       with only 512k chip mem to write larger files to the disk.
  90.  
  91.     * Info function allows more advanced users to see how many intros that
  92.       are installed on the disk, where they are and how big they are.
  93.       This function also give you access to a three color bitmap displayer.
  94.       The bitmap displayer shows you how many blocks that are free, how
  95.       many blocks that are allocated by files and how many blocks that are
  96.       allocated by intros.
  97.  
  98.     * Have its own disk format (MCATRK), which gives the disk one more
  99.       block to use for your intros. When you are using a MCADOS (DOS)
  100.       disk to write your intros to, you have 2*878 blocks free on an empty
  101.       disk. If you are using the MCATRK format (which will give you no
  102.       access to files on this disk), you will have 1*1757 blocks free on
  103.       an empty disk.
  104.       The default MCADOS format can be used on any disk, even if it do not
  105.       contain any intros. The disk will continue to work as before, but if
  106.       you install any intros on it, the intros will be executed before the
  107.       startup-sequence.
  108.  
  109.     * Can remove any of the intros that is installed and deallocates the
  110.       used blocks for that intro.
  111.  
  112.     * Can swap the order of two installed intros on the disk.
  113.  
  114.     * Another TEST function, but this allows you to test an installed intro
  115.       and can be useful when you are going to move or delete an intro.
  116.  
  117.     * Allows you to convert a disk from MCADOS to MCATRK format. This
  118.       function will deallocate the blocks used for any files on the disk.
  119.       After converting to MCATRK, you will have no access to the files that
  120.       was on the disk.
  121.  
  122.  This program was written in assembly language on my Amiga 500+ with 16(!)
  123.  megs of FAST mem and 2 megs of CHIP mem, VXL-30(33MHz) accelerator, and
  124.  some other nice things. It should run on any Amiga without problems.
  125.  
  126. ---------------------------------------------------------------------------
  127.  
  128. How to use IntroMaker:
  129.  
  130.  IntroMaker can be started either from Workbench or from CLI. To start it
  131.  from Workbench, double click on the IM1.3 icon. To start it from CLI,
  132.  change directory to the one that contains the program and type IM1.3 at the
  133.  CLI prompt. The IntroMaker window will open and you can now begin to use
  134.  the program.
  135.  
  136.  Here comes an explanation of all gadgets in the IntroMaker window
  137.  (explanation from top left to bottom right gadget):
  138.  
  139.     1) File:    String gadget that should contain the name of the file to
  140.                 put on the disk as a bootblock loaded program.
  141.  
  142.     2) GetFile  Button to pop up the ReqTools or Asl file requester. An
  143.                 easy way to change the file name in previous gadget.
  144.  
  145.     3) TEST     This function allows you to test the file that is in the
  146.                 File gadget. The file will be loaded to the Load Address
  147.                 and when the program starts, the program will jump to the
  148.                 Jump Address. This test is a bit more safe than when the
  149.                 intro is started from the bootblock, as it will save the
  150.                 interrupts, DMA, copperlist and memory(!) before starting
  151.                 the intro.
  152.  
  153.     4) LoadAddr Address to load the program to in the bootblock. Default
  154.                 address is $1f000 (it seems to work with a lot of intros).
  155.                 The address is entered in hexadecimal format.
  156.  
  157.     5) JumpAddr Address to jump to when executing the program, may not
  158.                 always be the same as the load address, but defaults to it.
  159.                 The address is entered in hexadecimal format.
  160.  
  161.     6) Disk:    Cycles through the list of trackdisk devices (DF0: to DF3:)
  162.  
  163.     7) WRITE:   Writes the file, updates bootblock and bitmap on dest disk.
  164.  
  165.     8) INFO     Displays a list of all intros that is installed on the disk.
  166.                 Press the DOWN ARROW gadget to get to the next page in the
  167.                 list. Press the UP ARROW gadget to get to the previous page.
  168.  
  169.                 The table of all intros have these values in it:
  170.  
  171.               | |^|v| DOffs   Len   LoadAddr  JumpAddr |
  172.               ------------------------------------------
  173.               |  01   00400  03200  0001F000  0001F000 |
  174.               |  02   03600  04800  00030000  00030000 |
  175.  
  176.                  ^^   ^^^^^  ^^^^^  ^^^^^^^^  ^^^^^^^^
  177.                  |    |      |      |         |
  178.                  |    |      |      |         |    Address to jump to when
  179.                  |    |      |      |         |--- when starting the intro
  180.                  |    |      |      |--- Address to load intro to
  181.                  |    |      |--- Length of the intro
  182.                  |    |--- Location on the disk (byte offset)
  183.                  |---Intro number
  184.  
  185.      BITMAP     At the bottom of this window there is another gadget. The
  186.                 BITMAP gadget allows you to see where your intros, and
  187.                 where your files are, it will also display the number of
  188.                 free blocks, blocks allocated by files and blocks allocated
  189.                 by intros.
  190.  
  191.     9) Type:    Disk type to install when the INSTALL gadget is pressed.
  192.                 This gadget also decides which disk type to install when
  193.                 write is used on a disk without MCA bootblock.
  194.                 DOS is the default format and it should not destroy
  195.                 anything (except the old intros) that is on the disk.
  196.                 TRK is my own disk format and it will remove all old info
  197.                 from the disk.
  198.  
  199.    10) DEL/SWAP Opens the same table as the INFO function, but allows the
  200.                 user to remove intros from the disk. Click on the gadget
  201.                 with the intro data to remove the intro.
  202.  
  203.         SWAP    At the bottom of this window there is another gadget. The
  204.                 SWAP gadget allows you to swap the order of two intros.
  205.                 After selecting the SWAP gadget, press once on the first
  206.                 intro, and then press once on the other intro (this will
  207.                 also be shown in the window title when you have selected
  208.                 SWAP). If you decide to cancel the SWAP function, press on
  209.                 the first selected intro again or close this window.
  210.  
  211.    11) TEST     Another intro test function, have exact the same security
  212.                 as the other TEST gadget (3), but allows you to test one
  213.                 intro from the bootblock. The gadget at the bottom of the
  214.                 window allows you to TEST ALL intros that is installed on
  215.                 the disk. You can stop this function by pressing CANCEL in
  216.                 the requester between the intros.
  217.  
  218.    12) INSTALL  Installs a new MCA bootblock. If the disk type is TRK it
  219.                 will remove all old info on the disk, if the type is DOS it
  220.                 will only remove all old intros from the disk. It is not
  221.                 possible to install a DOS bootblock on a disk in TRK format
  222.  
  223.    13) DOS->TRK Converts a MCADOS disk to a MCATRK disk. After converting
  224.                 to MCATRK format, there is no way to use the files that
  225.                 was on the disk before converting it. The files will be
  226.                 deallocated from the bitmap when selecting this function.
  227.                 If you want to keep any of the files that is on the disk
  228.                 that you are going to convert, copy them to another disk
  229.                 before converting this disk to MCATRK format.
  230.  
  231.                 This will also change the loader code a bit. When all
  232.                 are executed, it will skip back to the first one again.
  233.  
  234.    14) ABOUT    Some info about the program. TEST IT !!!
  235.  
  236.    15) Stat     Shows the current status of the program and unrecoverable
  237.                 errors, that doesn't need a requester. When an error
  238.                 message is displayed, press one of the mouse buttons to
  239.                 get rid of it.
  240.  
  241. ---------------------------------------------------------------------------
  242.  
  243.        Tutorial - Part 1 - Installing some intros on a disk
  244.       ------------------------------------------------------
  245.  
  246.  You should now be familiar with the user interface in IntroMaker. Here is
  247.  a little tutorial that installs some intros on a disk:
  248.  
  249.     1) Start the program as explained above.
  250.     2) Type in the name (or select a file with the file requester) of the
  251.        intro that should be loaded first when the disk is booted from.
  252.        This file MUST be a file that contains CODE (otherwise,your computer
  253.        will probably crash!), but it must not be a program that could be
  254.        executed from Workbench or CLI.
  255.     3) Select your destination drive with the DRIVE gadget by clicking on it
  256.     4) Set the disk type to DOS (default).
  257.     5) Press the WRITE gadget. The file you have selected will now be loaded
  258.        into the memory of your computer (this may limit the maximum size of
  259.        the intro you can install with your computer).
  260.     6) A requester will prompt you to insert the disk to write the intro to.
  261.        Insert the disk in your selected destination drive and press Continue
  262.     7) If your disk do not contain a MCA bootblock, a requester will give
  263.        you the option to install a MCA boot to it. Select Continue to
  264.        install the disk with my bootblock.
  265.     8) The disk should now be ready to boot from and the amount of free
  266.        space on the disk should now be less than it was before (if you are
  267.        using the MCADOS format).
  268.     9) To install more intros to the disk, repeat steps 2 thru 6 and.
  269.    10) You can test individual intros with the TEST function as described
  270.        above (press the TEST gadget above the ABOUT gadget and click on the
  271.        intro to test it).
  272.    11) You can sort or delete some of your installed intros with the
  273.        DEL/SWAP function (see above).
  274.    12) If you want to test the whole disk, put it in drive DF0 and reset
  275.        the computer (Ctrl-Amiga-Amiga).
  276.    13) The bootblock will open the CLI window when all intros have been
  277.        executed.
  278.  
  279. ---------------------------------------------------------------------------
  280.  
  281.        Tutorial - Part 2 - Using other functions (DOS->TRK)
  282.       ------------------------------------------------------
  283.  
  284.  Now we are going to change the format of the disk to MCATRK. This
  285.  will give you one block (512 bytes) extra to save your intros on.
  286.  It may not sound so much, but these 512 bytes can be very useful if
  287.  your intro doesn't seem to fit (maybe one byte too large) in the
  288.  free area before the root block of the disk.
  289.  The TRK format will give you one big chunk of free blocks for your
  290.  own use (blocks from 2 to 1758 will be free).
  291.  
  292.     1) Insert the disk that you installed some intros on in the drive that
  293.        you have selected as the destination drive.
  294.     2) Copy all files (if any) from the disk to another disk. The MCATRK
  295.        format doesn't support any access to any of the files on the disk.
  296.     3) Press the DOS->TRK gadget to convert the disk format.
  297.     4) Test the disk again. After the last intro, the bootblock will load
  298.        the first intro again and continue the loop until you remove the
  299.        disk from the drive.
  300.  
  301.  You can't convert a disk to TRK format if it's already in TRK format, and
  302.  it is not possible to change back to DOS format once you have changed to
  303.  TRK format. The only way to use the disk for files again is to reformat it
  304.  (quick format will work)
  305.  
  306. ---------------------------------------------------------------------------
  307.  
  308.                       The INSTALL function
  309.                      ----------------------
  310.  
  311.  It is not really necessary to use the INSTALL function before a intro is
  312.  installed on a disk. If the disk is in the ordinary DOS format (FFS or
  313.  OFS), IntroMaker will install it when it copies your intro onto the disk.
  314.  It is however, possible to install my MCADOS bootblock without destroying
  315.  any data on an Amiga DOS disk. The bootblock has the same function as the
  316.  standard bootblock you'll find on any disk you can boot from. The only
  317.  difference is that it searches through a table when you boot the computer.
  318.  If the disk is installed with IntroMaker, the table in the bootblock will
  319.  be empty, and nothing will happen if you boot with it. Using this function
  320.  is an easy way to deallocate all intros from the disk without having to
  321.  remove all files (=formatting the disk).
  322.  If you have the type gadget selected on TRK format, the INSTALL function
  323.  will remove any files that is on the disk together with all intros.
  324.  A warning will pop up if you are going to install a MCATRK bootblock on
  325.  the disk. If you press Cancel in the requester, then nothing will be done.
  326.  
  327. ---------------------------------------------------------------------------
  328.  
  329.     Send suggestions for other functions you want to see in this
  330.     program, bug reports, your own programs, the shareware fee,
  331.     old computers (or maybe a new A4000) to:
  332.  
  333.                 Per-Olof Yliniemi
  334.                 Muoniovaara
  335.                 S-980 64 Muodoslompolo
  336.                 SWEDEN
  337.  
  338. ---------------------------------------------------------------------------
  339.  
  340.