1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
<html>
<head>
<link rel="stylesheet" type="text/css" href=":/help/about.css" />
<link rel="stylesheet" type="text/css" href="about.css" />
<meta content="en" name="language" />
<meta content="en" http-equiv="Content-Language" />
<meta name="viewport" content="user-scalable=no, width=device-width" />
<title>ChessX Manual</title>
<body>
<div id="container">
<div id="header">
<h1>ChessX Help</h1>
<div id="nav">
<ul>
<li><a href="about0.html">Basics</a></li>
<li><b>Manual</b></li>
<li><a href="about1a.html">Customizing ChessX</a></li>
<li><a href="about2.html">Reference</a></li>
<li><a href="about3.html">Copyrights</a></li>
</ul>
</div>
</div>
<div id="content">
<h2><a name="Handbuch">ChessX Manual</a></h2>
<h3><a name="Open"></a>Opening a database</h3>
<p>You can open a database either from the File menu or drag a file from Explorer / Finder into the Databases view.</p>
<p>You can make a database stay permanently in the database list by turning it into a "Favorite" (right-click the file).
A database is reopened from there by clicking the asterisk or again by the context menu.</p>
<p>You can also drag files from yor Internet Browser into the ChessX Database List, they are downloaded into
the configured default path (see the Preferences-Advanced-Default Data Path entry). If they are compressed (zip),
the archive is stored at the Default Data Path and its content is extracted. Again, if there is something like PGN inside,
the files are opened afterwards.</p>
<h3><a name="Web"></a>Opening a periodic database from the web</h3>
<p><img class="button" src=":/images/folder_web.png" width="42" align="left">For regularly loading a periodically updated
database from the web, enter the target URL into the preference for Web Favorite, where $1 can
be replaced by an incrementing counter. Let's say amonthincheckers.com
hosts a monthly database update at "http://amonthincheckers.com/zips/amic123g.zip"
where 123 is incremented every time an update is posted, enter
"http://amonthincheckers.com/zips/amic$1g.zip" into the URL field and
set the starting number at the right of the URL. Each time the
database is successfully loaded, $1 is incremented by one so you are
all set for the next update.</p>
<h3><a name="Move"></a>Making moves</h3>
<p>A move is done by grabbing a piece and dragging it to another square.</p>
<p>Depending on your settings in the board preferences, you can either
<ul>
<li>Click on a piece and a target square (if move guesses are deactivated)
<li>Click on a piece and accepting the move quess (in case of deactivated next guess on right click)
<li>Right Click on a piece and then again until the correct target square is high-lighted, then press the
left mouse button to make the move (in case right click is used for next guess).
</ul>
</p>
<p>Going back a move can be done by a right-click (in case the right click is not configured for backtracking a move)
or by pressing CTRL-right click if backtracking is assigned to the right mouse key.</p>
<p>Usually, making a move will insert a new variation unless you are at the end of the game or a variation. If you do not
want to create a new variation, press CTR while moving, which replaces the current move and all following moves by the new move.</p>
<p>If you want to exchange a move without deleting subsequent moves, you can press CTRL ALT while moving, this will exchange
the move played with the new move and check the remaining game for illegal positions. The game is then truncated at these illegal positions.</p>
<p>If you promote a pawn, ChessX will pop up a selection dialog, which piece you would like to have.
This can be disabled in the Preferences. If you have enabled automatic promotion, you can still force the promotion dialog to appear bei
pressing the Meta-Key while dragging the pawn to the eigth row.</p>
<p>Castling is performed by moving the king to its destination square. See <a href="#Variants">Chess Variants</a>
on castling in Chess960.</p>
<h3><a name="Replay"></a>Let ChessX replay the game</h3>
<p><img src=":/images/replay.png" width="42" align="left">If you want ChessX to replay the game, select "Game->Auto Player".
You can change the move rate with the slider in the bottom right corner of the status bar.</p>
<h3><a name="Enter"></a>Entering moves with the keyboard</h3>
<p>If the focus is somewhere on the board or the notation, you can enter moves simply by starting to type.
A label in the status bar will indicate, what you have typed. Whenever ChessX recognizes a complete move, the move
is executed and the buffer is cleared.</p>
<p>You can enter anything that looks like (PGN-) notation, make sure, your move us unambiguos. For example,
typing "e4" in the starting position is fine, whereas a subsequent "e2" could either be Be2,Ne2,Ke2,Qe2 - or f1e2...
</p>
<p>By pressing [Enter] you can force ChessX to accept an entry or discard it, if ChessX cannot make anything reasonable of your entry.</p>
<h3><a name="Annotate"></a>Annotating moves</h3>
<p>Move annotations can be done by activating the context menu in the games text browser or by simply pressing the corresponding key sequence,
e.g. '!?','!!','??','!x','?x','=',' -','- ' and so on, where 'x' is used in case the first character is ambiguous, 'x' can be the
Return/Enter-Key or literally the small letter 'x'.</p>
<p>You can make special annotations like drawing an arrow or coloring squares by pressing Shift Right-Mouse-Clicking (either select a single square
or make a drawing gesture for drawing an arrow).</p>
<p><img src=":/images/brush_green.png" width="42" align="left">Pressing a green, red or yellow pen enters paint mode. You cannot enter moves,
instead, you can paint squares and arrows without having to press Shift Right-Mouse.</p>
<p><img src=":/images/brush_erase.png" width="42" align="left">Pressing the grey pen selects the eraser.</p>
<h3><a name="Save"></a>Saving games</h3>
<p>Saving games is slightly confusing! A game needs to be saved into the database (Press CTRL S, Menu Game/Save). From there,
the whole database needs to be saved to disk by pressing CTRL Shift S / Menu File/Save. This is somewhat inconvenient but on the other hand prevents
you from mistakenly overwriting games or files.</p>
<p>If you want to commit a database to harddisk immediately and automatically when saving a game, you can select Option "Commit Database
after Saving Game" from the Database Pane in the Preferences Dialog.</p>
<p>By default, a clipboard database is open, which does not have a backing file on disk. Anything that remains in the Clipboard is
lost upon closing ChessX! So you need to open at least one other database for writing and transfer anything from the Clipboard
into this database by either dragging the games to that database or using "Copy Games" from the Database menu.</p>
<h3><a name="Switch"></a>Switching databases</h3>
<p>Switching between open databases can be achieved by either the Database menu, pressing CTRL Shift Number 0 .. 9,
right-clicking or double-clicking into the database list or clicking onto the board's tab
associated with the database. The currently selected database is highlighted in the database list!</p>
<h3><a name="OpenGame"></a>Open or start a new game</h3>
<p>Once you have opened or selected a database a described above, you can either start a new game by pressing CTRL N or
select a game from the list of games inside the database.</p>
<p>If you want to start a game from a given position, enter CTRL-SHIFT-E to bring up the board editor. Within this editor,
you can set up an arbitrary position or a Chess960 starting position. The editor checks the position for legality so you might
need to adapt the castling rights or the side to move to make your position legal.</p>
<h3><a name="Analyse"></a>Analysing games</h3>
<p>There are two analysis windows where two different engines can be configured to analyse the current board position.</p>
<p>Engines must be configured before in the Preferences Dialog. A default engine (Stockfish) comes with this installation
and will be configured as first engine, if no other entries exist.
Stockfish is an open source engine (see <a href="http://stockfishchess.org">Homepage of Stockfish</a>.
The source code for Stockfish is also located on the homepage. Note that Stockfish is licensed under <a href="about3.html">GPLv3</a></p>
<p>You can fine-tune engines with the protocol options dialog (works for UCI only, Winboard is seldom used and due to the clumsy specification
hard to implement for GUI developers.</p>
<p>You can change the move rate with the slider in the bottom right corner of the status bar. Draw the slider to the very left for infinite analysis or
to the right to make the engine analyse from 1 to 10 secondes per move.</p>
<p>If the number of lines is set to at least 2, the Guid/Bratko complexity is also calculated - see the reference on details.</p>
<p>A hint for engine developers: You can log the communication from/to the engine with the "Log" checkbox in the engine settings.
Logging will be sent to a file 'name.log' where name is the "given" name in the engine settings. Logging directory is the Program data
path /log. What the program data path resolves to can be found in the About box.</p>
<h3><a name="Game"></a>Playing (out) games against an engine</h3>
<p><img src=":/images/respond.png" width="42" align="left">You can play out a game after the final position by activating Auto Respond mode.
Whenever you make a move the engine in pane 1 will start to analyse the
position for the time defined by the slider at the bottom right of the status bar. If the allotted time is over, the
engine will make the best move found so far.</p>
<p>If you start a game with Chess960 rules you will need an engine that supports this. The integrated Stockfish is ready for Chess960.</p>
<h3><a name="Auto-Annotate"></a>Automatically annotating games</h3>
<p><img src=":/images/annotate.png" width="42" align="left">Start an engine in the Analysis 1 window and select menu "Game->Auto Analysis". ChessX will start to move through the
current game, analysing each position for some time. After the alotted time is over, the best move will be inserted as variation into the game
text. Then ChessX will continue with the next move.</p>
<p>There are a couple of options which have an influence on the behaviuor:</p>
<ul>
<li>The slider in the status bar will determine, how long the engine will ponder on each position
<li>Preferences->Game->Automatically save and continue with next game: This allows analysing a complete database, select this option, start Engine 1,
open the first game from the database and select move 1.
<li>Preferences->Database->Commit Database after saving Game: Recommended, commits your results to the harddisk after each game, especially if you
analyse a complete database, a loss of power will otherwise lose all results so far.
</ul>
<h3><a name="Engine-Books"></a>Using Books in engines</h3>
<p>UCI engines may support books. Just set the OwnBook option to true, set the name of the "Book File" option and restart the engine.
The engine will answer immediately with a book move when playing out games (see above), depending on "Best Book Move" option this may or
may not be the best move from the book. In infinite analysis, the engine won't use information from opening books.</p>
<p>If your engine does not support books (e.g. Stockfish does not support it anymore), the GUI can act as a
frontend for the engine: Open a book as described below and select it from the book-selector in the Analysis pane.
If you start a engine match or a game against an engine, you can use the option "Allow use of books" and select
an algorithm, how the GUI shall select moves if several moves are available for a given position.
<ul>
<li>Best move will always take the preferred move
<li>Random selection will choose one move at random with equal probability
<li>Weighted selection will make a random selection but prefers better moves
</ul>
</p>
<h3><a name="Books"></a>Using Books in ChessX</h3>
<p>Polyglot is a book standard supported by ChessX. The original code was licensed under GNU GPL Version 2.0.</p>
<p>ChessX displays books like any other database in the Opening Tree Browser. Drag a polyglot book (which must have the suffix ".bin")
to the Database List or open the book via menu. Once it is open, it becomes available as any other open database
in the combo box "Source" beneath the opening tree.</p>
<p>One note: Polyglot books can be difficult to interpret: they are made for engines, as they give a hint on moves,
the engine should play. Moves which did not succeed at all are usually not part of polyglot books.</p>
<p>So do not learn openings from polyglot books - important moves might be missing!</p>
<h3><a name="Create-Book"></a>Creating your own book</h3>
<p>You can create your own book by selecting a open PGN database (right click with the mouse) and select "Make polyglot book".</p>
<p>ChessX will query the following parameters and pass them for creating a book:</p>
<ul>
<li>The number of plies (half moves) to read for each game. E.g. if set to
"20", only the first 10 full moves of each game will be scanned.
<li>The number of times a move must have been played to be kept in the book. In other
words, moves that were played too rarely will be left out. If you
scan full games "2" seems a minimum, but if you selected lines
manually "1" will make sense.
<li>You can overwrite the actual results of games by selecting the
side for which you want to build a repertoire, assuming that all the games
in a database contain lines that you want to play.
<li>Before, you can filter out unwanted games.
<li>By default, a probability is calculated by ChessX PolyGlot for each move
depending on how popular it is (how often it was playing in the
provided PGN file) and how much it "scored". This option bypasses the
default mechanism and affects equal probability to all moves. This
allows more variety of play.
</ul>
<h3><a name="Content"></a>Generating content</h3>
<p>You can copy/paste positions(FEN and images) and complete games(PGN) from/into the clipboard, export games in LATEX, HTML or PGN again.
See the Edit menu and the File/Export Dialog.</p>
<h3><a name="Merge"></a>Merging games</h3>
<p>By dragging a game from the game list into the current notation, the dragged game will be merged into the current game at the
first position after the current position, where both games deviate. The game will be merged with all annotations and variations.
If nothing is merged, no suitable point for merging was found. This can happen, if</p>
<ul>
<li>no position could be found where both games where equal (after the current position!)
<li>the remainder of the game to be merged in was already contained in the current game
</ul>
<p>You can select multiple games and merge them at once.</p>
<h3><a name="Sort"></a>Sorting and filtering games</h3>
<p>The list of games can be filtered either by the opening tree, the Player or Event widget or from the context menu in the list header.
Several searches can be combined or inverted.
Further occurrences of the current board position in the current database can be found via
the Find / Find Position menu.</p>
<p>Clicking on the header sorts the list. This feature is disabled for larger databases (>4K of games)
as it will take far too long to sort the list.</p>
<h3><a name="Filter"></a>Filter Databases into an opening tree</h3>
<p>The opening tree takes the current board position and matches it with each game in the selected database.
The moves found in the database are listed with the number of occurrences and the score that was achieved with
each move alternative. The database is updated continuously, the progress bar gives a hint how far the database is analysed.</p>
<p>The result of the position search can be filtered into the list of games. This filter can again be used as input for the
search in the opening tree. Especially on large databases this can speed up further searches (but will of course miss other move orders
into the same position).</p>
<p>Usually, clicking onto one of the moves in opening tree will only update the small overview in the opening tree widget.
Pressing Shift while clicking onto a move will add the move to the current game (if the position permits)</p>
<h3><a name="Duplicate games"></a>Filter duplicate games</h3>
<p>Filtering duplicate games searches for exact matching, all further copies of a game within the
database a put into the filter, the original game is not included into the filter. Thus all the
copies in the filter can be marked for deletion.</p>
<p>Filter for duplicate headers searches for identical tags. The games shown in the filter are
games that have a brother game, that is not included in the list and in addition, the invisible
brother has at least as many moves and comments as the games in the list.</p>
<p>The context menu in the game list has a context menu entry "Filter twins" which for all selected
games searches the whole database for exact duplicates. Both twins will appear in the filter list afterwards.</p>
<h3><a name="Merge databases"></a>Merge complete databases</h3>
<p>By dragging a database list item either onto a different database list item or by dragging it into the list of games,
games are appended to the database where the item was dropped or into the currently active database in case the drop target
is the list of games.</p>
<p>You can also drag databases from the file system into the list of games to append all content into the current database.</p>
<p>Dragging a database into the list of databases will open the database instead (i.e. it will not append to the database where it was dropped).</p>
<h3><a name="Training"></a>Training Mode</h3>
<p><img src=":/images/training.png" width="42" align="left">Selecting Game/Training starts the training mode. Moves starting from the current move are hidden on the game sheet. You can't modify a game
so you can make any move in a position. If the move is the right one (the one that was played or a existing variation) then the move is executed
and the game is moved one step forward.
The game notation is updated and variations on that move become visible. Ideal for use with a tactics database.</p>
<p>If you have no idea what to move, you can get hints by hovering with the mouse over your pieces. Perhaps, the right move pops up!
See the chapter on Making Moves and the associated preferences to enable move guesses.</p>
<p>You can combine training with Auto Respond mode, in this case, ChessX will make the next move automatically whenever you make a correct move.</p>
<h3><a name="Match"></a>Playing matches</h3>
<p><img src=":/images/black_chess.png" width="42" align="left">The match button makes sure, that ChessX does not give away hints on the position. This effectively disables
engine output, tablebase output, moving back or forward in a game, changing databases etc.</p>
<h3><a name="Engine-Match"></a>Matches between engines</h3>
<p><img src=":/images/chip.png" width="42" align="left">With "Game/Engine Match" you can arrange a match between two engines. Analysis pane 1 will play the white pieces, pane 2 with the black pieces.
Starting an engine match brings up the match parameter dialog.
If activated, the elapsed game time is annotated. You can play with Gong (each move will be made within a fixed time) or sudden death, where
each engine gets a fixed amount of time for the whole game. ChessX will supervise the time and also adjudicate a draw in case of a three-fold repetition,
insufficient material or the 50 move rule.</p>
<h3><a name="FICS"></a>Online Chess</h3>
<p><img src=":/images/fics.png" width="42" align="left">ChessX supports online access to games played or stored on the free internet chess server.</p>
<p>If you have a FICS account, you can enter the credentials in the Preferences, otherwise, ChessX will login as guest.</p>
<p>ChessX connects to FICS upon opening the virtual database FICS. A successful connection is indicated in the message pane of the FICS console.</p>
<p>Selecting the tab "Games" will read in the list of games which are currently played on FICS. Double clicking a games will start monitoring this game.
Selecting Players will read in all players currently connected to FICS. Double-clicking a player will read in the players history (last 10 games).
Double clicking a game from the History pane will read in the game into the current game of the FICS database. You can finally save any observed or examined game and transfer it
to a persistent database. Games in the FICS database are not persistent!</p>
<p>For playing games online, using TimeSeal is recommended. See the message pane upon connecting to FICS.
It will show, if Telnet or Timeseal is used. Telnet will give you a disadvantage for faster games so this is not recommended.</p>
<p>You can accept incoming match requests from other players pressing "Accept" or you can seek for an opponent in the seek pane.</p>
<p>While waiting for your opponents move, you can already grab a piece and hover over a target square or you can enter a premove by
dropping it somewhere, the premove piece and its target square a indicated. An active premove can be cancelled by clicking somewhere on the board
or by selecting a new premove.</p>
<p>Chess variants are not supported in Online mode</p>
<h3><a name="Variants"></a>Chess Variants</h3>
<p>ChessX supports Chess 960 games (also call Fisherandom).</p>
<p>You can start a Chess960 game by setting up the board manually. The setup dialog allows entering the
position identifier or chossing a random identifier.</p>
<p>While entering a Chess 960 game, castling is performed by dragging the king onto the castling rook.
This will work even if the king is already on its destination square.</p>
</div>
</div>
</body>
</html>
|
