yarrg/web/docs

   1 <%doc>
   2
   3  This is part of the YARRG website.  YARRG is a tool and website
   4  for assisting players of Yohoho Puzzle Pirates.
   5
   6  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   7  Copyright (C) 2009 Clare Boothby
   8
   9   YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
  10   The YARRG website is covered by the GNU Affero GPL v3 or later, which
  11    basically means that every installation of the website will let you
  12    download the source.
  13
  14  This program is free software: you can redistribute it and/or modify
  15  it under the terms of the GNU Affero General Public License as
  16  published by the Free Software Foundation, either version 3 of the
  17  License, or (at your option) any later version.
  18
  19  This program is distributed in the hope that it will be useful,
  20  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  GNU Affero General Public License for more details.
  23
  24  You should have received a copy of the GNU Affero General Public License
  25  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26
  27  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
  28  are used without permission.  This program is not endorsed or
  29  sponsored by Three Rings.
  30
  31
  32  This Mason component generates the documentation.
  33
  34
  35 </%doc>
  36 <html lang="en"><head><title>Website documentation - YARRG</title>
  37 </head><body>
  38
  39 <a href="lookup">YARRG</a> -
  40  Yet Another Revenue Research Gatherer
  41 |
  42 <a href="intro">introduction</a>
  43 |
  44 <b>documentation</b>
  45 |
  46 <a href="devel">development</a>
  47
  48 <h1>Looking up data in YARRG</h1>
  49
  50 YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
  51 for helping find profitable trades and trade routes in Yohoho Puzzle
  52 Pirates.  See the <a href="intro">Introduction</a> for more details.
  53
  54 <p>
  55
  56 The <a href="lookup">Market prices database</a> is the main output
  57 from YARRG.  It offers a variety of enquiry options.
  58
  59 <p>
  60
  61 Hopefully you will be able to work it without too much help, but this
  62 documentation page contains information about the database website
  63 which you may not be able to divine from the online user interface.
  64
  65 <h2>Bookmarkable URLs</h2>
  66
  67 Mostly, you can bookmark the specific pages and queries.  Select the
  68 ocean, query page, and other combinations of options, as you wish, and
  69 perhaps fill in the actual data fields too, and bookmark the resulting
  70 URL.
  71
  72 <p>
  73
  74 (An exception to this is if you select the `Update' option from the
  75 `Trades for route' lookup; the list of (de)selected stalls is too long
  76 to fit in a URL.)
  77
  78 <h2>Dynamic confirmation of meaning of text entry boxes</h2>
  79
  80 If you have Javascript enabled, the various text entry boxes will be
  81 annotated with a brief explanation of the system's interpretation of
  82 your current entry string.  To get the actual results updated, you
  83 must still hit `Go' or `Update'.
  84
  85 <h2>Trades for route</h2>
  86
  87 Given a list of islands (or archipelagoes), provides a list of
  88 potentially profitable trades.  If the route is suitable for the trade
  89 route optimiser, it will generate a complete voyage plan, telling you
  90 which goods to buy and sell where at which stalls and prices.
  91
  92 <p><a name="arbitrage"></a>
  93
  94 If you specify only one island or one archipelago, the site shows only
  95 arbitrage trades.  If you want single-hop trades within an
  96 archipelago, you must enter the archipelago name twice.
  97
  98 <p>
  99
 100 After getting the results, you can untick various trades individually,
 101 and select `Update' to get a new plan.  The unticked trades will be
 102 excluded from the voyage plan (if any) and also from the totals.
 103
 104 <h3><a name="capacity">Vessel capacity</a></h3>
 105
 106 If you don't specify a vessel or a vessel capacity, the trading plan
 107 will not take into account the fact that your voyage will be on a ship
 108 with a limited size.  This will probably result in a plan
 109 which trades excessively cumbersome goods (eg. hemp, wood, iron).
 110
 111 <p>
 112
 113 So you should specify your vessel capacity.  You can enter things
 114 like:
 115 <dl>
 116 <dt>sloop
 117 <dd>The capacity of a sloop, leaving no allowance for rum and shot
 118 <dt>wb - 1%
 119 <dd>The capacity of a war brig minus 1%
 120 <dt>13t 20kl
 121 <dd>13 tonnes (13,000kg), 20 kilolitres (20,000l)
 122 <dt>sloop - 10 small 40 rum
 123 <dd>The capacity of a sloop which remains after
 124     10 small shot and 40 rum are loaded
 125 <dt>2t plus 500kg minus 200kg
 126 <dd>2300kg, with no limit on volume
 127 </dl>
 128 Evaluation is strictly from left to right.
 129
 130 <p>
 131
 132 More formally:
 133 <pre>
 134  capacity-string := [ first-term term* ]
 135  term := ('+' | '-' | 'plus' | 'minus') (value+ | number'%')
 136  value := mass | volume
 137         | integer commodity-name-or-abbreviation
 138  mass := number ('t' | 'kg')
 139  volume := number ('kl' | 'l')
 140  first-term := mass | volume | mass volume | volume mass
 141              | ship-name-or-abbreviation
 142 </pre>
 143
 144 If the first term specifies only one of mass or volume, all the
 145 subsequent terms may only adjust that same value.
 146
 147 <h3><a name="losses">Expected losses</a></h3>
 148
 149 In theory if you were guaranteed to have a trouble-free voyage it
 150 would be worth trading goods at very low margins.  However, in
 151 practice problems can arise: you may be attacked and lose your stock,
 152 or market conditions may change between your collection and delivery
 153 of the goods.
 154
 155 <p>
 156
 157 We model this by pretending that you expect to lose a fixed proportion
 158 of your stock each league you sail.  This expected loss does not
 159 appear in the trade tables (although the distance does), but it does
 160 affect the way the voyage trading plan optimiser chooses which trades
 161 to do.
 162
 163 <p>
 164
 165 Trades whose margin is less than the expected loss are never included
 166 in the suggested plan.  For example, if you select 1% loss per league,
 167 and plan a voyage of 5 leagues, then any trade with a margin of less
 168 than 5.15% would be completely excluded (5.15% not 5% because the loss
 169 works like compound interest).  Theoretically very profitable trades
 170 which are close to the expected break-even point because of the
 171 distance can also be rejected by the optimiser in favour of shorter
 172 distance trades with theoretically smaller margins, if it's not
 173 possible to do both.
 174
 175 <p>
 176
 177 As a guide: you may expect to lose between 0.01% and 1% per league.
 178 For example 0.1% would correspond to losing one fight to brigands (who
 179 take 10% if they win) for every 100 leagues sailed.
 180
 181 <p>
 182
 183 You can enter the value in the box either as a percentage, or as a
 184 fraction 1/<em>divisor</em>, eg 1/2000 is the same as 0.05%; in each
 185 case it is taken as the loss for each league of the voyage.
 186
 187 <h3><a name="capital">Available capital</a></h3>
 188
 189 If you don't specify the amount of capital you have available to
 190 invest in the voyage, the trading plan will assume that your capital
 191 is unlimited.  If you specify an amount in PoE here, the trading plan
 192 will never require you to spend more than that amount on commodities.
 193
 194 <p>
 195
 196 The trading plan does not take into account accumulated profits from
 197 each leg of the journey when applying the available capital
 198 constraint.  For example, if you specify a journey from A to B to C
 199 and a capital limit of 10000 PoE, the trading plan will not tell you
 200 to buy 1000 peas at A for 10 PoE each, sail them to B and sell all of
 201 them for 20 PoE each, and then buy 2000 beans at B for 10 PoE each and
 202 sail them to C to sell for 20 PoE each even if such a trade would in
 203 fact be possible.  In practice this is unlikely to be a problem!
 204
 205 <& footer &>