oreolek/gamebookformat
1
0
Fork 0
mirror of https://github.com/Oreolek/gamebookformat.git synced 2024-06-16 15:10:45 +03:00
Code Issues Releases Wiki Activity

Some documentation about what checkgamebook.py will do.

Browse source
This commit is contained in:
Pelle Nilsson 2014-09-23 21:57:46 +02:00
parent bdd8eb2403
commit b98bc8456b
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
readme.org
View file

@ -84,6 +84,17 @@ to EPUB, so that should be a start. You probably want to
do some experimentation to find a way that creates results
you like.
** Check Gamebook
The included *checkgamebook.py* script can be used to run tests
on a book and warn about things that do not look right.
To use it first generate a *debug* output file version of
the book, using the same flags (eg include-tags) as when
formatting the real book. Then run *checkgamebook.py bookname.debug*.
(TODO: Currently does not really test anything. The idea
is that it should do things like trying to tell you about
sections that can not be reached, or items that are required
before they can possibly have been found.)
** Number Map Files
Whenever formatgamebook.py runs it looks for a file with the same
name as the output file, but with a .map suffix (eg output.map if
@ -102,7 +113,6 @@ what numbers were assigned to sections, if you need to
use the number of some section for something outside of
the gamebook itself.
** Gamebook Format
The input file expected by the formatgamebook.py script must be in a
format containing information about all sections in the book
plus some optional metadata. The format should (when TBD) be documented