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