home *** CD-ROM | disk | FTP | other *** search
/ Classic Fond 5 / ClassicFond05_nopass.iso / ARCADE / BRKFREE.RAR / GEDIT.TXT < prev    next >
Text File  |  1995-05-06  |  12KB  |  271 lines
  1.  
  2.                            GEDIT
  3.                   BreakFree Game Grid Editor
  4.  
  5.                     by Software Storm Inc.
  6.  
  7.  
  8. IMPORTANT!!!  IMPORTANT!!!  IMPORTANT!!!  IMPORTANT!!!  IMPORTANT!!!
  9.  
  10.   If you are not going to read this whole document, please at least
  11.   read the IMPORTANT GUIDELINES section at the end of this document. If
  12.   you do not follow these guidelines, you may create a level that will
  13.   not work properly with BreakFree.
  14.  
  15. IMPORTANT!!!  IMPORTANT!!!  IMPORTANT!!!  IMPORTANT!!!  IMPORTANT!!!
  16.  
  17.  
  18. GEDIT is used to edit the layout (grid) of a game level.
  19.  
  20. Level grid files have the naming convention MAZE00.GRD where 00 is
  21. the level number from 01 to 72.  All you need to know when loading a
  22. grid file is the element name or element number.  Levels in BreakFree
  23. are numbered 1 - 72 and named Hydrogen through Hafnium.
  24.  
  25. To run:
  26. =======
  27. Command-line Syntax -- GEDIT [filename]
  28.     If a file name is specified, GEDIT will load that grid
  29.     file as the initial game grid.
  30.     If there is no file name, GEDIT starts with a blank 32 by 32 
  31.     grid.
  32.  
  33. GEDIT must be run in the same directory as BRKFREE.MLB.  BRKFREE.MLB
  34. contains many files within it.  Several of those files are needed
  35. just for loading GEDIT.  Once GEDIT is loaded, the level files you
  36. edit will be extracted from BRKFREE.MLB and saved as external files. 
  37. Your original copy of BRKFREE.MLB will never be modified.  If you ever
  38. want to restore the original grid file for a level, just erase or rename
  39. the grid file that GEDIT created outside of BRKFREE.MLB.  The game will
  40. automatically revert to loading the file from BRKFREE.MLB.
  41.  
  42. Once in GEDIT you will see three primary boxes or screens and a few
  43. "buttons" across the top of the screen.  The buttons do exactly what
  44. they say they do.  The three screens are used for selection, editing,
  45. and display purposes.  The bar across the bottom of the screen is
  46. used for system messages and for text input.
  47.  
  48. +---------+----------+---------+-----------+---------+-----------------+
  49. |   NEW   |   LOAD   |  SAVE   |  SAVE AS  |  EXIT   | POS: coordinates|
  50. +---------+----------+---------+-----------+---------+-----------------+
  51. | SIZE: X,Y            BACK          FILE: MAZExx.GRD|      WALLS      |
  52. |                                                    |                 |
  53. |                                                    |                 |
  54. |                                                    |                 |
  55. |                                                    |      wall       |
  56. |                                                    |     palette     |
  57. |                                                    |                 |
  58. |                                                    |                 |
  59. |                    grid                            |                 |
  60. |                  edit area                         |                 |
  61. |                                                    |-----------------|
  62. |                                                    |                 |
  63. |                                                    |     current     |
  64. |                                                    |      wall       |
  65. |                                                    |     image       |
  66. |                                                    |                 |
  67. |                                                    |                 |
  68. | MEM: bytes          FRONT             LEVEL: name  |                 |
  69. +----------------------------------------------------+-----------------+
  70. | status and input line                                                |
  71. +----------------------------------------------------------------------+
  72.  
  73. The large box covering the middle and left portions of the screen is
  74. usually the edit screen.  This is where a grid of the currently
  75. selected level is usually displayed.  The wall image selection palette 
  76. and help text also appear here.
  77.  
  78. The small box in the lower right corner of the screen is used for
  79. displaying the currently selected wall image.  That will give you
  80. some idea of what wall you are working with.
  81.  
  82. The mid-sized box in the upper right corner is usually refered to as
  83. the wall palette.  Each wall is represented by a color block and
  84. name.  You can move through this palette using the standard cursor
  85. movement keys.
  86.  
  87.  
  88. Active Screen and Cursor:
  89. =========================
  90.  
  91. You can select which screen is "active" by pressing tab to toggle
  92. back and forth between the edit and wall palette screens.  A yellow
  93. border is drawn around the currently active screen.
  94.  
  95. Within each screen there is a cursor (small yellow box) to indicate
  96. the active element on that screen.  For instance, in the grid edit
  97. area, the cursor is on the grid position that can be modified.  In
  98. the wall palette, the cursor indicates the current wall that would be
  99. put in the grid.
  100.  
  101. In general, the process of editing is to select walls from the wall
  102. palette and set them in the grid using the mouse or keys.
  103.  
  104. To make a grid position empty, select the "<NONE>" wall, and put that
  105. in the desired grid position.
  106.  
  107. When using the mouse, you may draw solid boxes or empty rectangles by
  108. drawing with the mouse button down.  Hold the left button down to draw a
  109. solid box of the currently selected wall.  Hold the right button down to
  110. draw the outside of a rectangle with the currently selected wall.
  111.  
  112. When you choose New, the new grid will be filled with the currently selected
  113. wall.  Usually, you will want to select the <NONE> wall before choosing New.
  114.  
  115. If you want to change the size of a grid, but want to preserve its contents,
  116. use the Copy and Paste options.  You can Copy a rectangular region to a
  117. separate buffer, choose New to create a new grid with the desired dimensions,
  118. then position the cursor and press "P" to paste the saved region into the
  119. new grid.
  120.  
  121. Commands:
  122. =========
  123. You can see this list of commands inside GEDIT by pressing the F1
  124. key.
  125.  
  126. F1 -- Help screen.
  127. A -- Save As, prompts for user to enter file name to save
  128. C -- Copy, Prompts to mark two corners of area to copy to paste
  129.     buffer.
  130. E -- Extract (Eyedropper), move palette to wall that edit cursor
  131.     is currently on.
  132. F -- Floor, prompts user to select the floor and ceiling colors for the grid.
  133. I -- Identity (level name), prompts the user to enter a name for the level.
  134.      (Level name is saved to the LEVELxx.GAM file immediately)
  135. L -- Load, prompts the user to enter a file to load.
  136. N -- New, initializes new grid in the size specified. 
  137. O -- Origin, prompts the user to enter coordinates for the starting
  138.      position.  (Position is saved to the LEVELxx.GAM file immediately)
  139. P -- Paste, copies contents of paste buffer to area starting at
  140.      cursor location.
  141. S -- Save, saves current grid to file already specified.
  142. T -- Time, prompts the user to enter number of seconds for the level.
  143.      (Time is saved to the LEVELxx.GAM file immediately)
  144. W -- Walls, show an image pallette of walls in the main edit area.
  145. Z -- Set Zoom, prompts for new zoom setting.
  146. Tab -- Toggles between the palette and edit windows.
  147. Space -- Sets currently selected wall to grid position selected in edit
  148.     window.
  149. Q, X, ESC -- Exit GEDIT.
  150. Up, Down, Left, Right -- Move cursor in either edit area or wall palette.
  151. +, - -- Zoom in/out, magnifies or shrinks edit display.
  152. Home, End -- Move to first or last pixel in current row on screen.
  153. PgUp, PgDn -- Move to Top or Bottom pixel in current column on screen.
  154. Scroll Lock -- Toggle on/off paint as cursor moves.
  155.  
  156.  
  157. Explanation of effects:
  158. ==========================================================
  159. WARNING - you may spoil the game if you read this section!
  160. ==========================================================
  161.  
  162.  
  163. There are 5 styles of walls, which we refer to as motifs:
  164.  
  165.     brick
  166.     steel
  167.     cave
  168.     water
  169.     hidden
  170.  
  171. Each wall is named to identify the motif and wall type.  The first
  172. letter of the wall name is the first letter of the motif (B, S, C, W,
  173. or H).  The rest of the name indicates what type of wall it is.  In
  174. the list below, the first part of the name for the wall type is shown
  175. in parentheses.
  176.  
  177. Within each motif, there are 50 different walls.  The walls have different
  178. effects that they produce.  Hopefully, during play you have learned all the
  179. different ways that walls behave, but here are the general wall categories:
  180.  
  181. impregnable walls (IMPREG) - 3 per motif.  These walls cannot be
  182. destroyed.
  183.  
  184. bad wall (BAD) - every motif has 1 bad wall (with a skull on it). 
  185. These walls are usually positioned behind the player (on the back
  186. wall) and will "eat" the fireballs.
  187.  
  188. explosion walls (EXPL) - these can be placed on a level, but they will
  189. disappear immediately when the user starts the level.  They are used
  190. for animating wall explosions and are normally not placed on a level.
  191.  
  192. normal walls (NORM) - walls that are destroyable, but have no extra
  193. effect.
  194.  
  195. effect walls (name varies) - release objects, or affect the walls
  196. around them.
  197.  
  198. animation walls (ANI) - present a continuous animation until
  199. destroyed.
  200.  
  201. multi-hit walls (MULTI) - walls that must be hit multiple times to be
  202. destroyed.
  203.  
  204. reserved walls (RESERV) - these walls are currently reserved and
  205. should not be used.
  206.  
  207.  
  208. Example session:
  209.  
  210. 1) Start GEDIT.
  211.  
  212. At the DOS command prompt, while in the BRKFREE directory, type:
  213.     GEDIT MAZE01.GRD
  214.     or
  215.     GEDIT HYDROGEN
  216.     or
  217.     GEDIT 1
  218.  
  219. GEDIT will start, and the HYDROGEN level will be displayed.
  220.  
  221. 2) Select a wall to place.
  222.  
  223. KEYS: Press TAB to get to the wall palette, then use the arrow keys and
  224. page up/page down to choose a wall.
  225. MOUSE: Use the scroll buttons in the wall palette to see different walls,
  226. then choose a wall with the mouse.
  227.  
  228. 3) Place the wall on the grid.
  229.  
  230. KEYS: Press TAB to get back to the edit area.  Use the arrow keys to 
  231. move the cursor to the grid position where you want to place the wall. 
  232. Press the spacebar to put the selected wall in that position.
  233. MOUSE: Use the scroll buttons (if any) to scroll the grid to the area
  234. you need.  Select a grid position with the mouse.
  235.  
  236. 4) Save grid.
  237.  
  238. KEYS: Press S to save the grid as the current name.
  239. MOUSE: Choose the SAVE button to save the grid as the current name.
  240.  
  241. 5) Exit GEDIT.
  242.  
  243. KEYS: Press X to Exit GEDIT.
  244. MOUSE: Choose the EXIT button.
  245.  
  246.  
  247. Very Important Guidelines:
  248. ==========================
  249.  
  250. - In order for the game to run within 540000 bytes, the memory needed
  251. by a grid shouldn't go above 110000 bytes. Watch the MEM: indicator in
  252. the lower left corner of the display.  The amount of memory needed is
  253. different for different types of walls because of the amount of
  254. animation cells required to display the walls.
  255.  
  256. - You can choose your own ceiling and floor colors for interesting
  257. effects.  Press F to select new floor and ceiling colors.
  258.  
  259. - Make sure that every level you design has an outside edge that is
  260. solid.  This means a level should be completely surrounded by walls
  261. that cannot be destroyed (either impregnable or bad).  If this is not
  262. the case, then the ball can get loose and the program may have
  263. problems.
  264.  
  265. - The player starting position should be in an open space in the grid,
  266. as displayed in GEDIT.  The usual starting position is in the lower right
  267. corner of the grid.  Do not fill that section of the level with walls,
  268. unless you change the player starting position (origin).  Also, make
  269. sure the player can get to the rest of the grid from this starting position.
  270.  
  271.