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