X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-live.git;a=blobdiff_plain;f=yarrg%2Fweb%2Fdocs;h=9feaa6b651d02f6d60aa068ee3e004eb19f5cd81;hp=c84870935cb54d95cf68b30f67db34a740575c3b;hb=6302552bfa5844eddb7c26386c9995733f0a5174;hpb=315da411e1e9d4c92efac97c51cfc590ee6e4560 diff --git a/yarrg/web/docs b/yarrg/web/docs index c848709..9feaa6b 100755 --- a/yarrg/web/docs +++ b/yarrg/web/docs @@ -39,11 +39,11 @@ YARRG - Yet Another Revenue Research Gatherer | -development -| introduction | documentation +| +development

Looking up data in YARRG

@@ -89,7 +89,7 @@ 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 @@ -119,8 +119,9 @@ like:

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 +
sloop - 10 small 40 rum +
The capacity of a sloop which remains after + 10 small shot and 40 rum are loaded
2t plus 500kg minus 200kg
2300kg, with no limit on volume @@ -128,16 +129,20 @@ 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. +More formally: +

+ capacity-string := [ first-term term* ]
+ term := ('+' | '-' | 'plus' | 'minus') (value+ | number'%')
+ value := mass | volume
+        | integer commodity-name-or-abbreviation
+ mass := number ('t' | 'kg')
+ volume := number ('kl' | 'l')
+ first-term := mass | volume | mass volume | volume mass
+             | ship-name-or-abbreviation
+
+ +If the first term specifies only one of mass or volume, all the +subsequent terms may only adjust that same value.

Expected losses

@@ -169,14 +174,14 @@ 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. +As a guide: you may expect to lose between 0.01% and 1% per league. +For example 0.1% would correspond to losing one fight to brigands (who +take 10% if they win) for every 100 leagues sailed.

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 +fraction 1/divisor, eg 1/2000 is the same as 0.05%; in each case it is taken as the loss for each league of the voyage.

Available capital