@database Yahzee.guide
@author "Lorens Younes"
@(c) "Copyright © 1994 Lorens Younes"
@$VER: Yahzee.guide 1.3 (23.6.94)


@node Main "Yahzee Documentation"

@{b}Wellcome to Yahzee!@{ub}

This is an implementation of the famous dice game with a slightly different
name. I hope you will enjoy it!

   @{"Copyright Notice    " link Copyright}
   @{"Acknowledgements    " link Acknowledgements}
   @{"System Requirements " link Requirements}
   @{"Installation        " link Installation}
   @{"The Menu            " link Menu}
   @{"The Gadgets         " link Gadgets}
   @{"Tooltypes           " link Tooltypes}
   @{"Rules               " link Rules}
   @{"Version History     " link History}
   @{"Plans for the Future" link Future}
   @{"Troubleshooting     " link Troubleshooting}
   @{"Bug Reports         " link Bugs}
   @{"Localization        " link Localization}

@endnode

@node Copyright "Copyright Noice"

@{b}Copyright Notice@{ub}

Yahzee, Yahzee.info, Yahzee.guide and the Swedish catalog
Copyright © 1994 Lorens Younes.

Danish catalog by Kenneth Fribert.
Dutch catalog by Edmund Vermeulen.
French catalog by Monteilhet Florent.
Norwegian catalog by Rolf Grønland.

Yahzee.guide.info by Martin Huttenloher (from his wonderful MagicWB-package).

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:
   Yahzee                             - Executable file
   Yahzee.info                        - Icon for Yahzee
   Yahzee.guide                       - Documentation
   Yahzee.guide.info                  - Icon for Yahzee.guide
   Catalogs/dansk/yahzee.catalog      - Danish catalog for use with
                                        locale.library
   Catalogs/français/yahzee.catalog   - French catalog
   Catalogs/nederlands/yahzee.catalog - Dutch catalog
   Catalogs/norsk/yahzee.catalog      - Norwegian catalog
   Catalogs/svenska/yahzee.catalog    - Swedish catalog
   Catalogs/Instructions              - How to translate Yahzee
   Catalogs/yahzee.cd                 - Catalog description file
   Catalogs/template.ct               - Catalog traslation file
   misc/palette.ilbm                  - WB palette for 2.x
   misc/palette3.0                    - WB palette for 3.x

@endnode


@node Requirements "System Requirements"

@{b}System Requirements@{ub}

Yahzee will run on any Amiga computer with version 2.0 or higher of the OS (or
at least I hope it will). If you have version 2.1 or higher Yahzee will try to
use the language you have selected through Preferences.

@endnode


@node Installation "Installation"

@{b}Installation@{ub}

Copy Yahzee and Yahzee.guide to the place where you want to have the game. Copy
the catalogs you want to use either to sys:Catalogs or to a Catalog dir in the
same location as the executable file.
All icons are MagicWB style. If you don't have MagicWB installed and want the
icons to look nice you need at least an 8 color WB and you will have to load
the correct color palette into the palette Preferences. The palette can be
found in the misc dir (one for 2.x and one for 3.x).

@endnode


@node Menu "The Menu"

@{b}The Menu@{ub}

@{u}Game@{uu}
New            - Start a new game.
Undo           - Undo last choice.
High Scores... - Show the highest scores achived.
About...       - Show info about program (i.e. version number and author).
Quit Yahzee    - Quit the program (same effect as pressing the closegadget).

@{u}Settings@{uu}
Number of Players - Select number of players (won't have any effect until a new
                    game has been started).
Scoring Method    - Select scoring method (won't have any effect until a new
                    game has been started).
Save Settings     - Save the settings (uses @{"tooltypes" link Tooltypes}).

@endnode


@node gadgets "The Gadgets"

@{b}The Gadgets@{ub}

@{u}Roll Gadget@{uu}
Press this gadget to roll the selected dice.

@{u}Dice@{uu}
To select a die just click on it. When a die is selected it's image is a filled
rectangle, otherwise you can see it's eyes.

@endnode


@node Rules "Rules"

@{b}Rules@{ub}

Yahzee is played with five dice. The purpose with the game is to gather as many
points as possible. When it becomes your turn (your number will be highlighted
at the top) you may roll the dice three times. After each roll select the dice
you want to roll again. If you don't want to roll any dice don't select any of
them and press the @{"Roll Gadget" link Gadgets} once. When you have used all your rolls the
possible scores that your dice may give you will appear on the @{"scoreboard" link Scoring}.
Select the score you want to use by clicking on it. If you regret your choice
you may select Undo from the @{"Game Menu" link Menu}. The game will finish when the
scoreboard has been filled. If your score beats the High Score you will be
asked to enter your name.

