X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-live.git;a=blobdiff_plain;f=yarrg%2Fweb%2Fdocs;h=0f6249199c07344c4b17a919c4387ce4187cd0ab;hp=c211683717acf735bf05e23e34ba4892a2f16605;hb=2aa3a575e41e6c9ed3b58e822dde0cf73502012b;hpb=872e647cac241531e4599c8b8b330d8772020253 diff --git a/yarrg/web/docs b/yarrg/web/docs index c211683..0f62491 100755 --- a/yarrg/web/docs +++ b/yarrg/web/docs @@ -33,18 +33,7 @@ -Website documentation - YARRG - - -YARRG - - Yet Another Revenue Research Gatherer -| -introduction -| -documentation -| -development - +<& docshead &>

Looking up data in YARRG

YARRG (Yet Another Revenue Research Gatherer) is a third-party tool @@ -62,6 +51,11 @@ Hopefully you will be able to work it without too much help, but this documentation page contains information about the database website which you may not be able to divine from the online user interface. +

+ +If this page is all too complicated for you, you may prefer to read +the introduction instead. +

Bookmarkable URLs

Mostly, you can bookmark the specific pages and queries. Select the @@ -71,8 +65,8 @@ URL.

-(An exception to this is if you select the `Update' option from the -`Trades for route' lookup; the list of (de)selected stalls is too long +(An exception to this is if you select the "Update" option from the +"Trades for route" lookup; the list of (de)selected stalls is too long to fit in a URL.)

Dynamic confirmation of meaning of text entry boxes

@@ -80,7 +74,7 @@ to fit in a URL.) If you have Javascript enabled, the various text entry boxes will be annotated with a brief explanation of the system's interpretation of your current entry string. To get the actual results updated, you -must still hit `Go' or `Update'. +must still hit "Go" or "Update".

Trades for route

@@ -89,7 +83,7 @@ potentially profitable trades. If the route is suitable for the trade route optimiser, it will generate a complete voyage plan, telling you which goods to buy and sell where at which stalls and prices. -

+

If you specify only one island or one archipelago, the site shows only arbitrage trades. If you want single-hop trades within an @@ -98,7 +92,7 @@ archipelago, you must enter the archipelago name twice.

After getting the results, you can untick various trades individually, -and select `Update' to get a new plan. The unticked trades will be +and select "Update" to get a new plan. The unticked trades will be excluded from the voyage plan (if any) and also from the totals.

Vessel capacity

@@ -202,4 +196,55 @@ them for 20 PoE each, and then buy 2000 beans at B for 10 PoE each and sail them to C to sell for 20 PoE each even if such a trade would in fact be possible. In practice this is unlikely to be a problem! +

Locating commodities in the YPP client UI

+ +In the Voyage Trading Plan, YARRG indicates after the commodity name +where in the YPP commodity UI each commodity can be found. First +comes the initial letter of the category: +% my $dbh= dbw_connect('Midnight'); +% my $getclasses= $dbh->prepare( +% "SELECT commodclass FROM commodclasses ORDER BY commodclass"); +% $getclasses->execute(); +<% + join '; ', map { $_->[0] =~ m/^./ or die; "$&$'" } + @{ $getclasses->fetchall_arrayref() } +%>. +

+ +Then, if applicable, follows a number from 0 to +9 indicating roughly where the commodity is in the +list of commodities of the same class. The number indicates which +tenth of the list is: 0 for the first (top) tenth, +1 for the 2nd, and so on, up to 9 +for the final tenth. + +

+For example, +

+ +
Fine pink cloth   +
C 2
+
+
+indicates that Fine pink cloth can be found under Cloth, +between 20% and 30% of the way down through the types of Cloth. +If you mouseover that in a suitably equipped browser you should see the +text: +
+Fine pink cloth is under Cloth, commodity 14 of 55 +
+

+ +The position indicator digit isn't shown for very small +categories. + +The exact location of the commodity in the actual game +client may vary because YARRG only considers the list of all possible +commodities, not the list of actual offers at the island in question. + +Also, not all commodities are always completely categorised or +ordered; we are working to add the additional data + + <& footer &>