1 Files we use and update
2 -----------------------
4 The program reads and writes the following files:
8 Contains one or more images (as raw ppms, end-to-end) which are the
9 screenshots taken in the last run. This is (over)written whenever
10 we take screenshots from the YPP client. You can reprocess an
11 existing set of screenshots with the --same (aka --analyse-only)
12 option; in that case we just read the screenshots file.
14 You can specify a different file with --screenshot-file.
16 If you want to display the contents of this file, `display' can do
17 it, although you may have to uncompress it first. Don't try
18 `display vid:_pages.ppm' as this will consume truly stupendous
19 quantities of RAM - it wedged my laptop.
21 * _master-newcommods.txt _local-newcommods.txt
23 Dictionary of newly introduced commodities. When a new commodity
24 appears in Puzzle Pirates, the PCTB server operators need to add it
25 to their database for us to be able to upload data about it.
27 It can sometimes take a few days to do this. In the meantime, it
28 is possible to upload partial data - data just omitting that
29 commodity. This is controlled by these files: they list
30 commodities which should be automatically ignored if the PCTB
31 server doesn't know about them. The master file is downloaded and
32 updated automatically from my server. You may create the local
33 file yourself. The format is simple: one commodity per line.
35 Unrecognised commodities can also be due to OCR failure so
36 double-check what you're doing before overriding the uploader by
37 telling it to ignore an unrecognised commodity.
39 * _master-reject.txt _local-reject.txt
41 Dictionary of regexps which, when the OCR appears to match, we
42 reject instead. At the moment this is used to stop us thinking
43 that `Butterfly weed' is `Butterflyweed'. This happens if the
44 character set dictionary is missing the lowercase `y ' glyph.
47 * _master-char*.txt _local-char*.txt
48 _master-pixmap.txt.gz _local-pixmap.txt
50 Character set and image dictionaries. For the semantics of the
51 char* files README.charset. There is not currently any accurate
52 documentation of this dictionary format.
54 _master-*.txt contain the centrally defined and approved data.
55 They are downloaded automatically from the SC PCTB server and
56 updated each run. You can safely delete these files, if everything
57 is online, if you want to fetch a fresh copy.
59 _local-*.txt are a local copy of your submissions, so that they
60 will be used by your client pending approval by me. You can delete
61 this file if you think you may have made a mistake.
63 See README.privacy for details of the communications with the SC
64 server about the contents of these dictionaries.
68 Map from commodity names to the numbers required by the PCTB
69 server. This is fetched and updated automatically as necessary.
70 It can safely be deleted as it will then be refetched.
72 * _upload-1.html _upload-2.html _upload-3.html
74 We screenscrape the pages from the PCTB upload server. The actual
75 HTML returned from the upload server is left in these dropping
76 files for debugging etc.
80 When any of these tools overwrite one of the persistent dictionary
81 files, they temporarily write to _<file>.tmp. We also use a couple
82 of other temporary files.
84 Future versions may have more helpers and more data files.