Skip to content

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

License

Notifications You must be signed in to change notification settings

UWCS/wasd2023-nodecg

 
 

Repository files navigation

wasd2022-frontend

about

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

It also uses nodecg-cli to setup the bundles.

dependant NodeCG bundles

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

image

game screen

image

installation

Tested with node 16.13.1 and npm 8.1.2

clone and install NodeCG and bundles

npm install nodecg-cli -g

# Create repo
nodecg setup

# Install bundles
nodecg install speedcontrol/nodecg-speedcontrol
nodecg install ericthelemur/nodecg-tiltify
nodecg install EwanLyon/ncg-spotify

# Install this bundle 
cd bundles
git clone https://github.com/uwcs/wasd2023-nodecg

build

cd wasd2023-nodecg
npm ci
npm run build

configuration

Copy the JSON config files to /nodecg/cfg. In wasd2022-frontend:

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

In wasd2022-frontend:

npm run start

dev

Run npm run start to host, and npm run watch to incrementally build.

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 73.3%
  • CSS 26.7%