{"id":13503320,"url":"https://github.com/michaeljolley/twitch-orbit","last_synced_at":"2025-03-29T14:31:19.069Z","repository":{"id":48963098,"uuid":"349802044","full_name":"michaeljolley/twitch-orbit","owner":"michaeljolley","description":"Application that monitors Twitch chat to record activities into Orbit.","archived":false,"fork":false,"pushed_at":"2021-07-03T02:37:04.000Z","size":185,"stargazers_count":16,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T16:52:54.778Z","etag":null,"topics":["orbit","orbit-model","twitch"],"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/michaeljolley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-20T18:13:31.000Z","updated_at":"2024-08-26T06:22:29.000Z","dependencies_parsed_at":"2022-09-24T00:52:03.021Z","dependency_job_id":null,"html_url":"https://github.com/michaeljolley/twitch-orbit","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljolley%2Ftwitch-orbit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljolley%2Ftwitch-orbit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljolley%2Ftwitch-orbit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljolley%2Ftwitch-orbit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaeljolley","download_url":"https://codeload.github.com/michaeljolley/twitch-orbit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246196959,"owners_count":20739201,"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":["orbit","orbit-model","twitch"],"created_at":"2024-07-31T22:02:46.370Z","updated_at":"2025-03-29T14:31:18.728Z","avatar_url":"https://github.com/michaeljolley.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Twitch Orbit\n\n![CI](https://github.com/michaeljolley/twitch-orbit/actions/workflows/CI.yml/badge.svg)\n![Docker Image Version (latest semver)](https://img.shields.io/docker/v/michaeljolley/twitch-orbit?sort=semver)\n![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen)\n\nAn application monitors Twitch viewer activity and records to [Orbit](https://orbit.love).\n\n## Events\n\nBy default, all activities are recorded with a weight of 1. This can be changed\nvia environment variables.\n\nThe application listens for the following events to record:\n\n| Event | Description |\n| --- | --- |\n| Chat Message | Viewer sends their first message in Twitch chat today |\n| Command | Viewer has entered a command (`!command`) in Twitch chat |\n| Cheer | Viewer has cheered X bits |\n| Raid | Streamer has raided the channel with X viewers |\n| Subscribe | Viewer has subscribed to the Twitch channel |\n| Resubscribe | Viewer has renewed their subscription |\n| Gift Subscription | Viewer has received or given a gift subscription |\n\n## Quick Deploy\n\n\u003ca href=\"https://render.com/deploy?repo=https://github.com/phazonoverload/twitch-orbit\"\u003e\n  \u003cimg src=\"https://render.com/images/deploy-to-render-button.svg\"\u003e\n\u003c/a\u003e\n\n## Setup\n\nRename `.env-sample` to `.env` and provide the correct values for each variable.\nAdditional [variables](#Environment_Variables) are available and described below.\n\n```bash\nnpm run install\nnpm run build\n```\n\n## Running the Application\n\nThere are two options for running the application: node \u0026 Docker.\n\n### Node\n\nAfter completing the [Setup] above, run `npm run start` to start the application.\n\n### Docker\n\nAfter completing the [Setup] above, run `docker build .` to build an image. If\nrunning via Docker, ensure you provide the environment variables to the container.\n\nOfficial versions of the application are also available in the Docker Hub\nwith the image name: `michaeljolley/twitch-orbit`. Use the `:latest` tag or\na specific version.\n\n## Environment Variables\n\nUse the following environment variables to configure the application for your\nuse cases.\n\n| Variable | Required | Default | Description |\n| --- | --- | --- | --- |\n| TWITCH_CHANNELS | X | | A comma separated list of Twitch channels to listen to |\n| ORBIT_WS | X | | The Orbit workspace id |\n| ORBIT_KEY | X | | The Orbit API key |\n| ORBIT_WEIGHT_FOLLOW     | | 1 | Weight to apply for user follows |\n| ORBIT_WEIGHT_CHEER      | | 1 | Weight to apply for cheers |\n| ORBIT_WEIGHT_SUB        | | 1 | Weight to apply for all subscription events |\n| ORBIT_WEIGHT_RAID       | | 1 | Weight to apply for raids |\n| ORBIT_WEIGHT_CHAT       | | 1 | Weight to apply for chatting per day |\n| ORBIT_WEIGHT_COMMAND    | | 1 | Weight to apply for using a command |\n\n## Code of Conduct\n\nIn the interest of fostering an open and welcoming environment, we strive to make participation in our project and our community a harassment-free experience for everyone. Please check out our [Code of Conduct](CODE_OF_CONDUCT.md) in full.\n\n## Contributing\n\nWe :heart: contributions from everyone! Check out the [Contributing Guidelines](CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is subject to the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaeljolley%2Ftwitch-orbit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaeljolley%2Ftwitch-orbit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaeljolley%2Ftwitch-orbit/lists"}