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

sylae/bye

Repository files navigation

Bye

Bye is a simple set of PHP scripts designed to assist individuals and organizations in operating a livestreamed tournament.

About

Bye creates a set of HTML overlays that can be added to popular streaming software such as XSplit. Any streaming system that supports HTML web page overlays should be able to render Bye pages properly.

example output

Set up

Dependencies

Bye requires a somewhat-modern version of PHP (tested on v5.5.6). In addition, for use of the bracket overlay, QueryPath (qp.php) must be in PHP's PATH.

Usage

Simply copy config.sample.php to sample.php and fill in your tournament info and API keys as needed. The config file is self-explanatory.

The scripts do not require any server-specific settings to work, and in fact run perfectly well using php's built-in webserver (i.e. -S localhost:8080).

Please note that while Bye was designed with basic security in mind, it will most likely not hold up to a serious attack. The author highly recommends common-sense firewalling and port binding as needed.

Example Setup: XSPlit

The author recommends a scene setup similar to the following:

  • A 'game' scene, featuring the scorebug and a game capture/capture card capture. It is recommended to leave off the "keep source in memory" option for the scorebug.
  • A 'standings' scene, featuring the standings overlay on top of a relevent background. It is recommended to leave off the "keep source in memory" option for the overlay, but on for the background (especially for a video background)
  • A 'bracket' scene, set up to be similar as above. However, note that brackets with particularly many rounds may cause an unsightly scrollbar to appear. If so, you can use the HTML->Display->Resolution options to force it to be wide enough.

The overlays will by default use all available width, but only the height they need (and attach to the bottom of the "page" defined by the XSplit source. It is highly recommended that the user set up their scenes and rehearse thouroughly before going live.

example config

Contact and Contributions

Please feel free to contact me via email or XMPP at sylae@calref.net if you have any questions or are interested in helping out.

About

php/html-based video streaming assist

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published