Grow a Garden — OBS Overlays

WebSocket: /ws

Quick Start

  1. Set your .env: JSTUDIO_KEY (required), PORT (default 3007), POLL_MS (default 30000).
  2. Run the server: npm start
  3. In OBS add a Browser Source → point to one of the overlay URLs below.

All-in-one Overlay

Combines seeds + gear + eggs, shows next restock timer, and pops a rainbow toast when new PRISMATIC items appear.

Route: /overlay
Params:
  • scale — CSS scale factor (default 1)
  • speed — vertical wheel speed px/sec (default 26)
  • toastMs — PRISMATIC toast duration ms (default 3500)
Example:

Seeds Overlay

Shows only seeds stock with timer. Scrolls even with exactly 3 items (static only if ≤2).

Route: /overlay-seeds
Params:
  • scale — CSS scale factor (default 1)
  • speed — vertical wheel speed px/sec (default 26)
Example:

Gear Overlay

Shows only gear stock with timer. Same wheel animation & styling.

Route: /overlay-gear
Params:
  • scale — CSS scale factor (default 1)
  • speed — vertical wheel speed px/sec (default 26)
Example:

Eggs Overlay

Shows only eggs stock with timer. Same wheel animation & styling.

Route: /overlay-eggs
Params:
  • scale — CSS scale factor (default 1)
  • speed — vertical wheel speed px/sec (default 26)
Example:

Environment & Endpoints

.env
  • JSTUDIO_KEY — your JStudio API key (required)
  • PORT — server port (default 3007)
  • POLL_MS — REST poll interval in ms (default 30000)
  • SECRET_TOKEN — optional for /debug/pingfetch
Server endpoints
  • GET / — this page
  • GET /health — basic JSON health
  • WS /ws — broadcast snapshots to overlays
  • POST /debug/pingfetch — manual refresh (header x-token: SECRET_TOKEN)