<%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 introduction. YARRG (Yet Another Revenue Research Gatherer) YARRG - Yet Another Revenue Research Gatherer | introduction | documentation | development

YARRG development, contribution and troubleshooting

Free Software (aka Open Source) licensing

YARRG is Free Software - you may share and modify it. See the licences for details. Not only the client but also the website code is Free. The yarrg client, support files, and so forth are under the GNU GPL (v3 or later); the website is under the GNU Affero GPL (v3 or later).

Note that there is NO WARRANTY !

Resources for developers

Source code

git clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git/
obtains the source code of the latest version released for use as a client, which you can also find as an unpacked tree

Live website source code can be downloaded, 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 of its actually-running source code. So this link gives you the source code for the pages you are now looking at.

YARRG lookup website instances

Each of these allows you to download its own source code so you can get both the testing and the main version of the website.

You can add the form parameter ?debug=1 to each of the above to get a version of the site with debugging output enabled.


rsync rsync.yarrg.chiark.net::yarrg/
accesses files published for the benefit of the yarrg upload client,

This directory also contains slightly stale copies (updated daily) of the actual databases (in SQLite3 format). It is also available by http but please do not repeatedly download the databases by http - use rsync which is much more efficient. Note also that if you want to actually run your own improved yarrg website, I can arrange to feed you data in real time - see below.

rsync rsync.yarrg.chiark.net::yarrg/test/
accesses the data for the testing instance.


README.devel has the specification of the mechanism and format for uploading to YARRG.

Support from the YARRG team

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 YARRG code. Please just ask us - at our end it's just a matter of us adding your database instance's special email address to our alias file.

We encourage the development and improvement of this code. Please continue to share your improvements with the Puzzle Pirates community. In particular, do not remove or break the feature that allows users of your website to download the up to date code you are running.

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, isdevel => 1 &>