Skip to content

ayaadev/PeerTube-Plus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

PeerTube Plus

Finally watch PeerTube on Kodi!

Features

  • Ability to set a custom instance
  • Locally search videos on the custom instance, or search across the entire PeerTube fediverse with SepiaSearch!
  • Different feeds (all videos, subscriptions, trending, local videos)
  • Account authentication
  • 2FA Support
  • Metadata on videos for easy searching
  • Pagination on video feeds which increases responsiveness

Planned features

  • Filters for global search (SepiaSearch)
  • Add a "Playlists" feed which shows the user's playlists (#13)
  • Add a "Watch Later" feed (#13)
  • Allow for multiple users with their own custom instance (#14)
  • Show subscribed channels (and their videos) in a feed (#15)
  • Torrent PeerTube videos

Is a feature you want not listed here? Please create a new issue with your feature request.

Requirements

  • If you would like to use the upgraded video player (spoiler alert: you do!), you need version 22.3.6 or higher of the InputStream Adaptive addon. This is already available for Windows and MacOS Kodi installs. However, they're still working on making it available on Linux. If you would like, you may manually build and install the latest version of InputStream Adaptive here. Once you have the necessary version, you will automatically start using the upgraded video player.
  • Any PeerTube instance URL, even if you don't have an account. Please see the configuration section below.

Installation

  1. In the top left of Kodi, click on the settings wheel
image
  1. Navigate to "File manager"
image
  1. Click on "Add source" and click on "" in the window that appears
image
  1. Input https://ayaadev.github.io and click "OK"
image
  1. Enter a name for this source. You can name it anything, but I've named it "AyaaDev Repo" here. Click "OK"
image
  1. Navigate back and click on "Add-ons"
image
  1. Click on "Install from zip file"

  2. Navigate to the name of the repository you created. In my case, it is "AyaaDev Repo"

image
  1. Select the only result on the page
image
  1. Click on "Install from repository"
image
  1. Select "AyaaDev Kodi Repository"
image
  1. Select "Video add-ons"
image
  1. Select "PeerTube Plus" and click install!

Installing from source

  1. Run git clone https://github.com/ayaadev/PeerTube-Plus.git
  2. Run zip -r plugin.video.peertube-plus.zip plugin.video.peertube-plus/
  3. Open Kodi
  4. Click on the settings wheel in the top left
  5. Click "Add-ons"
  6. Click "Install from zip file"
  7. Navigate to the ZIP file you created in step 2.

Configuration

Before opening the addon, make sure to set the custom instance. Click on the "Configure" button after navigating to the addon: image

Set your PeerTube instance in the "Custom instances" setting. It should not begin with "http". For example, input "peertube.tech" instead of "https://peertube.tech". image The instance "peertube.tech" is just an example for the purpose of this guide. Please set it to any instance you would like.

Usage

When you first open the addon, you will see the following menu: image

You are able to access any feed that is shown while you are not logged in (e.g. "All Videos") without a PeerTube account.

If you would like to access your subscriptions feed, click "Login". Input your username, password and two-factor authentication code (if you have 2FA enabled).

image

You should now see the "Subscriptions" feed appear.

image

To watch any video, simply click on your desired feed and locate the video you would like to play.

Privacy and Security

  • Your username, password and two-factor authentication code are never stored.
  • However, your access token and refresh token (which gives the API access to your account) are stored in plaintext in the addon directory.
  • These tokens will only last for at most 2 weeks, but treat them like your password and never share it nor your Kodi directory online.
  • The plugin only stores data inside its respective directory inside the Kodi folder, except for cached results which are stored in a shared database in temp/commoncache.db.

To report a security vulnerability, please refer to the SECURITY.md file for details.

Known limitations

Acknowledgements

This project was inspired by and modified from Haui1112's plugin.video.pt Kodi addon. Modifications include:

  1. Reworked instance selection. Users can arbitrarily set their instance in the addon settings. This avoids users' frustration when their instance is not listed (see here).
  2. Implemented both local and global search (SepiaSearch)!
  3. Fixed video playback and made it more reliable.
  4. Added more metadata to videos which makes them easier to identify in the list.
  5. Added view and like count to videos.
  6. Added separate feeds (all videos, subscriptions, trending, local videos).
  7. Setup pagination which makes load times faster and lets users keep browsing all videos in the feed.
  8. Cached results for faster load times.
  9. Implemented much more error checking, leading to a less buggy experience.
  10. Added authentication, so users can perform authenticated actions (e.g. subscriptions feed).
  11. Implemented two-factor support for authentication.
  12. Implemented automatic renewal of short-lived PeerTube API token.
  13. Localized all dialog that the user sees.
  14. Et cetera.

About

A next-generation PeerTube addon for Kodi with features such as different feeds, account authentication with 2FA support, and search!

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors

Languages