chiark / gitweb /
mention ijackson's repo for jpctb-linkfarmer
[ypp-sc-tools.main.git] / yarrg / web / upload
index 63501a1f77b2fb761a32241cfb44f69ca31d734b..7e90f69273b7d02b2939d9d0b16045a88ac7ad8e 100755 (executable)
 
 </%doc>
 <& docshead &>
+<%perl>
+my $url_base_base= 'http://yarrg.chiark.net/download/jpctb';
+my $download_version= '0.9.1';
+my $url_base= "$url_base_base/$download_version";
+</%perl>
 <h1>Uploading to YARRG</h1>
 <p>
 
@@ -46,7 +51,7 @@ 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 trade run, as market conditions change and
 you want a plan based on recent data.
 
 <p>
@@ -74,18 +79,17 @@ YPP client.  Then press "Upload" in the JPCTB window.
 <p>
 
 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.
+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
+startup does not work, but the ordinary Puzzle Pirates startup does,
+report the problem to us, not to Three Rings.
 
 <h3>Installing and running on Linux</h3>
 
 Download
-<a href="http://www.greenend.org.uk/owen/free/jpctb.tar.gz">http://www.greenend.org.uk/owen/free/jpctb.tar.gz</a>
+<a href="<% $url_base %>/jpctb.tar.gz"><% $url_base %>/jpctb.tar.gz</a>
 and unpack it.  You run it from the command line.  Change
 to the directory where you unpacked the tarball above, and then run
 <pre>
@@ -98,16 +102,16 @@ ordinary Puzzle Pirates startup script, which is normally
 <h3>Installing on Windows</h3>
 
 Download
-<a href="http://www.greenend.org.uk/owen/free/jpctb-linkfarmer/jpctp-setup.exe">http://www.greenend.org.uk/owen/free/jpctb-linkfarmer/jpctp-setup.exe</a>
+<a href="<% $url_base %>/jpctb-setup.exe"><% $url_base %>/jpctb-setup.exe</a>
 and double-click on it.  It will either:
-<nl>
+<ol>
 <li>Just work, in which case you'll have a new icon on your desktop which
    runs Puzzle Pirates with JPCTB integrated.
 <li>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
    won't lose any of your pirates or pieces of eight!)
-</nl>
+</ol>
 
 <h3>Installing on Macs</h3>
 
@@ -125,11 +129,12 @@ databases.
 <p>
 
 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).
+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).
 
 <p>
 
@@ -141,7 +146,7 @@ core game functionality which would make cheating possible.
 
 <p>
 
-JPCTB works by running any unmodified copy of the YPP client but with
+JPCTB works by running an 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
@@ -149,13 +154,14 @@ it is still possible to launch Puzzle Pirates <em>without</em> JPCTB
 (for example, in case the JPCTB client should cause any kind of
 problem).
 
-<h2>Authorship and source code</h2>
+<h2>Authorship, source code and other versions</h2>
 
 Thanks to Burninator for writing the core of the JPCTB client.  Ian
 Jackson and Owen Dunn adapted it to improve the installation setup (in
 particular, to more completely avoid modifying the YPP client's
 startup files, which Three Rings unsurprisingly objected to).  Owen
-Dunn added support for uploading to YARRG and a Windows installer.
+Dunn added support for uploading to YARRG, updated the build system,
+and wrote a Windows installer.
 
 <p>
 
@@ -168,11 +174,18 @@ the MIT-style two-clause licence.
 
 <p>
 
+The download directory contains some historical versions, which you
+can see here:
+<a href="<% $url_base_base %>/"><% $url_base_base %>/</a> .
+
+<p>
+
 The source code for the downloadable released binaries is in the
-<a href="http://www.greenend.org.uk/owen/free/jpctb.tar.gz">Linux
+<a href="<% $url_base %>/jpctb.tar.gz">Linux
 tarball</a>.  We maintain YARRG JPCTB in git, and you can get
-recent and perhaps unreleased versions from
-<code>git://git.yarrg.chiark.net/jpctb.git</code>.
+source code for recent and perhaps unreleased versions from
+<code>git://git.yarrg.chiark.net/jpctb.git</code> and/or
+<code>git://git.chiark.greenend.org.uk/~ijackson/jpctb.git</code> .
 
 
 </div>