This manual describes version 0.2 of Quarry.
Copyright © 2004, 2005, 2006 Paul Pogonyshev
Permission is granted to copy, distribute and/or modify this document under the terms
of the GNU Free Documentation License, Version 1.2 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 section entitled
“GNU Free Documentation License” or in the file
COPYING-DOCS distributed with this manual.
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT:
DOCUMENT IS PROVIDED ON AN “AS IS” BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND
UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.
Feedback
To report a bug or make a suggestion regarding the Quarry application or this
manual, either send a message to <quarry-dev@gna.org> or use
Quarry bug tracker.
| Revision History | |
|---|---|
| Revision Quarry Manual V0.2 | November 2006 |
Table of Contents
List of Figures
List of Tables
The Quarry application allows you to play the board games of Go, Amazons and Reversi. You can play with computer programs or with another human, and save, view and edit game records.
Quarry provides the following features:
Support for Go, Amazons and Reversi games.
Nice resizable board.
Playing games:
Game records:
All games can be stored in widely supported SGF FF[4] file format.
Fast and robust parser can read SGF files of any version.
In particular, Kogo’s Joseki Dictionary can be browsed with Quarry.
Game Tree View allows for easy navigation of game records.
Text search in comments is a powerful tool if you know what to search for.
Go board position can be exported in a format suitable for inserting into Sensei’s Library.
Support for various SGF labels and markup.
Note
Quarry itself can play neither Go, nor Amazons, nor Reversi. To have a computer opponent, you need to find a program (e.g. GNU Go mentioned above) that supports GTP and register it in Quarry.
Note
Quarry does not have any support for Internet game servers and it will not be added before versions 0.3.x.
Table of Contents
You can start Quarry from your Applications menu, it should typically be available under → . However, this may depend on the exact way you installed the program and your operating system.
Quarry can also be started from the command line. Simply type quarry in and press Return.
You can also have Quarry open one or more game records immediatly after you start it. Just type
quarry file1.sgf file2.sgf ...
in the command line and press Return. Quarry will start with specified file(s) open.
Note
Filenames don’t have to end in .sgf, but names of SGF files
typically do have this suffix.
When you start Quarry, Control Center window is displayed:
The Control Center window consists of the following elements:
- button
This button allows you to start a new game. It will pop up the New Game dialog where you can select the game (Go, Amazons or Reversi), opponents and game-specific rules.
- button
Clicking this buttons allows you to create a game record without actually playing a game. New Game Record dialog will be shown, asking you for basic game record parameters.
- button
This button allows you to select a game record for viewing and/or editing. You will need to pick the file with the game record in the standard Open File dialog.
- button
Click this button to resume a game you adjourned earlier. Actually, you can resume about any unfinished game, even one you started in a different client. A standart Open File dialog will be popped up for you to select the file containing the game record you wish to resume.
- button
This button opens the Quarry Preferences dialog.
- button
Closes all windows and quits the program. However, if there are unsaved changes in any of the open game records, you will be asked what to do with them first.
Table of Contents
To start a new game, click the button in the Quarry Control Center window or choose → menu item in any of the already open Board Windows. The New Game dialog will appear, where you can choose the kind of game you want and the opponents.
If you want to play against a computer program, you need to register it in Quarry first (once only, of course.) To do this, click the button in the dialog.
For more information, see the detailed description of New Game dialog.
You can open a game record in one of three ways:
Click the button in the Control Center window. Quarry will display the Open SGF File dialog. Select the file with the game record you want to open and click the .
Choose → menu item or simply press Ctrl+O in any opened Board window. Similarly to the previous case, Quarry will display the Open SGF File dialog.
When starting Quarry from the command line, specify the name of file (or several names at once):
quarry
file1.sgf file2.sgf ...The specified file(s) will be opened automatically.
To save a game record, choose → menu item in its Board window (or simply press Ctrl+S.) If the game record does not yet have a filename, Quarry will display the Save As dialog. Enter the name for the file, then click the .
If you want to save a game record under a different filename, choose → menu item. Enter a name for the file in the Save As dialog and click .
To register a game-playing program in Quarry, first open the Preferences dialog and select GTP Engines category in its left pane. (You can also click the button in the New Game dialog, which immediatly displays the GTP Engines category.)
Then click the button and, in the appeared dialog, enter the command line required to launch the program in GTP mode. You should consult the program’s manual to find out how the command line should look like. For instance, command line for GNU Go should be like this (note the double hyphens):
gnugo --mode gtp --quiet
Other programs may require different options or no options at all.
To adjourn a game, choose → menu item. If the game has never been saved yet, you will need to enter the name of the file you would like to store it in.
Actually, adjourning differs from saving only in that it closes the game’s window.
To resume a previously adjourned game, click button in the Quarry Control Center window or select item from the menu. You will be prompted for the file that contains the game record.
When you select the file, Resuming Game Dialog pops up, where you should specify the players. Quarry will try to guess the opponents based on the data stored in the game record, but it can make a mistake in determining whether there are any computer players and which engines should play. You will always have the final say, though, and will be able to correct any mistakes.
If the game you select is already finished, you will be prompted to open it for viewing and/or editing instead of resuming.
Table of Contents
The New Game dialog consists of two pages, Game & Players and Game Rules. When you open the dialog, the first page appears. When you click button, the second page is displayed, which is specific for each of three games—Go, Amazons and Reversi.
On this page you can select one of three available games and the opponents. You can make selections in arbitrary order—first choose the game and then the opponents or the other way round. At any time, all playable combinations of games and computer players are marked with “Yes” icons, while all unplayable combinations are marked with “No” icons. The button is sensitive only when a playable combination of game and opponents is selected.
Note
Before playing against a computer program (e.g. GNU Go, you need to register it in Quarry. See GTP Engines section for how to do this.
Game & Players page conists of the following controls:
- Game section
Here you can select the game you want to play, either Go, Amazons or Reversi (also known as Othello). Note that most programs can play only one game.
- White Player and Black Player sections
This set of controls determines the opponents. Each opponent can be either a human or a computer program. For a human player you can specify her name (defaults to your name as reported by the system.) Computer opponent should be selected from the drop-down list. If the list does not contain the program you want to play against, click the at the end of the dialog to register the program in Quarry.
Which player is to move first depends on the game. In Go and Reversi black moves first, while in Amazons white has the first turn. You can always change sides with the button to the right.
- button
This button allows you to easily swap players’ sides. It does nothing else but copying settings from White Player section to Black Player section and vice versa.
- button
This button opens Quarry Preferences dialog at the GTP Engines page. A convenient way to register new program and/or modify parameters of the already registered ones just before starting a new game.
- button
When you are done with this page, click the button to tweak game specific rules on the next page.
On this page you can select the rules for the game. The page has two parts. The upper part is different for each of Go, Amazons and Reversi games and contains game-specific rules. The lower part contains time limit settings controls and is the same for all three games. It is described last.
When you have selected the rules you want, click the button to start the game.
Go has many different rule sets that differ in scoring details, treating of some special positions etc. Currently, Quarry doesn’t make any difference between them. However, existing rule controls should be enough in most cases.
- Board Size spin button
Choose the size of board for the game here. Go is traditionally played on a 19×19 board. 9×9 and 13×13 boards are also common. Quarry doesn’t limit you to these—choose any size between 5×5 and 25×25 inclusive.
- Traditional board size buttons
These buttons allows you to quickly select one of three “traditional” Go board sizes—either 9×9, 13×13 or 19×19.
- Handicap controls
When one of the players is weaker, it is common practice in Go to give him handicap stones. This gives her better chances to win and makes the game more challenging (and thus more interesting) for the stronger player. The weaker player is traditionally playing as black.
Quarry supports both fixed (also known as Japanese) and free (Chinese) handicaps. In the first case, handicap stones are placed following a traditional pattern, at hoshi points. Maximal fixed handicap is 9 stones. With free handicap, on the other hand, black player actively places the handicap stones at any intersections on the board. Free handicap is practically not limited.
Note
Quarry treats free handicap as non-obligatory: it allows black to place fewer handicap stones than specified in game rules (but not less than two.)
If you want an “even” game, simply set the handicap to zero.
- Komi spin button
Komi is the compensation to the white player for playing second. It is usually non-integer to make draws impossible. The currently suggested komi for “even” game on 19×19 board is 6.5 points. Smaller (or even negative) komi gives some advantage to black player and can be used in addition to or instead of handicap.
See also time limit settings description.
At present, Amazons rules in Quarry are limited to board size and common time limit settings. Standard board size for Amazons is 10×10 (which is also selectable with the small button to the right), but you can choose anything from 5×5 to 25×25 inclusive.
Reversi rules in Quarry are limited to board size and time limit settings described just below this section. Standard board size for Reversi is 8×8, though 10×10 boards are not uncommon either. This is reflected by the choice of “traditional” board sizes with the buttons to the right. However, in Quarry you can select any even board size from 6×6 to 24×24 inclusive.
Quarry allows to play games with limited time for both players. This also applies to computer program players—they have to honor the alloted time or lose. Of course the programs are properly notified about the time limit settings and the remaining time.
Note
Computer opponents use CPU time to generate moves. This means that they usually need less time on faster machines and more on slower machines. Also, if you run a computationally intensive task while playing, your computer opponents may become slower. Finally, certain computer programs may also “think” on opponent’s time.
Quarry has four types of time control:
- No limit
Both opponents can take as much time as they like on each move, there are no limits. In this mode you can select the Keep track of total time option. Then Quarry will display the total time spent on move pondering by each player. This is purely for your information and serves no other purpose.
- Limited time for entire game
Each player has limited time to play the whole game. If a player fails to finish the game in the alloted time, she loses. Note that time limit doesn’t depend on the number of moves in the game.
- Limited time per move
Each move has to be played in fixed time. Time not used is not stored and not added to available time on next moves. When using this mode, keep in mind that in most games there are “difficult” positions that require more pondering time.
- Canadian overtime (also known as Canadian byo-yomi)
This time control is often used in Go, but has nothing Go-specific, so it can be used in any other move-based game. Canadian overtime has the advantage of imposing certain speed of play, but, at the same time, allowing to occasionally spend more time on important moves.
Canadian overtime has three parameters: main time, overtime period length and moves per overtime. Both players begin game in their main time. During main time they can play any number of moves at any speed. When main time for a player is up, first overtime period begins. During each overtime period a player has to play the specified number of moves (moves per overtime.) If she fails to do so, she loses on time. Otherwise, next overtime (of the very same length) begins and the player has to play the same number of moves this before the time is up again. The number of overtimes is unlimited and they are completely equal to each other: time not used in one overtime period is not stored and not added to other overtime periods.
The New Game Record dialog allows you to start a new game record without actually playing a game. When you are done entering game record information, press the button. Or press the button to cancel game record creation.
The dialog consists of the following controls besides the mentioned buttons:
- Game selectors
Here you choose the game you want to create a record of—Go, Amazons or Reversi. All the games supported by Quarry are listed.
- Rules section
This section contains various controls for basic game rules. They are described in more details in the New Game dialog section.
One important change is the check button to the right of handicap spin button. It determines whether Quarry should place the handicap stones for you, or not. Stones are placed as if the handicap is fixed, but you can always change stones setup later if needed.
- Short Game Information
Here you can enter the names of white and black player and the name of the game. You can change or expand this information later, using the Game Information dialog .
The Resuming Game Dialog allows you to specify or correct game players when resuming a game. It also shows some information about the game, most of which is not editable.
You can specify both game players and fix their names, if needed. There are two radio buttons and a combo box for each player. Radio buttons control whether a player is a human or a computer (some GTP engine.) If you select to let computer control a player, you can choose any available GTP engine from the list for it.
Quarry tries to guess players based on their names, as stored in the game record. Normally, if the game was adjourned in Quarry and you don’t alter computer player names, it should guess correctly. However, you can always override and correct its decision.
Board windows are the main part of Quarry. They are used to play games and view and edit game records. To the left in a window is the game board itself. The exact appearance of the board depends on the current game (Go, Amazons or Reversi) and can be configured. On the right side of the window there is information pane, including the comment window. There can also be the game tree view to the bottom of the right pane.
Board displays current game position, including pieces, markup, labels and variations of the current node. Coordinate labels are shown on the edges of the board. They depend on the current game. In the top-left corner a small rectangle is drawn if the board has focus.
The last move made is marked. Depending on the markup theme, this can be a cross or a bullet. On the screen shot above, last placed stone at P15 is marked with a cross.
Note
This section can be improved.
Quarry treats variations as siblings of the current node. This is like Jago does and unlike CGoban. You always see the current variation and it is not a potential for the next node/move.
On the board, non-current variations that contain a move are shown as small ghostly pieces. Variations that don’t contain a move or contain a pass move (in Go) can be seen only in the Game Tree View. Screen shot above shows two variations—at Q18 and Q19—of the white move on the board.
You can activate (switch to) a particular variation by right-clicking on the ghost stone on the board. For instance, right-clicking on Q18 in the window shown in the screen shot would make White Q18 the current move. In rare cases when there are multiple variations with the same move, right-clicking and shift-right-clicking scrolls through the list of such variations. Alternative ways of switching to different variations include using the Game Tree View and using menu items, toolbar buttons or keyboard shortcuts.
Board has several keyboard shortcuts to ease game record navigation. Remember, that these shortcuts are active only if the board has focus, as indicated with a small rectangle in the top-left corner. Otherwise, you should type them with Alt modifier: more complicated shortcuts work everywhere in Board Windows.
Table 3.1. Board keyboard shortcuts
| Shortcut | Action |
|---|---|
| Left arrow | Go to the previous node (current node’s parent.) |
| Right arrow | Go to the next node (current node’s child.) By default, next node is the first child, but it is remembered if you switch to a different child. |
| Page Up | Go ten nodes backward. If there are less than ten nodes, stop at the root of the game tree. |
| Page Down | Go ten nodes forward. If there are less than ten nodes, stop at the branch end. |
| Home | Go to the game tree root. |
| End | Go to the last node in the current branch (variation.) |
| Up arrow | Go to the previous variation of the current node. I.e. go to the previous child of the parent of the current node. |
| Down arrow | Go to the next variation of the current node. I.e. go to the next child of the parent of the current node. |
Game Information Pane shows information about the game in general, about the last move made and about the current node. Some of its components are optional and can be hidden in the menu.
- Player Information
At the top of the pane is the player information for both players. It shows player name, team and rank (first line), plus game-specific information (second line.) If name is missing, string “[unknown]” is shown in its place. If team or rank is not specified, they are simply not shown.
Game-specific information includes number of captures made by a player plus white player’s komi for Go; and number of disks on the board for Reversi.
- Player Clocks
Close to player information are the clocks. When a game is played, they display the time left for a player. Additionally, they can display number of pieces left in the current Canadian overtime period in smaller digits to the right. When a game record is viewed, clocks display time left after move in the current node has been played. Clocks can be empty if a game is played without time limits.
- Move Information
Below player information and clocks a single line displays move information. It shows last move (usually, current node’s move) number and the move itself. Afterwards, player to move is specified. This can sometimes seemingly contradict with the last move, but it is allowed to override player to move in game records (see → submenu.) This feature is often used in problem collections.
- Game Result
Below move information game result is shown, but only at the very last node of the game. This is done in order to prevent spoiling of watching of unknown games. Also, if the game lacks any result or is unfinished there is nothing to show at all.
- Game Action Buttons
Yet below there are game action buttons. These include (for Go) and . Because functionality of this buttons is quite rarely used and they take up space, you can hide them using → menu item. They are shown by default mainly as a reminder of the options you have.
- Comment Window
Most of the right side is taken by comment window. It displays any commentary the current node has. Comment can be edited and you don’t need to take any actions to save your edits. Edits are also saved in the undo history and can be undone and redone freely.
If the current node has a name, it is shown above comment in bold underlined font. It can be edited just like comment and you don’t need any special steps to edit node name. However, to create a name for a node that lacks one, use → menu item. It will insert a placeholder for node name in the window, which you can then replace with actual name. To delete a name, simply delete all its text. Quarry will notice it and remove node line from the window.
- Game Tree View
Finally, there can be the Game Tree View, described in detail in the next section. Its visibility is controlled by → menu item and preferences.
Game Tree View shows game record as a tree in a style used by CGoban1. Generally, it is of interest only if the game record contains variations. For instance, a debut/joseki dictionary or a well-annotated game with alternate branches. Visibility of Game Tree View is controlled with item in menu and with preferences.
Node with a move of a specific player, including pass move in Go, are shown as pieces of player’s color. Other nodes, including position setup, at present lack any icon. Nodes that belong to a same branch (variation) are connected with a line and the current branch is highlighted. Current node is shown within a black rectangle. If it is not visible, you can bring it onscreen using command from the menu.
Subtrees can be collapsed/expanded by right-clicking on subtree root. This is useful to hide nodes you are not interested in currently. Roots of collapsed nodes have a cross on them.
If a mouse is held over a node, a tooltip with information about the node is shown. It includes move number, move itself, node name and comment. Of course, some of these can be absent from the tooltip, if they are not present in the node to begin with. If node comment is too long, only first part of it is shown. Tooltips can be disabled in preferences if they look too distracting to you.
Show New Game Dialog to start a new game.
Show New Game Record Dialog to create a new game record without actually playing a game.
Open a game record. Record may as well have been saved in a different application.
Open a game record and show Resume Game Dialog to resume the game. Games adjourned in different applications can be resumed too.
Export current board position as a free-format ASCII diagram to the clipboard. Useful e.g. to mail game position if you don’t need a full-blown SGF. Only board position without any markup is stored.
Export current board position as a Sensei’s Library diagram to the clipboard. Pieces, circle and square markup and labels are exported. Result, of course, can be imported into the Sensei’s Library. Only available for Go games.
Note
It is currenly impossible to export only part of the board. You need to manually delete unneeded information in such cases.
Save the game record under its filename. If the game record is new, ask for filename first. This command is disabled if the game record is not modified.
Save the game record under a different filename.
Close the board window. If the game record is modified, ask whether to save it first.
Quit Quarry. Prompts to save any unsaved game records first.
Undo the last change made in the current game record.
Redo the last undone change made in the current game record.
Cut subtree having the current node as its root into clipboard.
Copy subtree having the current node as its root into clipboard.
Paste subtree contained in clipboard as last child of the current node. This command may fail if e.g. the subtree was copied from a different kind of game.
Note
It is currently impossible to determine if the clipboard contains anything, therefore this menu item is sensitive even if there is no subtree to paste.
Delete the current node together with its children from the game record.
Tools are very important as they are the most used (together with comment editing) way of modifying game records. Active tool can also be changed using the editing toolbar of from keyboard.
Activate tool which is used to play new moves in the current game record.
Activate tool which is used to add and remove pieces from the current node.
Activate tool which adds cross markup to the current position.
Activate tool which adds circle markup to the current position.
Activate tool which adds cross markup to the current position.
Activate tool which adds sqiare markup to the current position.
Activate tool which adds triangle markup to the current position.
Activate tool which adds selected markup to the current position.
Note
It is not recommended to use this type of markup, as it has no standard appearance and may confuse other users.
Activate tool which places single letter and arbitrary text labels on the board.
Activate tool which places number labels on the board.
Activate tool which scores the current position. This tool is valid only for Go games.
Add an empty children to the current node. Standard way of adding children is by playing moves, but this command allows you to add node without any move.
Move current branch up i.e. swap it with the previous branch. Useful to rearrange branches in the game record.
Move current branch down i.e. swap it with the next branch. Useful to rearrange branches in the game record.
Edit the name of the current node. If the node has no name, it is inserted. Otherwise, you can edit node just by directly modifying it in the comment window and this command simply selects the name.
Set the number of the current move. Normally, move number is incremented by one after each move, but there are cases when this must be overridden, for instance, if game record starts not at the game beginning.
Sometimes it is needed to explicitly set who is to move next, for instance, in a problem collection.
Set player to move to White, regardless of what game rules say.
Set player to move to Black, regardless of what game rules say.
Let game rules determine who is to move next (this is the default.)
Show the Find Dialog to find a string in node comments and/or names.
Repeat the last search in forward direction. If there were no last search, acts just as menu item.
Repeat the last search in backward direction. If there were no last search, acts just as menu item.
Show the Game Information Dialog to view and/org edit game information.
Show the Preferences Dialog to change Quarry settings.
Show or hide main toolbar in this window.
Show or hide editing toolbar in this window.
Show or hide navigation toolbar in this window.
Show or hide Game Action Buttons ( for Go game and .) They have quite rarely used functionality and take precious space on the right.
Show or hide Game Tree View in this window. Its visibility can also be globally changed in the preferences.
Recenter Game Tree View on the current node. Of course, the view should be shown to begin with.
Show Quarry Control Center.
Play a pass move. (Only valid in Go.)
Resign current game. Opponent is declared a winner.
Adjourn current game and save game record, so it can be later resumed.
Note
This menu’s title is English verb “go”, not game name.
Go to the previous node (current node’s parent.)
Go to the next node (current node’s child.) By default, next node is the first child, but it is remembered if you switch to a different child.
Go ten nodes backward. If there are less than ten nodes, stop at the root of the game tree.
Go ten nodes forward. If there are less than ten nodes, stop at the branch end.
Go to the game tree root.
Go to the last node in the current branch (variation.)
Go to the previous variation of the current node. I.e. go to the previous child of the parent of the current node.
Go to the next variation of the current node. I.e. go to the next child of the parent of the current node.
Go to a named node given its name. You can also use Find Dialog for this purpose, but this way there is completion on node names.
Find Dialog allows you to search for text in node names and/or comments. It is invaluable for large game records, especially those containing multiple branches, like debut/joseki dictionaries.
When a node with matching text is found, board window switches to it, if needed. Matching text is selected in information pane. Search can be repeated later without opening this dialog using menu items or from keyboard.
Dialog contains several controls:
- Search for field
Enter the text to search for here. Field also has a history with up to 10 most recently found strings.
- Optons
There a few options that control the search. It can be case-sensitive or case-insensitive. It can be restricted to whole words or include any match. Search can be wrapped around when the end or beginning of search domain is reached, or stop there.
You can also select button. In this case, the dialog will be hidden after any successful search. You can repeat search afterwards using and items of menu or using Ctrl+G and Shift+Ctrl+G key combinations.
- Search scope
Search domain can include the whole game record tree or the current node only. The latter option is only interesting if current node’s comment is very long.
Search can also be performed in node names, comments or both. Typically, you will want to search in both of them, but can sometimes wish to restrict search to decrease number of matches you are not interested in.
- and buttons
When search parameters are entered, click one of this buttons, depending on direction you wish search to be performed. Buttons can be pressed repeatedly to repeat search. However, if option is selected, dialog will be closed on first successful search.
These buttons can be disabled if a search in certain direction certainly won’t hit any matches. However, they are many cases when this cannot be determined in advance (quickly), so activating one of these buttons is not guaranteed to find anything.
- button
Close the dialog without performing any further search. Use it when you’ve finished searching or changed your mind.
The Game Information Dialog allows you to set values that describe game tree as a whole and are not specific to a particular move or position in the game. It has a lot of fields which are splitted in three pages. All fields are optional and can be empty (not set), but defining them gives additional description to the game.
Fields on the first page (General) describe the game opponents, rules of the game and non-spoiling game details. Field on the second page (Description & Result) are generally spoiling and can even disclose game outcome. The third page (Game Record) describe the record itself.
- White Player and Black Player
This group of fields allows you to describe the opponents in the game. The Name fields should be obvious. The Team fields are used when the game is a part of a match between two teams, for instance national teams. Usually, they are left empty. The Rank of the opponents can be entered in the appropriate fields. This is usually the rank as applies to the game in question. For instance, this can be the rank awarded by the federation guiding the tournament or it can be the rank of an Internet server where the game took place.
Values of these fields are also displayed in the right column of board windows.
- Game Name
The name of the game. This field can be empty if the game is not special and doesn’t have a distinguished name.
- Place
The place the game took place at. This can be a geographical location or the name of an Internet server.
- Date
The date the game took place on. It should be in the international format of YYYY-MM-DD. For instance 2006-07-23 means 23 July 2006.
- Event
The event this game is part of. For instance, this can be the name of a tournament. This field is often empty.
- Round
The round this game is part of. For instance “1st round” or “Semifinal”. This field is often empty, especially if Event is.
- Rule set
Descriptive name of the rules this game was played in accordance with. For instance, for Go this can be “Japanese”, “Chinese” etc.
- Handicap
For Go only: number of stones the black was allowed to place on his first move. This field is either 0 or not set for the games with no handicap.
Note
Value of this field is only informational. It doesn’t imply any particular setting of the black stones.
- Komi
For Go only: the compensation, in points, the white receives for having the second turn. Can be negative or not set. However, it should always be set for games with non-zero komi, as otherwise proper scoring is impossible.
- Main time
Main time each player has. Should not be set if the game is played with no time limit.
- Overtime
Description of the overtime rules used for this game. For instance, “25/600 Canadian” means Canadian overtime with 10 minutes (600 seconds) for every 25 moves.
- Game result
The result of the game in SGF format.
Table 3.2. Valid Game result values
Value Meaning Void There is no result yet (the game is not finished) or there can be no result at all (e.g. for problems.) 0 or Draw The game is draw, i.e. is finished, but there’s no winner. W+ scoreor B+scoreA player has won by the specified score. For instance, “W+6.5” means that white has won by 6.5 points. W+ or B+ A player has won. Used mainly for the games without a notion for score, e.g. Amazons. W+Resign or B+Resign or W+R or B+R A player has won by resignation. W+Time or B+Time or W+T or B+T A player has won on time. I.e. his opponent exceeded his time limit. W+Forfeit or B+Forfeit or W+F or B+F A player has won by forfeit, e.g. his opponent made an illegal move. ? Game result is unknown. - Opening played
Description of the opening played in the game. This field is often empty.
- Comment / description
Description for the entire game. It can be some background information and/or the summary of the game.
- Copyright string
Short copyright information for the game record.
- Annotator
The name of the person who provided comments (annotation) for the game.
- Source
The source of the game record (book, journal etc.) Often is empty if the game record was in electronic form to begin with.
- Entered by
Name of the person who entered the game record. Usually empty for automatically created records.
Table of Contents
To configure Quarry either click the button in the Control Center window or choose → menu item.
The Preferences dialog is displayed. It consists of the following categories:
General
Editing & Viewing
GTP
Game Records (SGF)
Board Appearance
General interface of Quarry can be configured at this page. It is not really related to the functionality of the application.
- File Chooser Dialog Style
You can use either the new file chooser or the old one, which was the default on pre-2.4 GTK+.
Note
This option will be removed in Quarry ver. 0.3. It was added when the new file chooser was in early development stages and had significant usability problems. Nowadays it has little sense to keep supporting the old one.
- Toolbar Styles
By default, Quarry uses desktop settings for all its toolbars. However, you can choose specific style for each of three toolbar kinds. You can also return toolbars to using desktop defaults here.
Here you can customize appearance and behavior of the Game Tree View.
- Show Game Tree
You can choose whether the Game Tree View is shown in Board Windows by default. If you choose Automatically option, it will be shown if game record has anything in addition to the main branch. In any case, you can show or hide the view manually, using → menu item. In this case, automatic showing will be disabled, even if corresponding option is selected.
- Track Tree’s Current Node
You can choose whether the view should track the current node, i.e. reposition itself to show it. In automatic mode it only tracks the current node if it was showing it before. This mode prevents the view from scrolling if you intentionally scrolled it to some part of the tree not containing the current node. You can always force the view to display the current node by using → menu item.
You can also choose whether the view will scroll minimal possible distance while tracking (i.e. the current node will be somewhere near an edge), or if it will always recenter on the current node if needed. These options don’t make sense if tracking is disabled, so they are disabled then too.
- Show tooltips
Choose whether Game Tree View should show tooltips over nodes. See view description for details. You may want to disable tooltips if they look too distracting.
At this page, all game-playing programs registered in Quarry are shown. You can register new programs and modify information in existing entries.
All registered programs are shown in the list labeled List of GTP engines. When you select one of them, some information about it is shown in the lower part of the dialog. This inlcudes program name, version, supported game(s) and command line. The command line is exactly what you specified while registering the program, while the rest of information is reported by the program itself.
Programs from the list are also shown in the New Game and Resuming Game dialogs as available computer opponents. However, you can hide some of them by removing the mark beside the program name in the Show column. This may be better than removing a program record altogether in case you later regain your interest in it. Also, some GTP engines may be listed in Quarry system-wide settings; those cannot be removed, only hidden.
There are also five buttons on this page:
- and buttons
These two buttons allow you to register another program, or modify information about an already registered one, correspondingly. They both pop up the GTP Engine Information dialog.
- button
This button removes a game-playing program from the list of registered programs. The unregistered program will not appear in the New Game dialog as an available opponent. Of course, the program itself is not touched and you can re-register it in Quarry later.
- and buttons
Using these two buttons you can rearrange registered programs. Computer opponents in the New Game dialog are listed in exactly the same order as on this page, so you may want to place more frequently used programs on the top. Another way to reorder GTP programs is to drag-and-drop their names in the list.
This dialog is shown whenever you want to register a game-playing program in Quarry or modify information about an already registered one. Depending on the situation, it can be titled either New GTP Engine or Modify GTP Engine Information. After you fill in the dialog, press the or button. Quarry will launch the program to check if it works and ask it for some information.
Note
If the message “Querying engine’s name, version and known commands…” appears and persists for too long (more than a few seconds), this most likely indicates that the command line you specify starts the program in non-GTP mode or starts a wrong program to begin with. If you don’t expect the program to be very slow on initialization, then click the button and fix the command line.
The dialog has two text entry fields:
- Command line
The command line to start the program should be entered here. You can use the button to select the program, but normally just specifying program filename is enough. (More exactly, it is enough if the program is installed in a directory that is in your
$PATHenvironment variable.) In any case, you should enter program-specific options after its filename. To find out which options should be used, see the manual of the program in question.For GNU Go, the command line should look like this (note the double hyphens):
gnugo --mode gtp --quiet
You may also want to specify additional options. See GNU Go documentation for more information.
- Screen name
In this field you can specify the way Quarry will display the name of the program. You can enter the full name or use special symbols “%n” and “%v”. They will be replaced with the name and version of the program as it reports them itself. In most cases the default value of “%n %v” is what you want, but sometimes it makes sense to alter it. For instance, you can specify “%n %v level 5” here if you fixed program’s level in the command line. If, for some reason, you need the percent sign in the name, type it in as “%%” (the percent sign is used as escape symbol in this field.)
Currently, you can only specify whether to save game records in UTF-8 or to preserve original encoding. The former option is recommended because UTF-8 can encode any character and because Quarry loads UTF-8 encoded game records faster than with any other encoding. However, you may want to preserve original encoding if, for instance, you use other SGF editor/viewer with poor support for UTF-8 or this is required for some reason for distribution.
Version 1.2, November 2002
Copyright © 2000, 2001, 2002 Free Software Foundation, Inc.
Version 1.2, November 2002
Copyright © 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful document “free” in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
Include an unaltered copy of this License.
Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright © YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 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 section entitled “GNU Free Documentation License”.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:
with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.