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. Don't try `display vid:#pages#.pnm' as this will consume
18 truly stupendous quantities of RAM - it wedged my laptop.
20 * #master-newcommods#.txt #local-newcommods#.txt
22 Dictionary of newly introduced commodities. When a new commodity
23 appears in Puzzle Pirates, the PCTB server operators need to add it
24 to their database for us to be able to upload data about it.
26 It can sometimes take a few days to do this. In the meantime, it
27 is possible to upload partial data - data just omitting that
28 commodity. This is controlled by these files: they list
29 commodities which should be automatically ignored if the PCTB
30 server doesn't know about them. The master file is downloaded and
31 updated automatically from my server. You may create the local
32 file yourself. The format is simple: one commodity per line.
34 Unrecognised commodities can also be due to OCR failure so
35 double-check what you're doing before overriding the uploader by
36 telling it to ignore an unrecognised commodity.
38 * #master-reject#.txt #local-reject#.txt
40 Dictionary of regexps which, when the OCR appears to match, we
41 reject instead. At the moment this is used to stop us thinking
42 that `Butterfly weed' is `Butterflyweed'. This happens if the
43 character set dictionary is missing the lowercase `y ' glyph.
46 * #master-char*#.txt #local-char*#.txt
47 #master-pixmap#.txt #local-pixmap#.txt
49 Character set and image dictionaries. For the semantics of the
50 char* files README.charset. There is not currently any accurate
51 documentation of this dictionary format.
53 #master-*#.txt contain the centrally defined and approved data.
54 They are downloaded automatically from the SC PCTB server and
55 updated each run. You can safely delete this file, if everything
56 is online, if you want to fetch a fresh copy.
58 #local-*#.txt are a local copy of your submissions, so that they
59 will be used by your client pending approval by me. You can delete
60 this file if you think you may have made a mistake.
62 See README.privacy for details of the communications with the SC
63 server about the contents of these dictionaries.
67 Map from commodity names to the numbers required by the PCTB
68 server. This is fetched and updated automatically as necessary.
69 It can safely be deleted as it will then be refetched.
71 * #upload-1#.html #upload-2#.html
73 We screenscrape the pages from the PCTB upload server. The actual
74 HTML returned from the upload server is left in these dropping
75 files for debugging etc.
79 When any of these tools overwrite one of the persistent dictionary
80 files, they temporarily write to <file>.tmp.
82 Future versions may have more helpers and more data files.