chiark / gitweb /
Midnight has some Lime dye; Cobalt has some Navy dye
[ypp-sc-tools.db-live.git] / yarrg / web / upload
1 <& docshead &>
2 <h1>Uploading to YARRG</h1>
3 <p>
4
5 The YARRG system has two main parts: this website which maintains a
6 searchable database of commodity prices, and an upload client, which
7 screenscrapes the commodity data from the Puzzle Pirates game client
8 and uploads it to the database.
9
10 <p>
11
12 You will need to upload data yourself if there is no data for your
13 ocean or island, or the data that is there is too old.  You should
14 also upload when preparing trade run, as market conditions change and
15 you want a plan based on recent data.
16
17 <h2>Uploading from Linux</h2>
18
19 The YARRG upload client uploads both to YARRG and
20 <a href="http://pctb.crabdance.com/">PCTB</a>.
21
22 <p>
23
24 The current official version of YARRG for use as an upload
25 client can browsed here:
26  <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>
27 See particularly the
28 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
29
30 <p>
31 To install the client, install the "git" version control system
32 and the other dependencies listed in the "Installation requirements"
33 section of the README and then run:
34 <pre>
35 git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
36 cd ypp-sc-tools
37 cd yarrg
38 make
39 </pre>
40 this will download the code into the directory <code>ypp-sc-tools</code>,
41 and build the software.  (If your Linux is very up to date you may
42 find that it complains that it doesn't know the command <kbd>git-core</kbd>.
43 In that case, use <kbd>git core</kbd>, with a space, instead.)
44
45 <p>
46
47 When new versions of the upload client are released, you can:
48 <pre>
49 cd .../ypp-sc-tools
50 git-pull
51 cd yarrg
52 make
53 </pre>
54 to fetch the new version.  (Again, you may need <kbd>git pull</kbd>
55 instead of <kbd>git-pull</kbd>.)
56
57 <h2>Uploading from Windows</h2>
58
59 There is not currently an upload client for Windows which feeds data
60 into YARRG.  It would probably be straightforward to modify the
61 Windows PCTB v5 upload client to upload to YARRG as well.
62
63 <p>
64
65 See our <a href="devel">Developers' information</a> page.
66
67 <h2>Uploading from Macs</h2>
68
69 There is not currently a publicly available upload client for Macs for
70 either YARRG or PCTB.
71
72 <p>
73
74 </div>
75 <& footer &>