home *** CD-ROM | disk | FTP | other *** search
/ Falcon 030 Power 2 / F030_POWER2.iso / ST_STE / MAGS / ICTARI07.ARJ / ictari.07 / ASSEMBLY / SPRITES / SPR_CHCK.DOC < prev    next >
Text File  |  1993-09-03  |  6KB  |  150 lines
  1.  
  2.  
  3.                SPRITE CHECK PROGRAM OPERATING INSTRUCTIONS
  4.                ===========================================
  5.  
  6.             Written by Peter Hibbs  Copyright September 1993
  7.  
  8.                           Version 1.0  3-9-1993
  9.  
  10.  
  11. INTRODUCTION.
  12.  
  13. This program is used  to  display  sprites  which  have been designed and
  14. stored in a sprite object data  file by the NEOCHROME-MASTER art program.
  15. As well as displaying the  sprite  images  and sprite information, it can
  16. store the hot spot offset  values  for  any  sprite and also displays the
  17. colour palette information.
  18.  
  19. MAIN SCREEN.
  20.  
  21. Before the program is run ensure  that  the computer is in low resolution
  22. mode and that the SPR_CHCK.RSC file is  present in the same folder as the
  23. program itself.  Running the program shows  the main screen with a number
  24. of buttons. Some of the options will only  work when a data file has been
  25. loaded into memory.
  26.  
  27. LOAD (L).
  28.  
  29. First click on LOAD or press key L to load a data file, the file selector
  30. is displayed. Select a sprite data file (normally with the extension .OBJ
  31. although it doesn't have to be) and click  on  OK. If the file is a valid
  32. sprite data file it will be loaded  into  memory and the main screen will
  33. show the relevant information.
  34.  
  35. The filename and file size are displayed at the top of the screen.
  36. The filenames of the NEOCHROME picture files  used by the sprite file are
  37. shown in the left box.
  38. The number of sprites stored in  this  file  is  shown  at the top of the
  39. right hand box and the rest of  the  box shows the information for sprite
  40. number 1.
  41.  
  42. NEXT (UP ARROW).
  43.  
  44. To display the data for the  next  sprite  click  on NEXT or press the UP
  45. ARROW key, the sprite  number  and  sprite  data  is  shown  for the next
  46. sprite.
  47.  
  48. PREV (DOWN ARROW).
  49.  
  50. To display the data for the  previous  sprite  click on PREV or press the
  51. DOWN ARROW key.
  52.  
  53. SHOW (ESCAPE).
  54.  
  55. To display the sprite itself click on  SHOW  or press the ESCAPE key. The
  56. screen will clear and the  current  sprite  image will be displayed along
  57. with the sprite number,  width,  height,  x  offset  and  y offset on the
  58. bottom line. Press the UP  or  DOWN  arrow  keys  to  display the next or
  59. previous sprites. Press the ESCAPE key to return to the main screen.
  60.  
  61. The hot spot pixel will flash on and  off on the sprite image to indicate
  62. its position. Pressing key H  will  disable/enable the flashing. Pressing
  63. key I will hide or  display  the  information  line  at the bottom of the
  64. screen.
  65.  
  66. COLOURS (C).
  67.  
  68. Click on COLOURS or press key C  to display the colour palette. Note that
  69. when the sprite file is  loaded  the  program  loads the beginning of the
  70. first NEOCHROME screen  picture  file  (usually  screen  0)  and uses the
  71. palette from that file. If any sprites  are stored on other screens which
  72. have different palettes, the sprite colours may be incorrect.
  73.  
  74. The colour of each index  and  the  numerical  setting for each colour is
  75. displayed. Clicking on any box with  the left mouse button will increment
  76. the colour value and clicking with  the right mouse button will decrement
  77. it.
  78.  
  79. The numbers in brackets  are  the  GEM  colour  code equivalents for each
  80. index colour code and should be  used  if  setting colours with a GEM VDI
  81. call.
  82.  
  83. Click on OK (or press RETURN) to return to the main screen.
  84.  
  85. OFFSETS (O).
  86.  
  87. Clicking on OFFSETS or pressing  key  O  will  display the OFFSET screen.
  88. This screen allows the hot spot of any sprite (or range of sprites) to be
  89. changed. First enter the offset value into  the x and y offset fields. If
  90. only the current sprite is to  be  changed  (as  shown  at the top of the
  91. form) click on CURRENT. The program  returns  to the main screen with the
  92. new values displayed.
  93.  
  94. If a number of sprites need to  be  changed  with the SAME x and y offset
  95. values, the first sprite object number  and the last sprite object number
  96. should be entered into the  next  two  fields.  The sprites to be changed
  97. must, of course, be consecutive  numbers.  Click  on  RANGE to change the
  98. specified sprites, the main screen is then re-displayed.
  99.  
  100. HELP (HELP).
  101.  
  102. Click on  HELP  or  press  the  HELP  key  to  display  the  key commands
  103. available.
  104.  
  105. SAVE (S).
  106.  
  107. If a sprite file has been changed (i.e. hot spot values reprogrammed) the
  108. sprite file must be saved back to disk.  Click on SAVE or press key S and
  109. use the file selector to  save  the  file  as  normal. It is possible, of
  110. course, to change the filename when saving if required.
  111.  
  112. QUIT (Q).
  113.  
  114. Click on QUIT or press Q to return to the desktop, a warning message will
  115. be displayed if the sprite file has been changed but not saved.
  116.  
  117.  
  118.  
  119.  
  120.  
  121. LIMITATIONS.
  122.  
  123. This program does not allow  for  the  extra  colours  of  the STE at the
  124. moment, if anyone wants this option please let me know.
  125.  
  126. The internal buffers are limited to the following sizes.
  127.  
  128. Sprite data file        400K bytes
  129. Sprite mask buffer      100K bytes
  130. Sprite table            1000 sprites
  131.  
  132. Sprite data files should not exceed 400K  bytes  (if you need more let me
  133. know) and the number of sprites  not  more  than 1000 (999 is the maximum
  134. anyway). Since these buffers are defined within the program, this program
  135. will not work on a machine with less than 1Mb of memory.
  136.  
  137. If there are any bugs  found  or  any  extra  facilities required in this
  138. program please let me know, I MAY be able to oblige.
  139.  
  140. HISTORY.
  141.  
  142. Version 1.0     Original version.  3-9-1993
  143.  
  144. Please send any comments about this program to me at -
  145.  
  146.   63 Woolsbridge Road, Ashley Heath, Ringwood, Dorset, BH24 2LX
  147.  
  148.  
  149.  
  150.