signalk-race-control 0.1.0 → 0.3.0

package/README.md

@@ -7,6 +7,21 @@ and a live projected finishing order — during and after the race.
 - **Named, plannable races** — create races ahead of time, optionally with a
   scheduled start; switch between past and upcoming races from a dropdown to
   review results later. Nothing gets overwritten by starting the next race.
+- **Overnight / multi-day races** — most races are same-day, so this is off by
+  default; a normal finish-time entry (like `21:14:07`) already rolls over to the
+  next calendar day on its own if it's earlier than the start, so an ordinary race
+  finishing just after midnight needs nothing special. Check **Overnight / multi-day
+  race** when creating one instead (fixed for that race, not changeable afterward)
+  only once a single automatic day-rollover isn't enough — a multi-day distance
+  race, say — and finish/start times are then entered with a full date, not just a
+  time-of-day. Elapsed/corrected time already display past 24 hours either way (e.g.
+  `30:00:00`).
+- **Individual start times** — override the race's single start time for one boat at
+  a time (in its own **Start time** column, right next to Finish time): for a
+  staggered/pursuit start, or to correct a boat that didn't actually get away with
+  the fleet. Left blank, a boat just uses the race's own start time as before.
+  Starting or resetting the race clears every boat's override along with its finish
+  time, ready for a clean re-run.
 - **Add/remove boats explicitly** — type a name (autocompletes against the VET
   register, the cross-race boat registry, and any live AIS/self vessel — matching
   anywhere in the name, not just the start) and click **Add Boat**. Boats aren't
@@ -38,6 +53,23 @@ and a live projected finishing order — during and after the race.
   from a live AIS/self vessel with a matching name), it's remembered in a small
   cross-race registry: add a boat with the same name in a later race and its MMSI
   fills in on its own.
+- **Import a whole fleet from Manage2Sail** — off by default (`raceImportEnabled` in
+  the plugin's settings, alongside `vetEnabled`); once turned on, an **Import boats
+  from Manage2Sail** section lets you paste a Manage2Sail event URL, pick one or more
+  of its classes, and add every entry in them as a boat in the current race. Since a
+  class's published handicap number isn't always a directly-usable Time-on-Time
+  factor — Yardstick numbers, for instance, run the opposite direction (lower number
+  = faster boat) and need `TCF = 100 / number` (or `1000 /` for the RYA scale) rather
+  than being used as-is — the plugin converts it automatically once it recognizes the
+  system. If a class's numbers don't clearly match a known system's scale, you're
+  asked to pick which one applies (e.g. Yardstick vs. Portsmouth Yardstick) before
+  anything is imported for it; anything else unrecognized (ORC, IRC, ...) is used
+  as-is, same as before. Re-importing updates TCF on boats it already added (matched
+  by name) instead of duplicating them. Not every entry has a named boat — where
+  Manage2Sail has no boat name, the sail number is used as the identifier instead of
+  falling back to the skipper's name, and every imported boat's sail number is also
+  set in its own **Sail #** column (editable directly, like MMSI) whether or not it
+  ended up as the name.
 - **Editable finish times** — click **Now** to record a finish as it happens, type a
   specific `HH:MM:SS` into the finish-time field to correct a mistimed click, or
   **Clear** to undo. Handles races that cross midnight.
@@ -70,11 +102,26 @@ and a live projected finishing order — during and after the race.
   countdown to the moment self would tie them on corrected time if that boat has
   already finished (going negative, in red, once self can no longer catch up even by
   finishing instantly), or the current corrected-time gap if both are still racing or
-  both have finished.
+  both have finished. With no boat marked self, the column instead compares everyone
+  against the current **leader** (tagged accordingly), so it's never just blank.
 - **Export to Excel** — a genuine `.xlsx` snapshot of the current standings (same
-  ranking, same rows as the on-screen table: rank, boat, MMSI, TCF, elapsed,
-  corrected, finish time, status), with the finish-time column rendered in your
-  browser's own timezone rather than the server's.
+  ranking, same rows as the on-screen table: rank, boat, sail number, MMSI, TCF,
+  start time, elapsed, corrected, finish time, status), with the time columns
+  rendered in your browser's own timezone rather than the server's (and with the
+  date included, for a multi-day race).
+- **Download Offline Timer** — a single self-contained `.html` file, seeded with the
+  current race's boats, TCF, and multi-day setting, that runs the core of race timing
+  (start/stop/resume/reset, add/remove boats, edit TCF, individual start times,
+  record finishes, DNF, self-comparison) with no server and no internet connection at
+  all — including its own editable **Race start** field (Now/Clear, right under the
+  Start/Stop/Resume/Reset buttons) for backdating or correcting the race's start time
+  directly, without needing to click Start Race and lose already-recorded progress —
+  a backup for keeping a race running if
+  this plugin's server becomes unreachable mid-event. It saves everything to that
+  browser's own local storage, so closing and reopening the same downloaded file picks
+  up right where you left off. AIS boat names/positions, VET-tall lookup, and the
+  course/chart all need the live server and aren't included; TCF is entered by hand
+  instead. Also has its own "Download results as CSV" button.
 
 ## Install
 
