INTRODUCTION

This is the editor used for Solid Gold.

map8edit is an editor for 8-way scrolling background- and foreground tile
maps, which consist of 16x16 pixel tiles in 32 colors.

There may be up to 127 monster positions defined, out of 9 different monster
types and an initial orientation (left/right).

Of course, the foreground map and the monsters can be ignored, when the
game doesn't need them.

The program is called map8edit, because each tile in the map is represented
by a byte, which allows a maximum of 256 different background- and 256
different foreground tiles.

The first tile should be empty. Foreground tiles with code 0 are never
drawn.

Keep in mind that foreground tiles are expensive to display. Keep them
to a minimum! On the other hand, their animation comes for free.

The maximum map dimensions are 256 rows by 256 columns, which means the
resulting playfield would be 4096x4096 pixels large. These dimensions can
easily be increased by recompiling the source.


HARDWARE REQUIREMENTS

The editor should work on any Amiga with at least 1 MB RAM.
A joystick in the secondary port is used as an input device.


SOFTWARE REQUIREMENTS

Works on all AmigaOS versions since Kickstart 1.2.
Has to be started from the shell.


USAGE

You need a background- and a foreground graphics file, in a format
suitable for map8edit (see below).

You can work on an existing map file or create a new one, when the name
doesn't exist yet, by typing in the shell:

  map8edit <mapfile> <backgroundgfx-file> <foregroundgfx-file>


EDITOR DISPLAY

The editor is split into two regions. The main region of 320x240 pixels
shows the currently visible part of the map. Foreground tile animations
are displayed in realtime and monster locations appear as digits from '1'
to '9' with an arrow below them indicating their orientation.

Below is a status bar showing the following information from left to right:

- Code of the currently selected tile (0-255).
- 9 tile images, where the middle tile is the currently selected one.
- Current map column.
- Current map row.
- Number of monsters placed into the map.


EDITOR CONTROL

The cursor can be moved by the joystick in the secondary port. Pressing the
button will draw the currently selected tile into the map.

ESC: Quit the editor without saving the map.

F1: Select background tiles. The status display shows a sequence of background
tiles. Pressing the button will set a background tile.

F2: Select foreground tiles. The status display shows a sequence of foreground
tiles. Pressing the button will set a foreground tile. Typing F2 again
will flash all foreground tiles and monsters to make it easier to find them.

F5: Define the upper-left corner of an area to select.

F6: Define the lower-right corner of an area to select.

F7: Copy the selected area to the cursor position. Background and foreground
tiles are both copied.

F8: Fill the selected area with the current background tile.

F10: Quit the editor and save the map under the initially given name.

Cursor-Left: Select previous tile.

Cursor-Right: Select next tile.

Cursor-Up: Select 20 tiles before (one row in a 320 pixel wide picture).

Cursor-Down: Select 20 tiles later.

Space: Select tile 0.

1 - 9: Set a left-oriented monster of this type.

Shift1 - Shift9: Set a right-oriented monster of this type.

0: Delete monster.


MAP FILE FORMAT

$0000: "MAP8"
$0004: MapWidth.w
$0006: MapHeight.w
$0008: background map (MapWidth * MapHeight bytes)
       foreground map (MapWidth * MapHeight bytes)
       Up to 127 monster records. Until end of file.

A Monster Record has 8 bytes. Mcol/Mrow refer to tile coordinates, not pixel:
$0000: monster type (1-9)
$0002: monster orientation (-1 for left, 1 for right)
$0004: initial monster map column
$0006: initial monster map row


BACKGROUND GFX FILE FORMAT

$0000: color table with 32 RGB4 colors
$0040: block types (0=empty, 1=unmasked, 2=masked)
$0140: raw 5-planes interleaved 16x16 block images, empty blocks missing

Type 0 images are omitted and replaced automatically be the image of the
first tile.
Type 2 images do not occur in the background.


FOREGROUND GFX FILE FORMAT

