Giters

Levelent / wasd2022-frontend

A NodeCG bundle for broadcast graphics for Warwick's Awesome Speedruns & Demos 2022

Home Page:https://warwickspeed.run

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

wasd2021-summer

about

This is a NodeCG bundle used for broadcast graphics for the videogame speedrunning marathon event Warwick's Awesome Speedruns & Demos 2021 Summer.

dependant NodeCG bundles

  • nodecg-speedcontrol for run detail management, run timing and Twitch detail integration
  • nodecg-tiltify for pulling donation and reward information for a campaign from Tiltify.com
  • ncg-spotify for displaying the currently playing song used as background music being played via Spotify

dependant JS packages

  • mithril for a hyperscript based framework for creating the web graphics and interfaces.
  • gsap for providing animations for web graphics
  • fitty for dynamically resizing text to fit in dimension in web graphics.
  • lodash for the get function to fetch deeply nested values
  • moment for providing time conversion convenience functions
  • rollup and it's plugins for bundling the source JS code and it's assets for use with NodeCG.

screenshots

break screen

TBD

game screen

TBD

installation

clone and install NodeCG and bundles

# install nodecg
$ git clone --depth 1 --branch v1.8.1 git@github.com:nodecg/nodecg.git
$ cd nodecg
$ npm ci

# install bundles
$ cd bundles

# nodecg-speedcontrol
$ git clone --depth 1 --branch v2.3.0 git@github.com:speedcontrol/nodecg-speedcontrol.git
$ cd nodecg-speedcontrol
$ npm ci
$ cd ..

# nodecg-tiltify
$ git clone --depth 1 git@github.com:daniellockard/nodecg-tiltify.git
$ cd nodecg-tiltify
$ npm ci
$ cd ..

# ncg-spotify
$ git clone --depth 1 git@github.com:EwanLyon/ncg-spotify.git
$ cd ncg-spotify
$ npm ci
$ cd ..

# wasd2021
$ git clone --depth 1 git@github.com:jai-x/wasd2021-summer.git
$ cd wasd2021
$ npm ci

build

$ cd nodecg/bundles/wasd2021-summer
$ npm run build

configuration

Copy the JSON config files to /nodecg/cfg.

$ cp cfg/* ../../cfg

Edit the JSON files in /nodecg/cfg to populate them with credentials. See the README files of the dependent NodeCG bundles for how to obtain these credentials.

running

$ npm run start

license

All source code in this repository is licensed under the MIT license, aside from exceptions mentioned below. See the license.txt file for full license terms.

exceptions

About

A NodeCG bundle for broadcast graphics for Warwick's Awesome Speedruns & Demos 2022

https://warwickspeed.run

License:MIT License

Languages

Language:JavaScript 63.5%Language:CSS 36.5%