The on-stream graphics used for ZeldaSpeedRuns Community Races
This is a NodeCG v0.9 bundle. You will need to have NodeCG v0.9 installed to run it.
- Install to
nodecg/bundles/zsr-layouts. - Install
bowerif you have not already (npm install -g bower) - Install a compiler toolchain:
- WINDOWS: Install
windows-build-toolsto install the tools necessary to compilezsr-layouts' dependencies. - LINUX: Install
build-essentialand Python 2.7, which are needed to compilezsr-layouts' dependencies.
- WINDOWS: Install
cd nodecg/bundles/zsr-layoutsand runnpm install --production, thenbower install- Create the configuration file (see the [configuration][id] section below for more details)
- Copy the twitchPlayerSetup.json to the NodeCG root folder.
- Run the nodecg server:
nodecg start(ornode index.jsif you don't have nodecg-cli) from thenodecgroot directory.
Please note that you must manually run npm install for this bundle. NodeCG currently cannot reliably compile this bundle's npm dependencies. This is an issue we hope to address in the future.
This bundle is not intended to be used verbatim. Some of the codelines have be replaced with placeholders, and most of the hardcoded datasources have been blanked out. This bundle is open sourced so other NodeCG users have a chance to look into and benefit from the multiple extensions and dashboard functionalities created to support online speedrun events.
To reiterate, please don't just download and use this bundle as-is (it won't work). Build something new from it.
To configure this bundle, create and edit nodecg/cfg/zsr-layouts.json.
Refer to configschema.json for the structure of this file.
For a showcase of the ZSR Community Race functions (front-end), check a recent twitch highlight on ZSR: https://www.twitch.tv/videos/210392371
zsr-layouts is provided under the Apache v2 license, which is available to read in the LICENSE file.
Designed & developed by ZeldaSpeedruns
Original base (sgdq17-layouts) by Support Class