1 YARRG - Yet Another Revenue Research Gatherer
2 =============================================
8 - screenscrape the commodities trading screen
9 - produce the results as a tab separated values file
10 - upload the results to the YARRG and PCTB servers
12 To build, install the dependencies, cd to this directory and type `make'.
14 To screenscrape and upload to both servers, select `trade
15 commodities' from the hold of a vessel or building, and run:
17 We upload to the dedicated yarrg server yarrg.chiark.net,
18 and also to pctb.crabdance.com.
20 Or, for example, for a tab-separated values dump:
21 ./yarrg --tsv >commods.tsv
23 While it is capturing the screenshots, do not move the mouse or use
24 the keyboard. Keyboard focus must stay in the YPP client window. If
25 you use Gnome or KDE you must raise the YPP client window so that it
26 is completely unobscured - the yarrg program tries to do this but
27 metacity and kwin do not honour the request.
33 Setting the operation mode:
34 --find-window-only Just check that we can find the YPP client window.
35 --screenshot-only Page through and take screenshots, do not OCR
36 --analyse-only | --same Process previously taken screenshots
37 --everything (default) Take screenshots and process them
39 Options to vary the processing:
40 --single-page One screenful, no paging - results will be incomplete
41 --quiet Suppress progress messages
42 --screenshot-file F Store or read screenshots in F rather than _pages.ppm
43 --window-id ID Specified X window is the YPP client - do not search
44 --edit-charset Enable character set editing. See README.dictionary.
45 --no-edit-charset Do not edit charset even if _local-char*.txt exists.
46 --find-island Find and print the ocean and island. Suppresses OCR
47 and output unless used with result processing option.
48 --test-servers Set default servers to be the test servers, not
49 the real live ones (doesn't affect explicit settings).
51 Controlling what happens to the results - only one at a time:
52 --upload (default) Upload to the YARRG and PCTB servers
53 --tsv Print data as clean tab-separated-values file
54 --raw-tsv Dump the raw (not deduped, unsorted) OCR'd data
55 --best-prices Print best buy and sell price for each commodity
56 --arbitrage Print arbitrage opportunities
58 Privacy options, which control conversations with the dictionary server:
59 --dict-local-only * Do not talk to the server even to fetch new dictionary.
60 --dict-read-only * Only fetch new dictionary, do not submit new entries.
61 --dict-anon Don't quote pirate name if submitting entries.
62 --dict-submit Submit entries quoting my pirate name. (default)
63 Please do not use options marked * with --upload. See README.privacy.
65 Options to override which servers we talk to:
66 --yarrg-server HOST|URL When uploading to YARRG, use HOST or URL.
67 --pctb-server HOST|URL When talking to PCTB, use HOST or URL.
68 --dict-submit-url URL Submit dictionary updates here (default: use yarrg).
69 --dict-update-from SRC Fetch updated master dictionary with rsync from SRC.
70 Or set the environment variables
71 YPPSC_YARRG{_YARRG, _PCTB, _DICT_UPDATE, _DICT_SUBMIT}
74 Installation requirements
75 -------------------------
77 Your X server must be 24bpp (or better).
79 This program has quite a few dependencies:
82 - For building, C compiler and build environment build-essential
83 - pnm library, including dev files for building libnetpbm10-dev
84 - pnm command line utilities for image manipulation netpbm
85 - X11 libraries, including dev files for building libx11-dev
86 - XTEST library, including dev files for building libxtst-dev
87 - Perl-compatible regexp library, including dev files libpcre3-dev
88 - Tk interpreter /usr/bin/wish tk8.4
89 - Perl module XML::Parser libxml-parser-perl
90 - Perl module JSON::Parser libjson-perl
91 - XTEST extension in the X server (part of X package)
92 - Perl interpreter and basic modules perl (usu.installed)
94 On other Linux distros the packages may have different names, but
95 these should be roughly right for Debian and its derivatives. You can
96 install them with this rune:
97 sudo apt-get install build-essential libnetpbm10-dev netpbm libx11-dev libxtst-dev libpcre3-dev tk8.4 libxml-parser-perl libjson-perl
100 The supplied helper programs
102 commod-results-processor
104 must (currently) also be in the current working directory when you run
105 the main yarrg program.
107 The data files (see README.files) are also left in the current working
108 directory. There is not yet any feature to have the data files and
109 helpers be somewhere else.
115 If you need to report a bug, for example an inability to recognise,
116 please be sure to remember the exact error message and circumstances.
117 Also, for recognition problems there will probably be a very useful
118 screenshot file called `_pages.ppm'. This is likely to be very large
119 so don't just email it to me, but if you can put it up on a webpage
120 for me to download that will help. At least keep a copy of it.
122 If the problem is a failure to cope with some particular YPP client
123 display and is reproducible, try running:
124 ./yarrg --raw-tsv --single-page
125 If this reproduces the problem, please email me the screenshot file
126 _pages.ppm, which will consist only of the single screen, plus the
127 error messasge. I'll then be able to understand what's wrong,
134 The main purpose of this program is to connect to the YARRG and PCTB
135 servers and upload data. It will do that if you run it with --upload.
137 This program will also, by default, talk to the dictionary server I
138 have set up: to download updated image dictionaries, and to upload new
139 dictionary entries which you create with the yarrg client dictionary
140 GUI. This feature is mentioned in and controllable in the GUI itself,
141 so it won't happen without you knowing about it.
143 The uploads will by default mention your ocean and pirate name; if you
144 don't want that, pass the --dict-anon option, or untick the box in the
147 See README.privacy for full details.
150 Disclaimers, authorship and copyright
151 -------------------------------------
153 The PCTB server is a project of Joel Lord and various others.
155 The YARRG server was inspired by PCTB and is a project of the crew
156 Special Circumstances (on the Midnight Ocean) and of the Sinister
157 Greenend Organisation.
159 PCTB and YARRG are both completely unofficial and Three Rings, the
160 operators of Yohoho Puzzle Pirates, have nothing to do with either of
161 them. Please refer queries to us, not to Three Rings. If you want to
162 reuse the code here to do substantially novel things, you should ask
163 Three Rings for permission (for example, by petitioning an Ocean
167 This yarrg screenscraper and upload client was written entirely from
168 scratch by me, Ian Jackson, with assistance from Stephen Early and
169 Clare Boothby. It is part of ypp-sc-tools, a set of third-party tools
170 for assisting players of Yohoho Puzzle Pirates.
172 ypp-sc-tools and YARRG are
173 Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
174 Copyright (C) 2009 Clare Boothby
176 This program is free software: you can redistribute it and/or modify
177 it under the terms of
178 (a) for the website code, the GNU Affero General Public License and
179 (b) for the rest of the code, GNU General Public License
180 as published by the Free Software Foundation, either version 3 of
181 each applicable the License, or (at your option) any later version.
183 This program is distributed in the hope that it will be useful,
184 but WITHOUT ANY WARRANTY; without even the implied warranty of
185 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
186 GNU General Public License for more details.
188 You should have received a copy of the GNU General Public License and
189 GNU Affero General Public License along with this program. If not,
190 see <http://www.gnu.org/licenses/>.
192 Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
193 are used without permission. Once again, this program is not endorsed
194 or sponsored by Three Rings.
197 The character and UI images copied from the YPP client, and submitted
198 to stored and shared by the YPP SC YARRG dictionary server, are those
199 provided by Three Rings as part of the YPP client and by your Java
200 installation. I regard the current use of these images in this way as
201 Fair Dealing (in the UK) or Fair Use (in the USA).
203 These images do not form part of the ypp-sc-tools distribution,
204 although the ypp-sc-tools yarrg client does download them automatically
205 from my dictionary server when run in the most ordinary way.
209 ijackson@chiark.greenend.org.uk
210 Aristarchus on the Midnight ocean