owenrees 548f98f303 feat: add public Pgn_to_tex entry point
Move parsing and rendering internals into the private
pgn_to_tex_internal library and rename pgn2tex to converter. Expose only
Pgn_to_tex with default to_tex arguments, abstract diagram_data,
empty_diagrams, and parse_diagrams_json. Update tests, JS bridge, and
README to the new names.
2026-10-23 16:38:24 +02:00
2026-05-28 09:16:15 +02:00
2026-05-28 12:35:03 +02:00
2026-10-18 20:06:43 +02:00
2026-05-28 12:35:03 +02:00
2026-10-18 20:06:43 +02:00
2026-05-28 12:35:03 +02:00

Pgn to Tex

Install

  • Install the Opam package with: opam install pgn_to_tex
  • Reference pgn_to_tex in the libraries stanza in the relevant dune file

Usage

open Pgn_to_tex

let diagrams_json_stringified =
  {| [
       {"ply":1,"fen":"rnbqkbnr/pppppppp/8/8/3P4/8/PPP1PPPP/RNBQKBNR b KQkq - 0 1","path":["d4"]},
       {"ply":2,"fen":"rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 2","path":["d4","d5"]},
       {"ply":4,"fen":"rnbqkbnr/ppp1pppp/3p4/8/3PP3/8/PPP2PPP/RNBQKBNR b KQkq - 0 3","path":["d4","d5","e4","d6"]}
     ] |}

let diagram_data = parse_diagrams_json diagrams_json_stringified

let game_tex = to_tex ~diagram_data ~clock:false pgn

This will return a LaTex markdown representation of the PGN file along with chess board diagrams at the specified ply. Clock times can be rendered for both sides if you pass ~clock:true to the to_tex function.

Each diagram is placed at the position identified by its path — the SAN move sequence from the start of the game (e.g. ["d4","d5","e4","d6"]). path uniquely identifies positions in both the mainline and in variations, and diagrams inside a variation are rendered inline within that variation. The legacy ply field is still accepted and used as a fallback for mainline diagrams when path is omitted.

Variation diagrams are rendered at a slightly smaller size (smallboard) so they don't dominate the subline. Clock times can be rendered for both sides by passing ~clock:true to to_tex.

Latex preample and document setup markdown is not included in the output. You will need to add something similar to below around the game_tex output to create a valid document:

\begin{document}
\begin{multicols}{2}
game_tex goes here
\end{multicols}
\end{document}

Compile a JavaScript version of the library

With the library installed, you can compile the code to JavaScript by running:

make build

This will generate the JavaScript file at _build/default/bin/main.bc.js

This JavaScript file is minified and in CJS format, working in both Node and in the browser.

A single function to_tex is exposed, accepting the same arguments as the main library.

Dependencies

  • dune
  • sedlex
  • menhir
  • yojson
  • js_of_ocaml-compiler
  • ocamlformat
  • ocaml-lsp-server
  • ounit2
S
Description
A chess PGN to Tex conversion tool
Readme AGPL-3.0
239 KiB
Languages
OCaml 96.3%
Dune 1.6%
JavaScript 1.4%
Makefile 0.7%