fairymax.pod

   1 =head1 NAME
   2
   3 fairymax - xboard-compatible chess and chess-variant engine 'Fairy-Max'
   4
   5
   6 =head1 SYNOPSIS
   7
   8 B<fairymax> [hashSize] [iniFile]
   9
  10 B<shamax> [hashSize] [iniFile]
  11
  12 B<maxqi> [hashSize] [iniFile]
  13
  14
  15 =head1 DESCRIPTION
  16
  17 B<fairymax> is a program that plays chess and chess variants.
  18 It uses the xboard/winboard chess-engine protocol to communicate.
  19 Apart from 'regular' chess (also known as the Mad-Queen variant),
  20 it can play Capablanca chess, gothic chess, knightmate, cylinder chess,
  21 berolina chess, superchess, makruk (Thai chess) and courier chess.
  22 Fairy-Max can be easily configured by the user to play other variants as well,
  23 by modifying the ini file.
  24 This ini file describes the rules of movement
  25 of the participating pieces and the initial board setup.
  26
  27 Fairy-Max can also play shatranj,
  28 but in this case is not aware of the shatranj rule that a bare king loses.
  29 So it might play sub-optimally in the late end-game.
  30 A version of Fairy-Max adapted to implement the baring rule is
  31 available under the name B<shamax>.
  32
  33 Similarly, a version of Fairy-Max adapted to play Xiang Qi (Chinese Chess)
  34 is included in the fmax package as well.
  35
  36 B<fairymax> is a derivative of the world's (once) smallest chess program
  37 (source-code wise), micro-Max.
  38 The latter measures less that 2000 characters, (about 100 code lines),
  39 and has a computer rating of around 2050 on the CCRL rating list.
  40 Although this is about 1000 rating points behind the world champion,
  41 micro-Max still makes a quite tough opponent even for club players,
  42 although it is not unbeatable.
  43
  44 The main difference between micro-Max and Fairy-Max is that the latter loads
  45 its move-generator tables, which specify how the various pieces move,
  46 from an external file, so it can be easily adapted to incorporate un-orthodox pieces.
  47 For ease of use of the artificial-intelligence, Fairy-Max is equipped with
  48 I/O routines that allow it to run with the xboard graphical user interface.
  49
  50 See xboard(6) for instructions about how to use B<fairymax> through xboard. To
  51 start up quickly, you just need the command: B<xboard -fcp fairymax>.
  52 However, XBoard might not support symbols for every unorthodox piece in board sizes
  53 different from B<bulky>, B<middling> and B<petite>.
  54 It might thius be adviasable to specify a board size as well, e.g.
  55 B<xboard -fcp shamax -boardSize middling -variant shatranj>
  56 to get correct display of the elephant and general pieces in shatranj.
  57 Note that to be able to play the chess variants,
  58 you will need xboard 4.3.14 or later.
  59
  60 Fairymax supports multi-PV mode: by specifying a non-zero multi-PV margin in the
  61 Options -> Engine-Settings dialog of XBoard, Fairy-Max will not only print the
  62 principal variation for the best move, but also for every move that approaches
  63 the score of this best move to within the set margin.
  64 (If it does not find the best move on the first try, this might lead to printing
  65 of a few extra lines below the threshold.)
  66
  67 The fmax.ini file from which Fairy-Max by default takes the piece and game definitions
  68 is a self-documenting text file,
  69 which contains instructions for how to define new pieces and chess variants.
  70 In addition it contains an extensive list of pre-defined pieces,
  71 incuding many not occurring in any of the pre-defined variants,
  72 which the user can draw on to define his own variants.
  73
  74 Amongst the move types supported by Fairy-Max are normal leaper and slider moves,
  75 (e.g. knight and rook),
  76 divergent moves (i.e. capture and non-capture moves can be different)
  77 hoppers (which jump over other pieces, such as the Chinese cannon or the grasshopper),
  78 lame leapers (the move of which can be blocked on squares they cannot move to,
  79 such as the Chinese horse and elephant),
  80 and any combination thereof,
  81 in every possible direction.
  82 The board width is configurable upto a width of 14 squares,
  83 and cylindrical boards (where left and right edge connect) are supported as well.
  84
  85 =head1 OPTIONS
  86
  87 =over 8
  88
  89 =item B<hashSize>
  90
  91 If the first argument to fairymax is numeric,
  92 it is taken as an indicator for the amount of memory Fairy-Max is allowed to use
  93 for its internal hash table.
  94 The default value for this argument, 22, would result in a memory usage of 48MB.
  95 Each next-higher number doubles the memory usage, each next-lower halves it.
  96 Running with less than 6MB (i.e. argument 19) is not recommended.
  97 When fairymax is running under xboard 4.3.15 the hash-table size can be set
  98 through the xboard menus,
  99 making this argument superfluous.
 100
 101 =item B<iniFile>
 102
 103 A second or non-numeric first argument is taken as a filename.
 104 Fairy-max will use the mentioned file in stead of its default fmax.ini file
 105 to define the movement of pieces and initial setup of the variants.
 106 This makes it easier to define your own variants.
 107
 108 =back
 109
 110
 111 =head1 SEE ALSO
 112
 113 xboard(6)
 114
 115 http://www.chessvariants.org/index/msdisplay.php?itemid=MSfairy-max
 116
 117 http://home.hccnet.nl/h.g.muller/max-src2.html
 118
 119 http://www.open-aurec.com/wbforum/viewtopic.php?t=49439
 120
 121
 122 =head1 AUTHOR
 123
 124 B<Fairy-Max> was written by H.G.Muller <h.g.muller@hccnet.nl>.
 125
 126 This manual page was generated with pod2man(1).