X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.main.git;a=blobdiff_plain;f=pctb%2FREADME.files;h=b2384a1125b572defc47823dfa6eab3a3b550748;hp=254217a6d58e6200b0fb8007d781c451ad076332;hb=124bfe502b5841d6d05f3f7e9fc825f918d3109d;hpb=a08a94640f4f0c02c536f337630dd234e917121f diff --git a/pctb/README.files b/pctb/README.files index 254217a..b2384a1 100644 --- a/pctb/README.files +++ b/pctb/README.files @@ -3,7 +3,7 @@ Files we use and update 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 @@ -14,10 +14,10 @@ The program reads and writes the following files: 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 @@ -35,7 +35,7 @@ The program reads and writes the following files: 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 @@ -43,41 +43,41 @@ The program reads and writes the following files: 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. - * .tmp + * _.tmp When any of these tools overwrite one of the persistent dictionary - files, they temporarily write to .tmp. We also use a couple + files, they temporarily write to _.tmp. We also use a couple of other temporary files. Future versions may have more helpers and more data files.