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><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="devel">development</a>
  43 |
  44 <a href="intro">introduction</a>
  45 |
  46 <b>documentation</b>
  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>
  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>Vessel capacity</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.  Currently you must
 114 specify the actual mass and volume, as two numbers each with units.
 115 The system understands the units t (tonnes), kg, l and kl
 116 (kilolitres).  There should be a space between the two limits, and no
 117 space before the unit.
 118
 119 <h3>Expected losses</h3>
 120
 121 In theory if you were guaranteed to have a trouble-free voyage it
 122 would be worth trading goods at very low margins.  However, in
 123 practice problems can arise: you may be attacked and lose your stock,
 124 or market conditions may change between your collection and delivery
 125 of the goods.
 126
 127 <p>
 128
 129 We model this by pretending that you expect to lose a fixed proportion
 130 of your stock each league you sail.  This expected loss does not
 131 appear in the trade tables (although the distance does), but it does
 132 affect the way the voyage trading plan optimiser chooses which trades
 133 to do.
 134
 135 <p>
 136
 137 Trades whose margin is less than the expected loss are never selected.
 138 For example, if you select 1% loss per league, and plan a voyage of 5
 139 leagues, then any trade with a margin of less than 5.15% would be
 140 completely excluded (5.15% not 5% because the loss works like compound
 141 interest).  Theoretically very profitable trades which are close to
 142 the expected break-even point because of the distance can also be
 143 rejected by the optimiser in favour of shorter distance trades with
 144 theoretically smaller margins.
 145
 146 <p>
 147
 148 As a guide: you may expect to lose between 0.1% and 1% per league.
 149 0.1% would correspond, for example, to losing one fight to brigands
 150 every ten 10-league voyages.
 151
 152 <p>
 153
 154 You can enter the value in the box either as a percentage, or as a
 155 fraction 1/<em>divisor</em>, eg 1/200 is the same as 0.5%; in each
 156 case it is taken as the loss for each league of the voyage.
 157
 158 <& footer &>