Skip to content

Commit 738305e

Browse files
author
Torben
committed
update readme
1 parent 7562574 commit 738305e

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,72 @@
11
# ChuckooChess 1.12
22

3-
This is an adaption of Peter Österlund's CuckooChess 1.12, see http://hem.bredband.net/petero2b/javachess/index.html
3+
This is an adaptation of Peter Österlund's CuckooChess 1.12, see [official page](http://hem.bredband.net/petero2b/javachess/index.html)
44

55
The source code provided is a java maven eclipse project.
66

7-
The program, except for the chess font, is copyrighted by Peter Österlund, and is available as open source under the GNU GPL v3 license.
7+
The program, except for the chess font, is copyrighted by Peter Österlund, and is available as [open source](http://www.opensource.org/) under the [GNU GPL v3 license](http://www.gnu.org/licenses/gpl.html).
88

99
## About the program
1010

11-
Most of the ideas in the program are from the Chess Programming Wiki or from the TalkChess.com forum.
11+
Most of the ideas in the program are from the [Chess Programming Wiki](http://chessprogramming.wikispaces.com/) or from the [TalkChess.com](http://talkchess.com/forum/) forum.
1212

1313
The program implements many of the standard methods for computer chess programs, such as iterative deepening, negascout, aspiration windows, quiescence search with SEE pruning and MVV/LVA move ordering, hash table, history heuristic, recursive null moves, futility pruning, late move reductions, opening book and magic bitboards.
1414

15-
The program is rather slow compared to state of the art chess programs. However, it is still quite good at tactics and scores 299 of 300 on the win at chess tactical test suite, at 10 seconds thinking time per position, using an Intel Core i7 870 CPU. The only position not solved is the extremely complicated position 230, which according to current analysis, seems like a draw and therefore an invalid test position.
15+
The program is rather slow compared to state of the art chess programs. However, it is still quite good at tactics and scores [299](http://hem.bredband.net/petero2b/javachess/wac_10s.txt) of 300 on the [win at chess](http://chessprogramming.wikispaces.com/Test-Positions) tactical test suite, at 10 seconds thinking time per position, using an Intel Core i7 870 CPU. The only position not solved is the extremely complicated position 230, which according to [current analysis](http://rybkaforum.net/cgi-bin/rybkaforum/topic_show.pl?tid=18403), seems like a draw and therefore an invalid test position.
1616

17-
Note that the author does not consider Java the best language for implementing a chess engine. He wrote this program mostly to get some hands-on experience with java and eclipse.
17+
Note that the author does not consider Java the best language for implementing a chess engine. He wrote this program mostly to get some hands-on experience with java and [eclipse](http://www.eclipse.org/).
1818

19-
The program uses the Chess Cases chess font, created by Matthieu Leschemelle.
19+
The program uses the [Chess Cases](http://www.chessvariants.org/d.font/) chess font, created by Matthieu Leschemelle.
2020

21-
The author picked the name CuckooChess because the transposition table is based on Cuckoo hashing.
21+
The author picked the name CuckooChess because the transposition table is based on [Cuckoo hashing](http://en.wikipedia.org/wiki/Cuckoo_hashing).
2222

2323
## Downloads
2424

25-
You can also run the applet as a standalone program. Download the cuckoo-app-1.12-jar-with-dependencies.jar file and run it like this:
25+
You can also run the applet as a standalone program. Download the [cuckoo-app-1.12-jar-with-dependencies.jar](https://github.com/sauce-code/cuckoo/releases/download/1.12/cuckoo-app-1.12-jar-with-dependencies.jar) file and run it like this (graphical mode):
2626

27-
java -jar cuckoo-app-1.12-jar-with-dependencies.jar txt (text mode)
27+
java -jar cuckoo-app-1.12-jar-with-dependencies.jar gui
28+
29+
or like this (text mode):
2830

29-
or like this:
31+
java -jar cuckoo-app-1.12-jar-with-dependencies.jar txt
3032

31-
java -jar cuckoo-app-1.12-jar-with-dependencies.jar gui (graphical mode)
32-
33-
More commands are available in text mode than in graphical mode. Try the help command for a list of available commands.
33+
More commands are available in text mode than in graphical mode. Try the `help` command for a list of available commands.
3434

3535
## Build instructions
3636

37-
Compile the project using mvn install in root directory.
37+
Compile the project in root directory using
38+
39+
mvn install
40+
41+
You can find the compiled standalone jar here:
3842

39-
You can find the compiled standalone jar in cuckoo-app\target\cuckoo-app-1.12-jar-with-dependencies.jar
43+
cuckoo-app\target\cuckoo-app-1.12-jar-with-dependencies.jar
4044

4145
To run it, see description above.
4246

4347

44-
You can also find gui only, tui only and uci only versions in
48+
You can also find gui only, tui only and uci only versions here
4549

46-
- cuckoo-gui\target\cuckoo-gui-1.12-jar-with-dependencies.jar
47-
- cuckoo-tui\target\cuckoo-tui-1.12-jar-with-dependencies.jar
48-
- cuckoo-uci\target\cuckoo-uci-1.12-jar-with-dependencies.jar
50+
cuckoo-gui\target\cuckoo-gui-1.12-jar-with-dependencies.jar
51+
cuckoo-tui\target\cuckoo-tui-1.12-jar-with-dependencies.jar
52+
cuckoo-uci\target\cuckoo-uci-1.12-jar-with-dependencies.jar
4953

5054
For those, you don't need to add any parameters to run them.
5155

5256
## UCI mode
5357

54-
It is also possible to use the program as a UCI engine, which means that you can use it with many graphical chess programs. For example, to use it with XBoard/WinBoard + polyglot, set EngineCommand like this in the polyglot ini file:
58+
It is also possible to use the program as a [UCI engine](http://en.wikipedia.org/wiki/Universal_Chess_Interface), which means that you can use it with many graphical chess programs. For example, to use it with XBoard/WinBoard + polyglot, set EngineCommand like this in the polyglot ini file:
59+
60+
EngineCommand = java -jar /path/to/jar/cuckoo-app-1.12-jar-with-dependencies.jar uci
61+
62+
To use the program with the [Arena](http://www.playwitharena.com/) GUI, create a one-line bat-file containing:
5563

56-
EngineCommand = java -jar /path/to/jar/cuckoo-app-1.12-jar-with-dependencies.jar uci
64+
javaw -Xmx256m -jar cuckoo-app-1.12-jar-with-dependencies.jar uci
5765

58-
To use the program with the Arena GUI, create a one-line bat-file containing:
66+
Note that you must set the maximum heap size using `-Xmx` to a value larger than the hash size you set in the Arena program. (I don't know exactly how much larger.)
5967

60-
javaw -Xmx256m -jar cuckoo-app-1.12-jar-with-dependencies.jar uci
68+
If you are using windows, you may also be interested in a compiled version available from Jim Ablett's [chess projects page](http://jim-ablett.co.de/).
6169

62-
Note that you must set the maximum heap size using -Xmx to a value larger than the hash size you set in the Arena program. (I don't know exactly how much larger.)
70+
## Change Log
6371

64-
If you are using windows, you may also be interested in a compiled version available from Jim Ablett's chess projects page.
72+
You can find the changelog [here](http://hem.bredband.net/petero2b/javachess/ChangeLog.txt).

0 commit comments

Comments
 (0)