X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-test.git;a=blobdiff_plain;f=pctb%2FREADME;h=8379208a4e7319ef1e0c7481c8c4751405040439;hp=185a022ec3665e0fb3b58377b999f78139d7f747;hb=ca2598d063219f019ba8e04a4762552f556795ca;hpb=fc71bd8c21ff11ded6888512ec30a8506d7ed1ec diff --git a/pctb/README b/pctb/README index 185a022..8379208 100644 --- a/pctb/README +++ b/pctb/README @@ -6,17 +6,22 @@ This tool can: - produce the results as a tab separated values file - upload the results to PCTB -To run it, change to this directory, type `make', and then: - ./ypp-commodities --upload -to upload to the PCTB server. Currently we use pctb.ilk.org, -the testing instance of the PCTB database, pending approval from the -operators of the main server. +To build, install the dependencies, cd to this directory and type `make'. + +To screenscrape and upload to the PCTB server, 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. Or, for example, for a tab-separated values dump: - ./ypp-commodities --tsv >commods.tsv + ./ypp-commodities --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. Command-line options @@ -31,10 +36,10 @@ Setting the operation mode: Options to vary the processing: --single-page One screenful, no paging - results will be incomplete --quiet Suppress progress messages - --screenshot-file F Store or read screenshots in F rather than #pages#.pnm + --screenshot-file F Store or read screenshots in F rather than _pages.ppm --window-id ID Specified X window is the YPP client - do not search --edit-charset Enable character set editing. See README.dictionary. - --no-edit-charset Do not edit charset even if #local-char*#.txt exists. + --no-edit-charset Do not edit charset even if _local-char*.txt exists. --find-island Find and print the ocean and island. Suppresses OCR and output unless used with result processing option. --test-servers Set default servers to be the test servers, not @@ -64,6 +69,8 @@ Or set the environment variables YPPSC_PCTB{_PCTB, _DICT_UPDATE, _DICT_SUBMIT} Installation requirements ------------------------- +Your X server must be 24bpp (or better). + This program has quite a few dependencies: Package (Debian etch) @@ -80,7 +87,10 @@ This program has quite a few dependencies: - Perl interpreter and basic modules perl (usu.installed) On other Linux distros the packages may have different names, but -these should be roughly right for Debian and its derivatives. +these should be roughly right for Debian and its derivatives. You can +install them with this rune: + sudo apt-get install build-essential libnetpbm10-dev netpbm libx11-dev libxtst-dev libpcre3-dev tk8.4 libxml-parser-perl libjson-perl + The supplied helper programs dictionary-manager @@ -100,7 +110,7 @@ Reporting problems If you need to report a bug, for example an inability to recognise, please be sure to remember the exact error message and circumstances. Also, for recognition problems there will probably be a very useful -screenshot file called `#pages#.pnm'. This is likely to be very large +screenshot file called `_pages.ppm'. This is likely to be very large so don't just email it to me, but if you can put it up on a webpage for me to download that will help. At least keep a copy of it. @@ -108,7 +118,7 @@ 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 If this reproduces the problem, please email me the screenshot file -#pages#.pnm, which will consist only of the single screen, plus the +_pages.ppm, which will consist only of the single screen, plus the error messasge. I'll then be able to understand what's wrong, hopefully. @@ -132,6 +142,47 @@ GUI. See README.privacy for full details. +Authorship and copyright +------------------------ + +The PCTB server itself is a project of Joel Lord and various others. + + +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. + +ypp-sc-tools is +Copyright (C) 2009 Ian Jackson + +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. + +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 . + +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. + + +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 +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 +from my dictionary server when run in the most ordinary way. + - Ian Jackson ijackson@chiark.greenend.org.uk