https://github.com/sheepeatingtaz/xwingoverlayer

Overlay Generator for X-wing Miniatures Streaming
https://github.com/sheepeatingtaz/xwingoverlayer

Last synced: 2 months ago
JSON representation

Overlay Generator for X-wing Miniatures Streaming

• Host: GitHub
• URL: https://github.com/sheepeatingtaz/xwingoverlayer
• Owner: sheepeatingtaz
• License: mit
• Created: 2017-03-22T11:43:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-26T20:53:12.000Z (over 6 years ago)
• Last Synced: 2024-06-02T21:58:35.446Z (4 months ago)
• Language: Python
• Size: 2.99 MB
• Stars: 5
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-xwing - X-Wing Overlayer - Overlay Generator for X-wing Miniatures Streaming (Streaming / Other)

README

        
# 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:

```bash

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: [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/sheepeatingtaz/xwingoverlayer)

(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](https://www.youtube.com/watch?v=kfZpG1Zfmmk "Stream test")

#### Home Page

![Home Page](screenshots/home.png?raw=true "Home Page")

#### Import Page

![Import Page](screenshots/import.png?raw=true "Import Page")

#### Create Match Page

![Create Match Page](screenshots/create.png?raw=true "Create Match Page")

#### List Matches Page

![List Matches Page](screenshots/list.png?raw=true "List Matches  Page")

#### Control Page

![Control Page](screenshots/control.png?raw=true "Control Page")

#### Overlay Page

![Overlay Page](screenshots/overlay2.png?raw=true "Overlay Page")

![Overlay Page](screenshots/overlay.png?raw=true "Overlay Page")