CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/gamebooklib

Copyright (C) 2021 by Robert J Lee

This file may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3 of this license or (at your option) any later
version. The latest version of this license is in:


and version 1.3 or later is part of all distributions of
LaTeX version 2005/12/01 or later.

The gamebooklib package, provides a convenient set of macros to assist
the author choosing to develop a gamebook. In particular, it aims to
solve 2 non-trivial issues:

1) Writing a set of entries in order, then shuffling them in the
output routine, preserving reference links, and

2) Allowing LaTeX to output footnotes at the end of an entry, in the
case where another entry falls below the footnote mark on the page.

This package uses the standard TeX .dtx+.ins install mechanism,
although a UNIX Makefile is provided for convenience to generate all

The file "gamebooklib_test.tex" provides a simple demonstration of
this library.

The file "gamebooklib_countpagesperseed.sh" is a utility script using
bash, perl and pdflatex that will report on the number of pages for
your document, when entries are shuffled with different pseudorandom
seeds. This is useful if you have large objects such as graphics and
want to minimise needless white space. Further instructions are
provided in the header of that file.

It is suggested that the gamebooklib_countpagesperseed.sh utility
should be placed on the system path for ease of use, or into any
utility scripts directory.

Download the contents of this package in one zip archive (410.6k).

Gamebooklib – Macros for setting numbered entries in shuffled order

This package provides macros and environments to allow the user to typeset a series of cross-referenced, numbered “entries”, shuffled into random order, to produce an interactive novel or “gamebook”.

This allows entries to be written in natural order and shuffled automatically into a repeatable non-linear order.

Limited support is provided for footnotes to appear at the natural position: the end of each entry, or the end of each page, whichever is closest to the footnote mark.

This is unrelated to the gamebook package which is more concerned with the formatting of entries rather than their order. The two packages can be used together or separately.

Version1.4 2023-07-28
LicensesThe Project Public License 1.3
Copyright2021–2023 Robert J Lee
MaintainerRobert J Lee
Contained inTeX Live as gamebooklib
MiKTeX as gamebooklib
Guest Book Sitemap Contact Contact Author