README

   1 Sloppy is a free chess engine
   2 Copyright (C) 2007 - 2009 Ilari Pihlajisto (ilari.pihlajisto@mbnet.fi)
   3
   4
   5 LICENSE AND WARRANTY
   6
   7    Sloppy is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    Sloppy is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21 COMPILING
  22
  23    In UNIX/Linux systems just type "make" to compile Sloppy. There is no
  24    "make install" though, so if you want to install Sloppy to an other
  25    directory you'll need to copy the executable and the opening book (if any)
  26    to said directory.
  27
  28    The Windows version compiles at least with Mingw and Microsoft's Visual C++
  29    compiler. Makefiles for both are included (Makefile.mgw and Makefile.win).
  30
  31
  32 INTERFACE, COMMAND LINE OPTIONS
  33
  34    Sloppy uses the Xboard chess engine communication protocol. So if you want to
  35    use a GUI (you probably do), make sure it implements Xboard protocol 2. If
  36    it only supports UCI, you can still use Sloppy with the wb2uci adapter:
  37    http://home.online.no/~malin/sjakk/Wb2Uci/
  38
  39    Sloppy doesn't accept any command line options, see configuration below.
  40
  41
  42 CONFIGURATION
  43
  44    Sloppy is configured by editing the configuration file ("sloppy.conf").
  45
  46    On Windows systems the configuration file should be placed to the same
  47    directory where the executable is.
  48
  49    On non-Windows systems the configuration file should be placed to
  50    $HOME/.config/sloppy/ directory.
  51
  52
  53 ASCII INTERFACE COMMANDS
  54
  55    In addition to all Xboard input, Sloppy accepts these commands:
  56
  57    bench                 runs Sloppy's own benchmark
  58    debug                 toggles debugging mode
  59    divide [d]            perft to depth [d], prints a node count for every move
  60    help                  shows this list
  61    perft [d]             runs the perft test to depth [d]
  62    printboard            prints an ASCII chess board and the FEN string
  63    printeval             prints the static evaluation
  64    printkey              prints the hash key
  65    printmat              prints the material each player has on the board
  66    printmoves            prints a list of legal moves
  67    quit                  quits the program
  68    readpgn [f]           imports pgn file [f] to the book
  69    readpgnlist [f]       imports a list of pgn files (in file [f]) to the book
  70    testpos [sec] [fen]   runs a test position (eg. WAC, WCSAC)
  71    testsee [fen] [move]  tests the Static Exchange Evaluator
  72    testsuite [sec] [f]   runs a list of test positions (in file [f])
  73    xboard                switches to Xboard/Winboard mode
  74