{"id":29543869,"url":"https://github.com/quantum-0/ttv-orb-overlay","last_synced_at":"2026-05-19T04:32:19.220Z","repository":{"id":289910163,"uuid":"972794326","full_name":"Quantum-0/ttv-orb-overlay","owner":"Quantum-0","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-03T14:25:59.000Z","size":208,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-03T15:27:42.374Z","etag":null,"topics":["mixitup","obs","overlay","phasmophobia","twitch"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Quantum-0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-04-25T17:12:09.000Z","updated_at":"2025-05-03T14:26:03.000Z","dependencies_parsed_at":"2025-04-25T18:38:28.267Z","dependency_job_id":null,"html_url":"https://github.com/Quantum-0/ttv-orb-overlay","commit_stats":null,"previous_names":["quantum-0/ttv-orb-overlay"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Quantum-0/ttv-orb-overlay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantum-0%2Fttv-orb-overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantum-0%2Fttv-orb-overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantum-0%2Fttv-orb-overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantum-0%2Fttv-orb-overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Quantum-0","download_url":"https://codeload.github.com/Quantum-0/ttv-orb-overlay/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quantum-0%2Fttv-orb-overlay/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265614356,"owners_count":23798428,"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":["mixitup","obs","overlay","phasmophobia","twitch"],"created_at":"2025-07-17T14:08:53.098Z","updated_at":"2026-05-19T04:32:19.186Z","avatar_url":"https://github.com/Quantum-0.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Twitch Orb Overlay\n\n[![wakatime](https://wakatime.com/badge/github/Quantum-0/ttv-orb-overlay.svg)](https://wakatime.com/badge/github/Quantum-0/ttv-orb-overlay)\n\nДанный репозиторий представляет из себя оверлей для твича, подключаемый через [MixItUp](https://github.com/SaviorXTanren/mixer-mixitup) сделанный для [SillySnaily](https://www.twitch.tv/sillysnaily).\n\nОверлей добавляет Орб (он же \"призрачный огонёк\") из Phasmophobia, появляющийся на стриме с некоторой периодичностью.\nКогда появляется орб, пользователи в чате могут использовать команду `!орб` или `!orb`, для того, чтобы поймать его.\nДля того, чтобы вручную вызвать появление орба, можно использовать команду `!чопоорбам`.\n\n## Логика работы\n\nВ **MixItUp** создаётся кастомный виджет с возможностью получения сообщений из чата.\n\nВнутри него с помощью JS создаётся объект орба, который с некоторой периодичностью появляется и летает по экрану.\n\nЕсли виджет ловит событие сообщения во время активности орба - скрипт завершает его цикл и отправляет **HTTP POST** запрос в **API MixItUp** с указанными *ID* и *Secret*.\n\n**WebHook MixItUp** передаёт приложению событие о том, что орб был пойман, передавая туда значение `user` - пользователь, который поймал орб.\n\nПользователь может самостоятельно настроить обработку, указав желаемое сообщение или настроив любые другие действия.\n\n## Подключение\n\nПереходим в раздел **Webhooks**.\n\n![Step 1](doc/step1.png)\n\nСоздаём вебхук.\n\n![Step 2](doc/step2.png)\n\nВ вебхуке прописываем `user`: `user` в *Webhook JSON Map Pairs* и добавляем **Action** вызываемый когда пользователь ловит орб. В экшне появится параметр `user`, который можно использовать, чтоб, например, выдать сообщение, кто поймал орб.\n\n![Step 3](doc/step3.png)\n\nСохраняем, жмём *Copy URL*, из URL вытаскиваем 2 значения:\n- **ID вебкуха** - значение вида `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`;\n- **Secret вебхука** - цифробуквенное значение идущее после `secret=` в URL'е;\nЭти два значения пригодятся нам позже.\n\nПереходим в раздел **Overlay Widgets**.\n\n![Step 4](doc/step4.png)\n\nСоздаём виджет.\n- `Display Option` указываем `Sindle Widget URL`;\n- В *Details* -\u003e *Events* ставим галочку `Chat Messages`;\n- Переходим в **HTML**, удаляем всё что там есть;\n- Переходим в **CSS**, вставляем туда код [отсюда](orb.css);\n- Переходим в **JavaScript**, вставляем туда код [отсюда](orb.js);\n\n![Step 5](doc/step5.png)\n\nВозвращаемся в **Details**. В **Properties** добавляем 2 параметра:\n- `whId` - сюда вставляем значение ***ID вебхука***, вырезанное ранее из URL'а вебхука;\n- `whSecret` - сюда вставляем значение ***секрета вебхука***, вырезанное оттуда же;\n\n![Step 6](doc/step6.png)\n\nКопируем ссылку на созданный **Overlay Widget**.\n\n![Step 7](doc/step7.png)\n\nВставляем полученную ссылку в OBS как **браузерный источник**.\n\n![Step 8](doc/step8.png)\n\nГотово! Вы восхитительны!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantum-0%2Fttv-orb-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquantum-0%2Fttv-orb-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantum-0%2Fttv-orb-overlay/lists"}