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 lang="en"><head>
  37 <title>YARRG (Yet Another Revenue Research Gatherer)</title>
  38 <link rel="stylesheet" type="text/css" href="style.css">
  39 </head><body>
  40
  41 <div class="navoptbar">
  42 <a href="lookup">YARRG</a> -
  43  Yet Another Revenue Research Gatherer
  44 |
  45 <b>introduction</b>
  46 |
  47 <a href="docs">documentation</a>
  48 |
  49 <a href="devel">development</a>
  50 </div>
  51 <div class="docs">
  52 <h1>Introduction to YARRG</h1>
  53
  54 YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
  55 for helping find profitable trades and trade routes in Yohoho Puzzle
  56 Pirates.  It was inspired by
  57 <a href="http://pctb.crabdance.com/">PCTB</a>.
  58
  59 <p>
  60
  61 The system has two main parts: this website which maintains a
  62 searchable database of commodity prices, and an upload client, which
  63 screenscrapes the commodity data from the Puzzle Pirates game client
  64 and uploads it to the database.
  65
  66 <h2><a href="lookup">Market prices database</a></h2>
  67
  68 The <a href="lookup">lookup page</a> gives access to the uploaded data;
  69 there is also <a href="docs">documentation</a> to help with using that
  70 website.
  71
  72 <h2>Uploading from Linux</h2>
  73
  74 The YARRG upload client uploads both to YARRG and to the
  75 <a href="http://pctb.ilk.org/">PCTB testing server</a>.
  76
  77 <p>
  78
  79 The current official version of YARRG for use as an upload
  80 client can browsed here:
  81  <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
  82 See particularly the
  83 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
  84
  85 <p>
  86 To install the client, install the `git' version control system
  87 and the other dependencies listed in the `Installation requirements'
  88 section of the README and then run:
  89 <pre>
  90 git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
  91 cd ypp-sc-tools
  92 cd yarrg
  93 make
  94 </pre>
  95 this will download the code into the directory <code>ypp-sc-tools</code>,
  96 and build the software.  (If your Linux is very up to date you may
  97 find that it complains that it doesn't know the command <kbd>git-core</kbd>.
  98 In that case, use <kbd>git core</kbd>, with a space, instead.)
  99
 100 <p>
 101
 102 When new versions of the upload client are released, you can:
 103 <pre>
 104 cd .../ypp-sc-tools
 105 git-pull
 106 cd yarrg
 107 make
 108 </pre>
 109 to fetch the new version.  (Again, you may need <kbd>git pull</kbd>
 110 instead of <kbd>git-pull</kbd>.)
 111
 112 <h2>Uploading from Windows</h2>
 113
 114 There is not currently an upload client for Windows which feeds data
 115 into YARRG.  It would probably be straightforward to modify the
 116 Windows PCTB v5 upload client to upload to YARRG as well.
 117
 118 <p>
 119
 120 See our <a href="devel">Developers' information</a> page.
 121
 122 <h2>Contacting the YARRG developers</h2>
 123
 124 Email Ian Jackson ijackson (at) chiark.greenend.org.uk.  Or talk to
 125 any Fleet Officer or above of the crew Special Circumstances on the
 126 Midnight Ocean.
 127
 128 </div>
 129 <& footer &>