{"id":18469132,"url":"https://github.com/wfcd/giveaway-overlay","last_synced_at":"2025-08-16T13:51:50.219Z","repository":{"id":70976900,"uuid":"76996470","full_name":"WFCD/Giveaway-overlay","owner":"WFCD","description":"Giveaway overlay used on RSB Streams","archived":false,"fork":false,"pushed_at":"2024-12-06T04:21:49.000Z","size":1001,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-14T21:59:23.446Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/WFCD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-12-20T22:30:14.000Z","updated_at":"2024-12-06T04:21:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"e3ca8eaa-0554-4956-a3ee-eccbb9e4b8c0","html_url":"https://github.com/WFCD/Giveaway-overlay","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/WFCD/Giveaway-overlay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WFCD%2FGiveaway-overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WFCD%2FGiveaway-overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WFCD%2FGiveaway-overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WFCD%2FGiveaway-overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WFCD","download_url":"https://codeload.github.com/WFCD/Giveaway-overlay/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WFCD%2FGiveaway-overlay/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270720365,"owners_count":24634036,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-06T10:09:02.097Z","updated_at":"2025-08-16T13:51:50.179Z","avatar_url":"https://github.com/WFCD.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Giveaway-overlay\nGiveaway overlay used on RSB Streams\n\n[![Created by Monskiller](https://raw.githubusercontent.com/Monskiller/banner/master/banner.png)](https://github.com/Monskiller \"Created by Monskiller\")\n\nSimple Webscript overlay we used on our first giveaway event and might use it again in the future.\nNode.js is needed.\n\n## Setting up Node.js\n- [Download](https://nodejs.org/dist/v12.18.2/node-v12.18.2-x64.msi) and install Node.js\n- Open command prompt window inside the project directory with `Shift + Right Click`\n- Run the following command `npm i`\n\n## Setting up the overlay\n- Create a .env file in the root, it should have a structure like...\n```\nCHANNEL=YourTwitchChannel\nOAUTH_USER=yourTwitchUsername\nOAUTH_SECRET=###OUAHTSECRET###\nVIEWERS=\nKEYWORD=plat\nRESTRICT_FROM_MODS=true\nCALLERS=yourTwitchUsername\nTRIGGER=!gstart\nANNOUNCE_ON_JOIN=false\nANNOUNCE_ROLLS=false\nANNOUNCE_WINNER=false\nICON_URL=https://path.to.your.logo.ml\nSECRET=reallyreallyreallySECUREPIECEofLoTsOFTEXt!!one!1!!\n```\n- Change `OAUTH_USER` to your Twitch username, `OAUTH_SECRET` to your oath2 key which you can get [here](https://twitchapps.com/tmi/) and `CHANNEL` to your own Twitch channel.\n- Change `SECRET` to something you choose.\n\n## Adding rewards\n- Edit the JSON file `data.json` and add your rewards in `prizes:[]` just as a regular JavaScript array\n\n## Using it\n- Open command window in the project directory\n- Run the overlay server with `node server.js`\n- Run OBS and add a new Browser Source, linking `http://localhost:3000/static/index.html?secret=SECRET` (SECRET will be whatever you put in further up)\n- When you want to roll it: \n  - Right click the source, select Interact then press your spacebar\n  - Or use the configured `TRIGGER` phrase. This is configurable.\n\n\n## Contact\nYou can find me on Discord `Monskiller#8879`.\n\nTobiah#0001 did a bunch of changes to make it more modular without touching code.\nFeel free to reach out to me too.\n\n\n## Developing\n- Do all of the main setup steps\n- Run `npm run dev` in your terminal to start a dev session with automated restarts.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwfcd%2Fgiveaway-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwfcd%2Fgiveaway-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwfcd%2Fgiveaway-overlay/lists"}