Documentation

Quick Start

  1. 1

    Clone the repository

    git clone https://github.com/ospinajuanp/ospinajuanp-macroboard.git
  2. 2

    Install dependencies

    pnpm install
  3. 3

    Start the development server

    pnpm dev

OBS Configuration

The server connects to OBS via WebSocket. Make sure OBS is running with the WebSocket plugin enabled.

  • Enable WebSocket in OBS Settings → General
  • Set a password if desired
  • Default port is 4455

Building for Production

To create the Windows executable:

pnpm clean && pnpm build && pnpm package

The executable will be created in packages/server/dist/

Environment Variables

OBS_WEBSOCKET_PORTOBS WebSocket port (default: 4455)
OBS_WEBSOCKET_PASSWORDOBS WebSocket password (if set)
SERVER_PORTHTTP server port (default: 3000)