@database MultiPuzzle.guide
@author "Håkan L. Younes"
@(c) "Copyright (C) 1994-1998 Håkan L. Younes"
@$VER: MultiPuzzle.guide 1.2 (13.12.98)


@node Main "MultiPuzzle Documentation"

@{b}Wellcome to MultiPuzzle!@{ub}
   
MultiPuzzle is a little game that runs on the Workbench screen.
The purpose is to sort a number of bricks so that they form a picture.
The number of bricks and the picture used may be set by the user.

   @{"Copyright Notice     " link Copyright}
   @{"Acknowledgements     " link Acknowledgements}
   @{"System Requirements  " link Requirements}
   @{"Installation         " link Installation}
   @{"The Menu             " link Menu}
   @{"Tooltypes            " link Tooltypes}
   @{"The Game             " link Game}
   @{"Version History      " link History}
   @{"Plans for the Future " link Future}
   @{"Troubleshooting      " link Troubleshooting}
   @{"Contacting the Author" link Address}
   @{"Localization         " link Localization}
  
If you like MultiPuzzle you might want to take a look at my @{"Other Products" link Products}.

@endnode


@node Copyright "Copyright Notice"

Install, MultiPuzzle, MultiPuzzle.info, MultiPuzzle.guide and
the Swedish catalog
Copyright (C) 1994-1998 Håkan L. Younes.

This program may be freely distributed except for commercial purpose, so long
as the files included are not separated or modified.

If any of the following files are missing, please contact me:
   install                                - Installation script
   install.info                           - Icon for installation script
   multipuzzle                            - Executable file
   multipuzzle.info                       - Icon for MultiPuzzle
   multipuzzle.guide                      - Documentation
   multipuzzle.guide.info                 - Icon for MultiPuzzle.guide
   beach.ilbm                             - default picture
   catalogs/svenska/multipuzzle.catalog   - Swedish catalog
   catalogs/multipuzzle.cd                - Catalog description file
   catalogs/template.ct                   - Catalog translation file

@endnode


@node Requirements "System Requirements"

MultiPuzzle will run on any Amiga computer with version 3.0 or higher of the
OS (or at least I hope it will).

@endnode


@node Installation "Installation"

To install MultiPuzzle from scratch or to update an old version just run the
installation script.

@endnode


@node Menu "The Menu"

@{u}Game@{uu}
New                - Start a new game.
About...           - Show info about program (i.e. version number and author).
Quit MultiPuzzle   - Quit the program (same effect as pressing the
                     closegadget).

@{u}Settings@{uu}
Select Picture     - Select picture to use for puzzle.

@endnode


@node Tooltypes "Tooltypes"

The following tooltypes are recognized by MultiPuzzle:

PUBSCREEN=<name of public screen>
Use this to open the window on other public screens than the default one (if
there is no public screen with the given name, the program will try to open its
window on the default public screen).

PICTURE=<name of picture>
Set this to the name of the picture to be used.

ROWS=<number of rows>
Use this to set the number of rows wanted.

COLUMNS=<number of columns>
Use this to set the number of columns wanted.

(NOTE! The number of rows or columns set here will be corrected if they
are to big or small.)

@endnode


@node History "Version History"

v1.0 (10.4.94)  Initial version.
v1.1 (23.4.94)  Added the PUBSCREEN tooltype.
                Added possibility to load pictures from within the program.
v1.2 (13.12.98) Added support for locale.library.
                Source code made public!

@endnode


@node Future "Plans for the Future"

Make it possible to set the options now set by using tooltypes, from within
the program.
Make it runnable on pre V39 systems.
Write more catalogs (if you help me).
Add "online-help".

@endnode


@node Troubleshooting "Troubleshooting"

If you get a message about opening libraries make sure you've got at least
version 39 of the system libraries.
Any other messages are probably due to lack of memory. They're not likely to
show up.

@endnode


@node Acknowledgements "Acknowledgements"

I dedicate this program to my parents. It was during a vacation to Gran
Canaria with them that I figured out how to use custom pictures as motive
for the puzzles. Before this I could only use preprogrammed motives, or just
numbered bricks.

@endnode


@node Address "Contacting the Author"

Since the source code has been made public, you can fix bugs or make
improvements yourself. Of course, if you do so I still would like to know
about it.

This is where you can reach me:
snail-mail: Håkan L. Younes
            Sandkullsv. 16
            S-163 41 Spånga
            Sweden
Internet:   lorens@hem.passagen.se
            http://hem.passagen.se/lorens/

@endnode


@node Localization "Localization"

MultiPuzzle is localized, so if you have v2.1 or higher of the OS
MultiPuzzle will try to use the language you have set in Preferences. If
there is no catalog for your language, English will be used as default.

Since I'm not very good at languages I've only written one additional catalog
(the Swedish one). However I've included some files so that you easily can make
MultiPuzzle support your language too.

Translate the strings in template.ct and save it as <language>.ct. Then send
that file to me so that I can include it in my package.
NOTE! The first two characters in menuitems are used for menu shortcuts.
The first one is the shortcut (space means no shortcut) and the second is
always a nullbyte. Make sure you don't use the same character as shortcut
for different items in the same Menu!

@endnode


@node Products "Other Products"

Take a look at http://hem.passagen.se/lorens/amiga/ for a list of other Amiga
products made by me.

@endnode


@node Game "The Game"

When MultiPuzzle is run, it tries to load the selected picture (or a
default one if none has been selected). If this fails, a file requester
will open where a picture can be selected. When the picture is loaded a
window will open on the Workbench screen where the picture is diplayed.

To start a new game choose New from the Game menu. The bricks are now
shuffled (it may take some time if there are lots of bricks). When the
bricks have been shuffled it's time to start sorting them.

The bricks are moved by clicking on them with the left mousebutton or by
using the arrow keys. Only neighbors to the empty position may be moved.
It's possible to move a whole row or column with a single mouse click.

Since it some times is hard to see any difference between two bricks it's
possible to display their numbers. This is done by pressing 'n'. If the
mouse has three buttons, pressing the button in the middle also displays
the numbers. The numbers are hidden when a brick is moved or by pressing
'n' again (or the middle mousebutton).

To quit the program choose Quit from the Game menu or just close the
window.

The picture can also be set from within the program by selecting
Load Picture in the Settings menu. This brings up a file requester from
where a new picture can be chosen.

@endnode