Skip to content

Latest commit

 

History

History
57 lines (47 loc) · 3.2 KB

README.md

File metadata and controls

57 lines (47 loc) · 3.2 KB
Raw

xExtension-RedditImage

A FreshRSS extension to process Reddit feeds

If the link in the content is recognized, the content is replaced by the linked resource (images or videos). If the link in the content is not recognized, the link used in the title is modified to link to the content resource instead of the reddit comment page.

At the moment, the following resources are recognized:

  match type support
1 links finished by jpg, jpeg, png, gif, bmp image full
2 imgur links finished by gifv video full
3 imgur links finished with a token image partial
4 links finished by webm, mp4 video full
5 redgifs links finished with a token video none
6 reddit links finished with a token video limited (no audio)
7 reddit image galleries image full
8 imgur image galleries image full with API client id; none without
9 flickr image image full with API key; none without

Note the support from redgifs links with a token went from full to none after a change in their API.

Configuration

Display configuration

Item Detail Default
Media height Select a media height in viewport percentage 70%
Muted video Choose if videos are muted or not True
Display images Choose if images are displayed True
Display videos Choose if videos are displayed True
Display original content Choose if original contents are displayed True
Display metadata Choose if original content metadata are displayed False
Display thumbnails Choose if feed enclosure are displayed False

Note: When the display original content option is set to true, text content will be displayed twice. Once from the extracted content and once from the original content. To have a nicer interface, it is recommended to set that option to false.

Authorization configuration

Item Detail Default
Flickr API key Check Flickr API documentation for more information none
Imgur client id Check Imgur API documentation for more information none

Known limitations

  • not compatible with PHP versions under 7.2
  • loaded content can not be reprocessed
  • videos extracted from v.redd.it do not have audio. The audio is added by the current extension but is not linked to the video (and will never be). You can still enjoy the audio by linking it yourself with the help of the CustomJS extension. Here is a quick snippet to sync the sound with the video (tested only in Firefox console):
document.querySelectorAll('video.reddit-image').forEach(element => {
  element.addEventListener('play', event => { event.target.querySelector('audio').play(); })
  element.addEventListener('pause', event => { event.target.querySelector('audio').pause(); })
  element.addEventListener('seeking', event => { event.target.querySelector('audio').currentTime = event.target.currentTime })
});

Note: This is only an example. It might not supports every scenarios. If you need to make it work, you'll have to figure how. You can still provide a documentation PR if you have something worth sharing.