@endnode


@node Scoring "Scoring Methods"

@{b}Scoring Methods@{ub}

@{u}Traditional@{uu}
Aces   - Every die that is an ace gives one point.
Twos   - Every die that is a two gives two points.
Threes - Every die that is a three gives three points.
Fours  - Every die that is a four gives four points.
Fives  - Every die that is a five gives five points.
Sixes  - Every die that is a six gives six points.
Bonus  - 50 points if your Upper Total is 63 or more.
1 Pair - If you have a single pair the sum of the dice involved will show up in
         this position.
2 Pairs - If you have two pairs the sum of the dice involved will show up in
          this position.
3 of a Kind - If you have three dice of the same kind the sum of those dice
              will show up here.
4 of a Kind - Same as above, but you need four dice of the same kind.
Sm Straight - 15 points if the dice are 1 through 5.
Lg Straight - 20 points if the dice are 2 through 6.
Full House  - If you have three of a kind and pair at the same time the sum of
              all dice will show up in ths position.
Chance      - Use this when no other position seems usefull. The sum of all
              dice will count here, no matter what the dice show.
YAHZEE      - Gives 50 points if all dice are of the same kind.

@{u}American@{uu}
Aces through sixes are the same as for Traditional.
Bonus is 35 points instead of 50.
There is no such thing as 1 Pair or 2 Pairs.
3 and 4 of a Kind includes the total of all the dice.
Sm Straight only needs four consecutive dice, and the score is always 30.
Lg Straight is five consecutive dice, and the score is 40.
Full House is worth 25 points always.
Chance and YAHZEE are the same as for Traditional.

@endnode


@node Tooltypes "Tooltypes"

The following tooltypes are recognized by Yahzee:

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).

PLAYERS=<number of players>
Use this to set the initial value of the number of players.

RULES=<Traditional | American>
Use this to set the initial scoring method.

@endnode


@node History "Version History"

@{b}Version History@{ub}

v1.0 (94-04-30) Initial version.
v1.1 (94-05-17) Yahzee will now try several different ways to layout the
                display. If you're using a very big default font, Yahzee will
                use topaz 8 for the text instead.
                Added Save Settings menuitem in the Settings menu.
                Cleaned up the menus and changed or removed some menu
                shortcuts.
v1.2 (94-05-22) Localized Yahzee.
v1.3 (94-06-23) Added American scoring method.
                Some minor bugs fixed.

@endnode


@node Future "Plans for the Future"

Write more catalogs (if you help me).
Add "online-help".
Make it possible to play "Triple-Yahzee".
Make the display more colorfull on AGA-machines.
Write installation script.

@endnode


@node Troubleshooting "Troubleshooting"

If you get the message "Screen is too small!" when you run Yahzee, you're
either using a too big screen font or you're trying to run Yahzee on a too
small public screen. Yahzee is guaranteed to open on a 640 x 200 screen with a
screen font of resonable size.
If you get a message about opening libraries make sure you've got at least
version 37 of the system libraries.
Any other messages is probably due to lack of memory. They're not likely
to show up.

@endnode


@node Acknowledgements "Acknowledgements"

@{b}Acknowledgements@{ub}

Many people have shared their feelings about Yahzee with me, but there are a
few who's ideas, comments and work have helped me a lot in improving this game.
These people include Monteilhet Florent (who wrote the French catalog), Rolf
Grønland (who wrote the Norwegian catalog), Kenneth Fribert (who wrote the
Danish catalog), Edmund Vermeulen (who wrote the Dutch catalog), Greg Roberts
and Rebecca Figuli (who gave me the idea of additional scoring methods and who
also ß-tested the game for me) and Kevin Huculak (who got frustrated at Yahzee
because it wouldn't open on an NTSC 640 x 200 screen).

I hope that you will always let me know your feelings about my products. It's
through such communication that the progress of Amiga PD software continues to
be accomplished.

@endnode


@node Bugs "Bug Reports"

@{b}Bug Reports@{ub}

If you discover any bugs please let me know. Also if you have any suggestions
for improvements or just want to tell me how great this program is, I would
appreciate to hear from you.

This is where you can reach me:
snail-mail: Lorens Younes
            Sandkullsv. 16
            S-163 57 Spånga
Internet:   d93-hyo@nada.kth.se


@{u}Known Bugs@{uu}
An enforcer hit has been reported when Save Settings is selected.

@endnode


@node Localization "Localization"

Yahzee is localized, so if you have v2.1 or higher of the OS Yahzee 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
Yahzee support your language too. Read Instructions in the Catalog directory
for more information.

@endnode