https://github.com/hartwork/xiangqi-book-example

Example of a book featuring print-quality Xiangqi board setup graphics generated on-the-fly using xiangqi-setup; PDF output download at https://github.com/hartwork/xiangqi-book-example/releases/download/1.0.0/book_1_0_0.pdf
https://github.com/hartwork/xiangqi-book-example

boardgames book chinese-chess print wxf xiangqi xiangqi-setup

Last synced: 9 days ago
JSON representation

Example of a book featuring print-quality Xiangqi board setup graphics generated on-the-fly using xiangqi-setup; PDF output download at https://github.com/hartwork/xiangqi-book-example/releases/download/1.0.0/book_1_0_0.pdf

• Host: GitHub
• URL: https://github.com/hartwork/xiangqi-book-example
• Owner: hartwork
• Created: 2020-12-20T19:34:00.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-21T01:34:29.000Z (about 4 years ago)
• Last Synced: 2024-12-16T06:12:04.660Z (about 1 month ago)
• Topics: boardgames, book, chinese-chess, print, wxf, xiangqi, xiangqi-setup
• Language: TeX
• Homepage:
• Size: 2.93 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-xiangqi - xiangqi-book-example - LaTeX template to write text about xiangqi, using `xiangqi-setup` to generate board images from FEN notation. (Other useful tools / Games collections)

README

        
# About

This repository intends to demo creation of a book

featuring razor-sharp Xiangqi board setups

based on

LaTeX,

[xiangqi-setup](https://github.com/hartwork/xiangqi-setup),

and (a subset of) [FEN notation](http://wxf.ca/xq/computer/fen.pdf).

For details please see:

- [`GNUmakefile`](GNUmakefile)

- [`book.tex`](book.tex)

- `setups/`

    - [`default.wxf`](setups/default.wxf)

    - [`demo.wxf`](setups/demo.wxf)

# Build-time Requirements

- GNU make

- Python >=3.6

- Inkscape

- LaTeX

# How to Build

```console

# make

[..]

# okular book.pdf &

```

# FEN Notation

Example FEN, the default starting position:

> `rheakaehr/9/1c5c1/p1p1p1p1p/9/9/P1P1P1P1P/1C5C1/9/RHEAKAEHR w`

With regard to FEN notation, the syntax rules are:

- *Lowercase* letters indicate pieces of

  the *black* (or *blue*) party (with their palace at the top of the board),

  *uppercase* letters indicate pieces of

  the *red* (or *white*) party (with their palace at the bottom of the board).

- The pieces are:

    - `a`/`A` — advisor

    - `c`/`C` — cannon

    - `e`/`E`/`b`/`B` — elephant

    - `h`/`H`/`n`/`N` — horse

    - `k`/`K` — king

    - `p`/`P` — pawn

    - `r`/`R` — rook

- Digits `1` (one) to `9` (nine) is the number of consecutive empty fields in a row.

- A `/` (slash or solidus) starts a new row.

- Suffix ` w` or ` b` indicates that

  *red* (or *white*) is to move or that *black* (or *blue*) is to move,

  respectively.

This is effectively the first two fields described at http://wxf.ca/xq/computer/fen.pdf

plus the alternative letters used at https://www.chessdb.cn/query_en/ .