chiark / gitweb /
Mention setting JAVA_HOME for build in README
[jarrg-owen.git] / README
1 JPCTB - a client for uploading to Yarrg and PCTB
2 ================================================
3
4 Linux
5 -----
6
7 To run on Linux run this command from wherever you unpacked the JPCTB
8 distribution:
9
10 ./jpctb /path/to/yohoho/yohoho
11
12 Windows
13 -------
14
15 On Windows, double-click jpctb-setup.exe to install JPCTB.  It will do
16 one of two things:
17
18 1) Just work, in which case you'll have a new icon on your desktop which
19    runs Puzzle Pirates with JPCTB integrated
20
21 2) Fail, and tell you what to do next.  Usually this means installing a
22    Java Runtime Environment (or JVM) and then uninstalling and re-
23    installing Puzzle Pirates.  (Don't worry about reinstalling; you
24    won't lose any of your pirates or pieces of eight!)
25
26 Source
27 ------
28
29 To build from source you will need a Java SDK, version 6, and Apache
30 ant, as well as NSIS to build the Windows installer package.
31
32   cd src
33   ant -f PCTB.xml
34
35 Currently this only seems to work with the Sun JDK.  If your default
36 JDK is OpenJDK then the following rune may work better:
37
38   JAVA_HOME=/usr/lib/jvm/java-6-sun ant -f PCTB.xml
39
40
41 Bugs
42 ----
43
44 Current known bugs include:
45
46 * Does not work from the Booty Pillaged screen, even though that has a
47   buy/sell commodities interface.
48