{"id":21404201,"url":"https://github.com/supportclass/lfg-sublistener","last_synced_at":"2025-07-13T22:32:30.033Z","repository":{"id":24791144,"uuid":"28204938","full_name":"SupportClass/lfg-sublistener","owner":"SupportClass","description":"Easy Twitch subscription events for NodeCG","archived":false,"fork":false,"pushed_at":"2016-12-07T21:26:32.000Z","size":77,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-02-27T10:41:40.314Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SupportClass.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-18T22:47:32.000Z","updated_at":"2020-04-16T04:15:27.000Z","dependencies_parsed_at":"2022-08-22T16:50:35.452Z","dependency_job_id":null,"html_url":"https://github.com/SupportClass/lfg-sublistener","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupportClass%2Flfg-sublistener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupportClass%2Flfg-sublistener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupportClass%2Flfg-sublistener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupportClass%2Flfg-sublistener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SupportClass","download_url":"https://codeload.github.com/SupportClass/lfg-sublistener/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225925609,"owners_count":17546276,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T16:13:28.913Z","updated_at":"2024-11-22T16:13:29.423Z","avatar_url":"https://github.com/SupportClass.png","language":"JavaScript","readme":"#lfg-sublistener [![Build Status](https://travis-ci.org/SupportClass/lfg-sublistener.svg?branch=master)](https://travis-ci.org/SupportClass/lfg-sublistener)\nThis is a [NodeCG](http://github.com/nodecg/nodecg) bundle.\n\nListens to one or many Twitch chat channels via IRC for \"subscription\" events.\nUpon hearing one, it emits a NodeCG API message that other bundles can listen to and use.\nAlso displays recent subscriptions on the dashboard.\n\nIf [lfg-twitchapi](https://github.com/SupportClass/lfg-twitchapi) is present, sublistener will also poll the API every 60 seconds to fill in any gaps left by TwitchNotify.\n\nThis bundle integrates with [lfg-nucleus](https://github.com/SupportClass/lfg-nucleus).\n\n## Installation\n- Install to `nodecg/bundles/lfg-sublistener`\n\t- If [nodecg-cli](https://www.npmjs.com/package/nodecg-cli) is installed use `nodecg install SupportClass/lfg-sublistener`\n- Create `nodecg/cfg/lfg-sublistener.json` with a valid [tmi.js configuration](https://www.tmijs.org/docs/Configuration.html).\n\n### Config Example\n```json\n{\n\t\"tmi.js\": {\n\t\t\"connection\": {\n\t\t\t\"reconnect\": true\n\t\t},\n\t\t\"identity\": {\n\t\t\t\"username\": \"YOUR_USERNAME\",\n\t\t\t\"password\": \"oauth:YOUR_OAUTH\"\n\t\t},\n\t\t\"channels\": [\"ANY_CHANNEL\"]\n\t}\n}\n```\n\n## Usage\n\nFirst, add `lfg-sublistener` to your bundle's [`nodecg.bundleDependencies`](http://nodecg.com/tutorial-manifest.html).\nThis will ensure that `lfg-sublistener` loads before your bundle.\n\n### In a graphic or dashboard panel\n```js\nnodecg.listenFor('subscription', 'lfg-sublistener', subscription =\u003e {\n    // do work\n});\n```\n\n### In an extension\n```js\nmodule.exports = function (nodecg) {\n\tvar sublistener = nodecg.extensions['lfg-sublistener'];\n\t\n\tsublistener.on('subscription', data =\u003e {\n\t\t// do work\n\t});\n}\n```\n\n## Data Structure\n```js\n{\n\t\"name\": \"langeh\",\n\t\"channel\": \"chrishanel\",\n\t\"resub\": true,\n\t\"months\" 3,\n\t\"timestamp\": 1456850909701,\n\t\"prime\": false\n}\n```\n\n### License\nlfg-sublistener is provided under the MIT license, which is available to read in the [LICENSE][] file.\n[license]: LICENSE\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupportclass%2Flfg-sublistener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsupportclass%2Flfg-sublistener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupportclass%2Flfg-sublistener/lists"}