Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
Copyright (C) 2009 Clare Boothby
+ Copyright (C) 2009 Naath Cousins
YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
The YARRG website is covered by the GNU Affero GPL v3 or later, which
</%doc>
-<& docshead &>
-<h1>Introduction to YARRG</h1>
+<& docshead:head &>
+<style type="text/css">
+<& style.css &>
+ body { margin: 0; color: #000000; background: #c5c7ae; }
+ div.emph {
+ margin-left: 1em; padding-left: 1em; padding-top: 0.01em;
+ margin-right: 1em; padding-right: 1em; padding-bottom: 0.05em;
+ background: #ffffff;
+ }
+</style>
+<div class="navoptbar">
+<& navbar &>
+</div>
+<div class="docs">
+
+<h1>Guide to YARRG</h1>
YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
for helping find profitable trades and trade routes in Yohoho Puzzle
<p>
-</div>
<div class="emph">
<h2>Quick start for experts</h2>
<p>
You will also probably at some point want to read the
-<a href="docs">Documentation</a> which covers some features of the
-website which you might not guess just from using it.
+<a href="docs">Documentation for Experts</a> which covers some
+features of the website which you might not guess just from using it.
</div>
-<div class="docs">
<h2>How to use the YARRG website</h2>
<p>
-<b>For pirates wanting to sell or buy a specific comodity</b> prices for
+<b>For pirates wanting to sell or buy a specific commodity</b> prices for
commodity returns the best buy and sell prices for the selected
commodity at each island where trades are available. Type (or select
from a menu) the name of one commodity at a time. This is useful for
<p>
-<b>For pirates wanting more details about comodity prices at specified
+<b>For pirates wanting more details about commodity prices at specified
locations.</b> Offers at location returns all the offers to buy and sell
wood at the selected location(s). Type (or select) a commodity and the
islands (or achipelagos) you are interested in. This is useful when
<p>
-<b>For pirates just wanting to make some poe moving comodities about.</b> Find
+<b>For pirates just wanting to make some poe moving commodities about.</b> Find
Profitable Route finds you a profitable trading route: first select
either "open-ended" (which might take you anywhere) or "circular"
(which takes you back to where you started) then type (or select) your
<p>
-Prices for commodity and offers at location give very similar results;
-there will be two tables: the first titled Offers to BUY your
-commodity, the second offers to SELL it. The tables can be resorted
-by your prefered heading by clicking on the arrows.
+"Prices for commodity" and "Offers at location" give very similar results;
+there will be two tables: the first titled "Offers to BUY" your
+commodity, the second "Offers to SELL" it. The tables can be sorted
+as you wish by clicking on the arrows in the headings.
<p>
-Trades for route and Find profitable route both return voyage plans.
-Find profitable route has an additional step to get at your results -
+"Trades for route" and "Find profitable route" both return voyage plans.
+"Find profitable route" has an additional step to get at your results -
when you enter your query you are given a list of 15 good routes for
total profit and 15 good routes for profit per league which visit
-different islands. Select your prefered route: perhaps you will choose
+different islands. Select your preferred route: perhaps you will choose
to take the best profit or perhaps you need to miss out one island
because it is blockaded or another because you don't have the charts
to get to or from it. If you have asked for a trade for route or
<p>
After this there is a table reporting the age of the data used. And
-then a table of Relevant trades which lists just about everything you
+then a table of "Relevant trades" which lists just about everything you
could want to know about each trade the plan suggests you make (yes,
this table is fairly complicated). The ticky boxes down the side of
this table allow you to choose which trades you like the look of -
You can't trade more than fits in your hold. If you don't say
anything YARRG assumes that you have infinite hold space (perhaps you
will go over the route many times). You can enter a ship-type, a mass
-or a volume; additionally you can subtract quantities of comodities
+or a volume; additionally you can subtract quantities of commodities
from a ship-type (for instance 'sloop - 10 grog' gives the capacity of
a sloop that has 10 grog already on board); click the ? by this field
to get a full description of permitted entries here.
<p>
-How much do you expect to lose to the dasterdly brigands? enter either
-a % (as eg - 1%) or a fracition (as eg - 1/100) of the goods you
+How much do you expect to lose to the dastardly brigands? Enter either
+a % (as eg - 1%) or a fraction (as eg - 1/100) of the goods you
expect to loose to Brigands. Brigands take 10% if they defeat you,
but only you know how often you are defeated. Note that this doesn't
include rum-consumed so you will need to account for that
<p>
How far are you willing to sail today? The default is 20 leagues, the
-maximum supported is 35. Are you willing to sail all the way accross
-the ocean for a profit? or would you prefer to go only a short way?
+maximum supported is 35. Are you willing to sail all the way across
+the ocean for a profit? Or would you prefer to go only a short way?
<p>
YARRG will try to guess what you meant. If you pause for a moment then
beneath the text entry field you'll see what YARRG thinks you meant.
If it's got it correct you don't have to type any more of that
-comodity/island name: just go on to the next one.
+commodity/island name: just go on to the next one.
<p>
<p>
-It's all free, both free-as-in-beer or free-as-in-speach. If you're
+It's all free, both free-as-in-beer or free-as-in-speech. If you're
interested, read the <a href="devel">Development pages</a> for more
info about how to contribute or how to run your own website using
YARRG data (perhaps you don't like our colour choices)
Email Ian Jackson ijackson (at) chiark.greenend.org.uk. Or talk to
any Fleet Officer or above of the crew Special Circumstances on the
Midnight Ocean.
+<p>
</div>
<& footer &>
~yarrgweb / ypp-sc-tools.main.git / blobdiff