Skip to content
An open, simple and highly customisable notification/alert system for live streams on Twitch and YouTube.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
public
templates/default
views
.codeclimate.yml
.eslintignore
.eslintrc.json
.gitignore
.pug-lintrc
.travis.yml
LICENSE
README.md
config.js
package-lock.json
package.json

README.md

Build Status David Maintainability

Broadcast Notification System

The Broadcast Notification System (BNS) is an open, simple and highly customisable notification/alert system for live streams on Twitch and YouTube.

Features

  • Complete design freedom (fully HTML, CSS and JS editing)
  • Trigger different notifications and variations according to your own rules (soon with v0.11)
  • Modern and lightweight dashboard with different options, activity feed and weekly statistics
  • Different API support (look at notes)
  • Passwordless authentication (optional)
  • Runs on your local machine and on remote hosts
  • Cross-platform support

Notes

The project is still in development and not feature complete! Roadmap

Notification type support

  • Follows
  • Subscriptions
  • Donations
  • Hosts

API support

  • Twitch
  • Streamlabs
  • TipeeeStream
  • Twitch Event Tracker (own project)
  • YouTube

Current restrictions

  • Only new subscriptions will show up, no resubs! (This will change with a future API implementation like TipeeeStream)

Requirements

  • HTML and CSS skills (+ JS optional)
  • Technical know-how
  • NodeJS runtime
  • Server (optional)
  • OBS Studio + Browser plugin (plugin in full package included)

Getting started

Install

  1. Download and install the current NodeJS version
  2. Download and extract or clone the repo
  3. Open the bash or command prompt and switch to BNS directory (as admin on Windows)

Install it with

$ npm install --only=production

Configure the app via config.js in the root directory

Start the app with

$ npm start --production

Use

  1. Open the dashboard via http://localhost:8080 or what you have configured (for best experience please use a chromium based browser)
  2. Make your settings
  3. Take the default template as example and build your own
  4. Put http://localhost:8080/notification[/endpoint] in your OBS browser source (if authentication on, with token at the end)

If you have questions or find a bug, please open an issue

A better guide and wiki will follow later!

You can’t perform that action at this time.