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=c211683717acf735bf05e23e34ba4892a2f16605;hp=6f754bff46e258472de8c5d413723ab7fa8eb117;hb=a1fb96b672d234f5961a397215c19c2c631c5cc3;hpb=555b3391b3cd9967a29b219fff242b583137d2b8 diff --git a/yarrg/web/docs b/yarrg/web/docs index 6f754bf..c211683 100755 --- a/yarrg/web/docs +++ b/yarrg/web/docs @@ -33,17 +33,17 @@ -Website documentation - YARRG +Website documentation - YARRG YARRG - Yet Another Revenue Research Gatherer | -development -| introduction | documentation +| +development

Looking up data in YARRG

@@ -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,32 @@ 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

+ +If you don't specify the amount of capital you have available to +invest in the voyage, the trading plan will assume that your capital +is unlimited. If you specify an amount in PoE here, the trading plan +will never require you to spend more than that amount on commodities. + +

+ +The trading plan does not take into account accumulated profits from +each leg of the journey when applying the available capital +constraint. For example, if you specify a journey from A to B to C +and a capital limit of 10000 PoE, the trading plan will not tell you +to buy 1000 peas at A for 10 PoE each, sail them to B and sell all of +them for 20 PoE each, and then buy 2000 beans at B for 10 PoE each and +sail them to C to sell for 20 PoE each even if such a trade would in +fact be possible. In practice this is unlikely to be a problem! + <& footer &>