<%doc> This is part of the YARRG website. YARRG is a tool and website for assisting players of Yohoho Puzzle Pirates. Copyright (C) 2009 Ian Jackson Copyright (C) 2009 Clare Boothby YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). The YARRG website is covered by the GNU Affero GPL v3 or later, which basically means that every installation of the website will let you download the source. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero 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 Affero General Public License for more details. You should have received a copy of the 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. This Mason component generates the documentation. YARRG (Yet Another Revenue Research Gatherer) <& webcopyright &>

Introduction to YARRG

YARRG (Yet Another Revenue Research Gatherer) is a third-party tool for helping find profitable trades and trade routes in Yohoho Puzzle Pirates. It was inspired by PCTB.

The system has two main parts: this website which maintains a searchable database of commodity prices, and an upload client, which screenscrapes the commodity data from the Puzzle Pirates game client and uploads it to the database.

Market prices database

The lookup page gives access to the uploaded data.

Uploading from Linux

The YARRG upload client uploads both to YARRG and to the PCTB testing server.

The current official version of YARRG for use as an upload client can browsed here: http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/ See particularly the YARRG README.

To install the client, install the `git' version control system and the other dependencies listed in the `Installation requirements' section of the README and then run:

git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
cd ypp-sc-tools
cd yarrg
this will download the code into the directory ypp-sc-tools, and build the software.

When new versions of the upload client are released, you can:

cd .../ypp-sc-tools
cd yarrg
to fetch the new version.

Uploading from Windows

There is not currently an upload client for Windows which feeds data into YARRG. It would probably be straightforward to modify the Windows PCTB v5 upload client to upload to YARRG as well. The mechanism and format for uploading is documented in README.devel.

YARRG development, contribution and troubleshooting

Free Software (aka Open Source)

YARRG is Free Software - you may share and modify it. See the licences for details.

Not only the client but also the webserver code is Free. The website code can be found in the same tree as above, in the web directory.

But in case we have made changes but not yet pushed them (perhaps because we haven't done a release), and to make it easy for anyone else who runs a copy of the website to provide everyone with the source for their version, the website code itself lets you download an up-to-date tarball of its actually-running source code.

If you would like to run a (perhaps modified) copy of the YARRG website it would be very easy for us to make our system send you copies of updates submitted by users of the official YARRG client, in the format expected by the code you'll be running. Please just ask us.

Contacting the YARRG developers

Email Ian Jackson ijackson (at) chiark.greenend.org.uk. Or talk to any Fleet Officer or above of the crew Special Circumstances on the Midnight Ocean. <& footer, isdocs => 1 &>