@@ -93,8 +140,11 @@ Then restart the SignalK server, enable "Race Control" under
 
 ## Using it
 
-1. Click **+ New Race**, give it a name (e.g. "Onsdagsseilas 3"). It becomes the
-   active race, shared across every open browser tab/device.
+1. Click **+ New Race**, give it a name (e.g. "Onsdagsseilas 3"), and check
+   **Overnight / multi-day race** only if a single automatic day-rollover on finish
+   times won't be enough (can't be changed after creating the race) — leave it
+   unchecked for the usual same-day race, even one that finishes after midnight. It
+   becomes the active race, shared across every open browser tab/device.
 2. Add boats by name. Each gets a default TCF of 1.0 — edit it directly, or use the
    VET-alternatives dropdown once a matching register entry is found. Set an MMSI per
    boat if you want its AIS position tracked for the chart/estimate.
@@ -102,8 +152,15 @@ Then restart the SignalK server, enable "Race Control" under
    order — reorder with ↑/↓), and finish line, then **Save Course**.
 4. Either click **Start Race** now, or set a date/time and click **Schedule Start** —
    the race starts itself automatically at that moment (even across a server restart).
-5. As boats finish, click **Now** to stamp the current time, or type the exact
-   `HH:MM:SS` into the finish-time field. **Clear** undoes a finish.
+   Clicked it a little late? Fix the recorded moment directly in the **Race start**
+   field next to the clock (Now/Clear) — unlike Reset, it never touches any boat's
+   finish time, DNF, or individual start override. If a particular boat actually
+   started at a different moment (a staggered/pursuit start, or a correction), set
+   its own time in the **Start time** column instead of leaving it to follow the
+   race's start.
+5. As boats finish, click **Now** to stamp the current time, or type the exact time
+   (plus date, for a multi-day race) into the finish-time field. **Clear** undoes a
+   finish.
 6. **Stop** calls the race off now (freezes the clock, DNFs whoever hasn't finished);
    **Schedule Call-off** does the same at a future time instead. **Resume** discards
    a stop and un-DNFs whoever it DNF'd. **Reset** (click once to arm, again to
@@ -112,7 +169,9 @@ Then restart the SignalK server, enable "Race Control" under
 7. Click a boat's ☆ to mark it **self** and see the **vs Self** column fill in for
    every other boat.
 8. **Export to Excel** downloads the current standings as a `.xlsx` file at any time
-   — before, during, or after the race.
+   — before, during, or after the race. **Download Offline Timer** grabs a standalone
+   backup copy of the race instead — worth doing before the start if you want a safety
+   net in case the server drops out mid-race.
 9. Switch races anytime via the dropdown at the top to review an earlier race's
    results, or plan the next one. **Delete Race** (arm-then-confirm) removes one.