============================================================================
 PB-metr OBS — installation (README)
 A speedometer for your run, driven by LiveSplit + OBS WebSocket.
 purr.games
============================================================================

IN THIS ARCHIVE
  LiveSplit.PBMetrObs.dll   LiveSplit component.
  pbmetr-gauge.html         OBS browser source (the gauge / layout).
  pbmetr-obs.ini            Settings: theme and feel.
  README_EN.txt             This file.
  README_RU.txt             Russian version.

STEP 1 - OBS BROWSER SOURCE
  1. OBS -> Tools -> WebSocket Server Settings -> enable, port 4455.
     Easiest to leave the password empty (server listens on localhost only).
  2. Sources -> (+) -> Browser -> Local file -> pick pbmetr-gauge.html.
     Width 520, height 360. Transparent background.
  3. If OBS WebSocket has a password, add it to the URL: ?pass=YOUR_PASSWORD

STEP 2 - LIVESPLIT COMPONENT
  1. Copy LiveSplit.PBMetrObs.dll and pbmetr-obs.ini into the "Components"
     folder next to LiveSplit.exe.
  2. LiveSplit -> right-click -> Edit Layout -> (+) -> Other -> "PB-metr OBS"
     -> OK -> Save Layout.
  3. Start a run and hit your splits - the needle in OBS reacts. It connects
     to OBS by itself and reconnects if OBS restarts.

TUNING
  Theme (neon | minimal | retro) and feel live in pbmetr-obs.ini. The
  component re-reads it every ~2 seconds - change it live, mid-stream.

QUICK TEST WITHOUT LIVESPLIT
  Open pbmetr-gauge.html?demo=1 in a browser.
  Hotkeys: Q green, W gold, E red, R finish-PB, T reset.

Author: Purr  -  purr.games  -  Discord: purr.games
============================================================================