{"id":13503325,"url":"https://github.com/codigofalado/twitch-giphy","last_synced_at":"2025-03-29T14:31:18.263Z","repository":{"id":35457811,"uuid":"206675448","full_name":"codigofalado/twitch-giphy","owner":"codigofalado","description":"Um chatbot para Twitch que integra a API do GIPHY, fazendo com que hashtags no chat da Twitch virem GIFs na Live :)","archived":false,"fork":false,"pushed_at":"2022-12-11T04:32:25.000Z","size":255,"stargazers_count":42,"open_issues_count":16,"forks_count":13,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-25T23:38:35.888Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/codigofalado.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-05T23:42:46.000Z","updated_at":"2021-12-03T01:31:14.000Z","dependencies_parsed_at":"2023-01-15T21:36:05.442Z","dependency_job_id":null,"html_url":"https://github.com/codigofalado/twitch-giphy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codigofalado%2Ftwitch-giphy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codigofalado%2Ftwitch-giphy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codigofalado%2Ftwitch-giphy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codigofalado%2Ftwitch-giphy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codigofalado","download_url":"https://codeload.github.com/codigofalado/twitch-giphy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246196952,"owners_count":20739199,"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":["hacktoberfest"],"created_at":"2024-07-31T22:02:46.524Z","updated_at":"2025-03-29T14:31:18.003Z","avatar_url":"https://github.com/codigofalado.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# twitch-giphy\n\n\u003ci\u003eRead this in other languages:\u003c/i\u003e [Portuguese](README.pt.md)\n\nA Twitch chatbot that integrates the GIPHY's API to learn Typescript\n\n## Must Have\n\n- [x] - Interact with Twitch's chat\n- [x] - Capture a specific command from the users (everything that starts with `!giphy`)\n- [x] - Remove `!giphy` and take the remaining term\n- [x] - Send the remaining term to GIPHY\n- [x] - Return the first GIF from GIPHY'S API\n- [x] - Render the GIF on screen\n- [x] - Remove the GIF from screen 8 seconds later\n- [x] - Create a class in Typescript to deal with the chatbot/server\n- [x] - Allow other shortcuts to insert GIF on livestream (!giphy, !gif, #)\n- [x] - Modify GIF screen (Browser) to show the Username + Ballon HQ style around all GIF\n- [x] - Allow to determine different number of seconds for normal users and subscribers\n- [ ] - Refactor to allow all streamers in the WORLD to make use of this WONDER of nature that REVOLVES Livestreams :)\n\n## Nice to have\n\n- [x] - Do a GIF row to make sure every GIFs will be displayed\n- [ ] - Be able to set who can use the commands (everyone, only followers, only subs, VIPS, Mods etc.)\n- [x] - README in English\n- [ ] - Automate a deploy to AWS (always available)\n- [ ] - Implement X cooldown seconds to avoid FLOOD\n- [ ] - Allow integration with other plataforms besides Twitch\n- [ ] - Allow multiple commands (`!gif`, `!giphy`)\n- [ ] - Allow define a PRICE to the command (BITs, Channel Points)\n\n## Configuring the Project\n\n### Configuring server\n\nBefore all, you need to config the API options from Twitch and Giphy.\n\nCreate a environment variables file (.env) indentical to [file example](.env.example) and modify the informations according to the values below:\n\n- **TWITCH_USERNAME**, your username or your bot's\n- **TWITCH_TOKEN**, you can get from https://twitchapps.com/tmi/\n- **TWITCH_CHAT_CHANNEL**, normally is the same as your username\n- **GIPHY_RATING**, accept only the values 'y' | 'g' | 'pg' | 'pg-13' | 'r'\n- **GIPHY_TOKEN**, you can get from https://developers.giphy.com/\n\nWith this config, when the chatbot be implemented on a service like aws, netlify or other plataform, it will be only necessary to define this values on the plataform. \n\n### Configuring exhibition\n\nTo customize the exhibition, go to file `client/index.html` and search for:\n\n- It's not necessary to provide all the options, because they all have a default value\n\n```html\n\u003cscript\u003e\n  window.addEventListener(\"load\", () =\u003e {\n    const options = {\n      duration_default: 4, // Optional: value in seconds (default value is 4)\n      duration_sub: 8, // Optional: value in seconds to subs (default value is 8)\n      max_queue: 10, // Optional: quantidade máxima de gifs na fila (default value is 10)\n      separator: \":\", // Optional: separator between the user and the message (default value is :)\n    };\n    const twitch_giphy = new TwitchGiphy(options);\n  });\n\u003c/script\u003e\n```\n\n## Installing the dependencies\n\nOpen the terminal at the same directory that contains the file `package.json`, and execute:\n\n```bash\nnpm i # short form to 'npm install'\n```\n\n## Compiling the project\n\nOpen the terminal at the same directory that contains the file `package.json`, and execute:\n\n```bash\nnpm run build\n```\n\n## Executing the project\n\nOpen the terminal at the same directory that contains the file `package.json`, and execute:\n\n```bash\nnpm start\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodigofalado%2Ftwitch-giphy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodigofalado%2Ftwitch-giphy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodigofalado%2Ftwitch-giphy/lists"}