X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=yarrg%2Fweb%2Fupload;h=a0c40fe2360e3c23b49472c5489060ef4ef9b2f4;hb=21ccec5e9026b0fa07a16c7b296e898ddaeba056;hp=63501a1f77b2fb761a32241cfb44f69ca31d734b;hpb=fc8ad971bcaad7dfc125dcc65e3ee2a3e11bbe9c;p=ypp-sc-tools.main.git diff --git a/yarrg/web/upload b/yarrg/web/upload index 63501a1..a0c40fe 100755 --- a/yarrg/web/upload +++ b/yarrg/web/upload @@ -34,62 +34,83 @@ %doc> <& docshead &> +<%shared> +my $url_base_base= 'http://yarrg.chiark.net/download/jarrg'; +%shared> +<%def downloadurl><%args> +$leaf +$test => 0 +# ^ change this to change the default version +%args><%perl> +my $download_version= $test ? '/test' : ''; +my $url_base= "$url_base_base$download_version"; +my $url= $url_base.'/'.$leaf; +%perl><% + $m->has_content ? $m->content : $url +%>%def>
The YARRG system has two main parts: this website which maintains a searchable database of commodity prices, and an upload client (known -as YARRG JPCTB), which screenscrapes the commodity data from the +as JARRG), which screenscrapes the commodity data from the Puzzle Pirates game client and uploads it to the database.
You will need to upload data yourself if there is no data for your ocean or island, or the data that is there is too old. You should -also upload when preparing trade run, as market conditions change and +also upload when preparing a trade run, as market conditions change and you want a plan based on recent data.
-The YARRG JPCTB upload client uploads both to YARRG and +The JARRG upload client uploads both to YARRG and PCTB. It is intended to replace both the "yarrg" and "PPAOCR" screenscrapers.
-To upload data, run the Puzzle Pirates client with JPCTB (as detailed -below). You should see both the Puzzle Pirates window and the JPCTB +To upload data, run the Puzzle Pirates client with JARRG (as detailed +below). You should see both the Puzzle Pirates window and the JARRG window appear. Log in normally, and visit a commodity trading screen (at a market, shoppe or vessel hold). Select "All Commodities" in the -YPP client. Then press "Upload" in the JPCTB window. +YPP client. Then press "Upload Market Data" in the JARRG window.
-The JPCTB integration is done via fully supported Java Accessibility -interfaces and without modifying the Puzzle Pirates client, and should -not disturb the normal running of Puzzle Pirates. However, please -make sure that if your YPP client misbehaves at all, you try running -it in the vanilla way (without JPCTB integration) before asking for -help. In particular, if the JPCTB startup does not work, but the -ordinary Puzzle Pirates startup does, report the problem to us, not to -Three Rings. +It is OK to switch away from the commodity list in Puzzle Pirates as +soon as the Jarrg progress bar appears. The uploader has taken a copy +of the data, so you can do something else while the upload takes +place. + +
+ +The JARRG integration is done via fully supported Java Accessibility +interfaces, and should not disturb the normal running of Puzzle +Pirates. However, please make sure that if your YPP client misbehaves +at all, you try starting it in the vanilla way (without JARRG +integration) before asking for help. In particular, if the JARRG +startup does not work, but the ordinary Puzzle Pirates startup does, +report the problem to us, not to Three Rings.
cd
) to the top level jarrg
directory
+which was created when you unpacked the tarball, and then run
-./jpctb /path/to/yohoho/yohoho +./jarrg /path/to/yohoho/yohohowhere
/path/to/yohoho/yohoho
is the location of the
ordinary Puzzle Pirates startup script, which is normally
@@ -98,42 +119,48 @@ ordinary Puzzle Pirates startup script, which is normally
+ +Essentially, JARRG is a specialised "screen reader" which instead of reading information out loud, uploads it to the YARRG and PCTB databases.
-YARRG JPCTB uses the Java Accessibility API, which is a part of the -Java platform. It's an interface provided for making applications -available to users with disabilities, for example for hooking in -screen readers. This approach was helpfully suggested by a Ringer in -the forums (to another developer of a third-party tool, wanting help -getting information out of Duty Reports). +JARRG uses the Java Accessibility API, which is a part of the +Java platform. It's a facility in Java, available for all Java +programs, intended to help make applications available to users with +disabilities: for example, it permits hooking in screen readers. The +use of the Java Accessibility API was helpfully suggested by a Ringer +in the forums (to another developer of a third-party tool, wanting +help getting information out of Duty Reports).
-Installing YARRG JPCTB does not modify any game files, and does not +Installing JARRG does not modify any game files, and does not hook into the game itself. It makes no permanent or global changes to your overall computer, operating system or Java configuration. And it does not access (indeed, we don't think it could access) any of the @@ -141,38 +168,48 @@ core game functionality which would make cheating possible.
-JPCTB works by running any unmodified copy of the YPP client but with -a separate JVM (Java Virtual Machine) configured to use the -appropriate accessibility plugin. We do this (rather than configuring -the computer's main JVM to use the JPCTB accessibility plugin) so that -it is still possible to launch Puzzle Pirates without JPCTB -(for example, in case the JPCTB client should cause any kind of -problem). +JARRG runs the unmodified Puzzle Pirates game, but with a separate +copy of your system's JVM (Java Virtual Machine); that copy of the JVM +is configured to use the JARRG accessibility plugin. We do this +(rather than configuring the computer's main JVM to use the +accessibility plugin) to avoid interfering with other uses of Java on +your computer - in particular, so that it is always possible to launch +Puzzle Pirates without JARRG (for example, in case the plugin +should cause any kind of problem). -
-YARRG JPCTB is +JARRG is Copyright 2006-2009 Burninator, Copyright 2009-2010 Owen Dunn and -Copyright 2009-2010 Ian Jackson. +Copyright 2009-2011 Ian Jackson. It is Free Software with NO WARRANTY, released under the MIT-style two-clause licence.
-The source code for the downloadable released binaries is in the
-Linux
-tarball. We maintain YARRG JPCTB in git, and you can get
-recent and perhaps unreleased versions from
-git://git.yarrg.chiark.net/jpctb.git
.
+The code for the downloadable binaries is in
+in <& downloadurl, leaf=>'jarrg-source.tar.gz' &>.
+The download directory also sometimes contains other versions
+(eg unreleased test versions), which you can see here:
+ <& downloadurl, leaf => '', test => 0 &>
+
+
+ +We maintain JARRG in git, and you can get +source code for recent and perhaps unreleased versions from one of: +
+git://git.yarrg.chiark.net/jarrg-ian.git (gitweb) +git://git.yarrg.chiark.net/jarrg-owen.git (gitweb) +