oreolek/gamebookformat
1
0
Fork 0
mirror of https://github.com/Oreolek/gamebookformat.git synced 2024-05-24 11:58:13 +03:00
Code Issues Releases Wiki Activity

Some documentation for verbose checkgamebook.py.

Browse source
This commit is contained in:
Pelle Nilsson 2014-09-23 23:29:55 +02:00
parent f23bce59b1
commit 444bed78a9
2 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
readme.org
View file

@ -97,6 +97,11 @@ unlocked because it is impossible to find enough money to
pay for a key. Future versions will hopefully catch more
problems, but never all of them in complex books.
Run *checkgamebook.py -v* for verbose mode. Currently that just
means that all ending (death?) sections of the book are printed,
allowing you to manually check that there are no unexpected
dead-ends.
** 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

6
todo.org
View file

@ -1,4 +1,4 @@
* TODO [64/92] [69%]
* TODO [64/93] [68%]
** DONE Debug output
** DONE DOT output
** DONE LaTeX output
@ -181,3 +181,7 @@ listed even if it is not tagged.
or treat as any other missing section otherwise.
** TODO checkgamebook.py ignore dummy and fake sections
** TODO checkgamebook.py trace items to find sections they are needed but can not have been found
** TODO tag to generate checkgamebook.py warnings
Some tag that can be set on incomplete sections to trigger warnings
as a reminder that the book is not done yet, and show you what
sections remain to be written.