MODDING MUMMY'S PLAYTIME
========================

Everything the game shows or plays comes from the "data" folder: pictures,
sprites, voices, music, the font, the mouse pointer, all on-screen text,
colours, the Bangman word list and a few positions and settings. Change
the files, and the game uses them. No tools or rebuilding needed.

Tip: keep a copy of the original data folder before you start.

When are changes picked up?
  Each game reads its folder every time it starts, so just go back to the
  menu and pick the game again. The intro is read when the program starts,
  the title menu every time you return to it, and font.png / pointer.png
  when the program starts.

If a required file is missing or broken, the game tells you which one.
A missing sound is simply silent.


FOLDER LAYOUT
-------------
data/
  font.png          the text font
  pointer.png       the mouse pointer
  intro/            the theatre stage with the credits and the music
  title/            the game menu
  bangman/          Bangman
  gotroll/          Go Troll
  chase/            Chase The Troll
  choochoo/         Choo Choo Shoe Shoot

Every game folder has:
  game.txt          text, colours, sounds and settings (read the comments in it)
  *.png             the background picture(s)
  sprites/01.png..  the moving / pasted pictures (AMOS "bobs")
  sounds/*.wav      the voices and sound effects


GAME.TXT
--------
A plain text file (UTF-8) with sections:

  [text]      everything written on screen
  [colors]    text colours as #RRGGBB
  [sounds]    which WAV file plays for each sound number
  [settings]  positions and other numbers
  [buttons]   (title only) the clickable menu areas

Lines starting with # are comments. Put a value in "double quotes" to
keep spaces at its start or end (the credits use this to line up).
{troll}, {n} and {score} are filled in by the game, e.g.
  give_me = Please give me your {troll}

The screen is 40 characters wide and 25 lines high (8x8 pixels each).
Longer lines are cut off at the right edge. Letters from the Latin-1
range work (a, o and u with dots, e with accents, etc.) because the
font has them.

Mummy's mouth moves for a time based on the length of the text, just
like the original (3-5 frames per character), so a much longer line
makes her talk longer.


PICTURES
--------
Any PNG works: indexed, RGB, with or without transparency, any colours.
Backgrounds should be 320x200 (bigger ones are cropped, smaller ones get
black borders). If you move things around in a background, update the
matching positions in game.txt.

Sprites need transparent areas to be really transparent (alpha), e.g.
save as PNG with transparency. Keep the numbering: the game refers to
sprites by number. Sizes can change. Sprites are drawn from their top
left corner.

  title:    1-4 mummy's mouth talking, 5 her mouth for "Choo Choo"
  bangman:  1-4 mouth, 5 troll at the plunger, 6-9 troll pushing it,
            10 stick of dynamite, 11 explosion, 12 the man's scared face
            board.png is the normal screen; board_blown_up.png holds the
            greyed-out letter buttons and the blown-up man, which are
            copied over board.png during the game.
  gotroll:  1-13 the troll cards, 14-17 mouth, 18 the deck, 19 card back,
            20-23 the little "1"-"4" counters on your cards
  chase:    1-12 the troll cards, 14-17 mouth, 18 card back
  choochoo: 1-4 mouth, 5 mouth for "Shoes!", 6-8 and 9-11 the two pairs
            of shoes, 12 crosshair, 13 bang, 14-16 cowboy, 17-19
            terminator, 20-23 policeman, 24-26 gangster (don't shoot him)
            The bad guys shoot on their middle-ish frame (15, 18, 23).


SOUNDS AND MUSIC
----------------
WAV files, uncompressed PCM: 8 or 16-bit (24/32-bit also read), mono or
stereo, any sample rate. The originals are 8-bit mono at 11025 Hz. The
file names say what each one is; the [sounds] list in game.txt decides
which file goes with which sound number, so you can rename files or
point several numbers at the same file.

The intro music (intro/music.mod) can be any 4-channel ProTracker
module ("M.K."). Change the file name under [settings] in intro/game.txt.


FONT AND POINTER
----------------
font.png is 128x128 pixels: 16 x 16 characters of 8x8, in Latin-1 order
(character 65 "A" is row 4, column 1, counting from 0). White, opaque
pixels are drawn; everything else is background.

pointer.png is the mouse pointer. Its tip is the top left pixel.


BANGMAN WORDS AND LETTERS
-------------------------
bangman/words.txt: one word per line. Only A-Z can be guessed (the
letter board has 26 buttons), so words with other characters are
skipped. Lower case is fine. Up to 30 letters.

bangman/letters.txt: where each letter button is on the board, as
left, top, right, bottom.


SETTINGS WORTH KNOWING
----------------------
choochoo  speed   how fast the bad guys and shoes appear and go
                  (40 is about Amiga speed; 25 is gentler for small children)
choochoo  lives   hits before the game is over (10)
chase     win_score  rounds needed to win (5)
title     [buttons]  clickable areas of the menu picture


MAKING A TRANSLATION
--------------------
1. Translate the [text] section of each game.txt (and the troll names).
2. Re-record the voices as WAV files over the ones in each sounds folder
   (or add new files and point [sounds] at them).
3. Some words are painted into the pictures: the menu buttons in
   title/menu.png, "Choo Choo Shoe Shoot" on the train, the title on the
   intro stage, and the letter board in Bangman. Repaint them if needed.
   Bangman still uses A-Z for guessing.
