ericthelemur / nodecg-dono-control

NodeCG Bundle to read & moderate Tiltify donations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NodeCG Tiltify Donation Controller

Tiltify Control provides a donation reader and moderation interface for Tiltify Donations, using NodeCG & React. It is both a reliable donation reader, and a donation moderation tool -- allowing approval/censorship of donation messages before they are shown on stream. This project depends on my TypeScript rewrite of nodecg-tiltify, originally based on daniellockard/nodecg-tiltify.

By default, it requires manual approval of each message before it is displayed, however if the auto approval setting is on, messages are automatically approved if not censored within the time window configured (default: 15s).

There are fairly extensive filtering options too: options to allow any of read & unread, approved, censored, unmoderated, and sort by time or money ascending or descending. Viewing the allDonations list (no moderation) or donations by top donors are options too.

If you want donation amounts in a different currency to what Tiltify provides, set displayCurrency to the currency code e.g. GBP and conversionRateKey to a key for freecurrencyapi.com in the config of nodecg-tiltify.

example.png

Installation

  1. Install ericthelemur/nodecg-tiltify (replace daniellockard/nodecg-tiltify) with nodecg install ericthelemur/nodecg-tiltify
    • I highly recommend setting up a webhook, but this does require an exposed HTTPS server, which is a bit of a faff for dev
  2. Run nodecg defaultconfig nodecg-dono-control to generate a blank config
  3. Run NodeCG
  4. Open the graphic nodecg-dono-control/reader.graphic.html
    • If you have authentication on (you should if you have it exposed for the webhook), sharing the link with the key param is sufficient if you want to give people access without logging in
  5. nodecg-dono-control/alerts.graphic.html provides a donation notification example, using react-toastify

About

NodeCG Bundle to read & moderate Tiltify donations

License:MIT License


Languages

Language:TypeScript 87.5%Language:CSS 8.9%Language:HTML 3.6%