Skip to content

Webapp that transforms a Twitch channel into a podcast feed to be used inside a podcast client

License

Notifications You must be signed in to change notification settings

madiele/TwitchToPodcastRSS

Repository files navigation

based on twitchRSS

TwitchToPodcastRSS

ℹ️ Also check vod2pod-rss a rewrite in rust that adds youtube support and modern UI for feed generation

converts a twitch channel in a full-blown podcast

Features:

  • completely converts the vods in a proper podcast RSS that can be listened directly inside the client (you can even disable trascoding if they support audio only m3u8 playback, podcast addict is the only app I found that has support for it), no need for the twitch app
  • the description has a clickable image that opens the vod in the twitch app
  • the vods are not downloaded on the server, this means that the episodes are only available until they get deleted from twitch (2 weeks - 2 months in general, depends on the creator settings)
  • vods are transcoded to mp3 192k on the fly by default, tested to be working flawlessly even on a raspberry pi 3.

Known issues:

  • when transcoding seeking to the last minute or so can be buggy, I have no idea why, help is welcome
  • to improve performance you can only have one ongoing transcoding of the same vod on the same client at once
  • when transcoding seeking around too fast can be buggy
  • when playing transcoded vod's mp3 it's possible to hear audio skipping 1-2 second in time every once in a while, this is caused by the connection dropping when downloading, and due to a technical limitation can't really be fixed (twitch gives a variable bitrate stream with seek data in seconds, but the clients wants a fixed bitrate stream with seek data in bytes, when converting some rounding errors cause the audio to glitch)
  • (only if transcoding is disabled) first time you ask for a feed it will take up to a minute or two for the request to go through, this is due to technical limitations. since updates are generally done in background by the podcast clients this should not be a huge limitation, just give it time. if you only listen/watch inside the twitch app or website be sure to enable links only mode to make the feed generation much faster
  • (only if transcoding is disabled) downloading only works with transcoding enabled (unless the client supports m3u8 download, which is rare)

Donations

this is a passion project, and mostly made for myself, but if you want to gift me a pizza margherita feel free!

"Buy Me A Coffee"

Usage

when you host this just add /vod/channelName to your server path and an RSS will be generated

example: myserver.com/vod/channelname

just add the link to your podcast client

transcoding

to enable transcoding just add ?transcode=true to your url

example: myserver.com/vod/channelname?transcode=True

show currently streaming

unfinished streams are not included, but if you want them to just add ?include_streaming=True to the feed URL

example: myserver.com/vod/channelname?include_streaming=True

sorting

if you use a feed reader you can order the feed by any field suppored by twitch, the list of fields to sort by can be found here in the response field section

by default it sorts by the published_at field

to enable sorting just add sort_by=[key] or/and desc=True to the URL

some examples:

to sort by views:

myserver.com/vod/channelname?sort_by=view_count

to sort by views descending:

myserver.com/vod/channelname?sort_by=view_count&desc=true

only links mode

if you only listen to the episodes in the twitch app or website you can enable the links_only=true to skip the fetching of the audio stream, doing so will make the feed generation almost instant, so it's highly raccomanded to enable the option if you don't use the included audio feed

example: myserver.com/vod/channelname?links_only=True

mixing options

to mix options just add & beetween them

example: myserver.com/vod/channelname?sort_by=view_count&desc=true&links_only=true&include_streaming=True

install with docker

before doing anything be sure to get your SECRET and CLIENT ID from twitch https://dev.twitch.tv/console

precompiled images are here for linux machines with arm64, amd64, arm/v7, i386 architectures

images for raspberry pis are included

use docker-compose with precompiled image (easiest)

git clone https://github.com/madiele/TwitchToPodcastRSS.git

cd TwitchToPodcastRSS

edit docker-compose.yml with your PORT, SECRET and CLIENT_ID (in the file you will find also optional parameters like sub_folder for use with reverse proxies, define a unique server name, and so on)

nano docker-compose.yml

save and

sudo docker-compose up -d

when you want to update:

run this inside the folder with docker-compose.yml

sudo docker-compose pull && sudo docker-compose up -d

then run this to delete the old version form your system (note: this will also delete any other unused image you have)

sudo docker system prune

pull the precompiled image from hub.docker.com

docker pull madiele/twitch_to_podcast_rss:latest

edit with PORT,SECRET and CLIENT_ID

sudo docker run -d --restart always -p <PORT>:80 -e TWITCH_SECRET="<YOUR_SECRET>" -e TWITCH_CLIENT_ID="<YOUR_CLIENT_ID>" madiele/twitch_to_podcast_rss:latest

to update kill and delete the running container and run the same commands

build it yourself (this will take a while)

git clone https://github.com/madiele/TwitchToPodcastRSS.git

cd TwitchToPodcastRSS

docker build -t TwitchToPodcastRSS .

edit with PORT,SECRET and CLIENT_ID

sudo docker run -d --restart always -p <PORT>:80 -e TWITCH_SECRET="<YOUR_SECRET>" -e TWITCH_CLIENT_ID="<YOUR_CLIENT_ID>" TwitchToPodcastRSS

install without docker

since this is a flask app most methods of deployment listed here should work too

About

the original twitchRSS has been developed by László Zeke. Later modified into TwitchToPodcastRSS by Mattia Di Eleuterio