X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.main.git;a=blobdiff_plain;f=yarrg%2FREADME.files;h=daee35f94e4da17d332d4d0ac089ef12d8661b65;hp=87a90de5f51220110dab83e504caaeb54cf40bfb;hb=b6919a190cf9ce37ab245d1ec124320ffe49a969;hpb=c68fb80a6bbf7acbcac4b2cb2143f5fea745cd2b;ds=sidebyside diff --git a/yarrg/README.files b/yarrg/README.files index 87a90de..daee35f 100644 --- a/yarrg/README.files +++ b/yarrg/README.files @@ -21,21 +21,27 @@ The program reads and writes the following files: * _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 - to their database for us to be able to upload data about it. + appears in Puzzle Pirates, the YARRG and PCTB server operators each + need to add it to their database for us to be able to upload data + about it. It can sometimes take a few days to do this. In the meantime, it is possible to upload partial data - data just omitting that commodity. This is controlled by these files: they list - commodities which should be automatically ignored if the PCTB - server doesn't know about them. The master file is downloaded and - updated automatically from my server. You may create the local - file yourself. The format is simple: one commodity per line. + commodities which should be automatically ignored if the server + doesn't know about them. The master file is downloaded and updated + automatically from my server. You may create the local file + yourself. The format is simple: one commodity per line. Unrecognised commodities can also be due to OCR failure so double-check what you're doing before overriding the uploader by telling it to ignore an unrecognised commodity. + * _master-info*.txt _local-info.txt + + Database of valid commodities and islands/oceans for use when + uploading to YARRG. + * _master-reject.txt _local-reject.txt Dictionary of regexps which, when the OCR appears to match, we @@ -52,7 +58,7 @@ The program reads and writes the following files: documentation of this dictionary format. _master-*.txt contain the centrally defined and approved data. - They are downloaded automatically from the SC PCTB server and + They are downloaded automatically from the SC YARRG server and updated each run. You can safely delete these files, if everything is online, if you want to fetch a fresh copy. @@ -71,9 +77,9 @@ The program reads and writes the following files: * _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. + We HTML-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