Copyright (c) 2022 Tim Chadburn.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file "fdl.txt" which is part of this
package.

Here are instructions for using False Hamster Data Editor to administrate a
gaming tournament. The type of tournament supported is the league-like one,
where players score points in each game and those points are added up to make
a player's total score, which determines a player's position in the
tournament.

1. This document assumes that False Hamster Data Editor has been correctly
installed. See the INSTALL file for details of how to do this.

2. Start False Hamster Data Editor. It can be started from your main
application menu, and is likely to be in the "other" section or wherever your
system puts applications which don't fit into any other category. If you want
to start it from a terminal the command is `data-editor'.

3. Available functionality in False Hamster is split up into units called tasks.
Each task has its own file. In order for us to use a task, it must be open.
To open the `tournaments' task which will allow us to administrate
tournaments, click on `Open File' in the Actions column.

4. A box should pop up entitled `Open File'. Within this box, click on the box
which is to the right of the word `File' and underneath the title `Open File'
(it should currently say `(None)').

5. A much bigger box should pop up; on its right-hand side is a list of files.
In this list, click on the file `Tournaments-tournament.fhd', then click
`Open' in the bottom right hand corner.

6. The box which previously said `None' should now say `Tournaments-tournam...'.
Click on the `OK' button in the `Open File' box.

7. Many new buttons should appear in the `Information' column, and one new
button in the `Actions' column. These allow us to edit the types of data which
we need to edit in order to administrate a tournament. The `Create Matches'
action decides which players will play each other in a specific round of the
tournament.

8. We can now use the `Create Object' action to create our tournament. Click on
`Create Object'. A box entitled `Create Object' will pop up.

9. In this box, type in a name for your tournament (it can be anything).

10. Click on the box to the right of the word `Type' and underneath the name
you have just typed in. A menu should appear; click on the word `Tournie'.

11. Click `OK'.

12. At this point it's possible to configure our tournament. The normal,
minimum and maximum number of players per match will vary depending on what
game is being played. For the purposes of this tutorial they can happily be
left at the default setting which assumes all games are 2-player. The number
of rounds is something which you would want to change unless you happen to be
having the default which is 4. To change it, click on `Number of Rounds' in the
Information column; a `Number of Rounds' box will pop up. In this box, click on
the box to the right of our tournie's name in the `NUMBER OF ROUNDS' column,
delete the 4 and change it to the number you want (like 5 or 3). Close the
`Number of Rounds' box using your system's window closing button (most systems
have an X in the top corner of the window or something like it).

13. Now we need to create the players which will participate in our tournament.
These are created using the `Create Object' action. If we have players already
in our False Hamster system from previous tournaments, we don't need to create
new players; we simply add the existing ones to the tournament. To create a
player, click `Create Object', type in the player's name in the Create Object
box, then click on the box next to `Type' and click on `Player' in the menu
which pops up. Then click `OK'.

14. Repeat this action for all players who are going to participate in the
tournament.

15. We now need to add the new players to our tournament. Click on `Players
Attending' in the Information column. A box will pop up. It has two columns:
`TOURNAMENT' and `ATTENDERS'. If this is your first tournament, or the only
tournament currently open, the only tournament in the `TOURNAMENT' column will
be your tournament which you have just created. Each tournament will have a
small circle to the left of it and one of these circles will have a black dot
in it; this indicates that the tournament next to it is selected. We need to
make sure the tournament we are working with is selected; do this by clicking
the circle next to it. But as we probably only have one tournament at this
stage, it's probably already selected.

16. The `ATTENDERS' column lists the players attending the currently selected
tournament. It is currently empty. To add a player to our tournament, click
the `Add' button in the `ATTENDERS' column. A box will pop up with two things
in it: the `OK' button and a box above it with an up arrow and a down arrow at
the right hand side. Click the box with the arrows in. A list of players will
pop up: click the player you want to add, then click `OK'.

17. Notice that the player you just added is now in the `ATTENDERS' column.
Repeat the previous step for each player you want to add to the tournament.
Once you've added all the players you want, click the X in the top corner of
the window or whatever equivalent your system has to close the `Players
Attending' window.

18. It's time to decide who plays who in the first round of our tournament.  To
do this, click `Create Matches' in the Actions column. In the `Create Matches'
box which comes up, click on the box to the right of the word "Tournament", then
click the name of your tournament in the menu which comes up (which will
probably only contain your tournament and nothing else at this stage). Click in
the box to the right of the word `Round' and type the digit 1. Then click `OK'.

19. To see what matches have been decided, click on `Matches' in the information
column. A `Matches' window will pop up. As with the `Players Attending' window,
we need to make sure the right circle is selected. On each row of the table is
a tournament and a round. Make sure the selected circle is on the row
containing your tournament and round 1. The Matches column should show the
matches that have been created: each line in the Matches column displays the
players in one match. Inform your players, if you're doing this at a real
tournament, of who is playing who.

20. Once your players have finished their matches, find out how many points each
player scored in that game. Click on `Game Scores' in the Information column.
This will open a window into which we can input the players' scores. However,
the window is rather big at the moment and may not fit on the screen because it
contains spaces for the players' scores in every round, not just the first.
There is a way to make it display only spaces for round 1: Click on the box at
the top of the `ROUND' column which says `All'. Then click on `1' in the menu
which pops up. This will shrink the window to one space for each player, each of
which will accept the score that player got in round 1. To input a score, find
the player whose score you're inputting in the `PLAYER' column, click the white
box in the `SCORE' column in the same row as the player, then type in the score
in digits, such as 24. It is a significant flaw in False Hamster's tournament
software that only one score per player is allowed because most tournaments have
at least two scores: a main score and a tie-break score. If you aren't running
a real tournament feel free to make up the scores.

21. Repeat steps 18-20 for each round of the tournament, substituting the
current round for 1 in those instructions. To see how players are doing in the
tournament, you can click on `Total Scores' in the Information column. As for
the various information windows you open, it's up to you whether you leave them
open and re-use them or whether you close them and create new ones when needed.

22. Once all rounds have been played, check the Total Scores window to find out
who wins!

23. You needn't worry about saving your tournament: False Hamster automatically
saves it when you close the main window (entitled `False Hamster Data Editor'
and containing the Information and Actions columns). It is saved in the
directory .falsehamster in your home directory. The filename will include the
name of your tournament, plus an identification number. Unless you close your
tournament, it will be automatically opened again next time you start False
Hamster Data Editor.