{"id":17170279,"url":"https://github.com/alcadesign/sound-trigger-bot","last_synced_at":"2025-06-22T14:02:46.086Z","repository":{"id":49011540,"uuid":"206738406","full_name":"AlcaDesign/sound-trigger-bot","owner":"AlcaDesign","description":"A sound trigger bot for Twitch chat.","archived":false,"fork":false,"pushed_at":"2022-12-11T04:33:16.000Z","size":155,"stargazers_count":12,"open_issues_count":5,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-13T16:06:56.465Z","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":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlcaDesign.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}},"created_at":"2019-09-06T07:28:53.000Z","updated_at":"2021-04-06T14:13:37.000Z","dependencies_parsed_at":"2023-01-26T15:30:43.742Z","dependency_job_id":null,"html_url":"https://github.com/AlcaDesign/sound-trigger-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AlcaDesign/sound-trigger-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlcaDesign%2Fsound-trigger-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlcaDesign%2Fsound-trigger-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlcaDesign%2Fsound-trigger-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlcaDesign%2Fsound-trigger-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlcaDesign","download_url":"https://codeload.github.com/AlcaDesign/sound-trigger-bot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlcaDesign%2Fsound-trigger-bot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261304201,"owners_count":23138292,"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-10-14T23:29:23.214Z","updated_at":"2025-06-22T14:02:41.063Z","avatar_url":"https://github.com/AlcaDesign.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sound Trigger Bot\r\n\r\nA Node.js bot that will listen to Twitch chat for commands to play sound effects\r\nor TTS in a hidden webpage (like a browser source in OBS).\r\n\r\n## Do the things\r\n\r\n```bash\r\n# Clone the repo\r\ngit clone git@github.com:AlcaDesign/sound-trigger-bot.git\r\n# Change directory into the repo\r\ncd sound-trigger-bot\r\n# Copy the .env.example file to .env\r\ncp .env.example .env\r\n# Edit the .env file\r\nnano .env\r\n# Install the dependencies\r\nnpm install\r\n# Start the server\r\nnpm start\r\n```\r\n\r\nBy default, the port is set to `8500` in the `.env`. Go to `localhost:8500` and\r\nyou'll get a link to the sfx page. This is the page that would be loaded in OBS.\r\nThe main page may be used for adding more sound effects and other options later.\r\n\r\n## Commands\r\n\r\n### Sound Effects\r\n\r\n#### ***`!\u003csound effect\u003e`***\r\n\r\nSound effects are sounds files located in `www/sound-effects/` and listed in the\r\n`sounds` section of `db.json`.\r\n\r\nThe DB has \"ding\" listed with a \"ping\" alias. The command \"!ding\" or \"!ping\" will play the \"ding.mp3\" sound effect.\r\n\r\n### Text-To-Speech\r\n\r\n#### ***`!tts \u003ctext to say\u003e`***\r\n\r\nPlay some text-to-speech with a chirp sound queued before.\r\n\r\n## Adding more sound effects\r\n\r\nEdit the `db.json` file to include additional items in the `sounds` array and\r\nmatching files in `www/sound-effects/`. The file name can include additional\r\ndirectories as long as its based in the prior mentioned directory.\r\n\r\n```json\r\n{\r\n\t\"sounds\": [\r\n\t\t{\r\n\t\t\t\"name\": \"ding\",\r\n\t\t\t\"file\": \"ding.mp3\",\r\n\t\t\t\"aliases\": [ \"ping\" ]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"helloworld\",\r\n\t\t\t\"file\": \"helloworld.mp3\",\r\n\t\t\t\"aliases\": [ \"hello\", \"hello-world\" ]\r\n\t\t}\r\n\t]\r\n}\r\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falcadesign%2Fsound-trigger-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falcadesign%2Fsound-trigger-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falcadesign%2Fsound-trigger-bot/lists"}