README.md

X-wing Miniatures Overlay Generator

Work in Progress.

Overview

Generates a HTML overlay for use in OBS Studio (or similar, not really attempted anything else) for streaming X-wing miniatures games.

Takes XWS files as imports, and allows many of them. Generates the starting stats for the ship based on the base values + upgrades. Pair up squads to create a 'match' and the overlay is generated.

When a match is created, a control panel is available that uses websockets to push the changes (e.g. losing shield/hull, discarding upgrade cards) back to the overlay in realtime, no overlay editing required.

Clicking on Pilots, upgrades or damage cards in the Control Page will display the card on both the overlay and the control page for 7 seconds (so both the commentator and adoring public can see what you are talking about!)

Uses lots of good stuff made by other people:

https://github.com/guidokessels/xwing-data https://github.com/geordanr/xwing-miniatures-font

Without these, this project wouldn't happen.

as well as jQuery, bootstrap and a few plugins for such.

Feedback & Contributions welcome!

Now with WorksForMe™ vagrant-y goodness:

git clone https://github.com/sheepeatingtaz/xwingoverlayer.git
cd xwingoverlayer
vagrant up

Open a browser and got to http://localhost:8008 and you're in!

Alternatively: (nb: It uses a custom heroku Buildpack, as I couldn't work out for the life of me how to get it to run the initial setup needed before collectstatic can be run - contributions welcome!)

Screenshots:

First test of the overlay using OBS to stream Live to YouTube

Home Page

Import Page

Create Match Page

List Matches Page

Control Page

Overlay Page