Installation

Requirements

  • Windows with Overwolf installed for real game integration.
  • Node.js 22.12 or newer, pnpm 10.33.0, and optionally go-task.
  • Streamer.bot with its WebSocket and/or HTTP server enabled for live actions.

The project pins pnpm in package.json. Use pnpm, not npm. Overwolf hosts the distributed app’s JavaScript; Node.js is used for tooling and the simulator’s local server. Most integrations need no separate runtime bridge. Kick is an exception: both standalone and Overwolf require the separate Node.js Kick companion, obtained from this repository and started manually. It is not installed or started by the app.

Install dependencies

pnpm install --frozen-lockfile

or task install.

Run

Goal Command
Event Lab with hot reload task dev or pnpm dev
Build everything task build or pnpm build
Serve the built standalone task start or node dist/standalone/server.cjs
Overwolf development build task build:dev or task dev:overwolf
Overwolf OPK package task package:overwolf or pnpm package:overwolf
Local webhook gateway task dev:gateway or pnpm dev:gateway

The development simulator listens on http://127.0.0.1:5173. Its hot-reload WebSocket carries webpack development updates; it is not a Streamer.bot connection. The built server binds to 127.0.0.1; set PORT to change its port. To distribute the standalone app, copy the whole dist/standalone folder (server.cjs and app) and run node server.cjs.

See Development for every task and build output.