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
  13 Windows
  14 -------
  15
  16 On Windows, double-click jpctb-setup.exe to install JPCTB.  It will do
  17 one of two things:
  18
  19 1) Just work, in which case you'll have a new icon on your desktop which
  20    runs Puzzle Pirates with JPCTB integrated
  21
  22 2) Fail, and tell you what to do next.  Usually this means installing a
  23    Java Runtime Environment (or JVM) and then uninstalling and re-
  24    installing Puzzle Pirates.  (Don't worry about reinstalling; you
  25    won't lose any of your pirates or pieces of eight!)
  26
  27
  28 Source
  29 ------
  30
  31 To build from source you will need a Java SDK, version 6, and Apache
  32 ant, as well as NSIS to build the Windows installer package.
  33
  34 You can run the script "build-sh" do to the build:
  35   ./build-sh
  36
  37 It will create in the current directory (the top level of the build)
  38 the .jar files for JPCTB and also the two distribution files:
  39   jpctb-setup.exe   the installer for windows users
  40   jpctb.tar.gz      a filtered tarball of this whole directory, for linux users
  41
  42 Currently the build only seems to work with the Sun JDK, so the script
  43 sets JAVA_HOME to /usr/lib/jvm/java-6-sun.  If that's not what you
  44 want, set JAVA_HOME yourself.
  45
  46 To make shipping the files a bit easier it prints a rune for rsyncing
  47 the files to the distribution site with a pathname based on the output
  48 from "git-describe".  You can set JPCTB_PUBLISH_BASE and ..._DIR to
  49 control the exact output.
  50
  51 If you want to clean out the build directory to make sure you get a
  52 rebuild from scratch, say
  53   git-clean -x -f -d
  54
  55
  56 Bugs
  57 ----
  58
  59 Current known bugs include:
  60
  61 * Does not work from the Booty Pillaged screen, even though that has a
  62   buy/sell commodities interface.
  63