Updates. Bump version to 0.2.0.
[cboard.git] / NEWS
blob635811fe711bb436aed3d3dd6ac4bc43f6e6e03a
1 Cboard version 0.2.0
2 --------------------
3 Quite a while since the last release, I've lost interest in the project off
4 and on but still keep at it enough to fix and add things. The most important
5 change in this version is better SAN handling. Ambiguities are fixed along
6 with frfr to SAN conversion. There are quite a few internal changes too but
7 unfortunately this version is quite a bit slower than the last do to more
8 functionality. I'm trying to find ways to speed it up though. The PGN portion
9 of the code has been split up into a library "libchess". This allows for easy
10 inclusion into other projects. In-game keys have changed quite a bit. Press F1
11 to see them. Also read the manual page as configuration parameters have been
12 changed/added/removed. Here's the rest of the changes:
14 Switch from CVS to GIT.
16 Lots of FEN tag fixes when parsing, saving and editing the board.
18 When in history mode, the cursor is updated to the last position on the board.
20 Support for Unix 98 ptys.
22 Show the repeat count in the status window.
24 Added command line options -V to only validate a .pgn file, -S to save a PGN
25 formatted game and -R to save a reduced PGN formatted game. The return value
26 of cboard will be 1 if there was a parse error or 0 on success.
28 Added option -t to save custom tags from the configuration file when -S is
29 specified.
31 Added option -E to stop processing the file when a game contains a parse
32 error. Also see configuration parameter stop_on_error in the manual page.
34 A few key bindings have been removed. Press 'F1' in game for help.
36 Added human/human play. Toggle it with the 'H' key.
38 Added engine/engine play. Toggle it with the 'E' key then hit 'g'o!.
40 I've got a new email address. Send any bugs reports patches etc to me at
41 bjk@luxsci.net.
43 When a piece is selected cboard will only highlight legal squares the piece
44 can move to.
46 Updated manual page. Read this because a few configuration parameters have
47 changed.
49 Added game key 'd' to show board details. Details are the enpassant square and
50 castling availability.
52 The parser now supports RAV. Moves are read into the history but the interface
53 is minimal at the moment. Saving also works but is buggy.
55 Support window resizing when in an xterm. Need at least an 80x24 terminal.
57 Support for all engines that utilize the XBoard protocol. Not very well
58 tested. GNUChess and Crafty seem to work fine though.
60 Added configuration parameter 'engine_init' which sends a command to the
61 engine when initialized.
63 The file browser (save/load prompt) supports filters.
65 A "Loading..." window/line when a file is being loaded.
67 Added configuration parameter 'bind' which binds a key to a command to send to
68 the engine when in play mode. Read the manual page.
70 Added key 'W' to show an engine io window.
72 New menu code. Looks better with custom colors. Type ahead searching is buggy
73 though.
75 Lots of internal, parser, validation and bug fixes.
78 CBoard version 0.1.6
79 --------------------
80 A few important save game, validation and file parser fixes.
82 Added command 't' to edit tags. You won't be prompted to edit tags anymore
83 when saving.
85 Renamed game deletion commands 'd' and 'D' to 'x' and 'X'. The delete commands
86 also accept a "range" to delete by specifying a count the one of the delete
87 commands then a direction ('<' or '>').
89 Tildes in the load/save dialog are expanded.
91 Added commands '!'-'*' and 'A'-'H' to move the cursor to the specified
92 rank/file.
94 Move numbers and tags are no longer needed in a PGN file.
96 The ncurses interface is initialized before trying to parse a file specified
97 on the command line.
99 The annotation viewing commands '[' and ']' have changed to 'V' and 'v'.
101 The next/prev move text expression keys '}' and '{' have changed to ']' and
102 '['.
104 Added game searching commands '?', '}' and '{'. These work like to move text
105 searching commands, but for roster tags instead.
107 Now parses the FEN tag. When editing tags, you can press CTRL-f to insert or
108 update the FEN tag with the current move in the move history.
110 Added command 'e' to toggle edit mode. This will allow positioning, deleting
111 ('x' command) and inserting ('I' command) of pieces. No move validation is
112 done in edit mode and may only be enabled with a fresh board ('N' or 'n'
113 commands). After leaving edit mode, a FEN tag is created. It's somewhat
114 useless right now though.
116 Redone main command keys help.
118 Added commands '_' and '+' to decrease and increase the engine depth. These
119 can take a count.
122 CBoard version 0.1.5
123 --------------------
124 The repeat count commands are now 0-9. The first non-integer is the command to
125 repeat. So now you can have more than ten as a count. Pressing ESCAPE in the
126 middle of the count will reset it (similar to VIM's repeat).
128 The 'u'ndo command can take a repeat count.
130 Replaced the black and white status windows with a Seven Tag Roster window
131 (like before). The black and white info will be in the game status window.
133 Check and checkmate recognition are working (not draw though).
135 Added history move text searching commands. '/' will prompt for a new regular
136 expression and jump to the next match, '{' and '}' will jump to the previous
137 or next match prompting for an expression if one doesn't already exist. All of
138 these commands can take a repeat count.
140 Move numbers in the history window are full move numbers now. So by default,
141 the cursor keys in history mode will jump 2 moves. Pressing SPACE in history
142 mode will toggle half-move stepping.
144 The "board_moves" color parameter has been replaced by "board_white_moves" and
145 "board_black_moves" to specify the valid move color for those squares.
148 CBoard version 0.1.4
149 --------------------
150 This release fixes a few bugs and plugs a couple memory leaks in the menu code.
151 The SAN move parser still needs quite a bit of work though when interfaced
152 with the engine, so check and end-of-game determination are on hold until that
153 gets stable. But viewing games seems alright. Beginnings of ICS support
154 (ignore the manual references as its useless right now). Hopefully the code is
155 little more readable and easier to follow now. Heres the rest of the news:
157 "make install" will install the data files and example configuration file to
158 DATADIR/cboard (/usr/local/share/cboard by default). They will be copied to
159 ~/.cboard if they cannot be found.
161 Linux runtime fixes.
163 Can load and save .Z, .gz, .zip, .bz and .bz2 compressed files. Can't append
164 to a compressed file though (for now).
166 If theres a parse error when loading a file with multiple games, CBoard will
167 keep reading the file rather than aborting.
169 When editing the "Site" tag, you can lookup country codes which are stored in
170 ~/.cboard/cc.data.
172 If a filename doesn't contain a ".", then ".pgn" is appended to it when
173 saving.
175 A few but important PGN parser fixes.
177 Tags are sorted when loading and saving.
179 Added command "d" to toggle the delete flag of the current game. Pressing "D"
180 will delete all flagged games or the current one if none are flagged. This
181 adds the configuration parameter "delete_prompt". The default is on.
183 Added configuration parameter "valid_moves" to show valid moves when a piece
184 is selected. The color can be adjusted with the "board_moves" color parameter.
185 The cursor keys will move to the associated valid move. This is still buggy
186 though.
188 Added cursor repeat commands 0..9 (zero being ten). These will work with the
189 board navigation, history browsing and game browsing keys.
191 Removed cursor movement command 'j', 'k', 'l', and ';'.
193 Added commands 'j' and 'J' to jump to a history move number or game number.
195 Added "board_window" color configuration parameter.
197 Added "engine_cmd" to specify the chess engine path, command and any
198 arguments. The default is "gnuchess xboard". Note that other commands/engines
199 haven't been tested.
202 CBoard version 0.1.3
203 --------------------
204 Can now load and save SAN move format! Still not perfect I'm sure.
206 A file browser has been added to the load/save game prompt. Pressing TAB will
207 enable it.
209 Added configuration parameter "save_directory". If set, saved games will be
210 stored here and will also be the default open location of the file browser.
212 The annotation viewing keys have changed from 'V' and 'v' to '[' and ']'.
214 Configuration parameters whose values were either "0" or "1" are now "off" or
215 "on" respectively.
217 New configuration parameter "line_graphics". If "off", then the board line
218 graphics will not be drawn.
220 The data window has been replaced by two separate white and black player
221 information windows. This adds color configuration parameters white_... and
222 black_...
224 The PGN file parser now supports "!?"/"!!"/etc. NAG format and end-of-game
225 markers.
227 When multiple games are loaded, you can choose to save all games or just the
228 current one.
230 When saving from history mode, you can save up to the current move or all
231 moves.
233 Added configuration parameter "save_prompt" and ingame command "S". When set
234 to "off", don't prompt to edit roster tags and for history save commands when
235 in history mode.
237 The ingame "N" command has changed to start a new game from scratch. The "n"
238 command starts a new game or round.
240 Added command "D" to delete game.
243 CBoard version 0.1.2
244 --------------------
245 Loading a saved game and resuming a game from previous history works now. This
246 is done by having the chess engine read a FIFO and have CBoard write to it.
247 This allows for easy game switching when more than one game has been loaded.
249 Promotions, En Passant and castling moves are recognized now.
251 Agony strings are stored in ~/.cboard/agony.data and can be disabled with a
252 configuration file option (see below).
254 Rewritten move text section in the PGN parser. Now move annotations are read
255 and written and can be viewed with the 'v' and 'V' commands in history mode.
256 This supports both move comments and NAG data (see below).
258 There is no longer a -f command line option to specify a configuration file.
259 The new configuration file is stored in the ~/.cboard directory along with a
260 few data files. The files that need to be found in this directory are:
262     config     - This is optional, CBoard will use defaults if not found.
263     nag.data   - For viewing and editing move annotations.
264     agony.data - Agony strings displayed in the status window when a capture
265                  has been made.
266     fifo       - Used for resuming games.
268 You can find the data files along with an example configuration file in the
269 'etc/' directory of the archive. You'll have to copy them over to ~/.cboard
270 yourself until I figure out a way to do it with 'make install'.
272 You can define custom colors and attributes in the configuration file. See the
273 manual page for more infomation on the syntax.
275 Added configuration parameters:
276           pgntag - Define custom tags for new games or override defaults.
277            agony - Show a random agony string on a capture.
278     historyagony - Enable or disable agony strings in history mode.
280 SAN move format is the next major thing that needs to be done. It seems like
281 I'm going in reverse order of how things should be developed, but oh well.