https://github.com/jai-x/wasd2018
Broadcast graphics bundle for Warwick's Awesome Speedruns & Demos
https://github.com/jai-x/wasd2018
animejs mithriljs nodecg-bundle nodejs
Last synced: 3 months ago
JSON representation
Broadcast graphics bundle for Warwick's Awesome Speedruns & Demos
- Host: GitHub
- URL: https://github.com/jai-x/wasd2018
- Owner: jai-x
- Created: 2018-05-25T02:55:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-09T01:55:43.000Z (about 4 years ago)
- Last Synced: 2024-05-27T19:49:02.117Z (about 1 year ago)
- Topics: animejs, mithriljs, nodecg-bundle, nodejs
- Language: JavaScript
- Homepage: https://uwcs.co.uk/events/wasd-2018/
- Size: 864 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wasd2018
A bundle of broadcast graphics for
[Warwick's Awesome Speedruns & Demos](https://uwcs.co.uk/events/wasd-2018) to
be used with [nodecg](https://nodecg.com).
## Usage
This bundle was used for broadcast graphics at the Warwick's Awesome Speedruns
& Demos 2018 event, which was joint hosted by the University of Warwick
Computing Society and the Warwick Esports Society. Usage of these graphics
can be found in videos of the event in [this YouTube playlist](https://www.youtube.com/watch?v=hvA_k-yNEFQ&list=PL0cMFmWyMFGIUxjyapjmP9Wa_i5l1lOlS).
## Libraries
This bundle is built on the [nodecg](https://nodecg.com) broadcast graphics
framework, under the MIT license.
The dashboard uses [MithrilJS](https://mithril.js.org) for creating user
interface components, under the MIT license.
The broadcast graphics use the [anime.js](http://animejs.com) JavaScript
animation engine for animating on screen elements, under the MIT license.
This bundle uses [livesplit-core](https://github.com/LiveSplit/livesplit-core)
timing library, under the MIT license.
## Installation
* Setup and install [Node.js](https://nodejs.org)
* Setup and install [nodecg](https://nodecg.com)
* Clone this repo and place into the `/bundles` directory of your `nodecg`
installation
* Install dependencies by running `npm install` within the `wasd2018` directory
* Copy `wasd2018.json` to the `/cfg` directory of your `nodecg` installation
* Populate the `wasd2018.json` file with the correct credentials/settings
* Run using command `node index.js` in the directory of your `nodecg`
installation