Send parent variant with setup command
[fairymax.git] / README
1 This package contains the sources of the XBoard-compatible Chess and
2 Chess-variant engine Fairy-Max, and its dedicated derivatives ShaMax 
3 (for Shatranj) and MaxQi (for XiangQi = Chinese Chess). This version
4 of Fairy-Max is actually a derivative, patched to evaluate pair 
5 bonuses and regognize drawish end-games. To distinguish it from the 
6 regular version it is renamed 'Pair-o-Max' A Makefile
7 is provided to compile and install them. Normally this would require only
8 the command (given from the main directory of the package):
9
10 sudo make install
11
12 This will install the executables in /usr/games, (where XBoard expects
13 them), and their data files in /usr/share/games/fairymax.
14
15 Should you want to compile by hand, you could use the following 
16 commands:
17
18 gcc -O2 fairymax.c -o fairymax
19
20 gcc -O2 fairymax.c -DSHATRANJ -o shamax
21
22 gcc -O2 maxqi.c -o maxqi
23
24 In this case you will get versions that expect their fmax.ini or qmax.ini
25 files in the current direcory. To change the default path of the ini files,
26 you can include the argument 
27
28 -DINI_FILE=\"pathname\"
29
30 to the gcc compilation command line.
31
32
33 Pair-o-Max
34
35 The heuristic used for recognizing drawish end-games works as follows:
36 The evaluation score is divided by 2, 4, or 8 when the mating potential
37 of the leading site is already non-existent, or is in jeopardy because
38 the opponent can afford to sacrifice its cheapest piece for the only
39 remaining Pawn. Mating potential is considered non-existent if the
40 advantage in piece material is less than 350 cP ('one minor ahead'),
41 the leading side has at most two pieces, and the defending side at
42 most one (next to the Kings). The pair-bonus value can be used to
43 flag some exceptional conditions that fine tune this, by indicating
44 a 'minor' has mating potential, or minors that don't have mating
45 potential even in pairs, or a piece is color bound, and thus cannot
46 have mating potential on its own no matter how high its value.
47 Finally a minor can be marked as 'tough defender', meaning it can
48 hold out even against a Queen. As the Commoner is the only known
49 case of this, it also implies mating potential.
50
51 Without mating potential, a favorable score is divided by 8.
52 If no mating potential will remain after sacrificing the last Pawn
53 away, the score is divided by 4. In other cases having no Pawns
54 will reduce your lead by a factor 2, except against a bare King
55 (and perhaps some Pawns), where there is no discount.
56
57
58
59 H.G.Muller
60