yarrg/README.where-vessels

   1                         where-vessels
   2                         =============
   3
   4 where-vessels displays a map of the ocean with your ships marked on it.
   5
   6
   7 USAGE:
   8 ======
   9
  10     $ cd .../ypp-sc-tools/yarrg
  11     $ ./where-vessels [options]
  12
  13     Then, in your YPP client:
  14       * go to the docks of any island
  15       * click on the button "Where are my vessels"
  16       * press Ctrl-A Ctrl-C
  17
  18     In where-vessels, click "Acquire"
  19
  20 You may well want to create a "vessel-notes" file to get the best
  21 use out of where-vessels, see below.
  22
  23 If you don't have exactly one YPP client open and logged in then you
  24 will have to pass --ocean and --pirate options.
  25
  26 If there was trouble acquiring the data (or loading the notes, see
  27 below) you can click on the error message to open a window giving
  28 information about the problem.
  29
  30
  31 OPTIONS:
  32 ========
  33
  34  --ocean OCEAN
  35      Use map of OCEAN.  Default is to guess by looking for an
  36      open Puzzle Pirates client on the same display (logged on
  37      as PIRATE, if --pirate was used).
  38
  39  --pirate PIRATE
  40      Supplies the name of your pirate.  If you also supply a notes
  41      file (see below) where-vessels will treat ships belonging to
  42      PIRATE as your own.  An empty argument means do not care about
  43      vessel ownership.  Default is not to care about ownership without
  44      notes; with notes, default is to look for a Puzzle Pirates client
  45      on the same display (on OCEAN, if --ocean was used).
  46
  47  --notes SOURCE
  48      Use SOURCE as the vessel notes.  See below.
  49      SOURCE may be of the following forms:
  50        empty argument            No notes, this is the default
  51        SCHEME:... eg http:...    URL, fetched with Tcl's http package
  52        |COMMAND ARG ARG          command (Tcl list) whose output is the notes
  53        NOTES-FILE                ordinary file
  54
  55  --vessel-info-source RSYNC-SRC
  56      Update information about vessels, subclasses, icons, etc. from
  57      RSYNC-SRC.  Default is yarrg.chiark.net::yarrg/vessel-info.
  58      If RSYNC-SRC is the empty string, do not update and just use
  59      local data from icons/* and _vessel_info_cache.
  60
  61  --clipboard-file FILE
  62      Use FILE as the initial clipboard containing a set of vessels to
  63      display, rather than waiting for Acquire.  Useful for testing or
  64      if you want to save your vessel locations for when you're not
  65      logged in.  The easiest way to create a suitable FILE is
  66      xclipboard
  67
  68  --local-html-dir DIR
  69      Do not fetch ocean map from Yppedia.  Instead, use copy in DIR.
  70
  71
  72 VESSEL NOTES:
  73 =============
  74
  75 The information collected via the clipboard from the Yohoho Puzzle
  76 Pirates client does not include any information about who owns the
  77 ship.  (Sadly, it doesn't even include whether the ship is yours, even
  78 though this can be seen on the screen by looking at whether the icon
  79 has a blue fringe.)
  80
  81 It also doesn't include any information about how the ship is stocked,
  82 what might be recorded on the Officer Notice Board about how it is to
  83 be used, etc.
  84
  85 So to help you make sense of your fleet, where-vessels can read a file
  86 of notes about each ship.  The lines in this file are of the form:
  87   <vessel-id> <name> = <owning pirate name> [<flags>]
  88
  89 If your vessel-notes file doesn't mention a ship, you can click on the
  90 message "1 warning(s)" below "Reload notes" and it will open a window
  91 showing what the problem is.  This will include, for ships missing
  92 from the notes, a template line for each ship, eg:
  93     # Eta Island:
  94     1730081   High Silverside               =
  95 Copy and paste the line with the ship name to your vessel-notes file
  96 and fill it in, eg:
  97     1730081   High Silverside               =  Anaplian   T
  98 You probably don't want to copy the line with the island name into
  99 your vessel-notes; it's just there to help you identify and find the
 100 ship in question (for example if you want to look at it in-game), but
 101 it will become out of date if the ship moves.
 102
 103 Blank lines are ignored, as are lines starting with #.
 104
 105 It is best if you can arrange to have a single notes file for the
 106 whole crew, and find some what to edit it collectively.
 107
 108 Flags:
 109 ------
 110
 111 The "flags" field has nothing to do with the in-game political entity
 112 known as a Flag.  It's a mostly free-form text field, with the
 113 following properties:
 114  - It is displayed next to each ship on the map (so ships with
 115     non-identical flags are not grouped and counted)
 116  - You can filter ships by entering a Perl regexp on the flags
 117  - It may not contain spaces
 118
 119 It is therefore usually best to use the flags field for one-letter
 120 codes referring to the properties of each ship.  Here is an example,
 121 from the Special Circumstances shared vessel-notes file:
 122
 123 # Don't edit if you're not logged into Puzzle Pirates.
 124 # To avoid simultaneous clashing edits, please coordinate with
 125 # your other Fleet Officers using the in-game chat.
 126
 127 # Flags for the column after the owner.
 128 #
 129 #  L    Ship is public special use.  Eg the chart library.
 130 #
 131 #  S    Ship is personal special use.  Eg, personal storage
 132 #       for a stall or personal trading.
 133 #
 134 #  P    Ship is stocked and otherwise suitable for pillaging etc:
 135 #       It is normally kept well stocked with rum and cannonballs and
 136 #       doesn't mind much where it's left.
 137 #
 138 #  T    Ship is stocked and otherwise suitable for trading or memming:
 139 #       It is normally kept stocked with a little rum but few if any
 140 #       cannonballs.  It doesn't mind much where it's left.
 141 #
 142 #  G    Ship is often used for the ad-hoc storage of commodities eg
 143 #       as part of trading activities.
 144 #
 145 #  R    Ship is borrowable but with some restrictions; ONB has details.
 146 #
 147 #  A    Ship is an auxiliary vessel (eg a supply sloop) or normally
 148 #       sails as part of a convoy.
 149 #
 150 #  DO NOT rely on this file to be up to date.  Check the Officer
 151 #  Notice Board before borrowing a ship.