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

Looking up data in YARRG

YARRG (Yet Another Revenue Research Gatherer) is a third-party tool for helping find profitable trades and trade routes in Yohoho Puzzle Pirates. See the Introduction for more details.

The Market prices database is the main output from YARRG. It offers a variety of enquiry options.

Hopefully you will be able to work it without too much help, but this documentation page contains information about the database website which you may not be able to divine from the online user interface.

Bookmarkable URLs

Mostly, you can bookmark the specific pages and queries. Select the ocean, query page, and other combinations of options, as you wish, and perhaps fill in the actual data fields too, and bookmark the resulting URL.

(An exception to this is if you select the `Update' option from the `Trades for route' lookup; the list of (de)selected stalls is too long to fit in a URL.)

Dynamic confirmation of meaning of text entry boxes

If you have Javascript enabled, the various text entry boxes will be annotated with a brief explanation of the system's interpretation of your current entry string. To get the actual results updated, you must still hit `Go' or `Update'.

Trades for route

Given a list of islands (or archipelagoes), provides a list of potentially profitable trades. If the route is suitable for the trade route optimiser, it will generate a complete voyage plan, telling you which goods to buy and sell where at which stalls and prices.

If you specify only one island or one archipelago, the site shows only arbitrage trades. If you want single-hop trades within an archipelago, you must enter the archipelago name twice.

After getting the results, you can untick various trades individually, and select `Update' to get a new plan. The unticked trades will be excluded from the voyage plan (if any) and also from the totals.

Vessel capacity

If you don't specify a vessel or a vessel capacity, the trading plan will not take into account the fact that your voyage will be on a ship with a limited size. This will probably result in a plan which trades excessively cumbersome goods (eg. hemp, wood, iron).

So you should specify your vessel capacity. You can enter things like:

The capacity of a sloop, leaving no allowance for rum and shot
wb - 1%
The capacity of a war brig minus 1%
13t 20kl
13 tonnes (13,000kg), 20 kilolitres (20,000l)
sloop - 100l 100kg
The capacity of a sloop minus 100l, minus 100kg
2t plus 500kg minus 200kg
2300kg, with no limit on volume
Evaluation is strictly from left to right.

Formally, the capacity is a list of terms, all but the first preceded by one of -, minus, +, plus. Each term may specify a mass and/or a volume (separated by a space), as a number followed (without an intervening space) by a unit (t, kg, kl or l). Alternatively each term except the first may specify a percentage, which is applied as a percentage change to the answer from all the preceding terms. The first term may be a ship name or abbrevation instead. If the first term specifies only one of mass or volume, all the subsequent terms may only adjust that same value.

Expected losses

In theory if you were guaranteed to have a trouble-free voyage it would be worth trading goods at very low margins. However, in practice problems can arise: you may be attacked and lose your stock, or market conditions may change between your collection and delivery of the goods.

We model this by pretending that you expect to lose a fixed proportion of your stock each league you sail. This expected loss does not appear in the trade tables (although the distance does), but it does affect the way the voyage trading plan optimiser chooses which trades to do.

Trades whose margin is less than the expected loss are never included in the suggested plan. For example, if you select 1% loss per league, and plan a voyage of 5 leagues, then any trade with a margin of less than 5.15% would be completely excluded (5.15% not 5% because the loss works like compound interest). Theoretically very profitable trades which are close to the expected break-even point because of the distance can also be rejected by the optimiser in favour of shorter distance trades with theoretically smaller margins, if it's not possible to do both.

As a guide: you may expect to lose between 0.1% and 1% per league. 0.1% would correspond, for example, to losing one fight to brigands every ten 10-league voyages.

You can enter the value in the box either as a percentage, or as a fraction 1/divisor, eg 1/200 is the same as 0.5%; in each case it is taken as the loss for each league of the voyage. <& footer &>