home *** CD-ROM | disk | FTP | other *** search
/ AMOS PD CD / amospdcd.iso / 376-400 / apd394 / swiz / readme.doc next >
Text File  |  1992-01-05  |  11KB  |  257 lines
  1. -----------------------------------------------------------------------------
  2.  
  3.                   SWIZ V1.0 - written by M. VENN 1991/92
  4.                              README.DOC  5-1-92
  5.  
  6. -----------------------------------------------------------------------------
  7.  
  8.  
  9. INTRODUCTION:
  10. -------------
  11.  
  12.    Welcome to SWIZ V1.0 ! So, what is SWIZ ? Well, as you'll know, there are
  13. a few different types of utilities around for AMOS for developing bobs/icons
  14. and sprites, but what about the good old cursor ? No, well, that was until
  15. now ! If you've ever looked at the AMOS Set Curs command and decided to draw
  16. your own cursors for your own programs, you'll probably have gone through the
  17. old 8x8 grid graph paper routine, followed by working out the necessary
  18. bit-patterns for actually pulling the cursor from your grid into your AMOS
  19. code. This can become a little tiring after a while, is time consuming and
  20. requires a small understanding of binary. But then SWIZ came along...
  21. The good news though is that SWIZ will do all this for you ! It'll even
  22. write the AMOS code for you !
  23.  
  24.  
  25. LOADING SWIZ:
  26. -------------
  27.  
  28.    SWIZ can only be loaded via AMOS, so if you haven't got AMOS then you
  29. can't use the program ! After you've loaded AMOS simply go through the
  30. normal loading procedure via the editor and select the file SWIZ.AMOS on
  31. this disk via the AMOS file requester. Upon loading, AMOS may present you
  32. with a line like this:
  33.  
  34. Can't fit program into editor buffer. Change buffer size? (Yes or No)
  35.  
  36.    If this happens select YES and SWIZ will continue to load. When SWIZ has
  37. loaded run it !
  38.  
  39.  
  40. SWIZ SCREEN SETUP:
  41. ------------------
  42.  
  43.    The SWIZ main screen is split up into 4 distinctive parts. The left hand
  44. side of the screen contains a square made up of a set of boxes forming an
  45. 8x8 grid. Each horizontal line of the grid has a label on the far left which
  46. ranges from "L1" to "L8". An AMOS cursor can only be made up of an area of 8
  47. pixels x 8 pixels. So the "L" stands for (L)ine and the number (1-8) stands
  48. for the line of the cursor. So, L1 = L(ine)1 of cursor. L7=L(ine)7 of
  49. cursor. Each line consists of 8 horizontal pixels. 8 lines = 8 pixels x 8
  50. pixels. Throughout the rest of this DOC this part of the screen will be
  51. referred to as "the editing grid". See later for more detail.
  52.  
  53.    Opposite the editing grid, on the right hand side of the screen are 2 more
  54. boxes. The upper one is full of the current cursors bit-patterns. You'll
  55. notice that each bit-pattern has a label next to it L1 - L8. This referrs to
  56. the line from the editing grid. Throughout the rest of the DOC this part of
  57. the screen will be referred to as "the bit-pattern box". It will be
  58. explained in more detail later.
  59.  
  60.    Underneath the bit-pattern box there's another box. This one shows the
  61. current cursor that you are editing and 8 other cursors (including the one
  62. you're editing). This box will be referred to as "the cursor box" elsewhere
  63. in this DOC. Again, it'll be explained more later.
  64.  
  65.    The last box on the screen is underneath all of the above mentioned
  66. boxes. It contains a set of icons which enable you to do things such as
  67. disk access and cursor manipulation. This box will be referred to as "the
  68. options box" elsewhere in this DOC. It too will be explained in greater deal
  69. later.
  70.  
  71.  
  72. SELECTING A CURSOR:
  73. -------------------
  74.  
  75.    Cursor editing is made easy with the help of SWIZ. Firstly you have to
  76. select a cursor to edit. The cursor box contains a row of 8 boxes and
  77. underneath another box containing the current cursor that you are editing.
  78. To select a cursor to edit simply click the left mouse button on 1 of the
  79. eight boxes ! When selected it will be highlighted by a white box. As you
  80. now edit this cursor, it will be updated in the "current cursor" box
  81. (underneath the 8 boxes) and also in the highlighted box that you clicked
  82. on ! As a default, upon loading and running SWIZ, the first box will be
  83. automatically selected as the current cursor. You can change the cursor
  84. to edit by simply selecting another box from the 8. The reason for there
  85. being 8 cursors to choose from is that you can draw several cursors and
  86. compare them to each other at the same time.
  87.  
  88.  
  89. EDITING A CURSOR:
  90. -----------------
  91.  
  92.    Editing the cursor is really easy ! Simply position the mouse pointer
  93. over a box in the editing grid and press the left mouse button. If the box
  94. that you clicked on is purple it will be changed to green. If it's green
  95. it'll be changed to purple. As you use the editing grid your actions will
  96. also be displayed on the bit-pattern box. A purple box is given a value of 0
  97. (off) and a green one is given a value of 1 (on). This series of 0's and 1's
  98. forms the bit-pattern for each line of the cursor (for use with the Set Curs
  99. command). You can also edit directly on the bit-pattern box ! Simply click
  100. the left mouse button on the digit (0 or 1) within the bit-pattern box that
  101. you want to change and it will ! As editing is happening the necessary
  102. cursor boxes will be updated, as will the editing grid and the bit-pattern
  103. box. A purple box value 0 (off) will be a pixel that isn't displayed in your
  104. cursor (invisible). A green box value 1 (on) represents a pixel that will be
  105. displayed in your cursor.
  106.  
  107.  
  108. THE OPTIONS BOX:
  109. ----------------
  110.  
  111.    This box contains a total of 20 options for you to use. To activate an
  112. option simply click the left mouse button on it ! Here's a list of the
  113. options and what they do:
  114.  
  115.  
  116. NEW - resets ALL of the cursors to their default settings.
  117.  
  118. LOAD - bring up the AMOS file requester and asks you to load a cursor data
  119.        file previously saved with SAVE ACD option. It will load over ALL
  120.        existing cursors !
  121.  
  122. SAVE ACD - saves all 8 cursors to a data file that can be loaded using the
  123.            LOAD option. The AMOS file requester will appear again.
  124.  
  125. SAVE ASC - saves the current cursor data as AMOS code in an ASCII file which
  126.            can be loaded via the MERGE ASCII option within AMOS. The AMOS
  127.            file requester will appear again.
  128.  
  129. PRINT - prints the current cursor data as AMOS code to your printer. Upon
  130.         selecting the option a requester will appear to confirm your choice
  131.         telling you to ensure that your printer is set up correctly and
  132.         ready to go. The first time that this option is selected your
  133.         printer driver will be loaded from your boot disk.
  134.  
  135. ABOUT - doesn't need explaining ! Select O.K from the requester to return to
  136.         the main program.
  137.  
  138. QUIT - presents a requester to confirm your choice. Will return you to AMOS
  139.        or SWIZ depending on your choice.
  140.  
  141.  
  142. NOTES:
  143.  
  144.    When saving data do not add any suffixes after filenames. They will be
  145. automatically added by SWIZ. Don't use any "." in filenames too. If you do
  146. SWIZ may become confused !
  147.  
  148.    The SAVE ASC option saves the current cursor data as AMOS code to an
  149. ASCII file. To load this file into your own AMOS program select the MERGE
  150. ASCII option from AMOS. The MERGE ASCII option will produce a file requester
  151. asking you to select a file. Upon selecting the file (.ASC) AMOS will
  152. process it into AMOS code. The bit-patterns in a SWIZ .ASC file will be
  153. analysed by AMOS and may appear to be different when loaded against the
  154. original. This is because AMOS will try to make the numbers more efficient,
  155. you will however, get the same cursor as the one you designed !
  156.  
  157.    The above 7 options cannot be reversed in any way by the use of the UNDO
  158. option that is listed amongst the options below.
  159.  
  160.  
  161. 90° - turns the current cursor clockwise 90°.
  162.  
  163. FILL XL - changes the mouse pointer to a hair pin and waits for the user to
  164.           press the left mouse button over a box in the editing grid or a
  165.           number in the bit-pattern box. Once this has been done the entire
  166.           line will be filled horizontally (x). To exit this option press the
  167.           right mouse button. It will stay in this mode until the right mouse
  168.           button is pressed.
  169.  
  170. CLR XL - same rules as FILL XL except CLR XL clears an entire horizontal
  171.          line.
  172.  
  173. MOVE - waits for the user to press a cursor key (left, right, up or down)
  174.        and moves the current cursor 1 pixel in that direction. Press the
  175.        right mouse button to exit this mode.
  176.  
  177. CHAR - waits for the user to press a key within an ASCII range of 33 to 126.
  178.        The current cursor will become the character. (This option will erase
  179.        the current cursor and replace it with a character.) Press the right
  180.        mouse button to exit this mode.
  181.  
  182. WIPE - erases the current cursor completely. Fills the cursor with a set of
  183.        0's (off) purples.
  184.  
  185. UNDO - reverses the last action done with one of the options (not options 1
  186.        to 7). E.g: if you flip a cursor 90°, UNDO will place the cursor how
  187.        it was before the flip. But, if you click on the editing grid or
  188.        bit-pattern box then press UNDO nothing will happen. UNDO only
  189.        reverses the last option selected (not 1 to 7).
  190.  
  191. 180° - turns the current cursor clockwise 180°.
  192.  
  193. FILL YL - same rules as FILL XL except FILL YL fills an entire vertical line
  194.           (y).
  195.  
  196. CLR YL - same rules as FILL XL except CLR YL clears an entire vertical line
  197.          (y).
  198.  
  199. INVERT - inverts the current cursor.
  200.  
  201. FLOOD - erases the current cursor completely. Fills the cursor with a set of
  202.         1's (on) greens.
  203.  
  204. DEFAULT - resets the current cursor to the default AMOS cursor. (Upon
  205.           loading and running SWIZ all cursors are set to the AMOS default.)
  206.  
  207.  
  208. NOTES:
  209.  
  210.    You can change the current cursor that you are editing any time whilst
  211. using the program unless you are in an editing mode which requires you to
  212. press the right mouse button to leave it. If you are in no special editing
  213. modes at all then you can change the current cursor by clicking on the
  214. cursor you wish to edit in the cursor box.
  215.  
  216.    You'll also find a demo file called "SWIZ_examples.acd" on this disk
  217. which contains 8 cursors to have a look at. The disk also contain 8 .ASC
  218. files, each one from the above .ACD file. You can MERGE ASCII these .ASC
  219. files into the AMOS editor to test them out !
  220.  
  221.    Well, that's the full instructions for SWIZ ! I hope that i've explained
  222. everything clearly ! SWIZ is very easy to use anyway, so it may be that you
  223. don't even need this DOC to run it !
  224.  
  225.  
  226. WAFFLE:
  227. -------
  228.  
  229.    SWIZ V1.0 was coded the last week of DEC 1991 and finished in JAN 1992.
  230. All code was written by M. VENN and was written using AMOS V1.3. SWIZ V1.0
  231. was coded on a 1 MEG Amiga, but will work on half MEG Amigas too !
  232.  
  233.    If I do an upgrade it will contain any bug fixes that need doing or fixes
  234. to any bugs reported to me and may contain some new features for editing. If
  235. you'd line an AMOS format complied version of SWIZ (compiled in a special
  236. format that can be ran from AMOS), simply send me a disk (with some PD on it)
  237. and return postage, and I'll put it on your disk and send it to you. The
  238. complied version is faster ! Please send any bug reports, comments, ideas or
  239. spare cash to:
  240.  
  241.  
  242.                                M. VENN
  243.                                3 BRITTEN DRIVE
  244.                                GOODLEIGH RISE
  245.                                BARNSTAPLE
  246.                                NORTH DEVON
  247.                                EX32 8AQ
  248.  
  249.                                ENGLAND
  250.  
  251.  
  252.    Any disks or letters recieved will be returned/replied. Also, if anyone
  253. out there could possibly send me any PC TURBO PASCAL source code that they've
  254. done please do ! (On a PC disk please !)
  255.  
  256. Enjoy SWIZ !
  257.