chiark / gitweb /
mention ijackson's repo for jpctb-linkfarmer
[ypp-sc-tools.db-live.git] / 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  --filter-separate-lock-owner
56      In the filter, show two separate 3-button filters for the lock
57      status, and the ship owner, rather than one 9-button filter with
58      an option for each combination.  (If there are no notes, only
59      one 3-button filter, for the lock status, is shown, anyway.)
60
61  --vessel-info-source RSYNC-SRC
62      Update information about vessels, subclasses, icons, etc. from
63      RSYNC-SRC.  Default is yarrg.chiark.net::yarrg/vessel-info.
64      If RSYNC-SRC is the empty string, do not update and just use
65      local data from icons/* and _vessel_info_cache.
66
67  --clipboard-file FILE
68      Use FILE as the initial clipboard containing a set of vessels to
69      display, rather than waiting for Acquire.  Useful for testing or
70      if you want to save your vessel locations for when you're not
71      logged in.  The easiest way to create a suitable FILE is
72      xclipboard
73
74  --local-html-dir DIR
75      Do not fetch ocean map from Yppedia.  Instead, use copy in DIR.
76
77
78 USER INTERFACE:
79 ===============
80
81 There are some things that won't be obvious from the user interface.
82
83 The black square with the blue square inside it is the panner for the
84 map.
85
86 If you get an error message from Acquire, or a message about the
87 notes, shown as a red, yellow or blue message below the Acquire or
88 Reload Notes button, you can click on the message to get a pop-up
89 window with the full error message.
90
91 Colonised islands are shown with names in black; uncolonised in grey.
92 Dotted routes are unpurchaseable charts.  (Information from Yppedia.)
93
94 If you click on one of the little white icons on the map, you'll see
95 an explanation of what that icon string means appear in the top right.
96 Each element of the icon is explained in turn from left to right.
97 Then you'll see a list of the ships represented below, ordered by
98 owning pirate (if known) and then by name.
99
100 The "Show" panel allows you to filter the displayed ships.  If you
101 don't select "These:" then none of the other controls in the "Show"
102 panel have any effect, so touching any of the latter sets the overall
103 filtering style back to "These:".
104
105 "Copy island names" makes where-vessels "copy" (as in "copy and
106 paste") a comma-separated list of the names of the islands at which
107 selected ships are present.  You can then paste this into other tools
108 (eg, the YARRG website).  (Technically, "copy island names" claims the
109 X Primary Selection.)
110
111 "Display/combine details" allows the map display to be decluttered by
112 squashing together differing ships:
113  * "Size round down": selecting a size means that every ship of that
114    size will be rounded down to the next un-selected size.  Naturally
115    you cannot select sloops for rounding down!
116  * "Lock/owner": "Yours?" simply pretends that all unknown ships are
117    not yours; that is useful if your crew has many ships and you only
118    bother writing about your own ships in the notes.  "For you" shows
119    the vessel lock status, except that if it's your ship and unlocked
120    it shows just that it's yours (and doesn't show whether it's
121    unlocked or crew use).  "Lock" shows the lock status only.
122  * Flags: See perlop(1) on the tr/// (aka y///) operator.  All
123    characters entered into the boxes are literal; ranges etc. are not
124    supported.
125 Filtering done by the "Show" panel takes effect before the collapsing
126 done by "Display/combine details", so you can filter on details which
127 you are collapsing for display.
128
129 If you select (click on) one of the ship names in the list in the top
130 right, you'll get an icon string below the vessel list which gives the
131 complete information for that vessel, as it was before the collapsing.
132
133
134
135 VESSEL NOTES:
136 =============
137
138 The information collected via the clipboard from the Yohoho Puzzle
139 Pirates client does not include any information about who owns the
140 ship.  (Sadly, it doesn't even include whether the ship is yours, even
141 though this can be seen on the screen by looking at whether the icon
142 has a blue fringe.)
143
144 It also doesn't include any information about how the ship is stocked,
145 what might be recorded on the Officer Notice Board about how it is to
146 be used, etc.
147
148 So to help you make sense of your fleet, where-vessels can read a file
149 of notes about each ship.  The lines in this file are of the form:
150   <vessel-id> <name> = <owning pirate name> [<flags>]
151
152 If your vessel-notes file doesn't mention a ship, you can click on the
153 message "1 warning(s)" below "Reload notes" and it will open a window
154 showing what the problem is.  This will include, for ships missing
155 from the notes, a template line for each ship, eg:
156     # Eta Island:
157     1730081   High Silverside               =
158 Copy and paste the line with the ship name to your vessel-notes file
159 and fill it in, eg:
160     1730081   High Silverside               =  Anaplian   T
161 You probably don't want to copy the line with the island name into
162 your vessel-notes; it's just there to help you identify and find the
163 ship in question (for example if you want to look at it in-game), but
164 it will become out of date if the ship moves.
165
166 Blank lines are ignored, as are lines starting with #.
167
168 It is best if you can arrange to have a single notes file for the
169 whole crew, and find some what to edit it collectively.
170
171 Flags:
172 ------
173
174 The "flags" field has nothing to do with the in-game political entity
175 known as a Flag.  It's a mostly free-form text field, with the
176 following properties:
177  - It is displayed next to each ship on the map (so ships with
178     non-identical flags are not grouped and counted)
179  - You can filter ships by entering a Perl regexp on the flags
180  - It may not contain spaces
181
182 It is therefore usually best to use the flags field for one-letter
183 codes referring to the properties of each ship.  Here is an example,
184 from the Special Circumstances shared vessel-notes file:
185
186 # Don't edit if you're not logged into Puzzle Pirates.
187 # To avoid simultaneous clashing edits, please coordinate with
188 # your other Fleet Officers using the in-game chat.
189
190 # Flags for the column after the owner.
191 #
192 #  L    Ship is public special use.  Eg the chart library.
193 #
194 #  S    Ship is personal special use.  Eg, personal storage
195 #       for a stall or personal trading.
196 #
197 #  P    Ship is stocked and otherwise suitable for pillaging etc:
198 #       It is normally kept well stocked with rum and cannonballs and
199 #       doesn't mind much where it's left.
200 #
201 #  T    Ship is stocked and otherwise suitable for trading or memming:
202 #       It is normally kept stocked with a little rum but few if any
203 #       cannonballs.  It doesn't mind much where it's left.
204 #
205 #  G    Ship is often used for the ad-hoc storage of commodities eg
206 #       as part of trading activities.
207 #
208 #  R    Ship is borrowable but with some restrictions; ONB has details.
209 #
210 #  A    Ship is an auxiliary vessel (eg a supply sloop) or normally
211 #       sails as part of a convoy.
212 #
213 #  DO NOT rely on this file to be up to date.  Check the Officer
214 #  Notice Board before borrowing a ship.