Add variants Cashew and Macadamia Shogi
[hachu.git] / hachu.pod
1 =head1 NAME
2
3 hachu - xboard-compatible engine for Chu Shogi and other variants
4
5
6 =head1 SYNOPSIS
7
8 B<hachu>
9
10
11 =head1 DESCRIPTION
12
13 B<hachu> is a program that plays several shogi and chess variants,
14 currently sho shogi, chu shogi, dai shogi, makruk and shatranj.
15 In the future it might play more, and still larger shogi variants,
16 in particular tenjiku shogi.
17
18 HaChu uses the xboard/winboard chess-engine protocol to communicate.
19 It thus can use XBoard as a graphical interface for the variants also supported by the latter.
20 Only XBoard 4.8 and later support chu shogi,
21 but sho shogi should already work under XBoard 4.7,
22 and Makruk and Shatranj under much older versions.
23 Dai shogi is not supported by XBoard yet.
24
25 See xboard(6) for instructions about how to use B<hachu> through xboard.
26 To start up quickly, you just need the command: B<xboard -fcp hachu>.
27 You can then use XBoard's New Variant dialog to select the variant you want to play.
28 To play chu shogi, it is essential that XBoard's 'show target squares' option is switched on;
29 otherwise the two-step lion moves can not be entered.
30
31 Normally XBoard will use western-style chess symbols to represent the pieces.
32 But HaChu comes with a set of piece images in the shape of the Japenese kanji
33 for the names of the chu-shogi pieces.
34 These can be used in XBoard to get an oriental-style board display.
35 A settings file for configuring XBoard to use these pieces is also included with HaChu,
36 so that you can use the command B<xboard @chu> to start XBoard with HaChu for oriental-style chu-shogi.
37
38 =head1 OPTIONS
39
40 =over 8
41
42 =item B<INTERACTIVE OPTIONS>
43
44 HaChu supports some options that can only be set interactively,
45 though XBoard's engine settings menu dialog.
46 These include an option for solving tsume problems
47 (checkmate problems where the winning side is only allowed to play checking moves).
48 There are also options to adapt it to various versions of the chu-shogi rules:
49 whether you can only promote on entering the promotion zone,
50 or whether moves inside or out of the zone (after one move delay) can also be used for promotion,
51 and whether repeats should be strictly forbidden, or only avoided like other losing moves.
52
53
54
55 =back
56
57 =head1 AVAILABILITY
58
59 At http://hgm.nubati.net/cgi-bin/gitweb.cgi the source code can be obtained.
60
61 =head1 SEE ALSO
62
63 xboard(6)
64
65 game rules: http://hgm.nubati.net/rules
66
67 XBoard: http://hgm.nubati.net
68
69 =head1 STANDARDS
70
71 WinBoard, B<xboard>(6) interface ("Chess Engine Communication Protocol")
72
73 =head1 AUTHOR
74
75 H.G.Muller <h.g.muller@hccnet.nl>.
76
77 This manual page was generated with pod2man(1).