From: Ian Jackson Date: Sun, 5 Sep 2010 13:32:25 +0000 (+0100) Subject: jpctb is now called jarrg X-Git-Tag: 6.7.0~14^2~5 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-live.git;a=commitdiff_plain;h=0c82a742fdea92a147690f6bde067f70567c3af1 jpctb is now called jarrg --- diff --git a/yarrg/web/devel b/yarrg/web/devel index c21ffa2..d23e5f2 100755 --- a/yarrg/web/devel +++ b/yarrg/web/devel @@ -145,7 +145,7 @@ has the specification of the mechanism and format for uploading to YARRG. If you would like to run a (perhaps modified) copy of the YARRG website it would be very easy for us to make our system send you copies of updates submitted by users of the YARRG clients including -YARRG JPCTB, in the format expected by the YARRG code. Please just +JARRG, in the format expected by the YARRG code. Please just ask us - at our end it's just a matter of us adding your database instance's special email address to our alias file. diff --git a/yarrg/web/scraper b/yarrg/web/scraper index e39ec2e..c5236b7 100755 --- a/yarrg/web/scraper +++ b/yarrg/web/scraper @@ -37,8 +37,8 @@

"yarrg" screenscraper for YARRG and PCTB

There is an obsolete screenscraper for Linux, known as "yarrg". It is -much slower and less reliable than JPCTB. We recommend you use -YARRG JPCTB instead. +much slower and less reliable than JARRG. We recommend you use +JARRG instead.

Instructions for using obsolete "yarrg"

diff --git a/yarrg/web/upload b/yarrg/web/upload index 5ec821c..5e4cd9f 100755 --- a/yarrg/web/upload +++ b/yarrg/web/upload @@ -35,7 +35,7 @@ <& docshead &> <%perl> -my $url_base_base= 'http://yarrg.chiark.net/download/jpctb'; +my $url_base_base= 'http://yarrg.chiark.net/download/jarrg'; my $download_version= 'test'; my $url_base= "$url_base_base/$download_version"; @@ -44,7 +44,7 @@ my $url_base= "$url_base_base/$download_version"; 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.

@@ -56,45 +56,45 @@ 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.

Instructions

-First you must install YARRG JPCTB, following the instructions for +First you must install JARRG, following the instructions for your operating system, below. This will not modify your Puzzle Pirates installation. Instead, it provides you with a new way to run -Puzzle Pirates which integrates it with JPCTB to provides a YARRG/PCTB +Puzzle Pirates which integrates it with JARRG to provides a YARRG/PCTB Upload facility.

-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 +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 JPCTB -integration) before asking for help. In particular, if the JPCTB +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.

Installing and running on Linux

Download -<% $url_base %>/jpctb.tar.gz -and unpack it. You run jpctb from the command line. Change -(cd) to the top level jpctb directory +<% $url_base %>/jarrg.tar.gz +and unpack it. You run jarrg from the command line. Change +(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/yohoho
where /path/to/yohoho/yohoho is the location of the ordinary Puzzle Pirates startup script, which is normally @@ -103,11 +103,11 @@ ordinary Puzzle Pirates startup script, which is normally

Installing on Windows

Download -<% $url_base %>/jpctb-setup.exe +<% $url_base %>/jarrg-setup.exe and double-click on it. It will either:
  1. Just work, in which case you'll have a new icon on your desktop which - runs Puzzle Pirates with JPCTB integrated. + runs Puzzle Pirates with JARRG integrated.
  2. Fail, and tell you what to do next. Usually this means installing a Java Runtime Environment (or JVM) and then uninstalling and re- installing Puzzle Pirates. (Don't worry about reinstalling; you @@ -117,19 +117,19 @@ and double-click on it. It will either:

    Installing on Macs

    We believe that it should be straightforward for a MacOS expert to get -YARRG JPCTB working properly on MacOS but we have not been able to +JARRG working properly on MacOS but we have not been able to test this ourselves. The Linux installation method is probably the best starting point.

    How does it work? Is it a violation of the Terms of Service?

    -Essentially, JPCTB is a specialised "screen reader" which instead of +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 +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 @@ -139,7 +139,7 @@ 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 @@ -147,18 +147,18 @@ core game functionality which would make cheating possible.

    -JPCTB runs the unmodified Puzzle Pirates game, but with a separate +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 JPCTB accessibility plugin. We do this +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 JPCTB (for example, in case the plugin +Puzzle Pirates without JARRG (for example, in case the plugin should cause any kind of problem).

    Authorship, source code and other versions

    -Thanks to Burninator for writing the core of the JPCTB client. Ian +Thanks to Burninator for writing the core of the JARRG client. Ian Jackson and Owen Dunn adapted it to improve the installation setup (in particular, to avoid modifying any of the YPP client's startup files). Owen Dunn added support for uploading to YARRG, updated the build @@ -166,7 +166,7 @@ system, and wrote a Windows installer.

    -YARRG JPCTB is +JARRG is Copyright 2006-2009 Burninator, Copyright 2009-2010 Owen Dunn and Copyright 2009-2010 Ian Jackson. @@ -182,12 +182,12 @@ versions), which you can see here:

    The source code for the downloadable released binaries is in the -Linux -tarball. We maintain YARRG JPCTB in git, and you can get +Linux +tarball. 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/jpctb-ian.git (gitweb)
-git://git.yarrg.chiark.net/jpctb-owen.git (gitweb)
+git://git.yarrg.chiark.net/jarrg-ian.git (gitweb)
+git://git.yarrg.chiark.net/jarrg-owen.git (gitweb)