https://github.com/supportclass/lfg-imraising
Simple ImRaising integration for NodeCG
https://github.com/supportclass/lfg-imraising
Last synced: 23 days ago
JSON representation
Simple ImRaising integration for NodeCG
- Host: GitHub
- URL: https://github.com/supportclass/lfg-imraising
- Owner: SupportClass
- License: mit
- Created: 2015-07-31T16:28:07.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-19T17:37:30.000Z (about 10 years ago)
- Last Synced: 2025-01-23T03:30:26.981Z (about 1 year ago)
- Language: JavaScript
- Size: 2.93 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#lfg-imraising
This is a [NodeCG](http://github.com/nodecg/nodecg) bundle.
Listens for donations to a given account on [ImRaising](https://imraising.tv/) and emits API events for other bundles to use.
## Installation
- Install to `nodecg/bundles/lfg-imraising`
- Create `nodecg/cfg/lfg-imraising.json` with the advanced `apiKey` of the
[ImRaising](https://imraising.tv/) account that you wish to listen to:
```json
{
"apiKey": "xxxxx"
}
```
## Usage
### 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('donation', 'lfg-imraising', callback);
```
... where 'callback' is the name of a function with the signature `function callback(data)`
### In other bundles' extensions
If you want to use tip events in another bundle's extension,
add `lfg-imraising` as a `bundleDependency` in your bundle's [`nodecg.json`](http://nodecg.com/guide/nodecg.json.html)
Then add the following code:
```javascript
var imraising = nodecg.extensions['lfg-imraising'];
imraising.on('donation', function(donation) {
// Do your thing.
});
```
### License
lfg-imraising is provided under the MIT license, which is available to read in the [LICENSE][] file.
[license]: LICENSE