X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.main.git;a=blobdiff_plain;f=yarrg%2FREADME;h=b7731a3dc58d92a617796e37bbbc84ae1bf77581;hp=82301b20204a9d09bb7305ac726400aa5e30fab5;hb=19c49821438f668c75868ca696bd0b06c6a47d2a;hpb=a5147853c87706b66cd8b41ff8fd09c76270d844 diff --git a/yarrg/README b/yarrg/README index 82301b2..b7731a3 100644 --- a/yarrg/README +++ b/yarrg/README @@ -4,7 +4,7 @@ YARRG - Yet Another Revenue Research Gatherer Overview -------- -This tool can: +This tool will: - screenscrape the commodities trading screen - produce the results as a tab separated values file - upload the results to the YARRG and PCTB servers @@ -13,19 +13,18 @@ To build, install the dependencies, cd to this directory and type `make'. To screenscrape and upload to both servers, select `trade commodities' from the hold of a vessel or building, and run: - ./ypp-commodities -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). + ./yarrg +We upload to the dedicated yarrg server yarrg.chiark.net, +and also to pctb.crabdance.com. Or, for example, for a tab-separated values dump: - ./ypp-commodities --tsv >commods.tsv + ./yarrg --tsv >commods.tsv While it is capturing the screenshots, do not move the mouse or use -the keyboard. Keyboard focus must stay in the YPP client window. -If you use Gnome or KDE you must raise the YPP client window so that -it is completely unobscured - the ypp-commodities program tries to do -this but metacity and kwin do not honour the request. +the keyboard. Keyboard focus must stay in the YPP client window. If +you use Gnome or KDE you must raise the YPP client window so that it +is completely unobscured - the yarrg program tries to do this but +metacity and kwin do not honour the request. Command-line options @@ -65,10 +64,11 @@ Please do not use options marked * with --upload. See README.privacy. Options to override which servers we talk to: --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. + --pctb-server HOST|URL When talking to PCTB, use HOST or URL. + --dict-submit-url URL Submit dictionary updates here (default: use yarrg). --dict-update-from SRC Fetch updated master dictionary with rsync from SRC. -Or set the environment variables YPPSC_YARRG{_PCTB, _DICT_UPDATE, _DICT_SUBMIT} +Or set the environment variables + YPPSC_YARRG{_YARRG, _PCTB, _DICT_UPDATE, _DICT_SUBMIT} Installation requirements @@ -102,10 +102,10 @@ The supplied helper programs commod-results-processor database-info-fetch must (currently) also be in the current working directory when you run -the main ypp-commodities program. +the main yarrg program. The data files (see README.files) are also left in the current working -directory. There is notyet any feature to have the data files and +directory. There is not yet any feature to have the data files and helpers be somewhere else. @@ -121,7 +121,7 @@ for me to download that will help. At least keep a copy of it. If the problem is a failure to cope with some particular YPP client display and is reproducible, try running: - ./ypp-commodities --raw-tsv --single-page + ./yarrg --raw-tsv --single-page If this reproduces the problem, please email me the screenshot file _pages.ppm, which will consist only of the single screen, plus the error messasge. I'll then be able to understand what's wrong, @@ -147,8 +147,8 @@ GUI. See README.privacy for full details. -Authorship and copyright ------------------------- +Disclaimers, authorship and copyright +------------------------------------- The PCTB server is a project of Joel Lord and various others. @@ -156,32 +156,42 @@ 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. +PCTB and YARRG are both completely unofficial and Three Rings, the +operators of Yohoho Puzzle Pirates, have nothing to do with either of +them. Please refer queries to us, not to Three Rings. If you want to +reuse the code here to do substantially novel things, you should ask +Three Rings for permission (for example, by petitioning an Ocean +Master). + 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. +scratch by me, Ian Jackson, with assistance from Stephen Early and +Clare Boothby. It is part of ypp-sc-tools, a set of third-party tools +for assisting players of Yohoho Puzzle Pirates. -ypp-sc-tools is +ypp-sc-tools and YARRG are Copyright (C) 2009 Ian Jackson -Copyright (C) 2009 Stephen Early +Copyright (C) 2009 Clare Boothby 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 -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +it under the terms of + (a) for the website code, the GNU Affero General Public License and + (b) for the rest of the code, GNU General Public License +as published by the Free Software Foundation, either version 3 of +each applicable the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -You should have received a copy of the GNU General Public License -along with this program. If not, see . +You should have received a copy of the GNU General Public License and +GNU Affero General Public License along with this program. If not, +see . Yohoho and Puzzle Pirates are probably trademarks of Three Rings and -are used without permission. This program is not endorsed or -sponsored by Three Rings. +are used without permission. Once again, this program is not endorsed +or sponsored by Three Rings. The character and UI images copied from the YPP client, and submitted