X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=yarrg%2FREADME;h=82301b20204a9d09bb7305ac726400aa5e30fab5;hb=a5147853c87706b66cd8b41ff8fd09c76270d844;hp=8379208a4e7319ef1e0c7481c8c4751405040439;hpb=03d4218e5ced913f70a1fd9308edbd8f9615703c;p=ypp-sc-tools.web-live.git diff --git a/yarrg/README b/yarrg/README index 8379208..82301b2 100644 --- a/yarrg/README +++ b/yarrg/README @@ -1,18 +1,22 @@ +YARRG - Yet Another Revenue Research Gatherer +============================================= + Overview -------- This tool can: - screenscrape the commodities trading screen - produce the results as a tab separated values file - - upload the results to PCTB + - upload the results to the YARRG and PCTB servers To build, install the dependencies, cd to this directory and type `make'. -To screenscrape and upload to the PCTB server, select `trade +To screenscrape and upload to both servers, select `trade commodities' from the hold of a vessel or building, and run: ./ypp-commodities -Currently we use pctb.ilk.org, the testing instance of the PCTB -database, pending approval from the operators of the main server. +Currently we upload to the dedicated yarrg server yarrg.chiark.net, +and also to pctb.ilk.org (the testing instance of the PCTB database, +pending approval from the operators of the main server). Or, for example, for a tab-separated values dump: ./ypp-commodities --tsv >commods.tsv @@ -46,7 +50,7 @@ Options to vary the processing: the real live ones (doesn't affect explicit settings). Controlling what happens to the results - only one at a time: - --upload (default) Upload to the PCTB server + --upload (default) Upload to the YARRG and PCTB servers --tsv Print data as clean tab-separated-values file --raw-tsv Dump the raw (not deduped, unsorted) OCR'd data --best-prices Print best buy and sell price for each commodity @@ -60,10 +64,11 @@ Privacy options, which control conversations with the dictionary server: Please do not use options marked * with --upload. See README.privacy. Options to override which servers we talk to: - --pctb-server HOST|URL Talk to the PCTB server at HOST or URL. + --yarrg-server HOST|URL When uploading to YARRG, use HOST or URL. + --pctb-server HOST|URL Talk to the PCTB database at HOST or URL. --dict-submit-url URL Submit dictionary entries with HTTP POST under URL. --dict-update-from SRC Fetch updated master dictionary with rsync from SRC. -Or set the environment variables YPPSC_PCTB{_PCTB, _DICT_UPDATE, _DICT_SUBMIT} +Or set the environment variables YPPSC_YARRG{_PCTB, _DICT_UPDATE, _DICT_SUBMIT} Installation requirements @@ -126,12 +131,12 @@ hopefully. Privacy ------- -The main purpose of this program is to connect to the PCTB server and -upload data. It will do that if you run it with --upload. +The main purpose of this program is to connect to the YARRG and PCTB +servers and upload data. It will do that if you run it with --upload. This program will also, by default, talk to the dictionary server I have set up: to download updated image dictionaries, and to upload new -dictionary entries which you create with the PCTB client dictionary +dictionary entries which you create with the yarrg client dictionary GUI. This feature is mentioned in and controllable in the GUI itself, so it won't happen without you knowing about it. @@ -145,15 +150,21 @@ See README.privacy for full details. Authorship and copyright ------------------------ -The PCTB server itself is a project of Joel Lord and various others. +The PCTB server is a project of Joel Lord and various others. + +The YARRG server was inspired by PCTB and is a project of the crew +Special Circumstances (on the Midnight Ocean) and of the Sinister +Greenend Organisation. -However, this screenscraper and upload client was written entirely -from scratch by me, Ian Jackson. It is part of ypp-sc-tools, a set of -third-party tools for assisting players of Yohoho Puzzle Pirates. +This yarrg screenscraper and upload client was written entirely from +scratch by me, Ian Jackson, with assistance from Stephen Early. It is +part of ypp-sc-tools, a set of third-party tools for assisting players +of Yohoho Puzzle Pirates. ypp-sc-tools is Copyright (C) 2009 Ian Jackson +Copyright (C) 2009 Stephen Early This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -174,13 +185,13 @@ sponsored by Three Rings. The character and UI images copied from the YPP client, and submitted -to stored and shared by the YPP SC PCTB dictionary server, are those +to stored and shared by the YPP SC YARRG dictionary server, are those provided by Three Rings as part of the YPP client and by your Java installation. I regard the current use of these images in this way as Fair Dealing (in the UK) or Fair Use (in the USA). These images do not form part of the ypp-sc-tools distribution, -although the ypp-sc-tools pctb client does download them automatically +although the ypp-sc-tools yarrg client does download them automatically from my dictionary server when run in the most ordinary way.