pubgredzone
v0.0.1
Published
webapp for viewing the most exciting PlayerUnknown's BattleGrounds streams on Twitch
Downloads
2
Readme
pubgredzone
pubgredzone takes the concept of the red zone in American football and applies it to the popular online battle royale game PLAYERUNKNOWN'S BATTLEGROUNDS. The idea is to always be viewing the most popular PUBG twitch stream with the least amount of people alive in-game.
Installation
You can run your own instance of pubgredzone either for local development or just pure entertainment. Ubuntu and macOS are the currently supported platforms.
Prerequisite Software
The following pieces of software are required to run pubgredzone locally:
You can install these dependencies with one of the two following commands, depending on your os:
- Ubuntu:
$ sudo apt-get install tesseract-ocr ffmpeg imagemagick
$ pip install livestreamer
- macOS:
$ brew install tesseract ffmpeg imagemagick
$ pip install livestreamer
Installing pubgredzone
- Clone the repo and install with npm:
$ git clone [email protected]:eggshell/pubgredzone.git
$ cd pubgredzone
$ npm install .
Running It Locally
- Get an oauth token from twitch. Once obtained, export your token as an environment variable:
$ export token="YOUR_OAUTH_TOKEN"
- Navigate to the
pubgredzone
dir if you aren't there already, and start the app:
$ node app.js
Now you can open a browser and navigate to http://localhost:3000
to watch
pubgredzone.
Running in a Container
You can also run pubgredzone in a docker container.
- Clone the repo:
$ git clone [email protected]:eggshell/pubgredzone.git
- Get an oauth token from twitch. Once obtained, export your token as an environment variable:
$ export token="YOUR_OAUTH_TOKEN"
- Build the docker image:
$ cd pubgredzone
$ docker build -t "pubgredzone:latest" --build-arg token=$token .
- Start up the container:
$ docker run pubgredzone
License
pubgredzone is currently licensed under the MIT LICENSE.