|
||
---|---|---|
docs | ||
extension | ||
graphics | ||
.gitattributes | ||
.gitignore | ||
LICENSE | ||
README.md | ||
package.json | ||
tsconfig.json |
README.md
Twitch Phone Bundle
Installation
- Clone this bundle into nodecg-io and add it. (Not going to create a tutorial for this here.)
- Then, create a config in
nodecg/cfg/twitch-phone.json
with the following content:
{
"rewardTitle": "<Your reward name here>"
}
- When booting into nodecg-io, setup all dependencies (twitch-pubsub, gametts, opentts) and you're ready to go. Note that you do not need both tts services, as this bundle checks what services are set up when someone calls you.
- Upload all your sounds! For that, go to
Assets
and upload files in both the "Ringtones" and "Busytones" categories. - When you're finished, you just need to use the graphic. Just go to
Graphics
, search for "PHONE.HTML" and copy the url (or open it in a new window / tab).
Control your phone
To accept or decline calls, you need to send GET requests to the following urls:
URL | Action |
---|---|
http://<your-ip>/twitch-phone/control/accept-call | Accept the call |
http://<your-ip>/twitch-phone/control/decline-call | Decline the call |
http://<your-ip>/twitch-phone/control/reroll-ring | Reroll the ringtone |
Special behaviour
The decline call button has some special behaviours.
Situation | Action |
---|---|
While the tts is still loading | Skip call completely, without the beep beep beep. |
While the tts is playing | Stop the call, play beep beep beep. |
While the beep beep beep is playing | Skip the beep beep beep and jump to the next call. |
Also while playing the beep beep beep, you can go back to playing the tts.
Stream Deck Icons
I've created icons for the stream deck interaction buttons.
Action | Icon | SVG |
---|---|---|
Accept the call | ![]() |
accept.svg |
Decline the call | ![]() |
decline.svg |
Reroll the ringtone | ![]() |
reroll.svg |
Debug Mode
This bundle has a debug mode in the graphic, to watch the 3 players and the internal variables. Helpful for development.
You can get into this debug mode by adding a ?debug
to the graphics url!
License
This project is licensed under the MIT License - see the LICENSE file for details.