yarrg/web/upload

   1 <%doc>
   2
   3  This is part of the YARRG website.  YARRG is a tool and website
   4  for assisting players of Yohoho Puzzle Pirates.
   5
   6  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   7  Copyright (C) 2009 Clare Boothby
   8
   9   YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
  10   The YARRG website is covered by the GNU Affero GPL v3 or later, which
  11    basically means that every installation of the website will let you
  12    download the source.
  13
  14  This program is free software: you can redistribute it and/or modify
  15  it under the terms of the GNU Affero General Public License as
  16  published by the Free Software Foundation, either version 3 of the
  17  License, or (at your option) any later version.
  18
  19  This program is distributed in the hope that it will be useful,
  20  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  GNU Affero General Public License for more details.
  23
  24  You should have received a copy of the GNU Affero General Public License
  25  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26
  27  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
  28  are used without permission.  This program is not endorsed or
  29  sponsored by Three Rings.
  30
  31
  32  This Mason component generates information about the uploader.
  33
  34
  35 </%doc>
  36 <& docshead &>
  37 <%perl>
  38 my $download_version= '0.9.1';
  39 my $url_base= 'http://yarrg.chiark.net/download/jpctb/'.$download_version;
  40 </%perl>
  41 <h1>Uploading to YARRG</h1>
  42 <p>
  43
  44 The YARRG system has two main parts: this website which maintains a
  45 searchable database of commodity prices, and an upload client (known
  46 as YARRG JPCTB), which screenscrapes the commodity data from the
  47 Puzzle Pirates game client and uploads it to the database.
  48
  49 <p>
  50
  51 You will need to upload data yourself if there is no data for your
  52 ocean or island, or the data that is there is too old.  You should
  53 also upload when preparing a trade run, as market conditions change and
  54 you want a plan based on recent data.
  55
  56 <p>
  57
  58 The YARRG JPCTB upload client uploads both to YARRG and
  59 <a href="http://pctb.crabdance.com/">PCTB</a>.  It is intended to
  60 replace both the <a href="scraper">"yarrg"</a> and "PPAOCR" screenscrapers.
  61
  62 <h2>Instructions</h2>
  63
  64 First you must install YARRG JPCTB, following the instructions for
  65 your operating system, below.  This will not modify your Puzzle
  66 Pirates installation.  Instead, it provides you with a new way to run
  67 Puzzle Pirates which integrates it with JPCTB to provides a YARRG/PCTB
  68 Upload facility.
  69
  70 <p>
  71
  72 To upload data, run the Puzzle Pirates client with JPCTB (as detailed
  73 below).  You should see both the Puzzle Pirates window and the JPCTB
  74 window appear.  Log in normally, and visit a commodity trading screen
  75 (at a market, shoppe or vessel hold).  Select "All Commodities" in the
  76 YPP client.  Then press "Upload" in the JPCTB window.
  77
  78 <p>
  79
  80 The JPCTB integration is done via fully supported Java Accessibility
  81 interfaces, and should not disturb the normal running of Puzzle
  82 Pirates.  However, please make sure that if your YPP client misbehaves
  83 at all, you try starting it in the vanilla way (without JPCTB
  84 integration) before asking for help.  In particular, if the JPCTB
  85 startup does not work, but the ordinary Puzzle Pirates startup does,
  86 report the problem to us, not to Three Rings.
  87
  88 <h3>Installing and running on Linux</h3>
  89
  90 Download
  91 <a href="<% $url_base %>/jpctb.tar.gz"><% $url_base %>/jpctb.tar.gz</a>
  92 and unpack it.  You run it from the command line.  Change
  93 to the directory where you unpacked the tarball above, and then run
  94 <pre>
  95 ./jpctb /path/to/yohoho/yohoho
  96 </pre>
  97 where <code>/path/to/yohoho/yohoho</code> is the location of the
  98 ordinary Puzzle Pirates startup script, which is normally
  99 <code>yohoho/yohoho</code> in your home directory.
 100
 101 <h3>Installing on Windows</h3>
 102
 103 Download
 104 <a href="<% $url_base %>/jpctb-setup.exe"><% $url_base %>/jpctb-setup.exe</a>
 105 and double-click on it.  It will either:
 106 <ol>
 107 <li>Just work, in which case you'll have a new icon on your desktop which
 108    runs Puzzle Pirates with JPCTB integrated.
 109 <li>Fail, and tell you what to do next.  Usually this means installing a
 110    Java Runtime Environment (or JVM) and then uninstalling and re-
 111    installing Puzzle Pirates.  (Don't worry about reinstalling; you
 112    won't lose any of your pirates or pieces of eight!)
 113 </ol>
 114
 115 <h3>Installing on Macs</h3>
 116
 117 We believe that it should be straightforward for a MacOS expert to get
 118 YARRG JPCTB working properly on MacOS but we have not been able to
 119 test this ourselves.  The Linux installation method is probably the
 120 best starting point.
 121
 122 <h2>How does it work?  Is it a violation of the Terms of Service?</h2>
 123
 124 Essentially, JPCTB is a specialised "screen reader" which instead of
 125 reading information out loud, uploads it to the YARRG and PCTB
 126 databases.
 127
 128 <p>
 129
 130 YARRG JPCTB uses the Java Accessibility API, which is a part of the
 131 Java platform.  It's a facility in Java, available for all Java
 132 programs, intended to help make applications available to users with
 133 disabilities: for example, it permits hooking in screen readers.  The
 134 use of the Java Accessibility API was helpfully suggested by a Ringer
 135 in the forums (to another developer of a third-party tool, wanting
 136 help getting information out of Duty Reports).
 137
 138 <p>
 139
 140 Installing YARRG JPCTB does not modify any game files, and does not
 141 hook into the game itself.  It makes no permanent or global changes to
 142 your overall computer, operating system or Java configuration.  And it
 143 does not access (indeed, we don't think it could access) any of the
 144 core game functionality which would make cheating possible.
 145
 146 <p>
 147
 148 JPCTB works by running an unmodified copy of the YPP client but with
 149 a separate JVM (Java Virtual Machine) configured to use the
 150 appropriate accessibility plugin.  We do this (rather than configuring
 151 the computer's main JVM to use the JPCTB accessibility plugin) so that
 152 it is still possible to launch Puzzle Pirates <em>without</em> JPCTB
 153 (for example, in case the JPCTB client should cause any kind of
 154 problem).
 155
 156 <h2>Authorship and source code</h2>
 157
 158 Thanks to Burninator for writing the core of the JPCTB client.  Ian
 159 Jackson and Owen Dunn adapted it to improve the installation setup (in
 160 particular, to more completely avoid modifying the YPP client's
 161 startup files, which Three Rings unsurprisingly objected to).  Owen
 162 Dunn added support for uploading to YARRG, updated the build system,
 163 and wrote a Windows installer.
 164
 165 <p>
 166
 167 YARRG JPCTB is
 168 Copyright 2006-2009 Burninator,
 169 Copyright 2009-2010 Owen Dunn and
 170 Copyright 2009-2010 Ian Jackson.
 171 It is Free Software with <strong>NO WARRANTY</strong>, released under
 172 the MIT-style two-clause licence.
 173
 174 <p>
 175
 176 The source code for the downloadable released binaries is in the
 177 <a href="<% $url_base %>/jpctb.tar.gz">Linux
 178 tarball</a>.  We maintain YARRG JPCTB in git, and you can get
 179 source code for recent and perhaps unreleased versions from
 180 <code>git://git.yarrg.chiark.net/jpctb.git</code>.
 181
 182
 183 </div>
 184 <& footer &>