mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-19 05:26:47 +00:00
mauriceboe
17f3c86967
Widget plugins can now declare capabilities.widget.slot 'hero' to render as a transparent, click-through overlay sitting on the boarding-pass bar's top edge (migration 157 persists capabilities; manifest validation server+SDK, feed exposes the slot, dashboard mounts hero frames above the pass). Sidebar stays the default slot. Replaces the trip-countdown example with Koffi, the TREK mascot: an animated suitcase with a 14-state behavior engine driven by real trip data — walking, waving, napping, trolley rolls, passport-stamp stickers, a split-flap luggage- tag countdown under 7 days, and sunglasses while the trip runs. Validated by the SDK suite like any author plugin; published as mauriceboe/trek-plugin-koffi in the registry. Migrations 156/157 follow the idempotent ALTER pattern (the reconciliation test re-runs everything from v135, so duplicate-column must stay non-fatal).
48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
# Koffi
|
|
|
|
> A tiny animated suitcase mascot that lives on your boarding pass.
|
|
|
|
|
|
|
|
## What it does
|
|
|
|
Koffi is TREK's mascot — a little vintage suitcase with travel stickers, a
|
|
swinging luggage tag, and big friendly eyes. He walks along the top edge of the
|
|
dashboard's boarding-pass bar, looks around, waves at you, reads his map, naps
|
|
(only when there's plenty of time), rolls a stretch in trolley mode, and
|
|
collects passport-stamp stickers.
|
|
|
|
He also reacts to your actual trip: the closer the departure, the more excited
|
|
he gets — under 7 days he jumps for joy and his luggage tag flips into an
|
|
airport-style split-flap countdown; while the trip is running he puts on tiny
|
|
sunglasses. Vacation mode.
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Permissions
|
|
|
|
| Permission | Why this plugin needs it |
|
|
|---|---|
|
|
| `db:read:trips` | To read the current trip's start/end dates so Koffi knows how excited to be. The read is membership-checked by TREK, so he only ever sees a trip you already have access to. |
|
|
|
|
No network access, no data storage of its own — Koffi just vibes.
|
|
|
|
## Setup
|
|
|
|
None. Enable plugins on your instance (`TREK_PLUGINS_ENABLED=true`), install
|
|
and activate Koffi, and he appears on the boarding-pass bar of your dashboard
|
|
hero. He respects `prefers-reduced-motion` (static pose, no locomotion).
|
|
|
|
Requires TREK ≥ 3.2.0 (hero widget slot).
|
|
|
|
## Building
|
|
|
|
Plain JS/HTML — no build step. `server/index.js` is the plugin entry;
|
|
`client/index.html` is the mascot iframe.
|
|
|
|
## License
|
|
|
|
MIT — see the TREK repository.
|