Skip to content

README.md

Latest commit

 

History

History
21 lines (16 loc) · 869 Bytes

README.md

File metadata and controls

21 lines (16 loc) · 869 Bytes

Firebot HypeRate Integration Script

Setup (Users)

  1. Download the hyperateScript.js file from the latest release.
  2. Install the script into your Firebot profile and set it as a Startup Script
  3. Go to Settings > Integrations > HypeRate. Enter your Device ID in the ID field and click Save. Use internal-testing to receive frequent testing data.
  4. The HypeRate script exposes an event Heartrate and two variables $heartrate (in bpm) and $heartrateTime (time since last heartrate event in seconds)

Setup (Developers)

  1. npm install
  2. Copy the src/example.auth.ts file to src/auth.ts and enter a HypeRate API Key. You can request a key here

Building

Dev:

  1. npm run build:dev
  • Automatically copies the compiled .js to Firebot's scripts folder.

Release:

  1. npm run build
  • Copy .js from /dist