yarrg/web/intro

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