home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 4 / AUCD4.iso / utils / games / mapper / !Mapper_O / !Help < prev    next >
Text File  |  1998-01-28  |  13KB  |  378 lines

  1.                      *   *   *** ****  ****  ***** ****
  2.                      ** **  *  * *   * *   * *     *   *
  3.                      * * * ***** ****  ****  ***   ****
  4.                      *   * *   * *     *     *     *   *
  5.                      *   * *   * *     *     ***** *    *
  6.  
  7.                      Version : 4.00 Released : 14/12/96
  8.                      Version : 4.10 Updated  : 1/11/97
  9.                      Version : 4.11 Updated  : 28/1/98
  10.  
  11. I.  Contents :
  12.  
  13.     1............Introduction
  14.     2............What is a map editor ?
  15.     3............The legal bit
  16.     3............The differences
  17.     3............System requirements
  18.     3............Extra commands
  19.     4............The WIMP options
  20.     5............The editing screen
  21.     5............Key commands
  22.     6............The Sprite Overlay System™
  23.     6............Saving and loading
  24.     7............MAP format
  25.     A............Glossary
  26.     B............And finally...
  27.     C............The new bits...
  28.  
  29. 1.  Introduction 
  30. ----------------
  31.  
  32. Welcome to the very last version of !Mapper - because this is the ultimate
  33. version of my !Mapper series, there is no need to do any more, apart from
  34. probably the odd bug fix or update.
  35.  
  36. 2.  What is a map editor?
  37. -------------------------
  38.  
  39. A map editor is normally used for 2D games, for example Chaos Engine, Cannon
  40. Fodder etc. etc., and allows you to position background sprites anywhere
  41. within a defined area.  When you come to display the background in your
  42. program, the code used will tell you which sprite you need to display.  
  43.  
  44. You could do things the hard way, and design the background completely in
  45. some art package, but to do so will use a lot of memory and you will have a
  46. hard job animating sprites and performing special actions.
  47.  
  48. Alternatively you could type in DATA statements into your program, but doing
  49. so is slow, boring and prone to error.
  50.  
  51. Let !Mapper V4.xx increase your productivity...
  52.  
  53. 3.  The legal bit
  54. -----------------
  55.  
  56. !Mapper+, !Mapper V3.xx, and !Mapper V4.xx are 
  57. (C) Nicholas Kingsley Bsc 1995/1996
  58.  
  59. The Sprite Overlay System is trademark of Nicholas Kingsley
  60.  
  61. All unauthorised coping, reverse engineering, lending, loaning is strictly
  62. forbidden without MY WRITTEN PERMISSION.
  63.  
  64. Thanks to Pineapple Software for the filetype allocation of the MAP
  65. filetype.
  66.  
  67. 4.  The differences
  68. -------------------                     
  69.  
  70. Most of the options in !Mapper V3.xx were not needed.  Here is a list of the
  71. differences between the two :
  72.  
  73. Functions removed :
  74.  
  75. A)  X and Y Mirroring
  76. B)  Compression saving
  77. C)  Virtual memory
  78. D)  Editing grid
  79.  
  80. Functions that are the same :
  81.  
  82. A)  Mouse functions are generally the same
  83. B)  The WIMP options are the same (but have been extended)
  84.  
  85. Functions added :
  86.  
  87. A)  Multiple editing modes 
  88. B)  Sprite Overlay System™ 
  89. C)  Each sprite has status information
  90.  
  91. 5.  System Requirements 
  92. ----------------------
  93.  
  94. You will need at least 1Mb to run this program (although you can change
  95. various items to run the program if you are low in memory).  The program has
  96. only be tested on a RISC OS V3.11 and so MAY NOT run on other machines. 
  97.  
  98. UPDATE : This program will run on a StrongArm computer.
  99.  
  100. 5.  Extra commands
  101. ------------------
  102.  
  103. The following commands must be placed just before the comment on the last
  104. line of the !Run file.  Each command must be separated from the previous
  105. command and the parameter value by a space.
  106.  
  107. The commands are :
  108.  
  109. -xsize <value> - This changes the default value for the maximum value for
  110. the map width.  The value can be any size between 1 and 255
  111.  
  112. -ysize <value> - This changes the default value for the maximum value for
  113. the map height.  The value can be any size between 1 and 255
  114.  
  115. -layers <value> - This changes the default value for the number of layers. 
  116. The value can be between 1 and 255
  117.  
  118. -sprites <values> - This changes the default value for the maximum number of
  119. sprites that can be read.  The value can be between 1 and 999
  120.  
  121. UPDATE :
  122.  
  123. -repeat <value> - This changes the speed at which the computer scrolls through
  124. the different sprites.  The value can be between 1 and 255
  125.  
  126. NOTE : If the computer can't claim enough memory for any value, an error
  127. message will be displayed, and the program will remove itself from memory.
  128.  
  129. 6.  The WIMP options 
  130. --------------------
  131.  
  132. There are very few WIMP options.  These are to be found in "Change Map" and
  133. "Save Map".  The values in "Change Map" affect ALL the layers.
  134.  
  135. The "Change Map" options are :
  136.  
  137. Layer X Size - This allows any value between 1 and the current maximum 
  138.                width allowed, and changes the width of the map.
  139. Layer Y Size - This allows any value between 1 and the current maximum
  140.                height allowed, and changes the height of the map.
  141. Delete value - This allows any value between 0 and 65535, and governs what
  142.                value is stored when the delete button is pressed on the
  143.                mouse.  Delete values can have sprites associated with them,
  144.                and if they do then the correct sprite is displayed when you
  145.                delete graphic.
  146. Mask value   - This allows any value between 0 and 255 and is only used with
  147.                the Sprite Overlay System™.  This governs what value will be
  148.                ignored multiple layers are displayed.  Please read the
  149.                overlay system text
  150.  
  151. The following headings allow you to set up global status values, without
  152. having to press the MIDDLE button after plotting each tile :
  153.  
  154. Walkability, Special #1, Special #2 and Special #3 - Click on the box to
  155. active the speciality.
  156.  
  157. Animation frames - Used only in your own programs, this lets you know how
  158. many animation frames a tile has
  159.  
  160. X Modify and Y Modify - Activated ONLY when Special #3 has been selected,
  161. this is only used in your own programs to help implement hidden walls,
  162. floors etc., by defining the character X and Y position
  163.  
  164. L Modify - Used as above, but specifies which layer the hidden tile is on.
  165.  
  166. The "Save Map" options :
  167.  
  168. The button next to "All" determines how many layers are saved.  With it
  169. crossed then ALL layers are saved.  When it isn't then only the CURRENT
  170. EDITED layer is saved.
  171.  
  172. 7.  The editing screen
  173. ----------------------
  174.  
  175. In the default editing map ("Normal editing") then screen is split into
  176. two parts.  The top displays the sprites, while the second part at the
  177. bottom displays some useful information about the current layer :
  178.  
  179. Layr  - Current layer number 
  180. XSize - Current WIDTH of the map
  181. YSize - Current HEIGHT of the map
  182. X:    - Current X position of the pointer in the current layer  
  183. Y:    - Current Y position of the pointer in the current layer
  184.  
  185. The boxes in the left size of the screen contain the previous sprite
  186. graphic, the current sprite graphic and the next sprite graphic.  Clicking
  187. on the left hand arrow with the LEFT mouse button moves the sprites right
  188. (allows you to select the previous sprite), while clicking on the RIGHT
  189. button moves the sprites left (allows you to select the next sprite).
  190.  
  191. The sprite in the middle is the currently selected sprite (CSS).
  192.  
  193. Clicking on the left hand arrow with the RIGHT button positions the sprites
  194. so that the FIRST sprite is the CSS, while clicking on the right hand arrow
  195. with the RIGHT button positions the sprites so that the LAST sprite is the
  196. CSS.
  197.  
  198. The arrows underneath the word "Layr" selects which layer will be currently
  199. edited.  Clicking on the left hand arrow with the LEFT mouse button selects
  200. the previous layer, while clicking on the right hand arrow with the LEFT
  201. button selects the next layer.
  202.  
  203. Clicking on the left hand arrow with the RIGHT mouse button selects the
  204. FIRST layer, while clicking on the right hand arrow with the RIGHT button
  205. selects the LAST layer. 
  206.  
  207. The characters underneath the word "Status" show the status of the sprite
  208. currently under the pointer.  If a character is "lit up" (not grey), then
  209. that speciality is active.  
  210.  
  211. The specialities are :
  212.  
  213. W - Walkability  (Can the player move ONTO this tile ?) 
  214. 1 - Special #1   (Is this tile in Special group #1) 
  215. 2 - Special #2   (Is this tile in Special group #2) 
  216. 3 - Special #3.  This is different to the previous specialities in as much
  217.                  as when this is active a number will be displayed on the
  218.                  line below.  These are the grid references (X and Y) of a
  219.                  tile that will be modified when the player steps onto the
  220.                  CSS.  Beneath these values holds the layer of the tile that
  221.                  will be modified.
  222.  
  223. You can only modify the specialities when in "normal editing mode".  
  224.  
  225. Version V4.00 ONLY : To do so, press the MIDDLE mouse button and go through
  226. all the questions at the bottom of the screen, and where appropriate entering
  227. values.  The LEFT mouse button confirms a question, while the other two don't.
  228.  
  229. The value to the right of the "Anim:" word contains the number of frames of
  230. animation for that tile.
  231.  
  232. 8.  Key commands
  233. ----------------
  234.  
  235. The following keys can be used in any mode  :
  236.  
  237. The Space bar - wraps around between normal editing, full screen editing
  238.                 and the Sprite Overlay System™
  239. ⇦ ⇧ ⇨ ⇩       - Scrolls the editing or Overlay screen around
  240. Home          - Re-displays the current layer from the top left
  241.  
  242. 9.  The Sprite Overlay System™
  243. ------------------------------
  244.  
  245. This is a very powerful feature allowing you to position your sprites
  246. EXACTLY where you want them.
  247.  
  248. Each layer is displayed from the first (or BASE layer) to the very last, in
  249. such a way that, created properly, all sprites at a certain position can be
  250. displayed.
  251.  
  252. 10. Saving and loading
  253. ----------------------
  254.  
  255. Before editing can commence, a sprite file needs to be dragged to the
  256. !Mapper icon.  If no valid sprites are found then an error message is
  257. displayed.
  258.  
  259. MAP files can also be dragged to the !Mapper icon and will use the currently
  260. stored sprites.  In addition, MAP files can also be loaded by
  261. double-clicking on the MAP icon.
  262.  
  263. MAP files from !Mapper V3.xx is NOT compatible.
  264.  
  265. To save a MAP file just drag the MAP icon to a directory, press the OK
  266. button or type in a filename.  The selectable icon to the right of the icon
  267. graphic determines whether all layers are saved (star is in the box) or the
  268. current layer only is saved (box is clear).
  269.  
  270. NOTE : Layers that are saved singly can ONLY be loaded into the layer that
  271. they were saved from.
  272.  
  273. 11. MAP format
  274. --------------
  275.  
  276. The format of the MAP file is as follows :
  277.  
  278. +0  (4 Bytes) - Header (&19861987)
  279. +4  (2 Bytes) - Map width
  280. +6  (2 Bytes) - Map height
  281. +8  (1 Byte)  - Type of saving 0 - All layers saved
  282.                               >0 - Given layer is saved
  283.  
  284. This is followed by the tile data :
  285.  
  286. +0  (2 Bytes) - Sprite number
  287. +2  (1 Byte)  - Sprite status - Bit 0 Set - Walkability
  288.                                 Bit 1 Set - Special #1
  289.                                 Bit 2 Set - Special #2
  290.                                 Bit 3 Set - Special #3
  291. +3  (1 Byte)  - No. of frames of animation
  292. +4  (1 Byte)  - X Modify location    
  293. +5  (1 Byte)  - Y Modify location    
  294. +6  (1 Byte)  - Modify layer value  
  295.  
  296. A.  Glossary 
  297. ------------
  298.  
  299. BASE LAYER - The first layer which is used to hold floor, walls, grass,
  300. doors, water and mud etc. sprites.
  301.  
  302. TILE - A Sprite.
  303.  
  304. SPRITE STATUS - Holds each tiles speciality.
  305.  
  306. SPECIALITY - Defines how the player should react to a given tile.  The
  307. specialities are : Walkability (can the player walk ONTO this tile ?),
  308. Special #1, Special #2 (These are for the user's use) and Special #3 (Which
  309. allows the programmer to modify a tile)
  310.  
  311. SPRITE OVERLAY SYSTEM™ - Overlays layers so that A) You can position sprites
  312. correctly and B) You can see which sprites go where.
  313.  
  314. LAYER - A group of tiles
  315.  
  316. MODIFICATION LOCATION - Allows easy programming of 'hidden' walls etc., by
  317. storing the X, Y and layer number of the sprite the program has to modify.
  318.  
  319. MAP - A group of layers  
  320.  
  321. B.  And finally...
  322. ------------------
  323.  
  324. Whilst they shouldn't be any problems with the program, you can contact me
  325. by sending E-Mail to : nichk@argonet.co.uk
  326.  
  327. C.  The new bits...
  328. -------------------
  329.  
  330. Since this program was written, the StrongArm computer has come out.  Being much
  331. faster than the programmers original computer, it was found that a slight
  332. modification was needed to allow the user to successfully choose different
  333. sprites and layers.  In addition, a new 'speciality' has been added : The
  334. 'OPAQUE' speciality.  This allows the programmer to code hidden doors, walls
  335. etc easily without having to use any of the original specialities.  It limits
  336. what can be seen behind the 'opaqued' tile.
  337.  
  338. The specialities can now be entered in a much easier way using a 'LOCK'. 
  339. Pressing the MIDDLE button within the editing area with put a red rectangle
  340. around the current sprite.  This sprite is then locked.  This means that,
  341. until the MIDDLE button is pressed again, the only thing you can modify on
  342. that tile is the specialities.  
  343.  
  344. To do that, press the LEFT mouse button over the 'W123O' letters to toggle
  345. them on and off.  If speciality #3 is active, then, you can modify the
  346. modification X, Y and layer values by pressing the LEFT mouse button between
  347. the brackets.
  348.  
  349. To modify the animation value, just LEFT click on the three numbers.
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.