# texlive-game-xiangqi

**Repository Path**: careone/texlive-game-xiangqi

## Basic Information

- **Project Name**: texlive-game-xiangqi
- **Description**: Tex/Latex micro package, modified from xq.sty. You can make Tex/Latex files to native Xiangqi (Chinese chess) position pictures in PDF.
- **Primary Language**: TeX/LaTeX
- **License**: LPPL-1.3c
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-05-12
- **Last Updated**: 2021-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# texlive-game-xiangqi

#### 介绍
TeX/LaTeX micro package, modified from xq.sty. You can make TeX/LaTeX files to native Xiangqi (Chinese chess) position pictures in PDF.

在debian上用tex画中国象棋棋盘和棋子布局图。

* 2019-12-02, v0.4-5, updated by Careone <emacslocale@126.com>
* 2020-05-14, v0.4-6, updated by Careone

  ===============

目前主要有3个宏包可以实现：cchess, xq 和 xiangqi (即 xq 宏包的修改版)。

## 宏包1. cchess （不推荐使用）

主要缺点：棋子汉字图片稍微有点丑。

其它说明：大写字母代表黑方，小写字母代表红方。另外，仕/士是用字母 g （红仕）/G (黑士)来表示的。
其它的六种棋子，与 PGN 棋谱文件中的定义基本相同，即：

 ----
r/R: 红车/黑车
n/N: 马
...
b/B: 相/象
k/K: 帅/将
c/C: 炮
p/P: 兵/卒
 ----


#### 用法：
\documentclass{article}
\usepackage{cchess} 

cchess 宏包在 1997-06-16，由维护者 Frank Mit­tel­bach
和 Jac­ques Richer 发布。
下载地址：
https://ctan.org/tex-archive/macros/latex/contrib/cchess
http://mirrors.ctan.org/macros/latex/contrib/cchess.zip
压缩包大小：14.6 k

压缩包中，包含5个文件：
 ----------
cchess46.mf
cchess46.tfm
cchessboard.tex
cchess.sty
ccpieces.mf
 ----------

### 文件路径说明：

* cchess.sty 和 cchessboard.tex 这两个文件，需要放在
/usr/share/texmf/tex/latex/cchess/ 目录下；

* 2个 .mf 格式的是原始字体文件，需要放在
/usr/share/texmf/fonts/source/cchess/ 目录下；

* cchess46.tfm 是编译过的字体文件，需要放在
/usr/share/texmf/fonts/tfm/cchess/ 目录下。

### 用法说明：

按照样例文件，新建一个 test1.tex 文件。
运行命令 xelatex test1.tex 即可编译生成 test1.pdf 文件。

文件 test1.tex 内容示例：
----------
\documentclass{article}
\usepackage{cchess}
\begin{document}

\normalsize 15
%% cchess package: https://ctan.org/tex-archive/macros/latex/contrib/cchess/
%% 

\normalboard
\begin{position}
\piece{a}{1}{r} \piece{i}{1}{r}
\piece{b}{1}{n} \piece{h}{1}{n}
\piece{c}{1}{b} \piece{g}{1}{b}
\piece{d}{1}{g} \piece{f}{1}{g}
\piece{e}{5}{c} \piece{e}{7}{c}
\piece{a}{4}{p} \piece{c}{4}{p}
\piece{e}{4}{p} \piece{g}{4}{p}
\piece{i}{4}{p} \piece{e}{1}{k}
\piece{a}{9}{R} \piece{i}{10}{R}
\piece{a}{8}{N} \piece{g}{8}{N}
\piece{c}{10}{B} \piece{g}{10}{B}
\piece{d}{10}{G} \piece{f}{10}{G}
\piece{b}{8}{C} \piece{h}{8}{C}
\piece{a}{7}{P} \piece{c}{7}{P}
\piece{g}{7}{P}
\piece{i}{7}{P} \piece{e}{10}{K}
\end{position}
\end{document}
----------

* 重要提示：
   ==========
1. 不要运行命令 pdflatex test1.tex
这样生成的图片，棋子是透明的，底下能看到棋盘十字格线，看起来会眼花。见附图。

2. 如果编译 tex 到 pdf 时, 提示 grep cchess46.log 失败之类的提示，是因为上面的 .mf 
和 .tmf 字体文件没有放到对应的目录下。请按上面的方法，确认文件是否已经放在对应的目录下。

 =============================

## 宏包2：xq（图片质量较好。但国际象棋式的坐标显示方式，不符合中国象棋习惯）

用法：
\documentclass[twocolumn,11pt]{article}
\usepackage{xq} 

xq 宏包，最初于 2006-6-29 发布。当前版本为 0.4, 2014-9-20 发布。
当前维护者是 Se­bas­tian Pip­ping (in­ac­tive) 和 Stephan Wein­hold (in­ac­tive)。
下载地址: https://ctan.org/pkg/xq
https://mirror.bjtu.edu.cn/CTAN/fonts/xq.zip
压缩包大小：337.6 k

压缩包文件清单：

 ---------------
bugs-0-3.pdf
bugs-0-3.tex
ChangeLog
Makefile
README
xqaddsignsbase.mf
xqaddsignslarge.mf
xqaddsignsnormal.mf
xqbase.mf
xqexample.pdf
xqexample.tex
xqhints.mf
xqlarge.mf
xqnormal.mf
xq.sty
xqwestbase.mf
xqwestlarge.mf
xqwestnormal.mf
 ---------------

#### 文件说明

* 文件 xq.sty 需要放在 /usr/share/texmf/tex/latex/xq/ 目录下；

* 再把 .mf 格式的原始字体文件，放在 /usr/share/texmf/fonts/source/xq/ 目录下；

* xqexample.tex 是示例文件；
* xqexample.pdf 是编译好的 PDF 文件。
 
#### 技术细节

1. 在 xq 0.4 版本中，几种棋子的定义规则：
	大写字母为红方棋子，小写为黑方棋子。
	其中，马改用  H/h (Horse), 相/象 改用 E/e (大象)。
	A/a 分别代表 红仕/黑士。
	其它棋子与 FEN 棋谱文件定义规则相同。

2. 只要 tex 文件内容不包含中文，不管用 pdflatex（速度较快）, 还是 xelatex (速度稍慢)，
都能正常编译生成 PDF 文件。
如果 tex 文件内容包含中文，推荐使用 xelatex 命令进行编译。

## 宏包3：xiangqi（推荐）

用法：
%\documentclass[twocolumn,11pt]{article}
\usepackage{xiangqi} 

在宏包 xq 0.4 版本的基础上，做了一些调整，更符合中国象棋棋盘显示风格。

#### 针对宏包 xq 的修改：

* 去除国际象棋风格的棋格坐标字母和数字，包括：
	棋盘底部的字母 a-g, 棋盘左右两侧的数字0-9。

* 在棋盘上方，添加一排阿拉伯数字：1-9（从左到右）；在棋盘下方，添加一排中文数字：九到一（从左到右）。

* 语法和调用方式，完全沿用并依赖宏包 xq。详见
 /usr/share/doc/texlive-doc/fonts/xq/ 目录下的文档和示例文件。