README.en.md

Sunfish

Sunfish is computer Shogi(Jpanese Chess) program. This is 4th version of Sunfish.

Older Versions

• Sunfish
  • 2008 ~ 2012
  • Participated in WCSC(World Computer Shogi Championship)2011 and WCSC2012.
  • Rookie Award in WCSC2012
• Sunfish2
  • 2012 ~ 2013
  • Participated in WCSC2013
• Sunfish3
  • 2014 ~ 2015
  • Participated in WCSC2015

Releases

https://github.com/sunfish-shogi/sunfish4/releases

Usage

Download latest version from Releases.

And register sunfish_usi.exe to GUI Shogi application (e.g. Shogidokoro, Shogi GUI, ShogiBrowserQ).

Build

Requirements

• CMake
• C++ Compiler(GCC4.9/Clang/MSVC2013)

GNU Make

make TARGET

Xcode

mkdir -p out/xcode_test
cd out/xcode_test
cmake -G Xcode ../../src/test

Visual Studio

See CMake projects in Visual Studio and setup CMake into Visual Studio, and open a folder containing CMakeSettings.txt. For example, if you want to build USI, open src/usi .

Build Targets

CSA Client

This is a client program of CSA network protocol. See "CSA network Protocol".

make csa
vi config/csa.ini
./sunfish_csa

USI Engine

USI(Universal Shogi Interface) is a protocol used for communication between Shogi engine and GUI application. See "About USI Protocol".

Build src/usi. If you use make, execute with usi target as follows:

make usi

# debugging mode
#make usi-debug

Register sunfish_usi.exe or sunfish_usi into the GUI application.

Unit Tests

make test

Experiments

make expt
./sunfish_expt --help

Profiling

make prof

Benchmark Tests

make bm
./sunfish_bm

Machine Learning

make ln
vi config/batch_learn.ini
./sunfish_ln

Development Tool

make dev
./sunfish_dev --help

License

MIT License