Manual adjustment of pirates aboard

[ypp-sc-tools.main.git] / yoweb-scrape.txt

diff --git a/yoweb-scrape.txt b/yoweb-scrape.txt
index 752080a3d23fb76166217b9afe93d9cc618e6b54..452fdd2e31004cc77a562dd0d0d29df477fb4a89 100644 (file)
--- a/yoweb-scrape.txt
+++ b/yoweb-scrape.txt
@@ -35,14 +35,37 @@ I know of one key defect:
    ship is empty when you return to it).
 
    This means that there needs to be a way to manually add and remove
-   pirates - but there isn't.  I think this could probably be added by
-   someone who could be bothered to replace the `sleep 1' in the main
-   loop by something which looked for keyboard input.
-
-   However it will notice that a pirate is on board if they abandon a
-   duty station (in circumstances where the game reports this in the
-   log, which doesn't seem to be all the time) or you give them a
-   stationing order, and from various other messages that might occur.
+   pirates.  This is as follows: send or receive a message on the crew
+   officer chat, or send (not receive!) a private message, of the
+   following format:
+         /a <pirate>...                        /d <pirate>...
+        /a <ship>: <pirate>...         /d <ship>: <pirate>...
+   <pirate> and <ship> can be in any case and will be converted to
+   the proper mixed-case form automatically.  <ship>, if it is not
+   provided, will be assumed to be the one you're on (so officers
+   shouldn't send these runes unless only one ship is out).  If <ship>
+   is supplied it may be the full ship name, or only the second word.
+
+   For example:
+         /a haddock: aiah
+        /d aiah
+        /a smart sunfish: copperkatie
+   These are actually sent by typing in the chat box things like:
+         /o /d plonker
+         /off /a hypiscles
+   since other formulations interpret the scraper command as a YPP
+   chat command.  This is deliberate and makes it harder to invoke by
+   mistake.
+
+   These messages can also be sent by some other officer in your crew
+   while you are off the vessel (although currently a bug means that
+   if you board some _other_ vessel then these messages for the vessel
+   you come back to may not be properly recorded).
+
+   The program will notice that a pirate is on board if you give them
+   a stationing order or they abandon a duty station (in circumstances
+   where the game reports this in the log, which doesn't seem to be
+   all the time), and from many of the other messages that occur.
 
 Other things to mention: