Skip to content

Usage

Jump to bottom
KevinSnyderCodes edited this page Jun 21, 2018 · 1 revision

kqstats' primary function is to display game statistics in real time. These displays can be viewed through a web browser and (more importantly) incorporated into your Open Broadcast Software (OBS) streams.

Follow these two steps to display real-time game statistics in your OBS stream:

  1. Run the web app
  2. Display the killboard in your OBS stream

Run the web app

First, make sure you have the following software installed:

Next, download or clone this repository to your computer.

Then, using the command line, navigate to the repository folder and run the following commands:

npm install

Connect your computer to same network that the Killer Queen cabinet is on. Then get the local IP address of your cabinet. This IP address usually follows the format 192.168.X.X or 10.0.X.X.

You can find the IP address in Killer Queen's settings menu (accessed by pressing F6 on the cabinet's keyboard on the settings button behind the coin door). Navigate to "INTERNET SETUP" and you should see it listed on the left.

If you don't know or can't find the IP address, you can use port scanning software to find it. Scan for IP addresses on your local network with port 12749 open. You will probably find only one IP address with that port open, and it will be the Killer Queen cabinet.

Finally, run the following command from the repository folder, replacing [IP_ADDRESS] with the IP address of the cabinet:

npm run start -- -c ws://[IP_ADDRESS]:12749

A new page should open in your web browser. If it doesn't, navigate to http://localhost:3000.

Display the killboard in your OBS stream

Open Broadcast Software, a popular and free software for streaming on Twitch, lets you overlay webpages in your stream. This is how we will display the killboard.

First, follow the steps above to get the web app running.

There are three different killboards:

  • Full
  • Blue team
  • Gold team

We're going to display blue team's killboard:

  1. In OBS, under the "Sources" section, click the + button
  2. Select "BrowserSource"
  3. Give your source a name and click "OK"
  4. Put in the following values, leaving all others the same:
  • URL: http://localhost:3000/killboard/blue
  • Width: 1280
  • Height: 122
  1. Click OK

The killboard should now appear in your scene. You can move and resize it as you see fit.

Home

kqstats

Killer Queen

Clone this wiki locally