The program reads and writes the following files:
- * #pages#.pnm
+ * _pages.ppm
Contains one or more images (as raw ppms, end-to-end) which are the
screenshots taken in the last run. This is (over)written whenever
You can specify a different file with --screenshot-file.
If you want to display the contents of this file, `display' can do
- it. Don't try `display vid:#pages#.pnm' as this will consume
+ it. Don't try `display vid:_pages.ppm' as this will consume
truly stupendous quantities of RAM - it wedged my laptop.
- * #master-newcommods#.txt #local-newcommods#.txt
+ * _master-newcommods.txt _local-newcommods.txt
Dictionary of newly introduced commodities. When a new commodity
appears in Puzzle Pirates, the PCTB server operators need to add it
double-check what you're doing before overriding the uploader by
telling it to ignore an unrecognised commodity.
- * #master-reject#.txt #local-reject#.txt
+ * _master-reject.txt _local-reject.txt
Dictionary of regexps which, when the OCR appears to match, we
reject instead. At the moment this is used to stop us thinking
character set dictionary is missing the lowercase `y ' glyph.
See README.charset.
- * #master-char*#.txt #local-char*#.txt
- #master-pixmap#.txt #local-pixmap#.txt
+ * _master-char*.txt _local-char*.txt
+ _master-pixmap.txt _local-pixmap.txt
Character set and image dictionaries. For the semantics of the
char* files README.charset. There is not currently any accurate
documentation of this dictionary format.
- #master-*#.txt contain the centrally defined and approved data.
+ _master-*.txt contain the centrally defined and approved data.
They are downloaded automatically from the SC PCTB server and
updated each run. You can safely delete this file, if everything
is online, if you want to fetch a fresh copy.
- #local-*#.txt are a local copy of your submissions, so that they
+ _local-*.txt are a local copy of your submissions, so that they
will be used by your client pending approval by me. You can delete
this file if you think you may have made a mistake.
See README.privacy for details of the communications with the SC
server about the contents of these dictionaries.
- * #commodmap#.tsv
+ * _commodmap.tsv
Map from commodity names to the numbers required by the PCTB
server. This is fetched and updated automatically as necessary.
It can safely be deleted as it will then be refetched.
- * #upload-1#.html #upload-2#.html
+ * _upload-1.html _upload-2.html _upload-3.html
We screenscrape the pages from the PCTB upload server. The actual
HTML returned from the upload server is left in these dropping
files for debugging etc.
- * <file>.tmp
+ * _<file>.tmp
When any of these tools overwrite one of the persistent dictionary
- files, they temporarily write to <file>.tmp. We also use a couple
+ files, they temporarily write to _<file>.tmp. We also use a couple
of other temporary files.
Future versions may have more helpers and more data files.
~yarrgweb / ypp-sc-tools.main.git / blobdiff