$0000: number of animation phases
$0100: animation speed in frames
$0200: block types (0=empty, 1=unmasked, 2=masked)
$0300: 5-planes interlv. 16x16 block images with mask, empty blocks missing

Type 0 images are omitted and replaced automatically be the image of the
first tile.
Type 1 images do not occur in the foreground. All images are masked, which
means their size is doubled (each plane is masked in interleaved mode).


BUGS

The result of the copy- and fill functions cannot be seen immediately on the
screen. You have to "refresh" this area manually, by scrolling away and then
back into it.

Some graphics corruptions in the display, especially when scrolling
diagonally.


AUTHOR

Frank Wille <frank@phoenix.owl.de>

PERMISSION  UID  GID    PACKED    SIZE  RATIO METHOD CRC     STAMP     NAME
---------- ----------- ------- ------- ------ ---------- ------------ ----------
drwxr-xr-x  1000/0           0       0 ****** -lhd- 0000              Map8Editor/
-rw-r--r--  1000/0        2111    4891  43.2% -lh5- b0f9              Map8Editor/README
-rwxr-xr-x  1000/0        5314   13524  39.3% -lh5- be69              Map8Editor/map8edit
drwxr-xr-x  1000/0           0       0 ****** -lhd- 0000              Map8Editor/src/
-rw-r--r--  1000/0         476    1083  44.0% -lh5- b446              Map8Editor/src/Makefile
-rw-r--r--  1000/0         478    1078  44.3% -lh5- c363              Map8Editor/src/Makefile.unix
-rw-r--r--  1000/0         151     344  43.9% -lh5- 0151              Map8Editor/src/cia.i
-rw-r--r--  1000/0        1261    4455  28.3% -lh5- c8d6              Map8Editor/src/custom.i
-rw-r--r--  1000/0        2714   10389  26.1% -lh5- cbfb              Map8Editor/src/display.asm
-rw-r--r--  1000/0         544    1145  47.5% -lh5- b94d              Map8Editor/src/display.i
-rw-r--r--  1000/0         134     174  77.0% -lh5- 7b97              Map8Editor/src/end.asm
drwxr-xr-x  1000/0           0       0 ****** -lhd- 0000              Map8Editor/src/gfx/
-rw-r--r--  1000/0        2208    6502  34.0% -lh5- bba4              Map8Editor/src/gfx/bmptoraw.c
-rw-r--r--  1000/0         414    4790   8.6% -lh5- 2071              Map8Editor/src/gfx/numbers.bmp
-rw-r--r--  1000/0         625    1690  37.0% -lh5- 1e1c              Map8Editor/src/init.asm
-rw-r--r--  1000/0         974    2113  46.1% -lh5- 642a              Map8Editor/src/input.asm
-rw-r--r--  1000/0        1113    5035  22.1% -lh5- e90c              Map8Editor/src/interrupt.asm
-rw-r--r--  1000/0         100     156  64.1% -lh5- 13b7              Map8Editor/src/interrupt.i
-rw-r--r--  1000/0         277     461  60.1% -lh5- 01fa              Map8Editor/src/macros.i
-rw-r--r--  1000/0       14066   50297  28.0% -lh5- 8bb7              Map8Editor/src/main.asm
-rw-r--r--  1000/0         610    1202  50.7% -lh5- e94f              Map8Editor/src/main.i
-rw-r--r--  1000/0         114     155  73.5% -lh5- 684b              Map8Editor/src/map.i
-rw-r--r--  1000/0        1706    4939  34.5% -lh5- fbbf              Map8Editor/src/os.asm
-rw-r--r--  1000/0        1467    3797  38.6% -lh5- e555              Map8Editor/src/startup.asm
-rw-r--r--  1000/0         353     752  46.9% -lh5- 38c9              Map8Editor/src/view.i
---------- ----------- ------- ------- ------ ---------- ------------ ----------
 Total        25 files   37210  118972  31.3%            Jan 22 21:43