https://github.com/supportclass/lfg-doncorleone
Easy donation listening for NodeCG
https://github.com/supportclass/lfg-doncorleone
Last synced: 11 months ago
JSON representation
Easy donation listening for NodeCG
- Host: GitHub
- URL: https://github.com/supportclass/lfg-doncorleone
- Owner: SupportClass
- License: mit
- Created: 2014-12-18T22:46:08.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T16:55:21.000Z (about 3 years ago)
- Last Synced: 2025-01-23T03:30:29.644Z (about 1 year ago)
- Language: HTML
- Homepage:
- Size: 73.2 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lfg-doncorleone
This is a [NodeCG](http://github.com/nodecg/nodecg) bundle.
Listens for donations to a given account on [Barry's Donation Tracker](http://don.barrycarlyon.co.uk) and emits API events for other bundles to use.
Also displays stats on the dashboard and easily allows the user to reset said stats.
## Installation
- Install to `nodecg/bundles/lfg-doncorleone`
- Create `nodecg/cfg/lfg-doncorleone.json` with the username and password of the [Barry's Donation Tracker](http://don.barrycarlyon.co.uk) account
that you wish to listen to:
```json
{
"username": "myUsername",
"password": "myPassword"
}
```
## Usage
### As a dashboard panel
If you simply want to see top donations for the `day` and `month` periods on your dashboard, you are done.
### In other bundles' view pages and dashboard panels
If you would like to use this data in another bundle, add the following code to your view/panel:
```javascript
nodecg.listenFor('tip', 'lfg-doncorleone', callback);
```
... where 'callback' is the name of a function with the signature `function callback(data)`
### In other bundles' extensions
If you want to use donation events in another bundle's extension,
add `lfg-doncorleone` as a `bundleDependency` in your bundle's [`nodecg.json`](https://github.com/nodecg/nodecg/wiki/nodecg.json)
Then add the following code:
```javascript
var donCorleone = nodecg.extensions['lfg-doncorleone'];
donCorleone.on('initialized', function initialized(data) {
// do work
// data.Completed = Array of recently completed donations
// data.totals = Object containing stats such as data.totals.day_top and data.totals.month_top
// Other properties exist as well
));
donCorleone.on('gotDonations', function gotDonations(data) {
// do work
// data object is the same as in the 'initialized' event
// However, in this event 'data.Completed' is only newly completed donations.
// Example of iterating over the data.Completed property and processing each new donation
data.Completed.forEach(function(donation) {
console.log(donation);
});
));
```
### License
lfg-doncorleone is provided under the MIT license, which is available to read in the [LICENSE][] file.
[license]: LICENSE