Skip to content
This repository has been archived by the owner on Nov 11, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sandro Stikić committed Mar 15, 2019
1 parent 45826e4 commit 1524410
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,23 @@
![](https://i.imgur.com/B8IMVQh.gif)

## Key features
* Scoreboard and commentator overlays
* 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](#download) or [build](#building) pika-overlay
* Start the pika-overlay server
* Windows users: run "Start PIKA Overlay server.bat"
* Everyone else: run node index.js
* Nagivate to [http://localhost:9090](http://localhost:9090), preferably with Chromium
* Windows users: run `Start server.bat`
* Everyone else: run `node index.js`
* Navigate to [http://localhost:9090](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
* Set the URL to the overlay URL you just copied
* 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
Expand All @@ -49,7 +51,7 @@ Portable binaries for Windows are available in the
* nodejs >= 8.3
* npm >= 2

Begin by installing nodecg
Begin by installing nodecg:
```
npm install -g bower
git clone https://github.com/nodecg/nodecg.git
Expand All @@ -58,14 +60,14 @@ npm install --production
bower install
```

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

Run the server
Run the server:
```
node ../../index.js
```
Expand Down

0 comments on commit 1524410

Please sign in to comment.