/pika-overlay

NodeCG overlay designed for the Perth Iron King Arena tournament streams.

Primary LanguageJavaScriptISC LicenseISC


pika-overlay
Perth Iron King Arena overlay

A NodeCG overlay designed for the Perth Iron King Arena tournament streams.

Key Features • How To Use • Download • Acknowledgments • License

Key features

  • Scoreboard overlays for Tekken 7 and Street Fighter V
  • Commentator overlays
  • Intuitive user interface
  • Easily customisable
  • Persistent players and commentators via SQLite database

How to use

  • Download or build pika-overlay
  • Start the pika-overlay server
    • Windows users: run Start server.bat
    • Everyone else: run node index.js
  • Navigate to http://localhost:9090, preferably with Chromium
  • This is the dashboard, you use this screen to modify the overlay state
  • Click the graphics button at the top right corner
  • Copy the URL of the overlay you would like to use
  • Create a new browser source in OBS
  • Paste the overlay URL
  • Set the width to 1920 and the height to 1080
  • Ensure "shutdown source when not visible" and "refresh browser when scene becomes active" are disabled

Download

Portable binaries for Windows are available in the repository tags.

Building

Prerequisites

  • nodejs >= 8.3
  • npm >= 2

Begin by installing nodecg:

npm install -g bower
git clone https://github.com/nodecg/nodecg.git
cd nodecg
npm install --production
bower install

Install pika-overlay:

cd bundles
git clone --recurse-submodules https://github.com/opeik/pika-overlay.git
npm install --production sqlite3

Run the server:

node ../../index.js

Built with

Versioning

We use Semantic Versioning for versioning.

License

This project is licensed under the ISC license. Please see the LICENSE.md file for details.

Acknowledgments

  • The PIKA tournament organisers for hosting amazing events
  • Escape Portal for providing an amazing venue