Skip to content

A LaTeX plugin used to show the board and kifu (game record) of Shogi.

License

Notifications You must be signed in to change notification settings

RyuOhTeX/RyuOhTeX

Repository files navigation

RyuOhTeX LaTeX package

Quick Start

Good News!

This version of RyuOhTeX template has been uploaded to Overleaf Template library!
Please refer to the link below and use Overleaf.com to reduce your setup time on your Shogi documentation using RyuOhTeX.
Overleaf Template
Please be noted that registrations may be required if you do not have an Overleaf account.

Legacy way

Please download RyuOhTeX Template.zip to your computer and open your LaTeX compiler (or IDE) to compile the whole document, and you're good to go!

Include

\usepackage{RyuOhTeX}

Usage

Placing a Shogi Piece

\koma<column><row><piece command>

Taken Pieces (Mochigoma)

\mochigoma[<number of this piece>]<piece>

Please be noted that:

  • different pieces should be declared separately.
  • An upright piece command represents that this piece is captured by sente (black side).

Shogi Piece Commands

All Shogi Piece commands are named after a "CSA" way, which is a notation method proposed by Computer Shogi Association.

The general idea for naming piece is listed below:

  • All pieces is named in CSA notation method.
  • For ally (upright, black side) pieces, enter the command ALL CAPITALIZED. (e.g. \FU, \OU )
  • For opponent (reverted, white side) pieces, only the second character of the command is in lowercase. (e.g. \Ka, \Ry )

For more details for piece command, please refer to the PDF file.

Full Board

\shogiban{<shogi position>}

Section of a Board

\tsumeshogi{begin column}{end column}{begin row}{end row}{<shogi position>}

Displaying Kifus (Game Records)

For a single kifu with including rows and columns: (e.g. ☗7六步)

\siro<column><row><pieces><move suffixes(optional)>

For a kifu only contains kanjis: (e.g. ☖同銀)

\Siro<pieces><suffixes>

For black pieces, change the \siro and \Siro to \Kuro and \Kuro.

Graphicalize Pieces

\shogiban{\gazouka<shogi pieces>}

Reverted Game Boards

\gyakuban{<shogi pieces>}

Please be noted that the coordinate system has been reverted in this environment.