wiki-plugin-shoal

A Federated Wiki plugin that draws a magic fish shoal — an ambient boids animation over the page, grown from the farm's per-site fish signature. Built for Hitchhiker TV; purely client-side, no server component, no network calls.

Item syntax

UPPERCASE directives, one per line (optional trailing colon):

ANIMATION shoal            which animation from the curated library
SHOAL <species>            which fish species swim
COUNT 3–24                 how many fish
SIZE 6–24                  sprite size
LOITER 2–60                seconds the shoal loiters
WHEN logged-out|always|never   when the animation may run
TRIGGER flag|item          launch from the site flag or the item itself
FULLSCREEN                 take the whole window (the tank)
CAPTION <text>             caption under the item

Author-supplied animation code is deliberately not supported — behaviours ship in this package's curated library.

Install

npm install wiki-plugin-shoal

Restart the wiki server so the factory and the bundled about page register.

Develop

npm install
npm run build   # esbuild bundle into client/ (also run on publish)
npm test

src/client/vendor/fish.cjs is vendored from the author's own fish-picker project (MIT) — edit it upstream, not here.

License

MIT © David Bovill