yarrg/web/howto

   1 <html lang="en"><head>
   2
   3 </head>
   4
   5 <body>
   6
   7 <h1>How to use YARRG.</h1>
   8 A basic introduction to YARRG.
   9
  10 <h2>What is YARRG for?</h2>
  11
  12 <p>
  13
  14 YARRG is designed to help pirates make profitable trades, it is not
  15 designed as a trading tutorial and some familiarity with trading in
  16 YPP is assumed. <a
  17 href="http://yppedia.puzzlepirates.com/Trading">yppedia.puzzlepirates.com/Trading</a>
  18 contains some advice on trading basics.
  19
  20 <p>
  21
  22 <h2>So how do I use it then?</h2>
  23
  24 <p> First look at the top of the page.  You need to select your Ocean,
  25 the sort of Interface you would like and the type of Query you wish to
  26 ask.
  27
  28
  29 <p>
  30
  31 <h2>Selecting your Ocean: </h2>
  32
  33 <p>
  34
  35 <b>Which ocean do you want to trade on?</b>  just click on that ocean's
  36 name.
  37
  38 <p>
  39
  40 <h2>Selecting your Interface:</h2>
  41
  42 <p> You can choose to enter commodity and island names by typing them
  43 into a text entry field or by selecting them from a drop down menu.
  44 The "select from menu" option allows only a restricted number of
  45 options to be entered into each field.
  46
  47 <p>
  48
  49 <h2>Type of Query:</h2>
  50
  51 <p>
  52
  53 There are currently four types of query available, which answer
  54 slightly different questions.
  55
  56 <p>
  57
  58 <h3>Trades for route: </h3>
  59
  60 <p>
  61
  62 <b>For pirates who know where they are going.</b>  Trades for route allows
  63 you to enter a route that you are planning to sail and find out if
  64 there are any profitable trades you can make along the way.  This is
  65 for pirates who already have a definate sailing plan for some reason.
  66 Under "Enter Route" you need to type (or select from menus) the names
  67 of the islands or Archipelagoes that you plan to visit.  If you wish
  68 to know about arbitrage opportunities at an island you can enter just
  69 that island name.  If you enter only one Archipelago then you will get
  70 arbitrage opportunities in that archipelago, if you enter the same
  71 archipelago twice you'll get trades within that archipelago.
  72
  73 <p>
  74
  75 <h3>Prices for commodity: </h3>
  76
  77 <p>
  78
  79 <b>For pirates wanting to sell or buy a specific comodity</b> prices for
  80 commodity returns the best buy and sell prices for the selected
  81 commodity at each island where trades are available.  Type (or select
  82 from a menu) the name of one commodity at a time.  This is useful for
  83 pirates wishing to purchase or sell a specific commodity and wanting
  84 the best price.
  85
  86 <p>
  87
  88 <h3>Offers at location: </h3>
  89
  90 <p>
  91
  92 <b>For pirates wanting more details about comodity prices at specified
  93 locations.</b> Offers at location returns all the offers to buy and sell
  94 wood at the selected location(s). Type (or select) a commodity and the
  95 islands (or achipelagos) you are interested in.  This is useful when
  96 the best buy or sell offer is for only a small quantity, you can check
  97 what the others offers are like.
  98
  99 <p>
 100
 101 <h3>Find Profitable route: </h3>
 102
 103 <p>
 104
 105 <b>For pirates just wanting to make some poe moving comodities about.</b> Find
 106 Profitable Route finds you a profitable trading route, first select
 107 either "open-ended" (which might take you anywhere) or "circular"
 108 (which takes you back to where you started) then type (or select) your
 109 starting point (or points - you may for instance have two ships in
 110 different locations either of which you could use).
 111
 112 <p>
 113
 114 <h2>Data age: </h2>
 115
 116 <p>
 117
 118 Data age tells you how long ago data was uploaded from each island in
 119 your ocean, data changes very quickly and trusting old data to be
 120 accurate is unlikely to be rewarding.
 121
 122 <p>
 123
 124 <h2>What do the results mean:</h2>
 125
 126 <p>
 127
 128 Prices for commodity and offers at location give very similar results;
 129 there will be two tables the first titled Offers to BUY your
 130 commodity, the second offers to SELL it.  The tables can be resorted
 131 by your prefered heading by clicking on the arrows.
 132
 133 <p>
 134
 135 Trades for route and Find profitable route both return voyage plans.
 136 Find profitable route has an additional step to get at your results -
 137 when you enter your query you are given a list of 15 good routes for
 138 total profit and 15 good routes for profit per league which visit
 139 different islands; select your prefered route, perhaps you will choose
 140 to take the best profit or perhaps you need to miss out one island
 141 because it is blockaded or another because you don't have the charts
 142 to get to or from it.  If you have asked for a trade for route or
 143 after selecting the profitable route you prefer you will get a Voyage
 144 trading plan - this provides you with instructions for what to do (buy
 145 this, sell that, sail there).
 146
 147 <p>
 148
 149 Sometimes no useful trades are available, in this case the results
 150 section says simply "No profitable trading opportunities were found".
 151
 152 <p>
 153
 154 After this there is a table reporting the age of the data used.  And
 155 then a table of Relevant trades which lists just about everything you
 156 could want to know about each trade the plan suggests you make(yes,
 157 this table is fairly complicated), the ticky boxes down the side of
 158 this table allow you to choose which trades you like the look of -
 159 untick any that you are not interested in (for instance you may be
 160 uninterested in trades with a low profit margin).
 161
 162 <p>
 163
 164 <h2>What are the Advanced options:</h2>
 165
 166 <p>
 167
 168 These options are very useful, and not very advanced, but not needed
 169 for searching the data.
 170
 171 <p>
 172
 173 <h3>Capacity: </h3>
 174
 175 <p>
 176
 177 You can't trade more than fits in your hold.  If you don't say
 178 anything YARRG assumes that you have infinite hold space (perhaps you
 179 will go over the route many times).  You can enter a ship-type, a mass
 180 or a volume; additionally you can subtract quantities of comodities
 181 from a ship-type (for instance 'sloop - 10 grog' gives the capacity of
 182 a sloop that has 10 grog already on board); click the ? by this field
 183 to get a full description of permitted entries here.
 184
 185 <p>
 186
 187 <h3>Capital:</h3>
 188
 189 <p>
 190
 191 How much poe do you have?  If you don't say anything YARRG assumes you
 192 have infinite poe to spend, but you probably don't.  Enter the amount
 193 you are willing to spend on commodities for trading with.
 194
 195 <p>
 196
 197 <h3>Expected losses:</h3>
 198
 199 <p>
 200
 201 How much do you expect to lose to the dasterdly brigands? enter either
 202 a % (as eg - 1%) or a fracition (as eg - 1/100) of the goods you
 203 expect to loose to Brigands.  Brigands take 10% if they defeat you,
 204 but only you know how often you are defeated.  Note that this doesn't
 205 include rum-consumed, and you will need to account for that
 206 seperately.
 207
 208 <p>
 209
 210 <h3>Max distance: </h3>
 211
 212 <p>
 213
 214 How far are you willing to sail today?  The default is 20 leagues, the
 215 maximum supported is 35.  Are you willing to sail all the way accross
 216 the ocean for a profit?  or would you prefer to go only a short way?
 217
 218 <p>
 219
 220 <h2>Other fairly useful information:</h2>
 221
 222 <p>
 223
 224 The search information is encoded in the URL - you can bookmark pages
 225 for searches you want to perform a lot and go straight to them without
 226 re-entering you data (or you can copy the URL and tell your hearties
 227 and crew mates if you want to).  There's no need to come back to the
 228 introductory page each time.
 229
 230 <p>
 231
 232 Java magic - when you type things into the text entry fields YARRG
 233 will try to guess what you meant, if you pause for a moment then
 234 beneath the text entry field you'll see what YARRG thinks you meant if
 235 it's got it correct you don't have to type any more of that
 236 comodity/island name, just go on to the next one.
 237
 238 <p>
 239
 240 You'll probably want to upload data to ensure you have fresh data
 241 available, unfortunately YARRG only has a Linux upload client at
 242 present (a windows one is in the works).  You should read
 243 http://yarrg.chiark.net/intro and the linked README page for
 244 information about the client which contain easy-to-follow instructions
 245 to download, install and run it in the form of a few comand line
 246 instructions that you can copy and paste.
 247
 248 <p>
 249
 250 It's all free, both free-as-in-beer or free-as-in-speach.  If you're
 251 interested, read the 'development' pages for more info about how to
 252 contribute or how to run your own website using YARRG data (perhaps
 253 you don't like our colour choices)