yarrg/web/docs

   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 the documentation.
  33
  34
  35 </%doc>
  36 <html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
  37 </head><body>
  38
  39 <h1>Introduction to YARRG</h1>
  40
  41 YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
  42 for helping find profitable trades and trade routes in Yohoho Puzzle
  43 Pirates.  It was inspired by
  44 <a href="http://pctb.crabdance.com/">PCTB</a>.
  45
  46 <p>
  47
  48 The system has two main parts: this website which maintains a
  49 searchable database of commodity prices, and an upload client, which
  50 screenscrapes the commodity data from the Puzzle Pirates game client
  51 and uploads it to the database.
  52
  53 <h2><a href="lookup">Market prices database</a></h2>
  54
  55 The <a href="lookup">lookup page</a> gives access to the uploaded data.
  56
  57 <h2>Uploading from Linux</h2>
  58
  59 The YARRG upload client uploads both to YARRG and to the
  60 <a href="pctb.ilk.org">PCTB testing server</a>.
  61
  62 <p>
  63
  64 The current official version of YARRG for use as an upload
  65 client can browsed here:
  66  <a href="/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
  67 See particularly the
  68 <a href="/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
  69
  70 <p>
  71 To install the client, install the `git' version control system
  72 and the other dependencies listed in the `Installation requirements'
  73 section of the README and then run:
  74 <pre>
  75 git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
  76 cd ypp-sc-tools
  77 cd yarrg
  78 make
  79 </pre>
  80 this will download the code into the directory <code>ypp-sc-tools</code>,
  81 and build the software.
  82
  83 <p>
  84
  85 When new versions of the upload client are released, you can:
  86 <pre>
  87 cd .../ypp-sc-tools
  88 git-pull
  89 cd yarrg
  90 make
  91 </pre>
  92 to fetch the new version.
  93
  94 <h2>Uploading from Windows</h2>
  95
  96 There is not currently an upload client for Windows which feeds data
  97 into YARRG.  It would probably be straightforward to modify the
  98 Windows PCTB v5 upload client to upload to YARRG as well.  The
  99 mechanism and format for uploading is documented in
 100 <a href="/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>.
 101
 102 <h1>YARRG development, contribution and troubleshooting</h1>
 103
 104 <h2>Free Software (aka Open Source)</h2>
 105
 106 YARRG is Free Software - you may share and modify it.  See the
 107 licences for details.
 108
 109 <p>
 110
 111 Not only the client but also the webserver code is Free.  The website
 112 code can be found in the same tree as above, in the <code>web</code>
 113 directory.
 114
 115 <p>
 116
 117 But in case we have made changes but not yet pushed them
 118 (perhaps because we haven't done a release), and to make it easy for
 119 anyone else who runs a copy of the website to provide everyone with
 120 the source for their version, the website code itself lets you download
 121 an up-to-date <a href="source.tar.gz">tarball</a> of its
 122 actually-running source code.
 123
 124 <p>
 125
 126 If you would like to run a (perhaps modified) copy of the YARRG
 127 website it would be very easy for us to make our system send you
 128 copies of updates submitted by users of the official YARRG client, in
 129 the format expected by the code you'll be running.  Please just ask
 130 us.
 131
 132 <h2>Contacting the YARRG developers</h2>
 133
 134 Email Ian Jackson ijackson (at) chiark.greenend.org.uk.  Or talk to
 135 any Fleet Officer or above of the crew Special Circumstances on the
 136 Midnight Ocean.
 137
 138 <& footer, isdocs => 1 &>