3 This is part of the YARRG website. YARRG is a tool and website
4 for assisting players of Yohoho Puzzle Pirates.
6 Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 Copyright (C) 2009 Clare Boothby
9 YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
10 The YARRG website is covered by the GNU Affero GPL v3 or later, which
11 basically means that every installation of the website will let you
14 This program is free software: you can redistribute it and/or modify
15 it under the terms of the GNU Affero General Public License as
16 published by the Free Software Foundation, either version 3 of the
17 License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU Affero General Public License for more details.
24 You should have received a copy of the GNU Affero General Public License
25 along with this program. If not, see <http://www.gnu.org/licenses/>.
27 Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
28 are used without permission. This program is not endorsed or
29 sponsored by Three Rings.
32 This Mason component generates the introduction.
36 <html lang="en"><head>
37 <title>YARRG (Yet Another Revenue Research Gatherer)</title>
40 <a href="lookup">YARRG</a> -
41 Yet Another Revenue Research Gatherer
45 <a href="docs">documentation</a>
47 <a href="devel">development</a>
49 <h1>Introduction to YARRG</h1>
51 YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
52 for helping find profitable trades and trade routes in Yohoho Puzzle
53 Pirates. It was inspired by
54 <a href="http://pctb.crabdance.com/">PCTB</a>.
58 The system has two main parts: this website which maintains a
59 searchable database of commodity prices, and an upload client, which
60 screenscrapes the commodity data from the Puzzle Pirates game client
61 and uploads it to the database.
63 <h2><a href="lookup">Market prices database</a></h2>
65 The <a href="lookup">lookup page</a> gives access to the uploaded data;
66 there is also <a href="docs">documentation</a> to help with using that
69 <h2>Uploading from Linux</h2>
71 The YARRG upload client uploads both to YARRG and to the
72 <a href="http://pctb.ilk.org/">PCTB testing server</a>.
76 The current official version of YARRG for use as an upload
77 client can browsed here:
78 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
80 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
83 To install the client, install the `git' version control system
84 and the other dependencies listed in the `Installation requirements'
85 section of the README and then run:
87 git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
92 this will download the code into the directory <code>ypp-sc-tools</code>,
93 and build the software. (If your Linux is very up to date you may
94 find that it complains that it doesn't know the command <kbd>git-core</kbd>.
95 In that case, use <kbd>git core</kbd>, with a space, instead.)
99 When new versions of the upload client are released, you can:
106 to fetch the new version. (Again, you may need <kbd>git pull</kbd>
107 instead of <kbd>git-pull</kbd>.)
109 <h2>Uploading from Windows</h2>
111 There is not currently an upload client for Windows which feeds data
112 into YARRG. It would probably be straightforward to modify the
113 Windows PCTB v5 upload client to upload to YARRG as well.
117 See our <a href="devel">Developers' information</a> page.
119 <h2>Contacting the YARRG developers</h2>
121 Email Ian Jackson ijackson (at) chiark.greenend.org.uk. Or talk to
122 any Fleet Officer or above of the crew Special Circumstances on the