home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilsm / mapper / !MAPPER / !HELP < prev    next >
Text File  |  1995-09-21  |  9KB  |  237 lines
  1. Welcome to probably the first generic map editor for the Archimedies
  2. Designed & programmed by Nicholas Kingsley
  3. This is version 1.00
  4. --------------------------------------------------------------------
  5.  
  6. 1.  INTRODUCTION
  7.  
  8. !Mapper is a program for designing game maps.  
  9. "Whats a game map", I hear you cry...  Well, when your designing a 2D game 
  10. like Chaos Engine, Lemmings etc, you need a way of storing the background 
  11. graphics.  You could type in all the data manually, design your own
  12. custom map editor, or you could do things the easy way and let !Mapper do
  13. all the hard work for you...  Being generic it can handle sprites in either
  14. mode 12, 13 or 15 and handle a 256 * 256 game map.
  15.  
  16. THIS SOFTWARE IS SHAREWARE.  TO OBTAIN THE NEXT VERSION, SEND £5 TO
  17. THE ADDRESS AT THE BOTTOM OF THIS FILE, WITH YOUR NAME & ADDRESS (AND 
  18. E-MAIL ADDRESS IF YOU HAVE ONE).
  19.  
  20. 2.  THE FILES
  21.  
  22. In order to run this program, you need the following files :
  23.  
  24. !Boot (Obey file)
  25. !Mapper (Basic)
  26. !Run (Obey)
  27. !Sprites (Sprite)
  28. GRAPHICS - Shapes (Sprite)
  29. MODULES  - MenuUtils (Relocatable module)
  30. DEMO     - Graphics (Sprite)
  31.          - Obeyfile (Obey)
  32.          - Map (Data)
  33.  
  34. The program takes up 256K to allow for editing of 256 * 256 maps!
  35.  
  36. To load sprites into the system sprite area, use the SLOAD command in the
  37. command line.
  38.  
  39. Note : If you have loaded more than 255 sprites into the sprite area, then
  40. only the first 255 sprites are examined.
  41.  
  42. Before you can run the program, you will need to change the filetypes of
  43. most of the files to those given in the list above.  Sorry, but LHARC 
  44. doesn't preserve filetypes!
  45.  
  46. 3.  THE PROGRAM
  47.  
  48. Once the !Mapper icon has been placed on the icon bar, pressing the MIDDLE
  49. mouse button will display the following options :
  50.  
  51. 1.  Info - Gives information about the program
  52. 2.  Mode - Allows you to choose which type of sprites to use 
  53. (see "GRAPHICS").  Note : With first use, the default is mode 13
  54. 3.  X Size - Allows you to re-define the X size of the map
  55. 4.  Y Size - Allows you to re-define the Y size of the map.  
  56. Note : When first loaded, the default X and Y value is 40 and 25 respectivly.
  57. 5.  Filename - Allows you to type in a new filename for saving & loading
  58. 6.  Save - Saves the map using the filename given above (see "FILE ACCESS")
  59. 7.  Load - Loads a map using the filename given above
  60. 8.  Clear Map - Clears the whole of the map
  61. 9.  Edit Map - Allows you to edit a map (see "GRAPHICS")
  62.  
  63. In addition, the following items are displayed when you select "EDIT MAP":
  64.  
  65. 1.  On the bottom left of the screen is an arrow pointing left.  Use this
  66. to scroll the sprites left (if possible)
  67. 2.  On the bottom right of the screen is another arrow, this time pointing
  68. right.  Again it is used to scroll the sprites right (if possible)
  69. 3.  On the bottom row between the left and right arrows, are your sprites
  70. that can be used for a given mode.  Move the pointer to one of these
  71. sprites to select it for plotting in the map.
  72.  
  73. The following status items will now be explained :
  74.  
  75. 1.  X=000/000/000 - The first 3 digits represent the UDG X position
  76.                     The next 3 represent the map X position
  77.                     The last 3 describe the size of the map in the X 
  78.                     direction (so, if it says 041, you have defined a map
  79.                     of 41 bytes running from 0 to 40)
  80. 2.  Y=000/000/000 - The first 3 digits represent the UDG Y position 
  81.                     The next 3 represent the map Y position
  82.                     And the last 3 describe the size of the map in the Y
  83.                     direction, running from 0 to number-1
  84. 3.  Pos=0000      - This is the actual location in the map data
  85. 4   Select=000/000/xxxxxxxxxxxx - The first 3 digits describe which sprite
  86.                                   you have currently selected
  87.                                   The next 3 represent the maximum number of
  88.                                   sprites that are valid, while the text 
  89.                                   is the sprite name of the currently
  90.                                   selected sprite.
  91.  
  92. Note : Valid means the number of sprites that can be used for a given mode.
  93. Although you may have more sprites in the sprite area than those listed,
  94. a sprite is only valid if it is 16 * 16 pixels, and has been designed in
  95. the mode as given by the "MODE" option.
  96.  
  97. 4.  CONTROLS
  98.  
  99. Mouse Up/Down/Left/Right - Move pointer up/down/left/right and if in map 
  100.                            area, will also move positioning cursor
  101. SELECT - If in map area, place current select sprite in map, else either
  102.          select sprite under pointer or scroll sprites left or right
  103. MENU   - Delete sprite at given location
  104. ADJUST - Return to desktop
  105. F1 - Display option/Save map using current filename
  106. F2 - Load map using current filename
  107. F3 - Clear map
  108. F12- Exit options
  109. HOME - Position map at the top left
  110. CURSOR LEFT - Scroll map left
  111. CURSOR RIGHT- Scroll map right
  112. CURSOR UP   - Scroll map up
  113. CUSROR DOWN - Scroll map down
  114.  
  115. Note : There is no protection against making mistakes if you use the load,
  116. save or clear from within the program.
  117.  
  118. 5.  GRAPHICS
  119.  
  120. In order to edit a map, you need some sprites.
  121.  
  122. These can be designed in either modes 12, 13 or 15, MUST be 16 pixels
  123. by 16, sprite mode MUST equal selected mode AND MUST be loaded into the 
  124. system sprite area before editing a map (see "IMPROVEMENTS").
  125.  
  126. Any sprites that do not conform to this will be ignored, and you will not
  127. be able to use them.
  128.  
  129. If the number of sprites exceed the number that can be displayed, use the
  130. left and right arrows to scroll through the list.
  131.  
  132. 6.  FILE ACCESS
  133.  
  134. All maps are loaded and saved in a fixed format to the file current
  135. specified by the "Filename" option.
  136.  
  137. The format for a map file is as follows :
  138.  
  139. + 0 - Version (* 100) ie 100
  140. + 1 - Map X Size
  141. + 2 - Map Y Size
  142. + 3 - Mode that the map was defined in
  143. + 4 -
  144. + 5  | _
  145. + 6  |   Reserved for future enhancement (must be 0)
  146. + 7 -
  147. + 8 onwards - Map data (0 - No sprite to plot
  148.                         > 0 - Sprite to plot)
  149. Last byte - Checksum
  150.  
  151. Note : The number store in the map is the order number of the selected
  152. sprite.
  153.  
  154. A.  IMPROVEMENTS
  155.  
  156. For future enhancements, I intend to add the following :
  157.  
  158. 1)  Allow sprites of any size (although all sprites will have to be the 
  159. same size)
  160. 2)  Possible increase of user-friendlyness
  161. 3)  Load into program area rather than system area
  162. 4)  Improve loading and saving system
  163. 5)  Possibly increase map size.
  164.  
  165. B.  ERROR MESSAGES
  166.  
  167. The following is a list of error messages you may come across whilst using
  168. the program :
  169.  
  170. 1)  The map has been modified.  Are you sure you want to quit/load map ?
  171. You have modified a map by either placing or deleting a block.  Select
  172. OK to continue with the action, or CANCEL to abort it
  173.  
  174. 2)  No system sprite memory for sprites
  175. The system sprite memory is currently at 0.  Use the task manager to 
  176. increase it.
  177.  
  178. 3)  No sprites availiable
  179. There are no sprites in the system sprite area
  180.  
  181. 4)  No valid sprites
  182. There are no sprites that are 16*16 and have been designed in the current
  183. selected sprite mode
  184.  
  185. 5)  Invalid X size - the allowable range is 1 to 256
  186. The map size can be between 1 and 256.  Re-enter a value in this range
  187.  
  188. 6)  Invalid Y size - the allowable range is 1 to 256
  189. The map size can be between 1 and 256.  Re-enter a value in this range
  190.  
  191. 7)  Filename must be given
  192. No filename has currently been given.  Use the "FILENAME" option to select
  193. one
  194.  
  195. 8)  Invalid filename/file locked/file is a directory
  196. No data has been saved to file.  Possible causes :  Invalid filename,
  197. file medium is full, file is write protected or file is a directory
  198.  
  199. 9)  Checksum in file incorrect - possible file corruption
  200. The result when adding the bytes together whilst loading is different from
  201. that stored in the file.  Possible causes : File corrupted, file open
  202. or file has been modified using a text editor
  203.  
  204. 10) File not found/invalid filename
  205. No file has been loaded.  Possible causes :  Invalid filename or
  206. no such filename
  207.  
  208. 11) Version number of data is later than the version number of this program
  209. You are trying to load a map which has got a version number of at least 200
  210. (ie version 2+).  Re-do map using earlier version.
  211.  
  212. C.  MODULES USED
  213.  
  214. Th