PlexKodiConnect/README.md

130 lines
9.2 KiB
Markdown
Raw Normal View History

2016-07-16 23:00:06 +10:00
# PlexKodiConnect (PKC)
**Combine the best frontend media player Kodi with the best multimedia backend server Plex**
2016-12-05 00:38:03 +11:00
PKC combines the best of Kodi - ultra smooth navigation, beautiful and highly customizable user interfaces and playback of any file under the sun - and the Plex Media Server.
2016-07-16 23:00:06 +10:00
2016-07-17 00:09:10 +10:00
Have a look at [some screenshots](https://github.com/croneter/PlexKodiConnect/wiki/Some-PKC-Screenshots) to see what's possible.
### Call for Translations
Please help translate PlexKodiConnect into your language: [visit crowdin.com](https://crowdin.com/project/plexkodiconnect/invite)
2016-12-05 00:44:52 +11:00
### Content
2017-02-05 22:59:30 +11:00
* [**Warning**](#warning)
2016-12-05 00:53:17 +11:00
* [**What does PKC do and how is it different from the official 'Plex for Kodi'**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#what-does-pkc-do-and-how-is-it-different-from-the-official-plex-for-kod)
2016-12-05 00:44:52 +11:00
* [**Download and Installation**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#download-and-installation)
2016-12-05 01:07:34 +11:00
* [**Important notes**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#important-notes)
2016-12-05 00:44:52 +11:00
* [**Donations**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#donations)
* [**What is currently supported?**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#what-is-currently-supported)
* [**Known Larger Issues**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#known-larger-issues)
* [**Issues being worked on**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#issues-being-worked-on)
* [**Pipeline for future development**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#what-could-be-in-the-pipeline-for-future-development)
2016-12-05 01:07:34 +11:00
* [**Checkout the PKC Wiki**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#checkout-the-pkc-wiki)
2016-12-05 00:44:52 +11:00
* [**Credits**](https://github.com/croneter/PlexKodiConnect/tree/hotfixes#credits)
2016-10-16 23:23:40 +11:00
### Warning
2016-12-05 00:38:03 +11:00
Use at your own risk! This plugin assumes that you manage all your videos with Plex (and none with Kodi). You might lose data already stored in the Kodi video and music databases as this plugin directly changes them. Don't worry if you want Plex to manage all your media (like you should ;-)).
2016-10-16 23:23:40 +11:00
2016-12-05 00:53:17 +11:00
### What does PKC do and how is it different from the official ['Plex for Kodi'](https://www.plex.tv/apps/computer/kodi/)?
2016-12-05 01:07:34 +11:00
With other Plex addons for Kodi such as the official [Plex for Kodi](https://www.plex.tv/apps/computer/kodi/) or [PlexBMC](https://forums.plex.tv/discussion/106593/plexbmc-xbmc-add-on-to-connect-to-plex-media-server) there are a couple of issues:
- Other Kodi addons such as NextAired, remote apps and others won't work
2016-12-05 00:53:17 +11:00
- You can only use special Kodi skins
2016-12-05 01:07:34 +11:00
- Slow speed: when browsing data has to be retrieved from the server. Especially on slower devices this can take too much time and you will notice artwork being loaded slowly while you browse the library
2016-12-05 00:53:17 +11:00
- All kinds of workarounds are needed to get the best experience on Kodi clients
PKC synchronizes your media from your Plex server to the native Kodi database. Because PKC uses the native Kodi database, the above limitations are gone!
- Use any Kodi skin you want!
2016-12-05 01:07:34 +11:00
- You can browse your media at full speed, images are cached
- All other Kodi addons will be able to "see" your media, thinking it's normal Kodi stuff
Some people argue that PKC is 'hacky' because of the way it directly accesses the Kodi database. See [here for a more thorough discussion](https://github.com/croneter/PlexKodiConnect/wiki/Is-PKC-'hacky'%3F).
2016-12-05 00:53:17 +11:00
2016-07-16 23:00:06 +10:00
### Download and Installation
2016-04-30 04:44:38 +10:00
[ ![Download](https://api.bintray.com/packages/croneter/PlexKodiConnect/PlexKodiConnect/images/download.svg) ](https://dl.bintray.com/croneter/PlexKodiConnect/bin/repository.plexkodiconnect/repository.plexkodiconnect-1.0.0.zip)
2016-04-30 03:52:45 +10:00
2016-12-05 00:38:03 +11:00
Install PKC via the PlexKodiConnect Kodi repository (we cannot use the official Kodi repository as PKC messes with Kodi's databases). See the [installation guideline on how to do this](https://github.com/croneter/PlexKodiConnect/wiki/Installation).
2016-05-16 19:40:03 +10:00
2016-08-12 16:09:14 +10:00
**Possibly UNSTABLE BETA version:** [ ![Download](https://api.bintray.com/packages/croneter/PlexKodiConnect_BETA/PlexKodiConnect_BETA/images/download.svg) ](https://dl.bintray.com/croneter/PlexKodiConnect_BETA/bin-BETA/repository.plexkodiconnectbeta/repository.plexkodiconnectbeta-1.0.0.zip)
2016-08-12 06:43:59 +10:00
2016-12-05 01:07:34 +11:00
### Important Notes
2016-04-10 22:18:18 +10:00
1. If you are using a **low CPU device like a Raspberry Pi or a CuBox**, PKC might be instable or crash during initial sync. Lower the number of threads in the [PKC settings under Sync Options](https://github.com/croneter/PlexKodiConnect/wiki/PKC-settings#sync-options): `Limit artwork cache threads: 5`
2016-07-16 23:00:06 +10:00
Don't forget to reboot Kodi after that.
2016-12-05 00:53:17 +11:00
2. **Compatibility**:
2016-12-05 00:38:03 +11:00
* PKC is currently not compatible with Kodi's Video Extras plugin. **Deactivate Video Extras** if trailers/movies start randomly playing.
2016-12-05 00:53:17 +11:00
* PKC is not (and will never be) compatible with the **MySQL database replacement** in Kodi. In fact, PKC replaces the MySQL functionality because it acts as a "man in the middle" for your entire media library.
2016-12-05 00:44:52 +11:00
* If **another plugin is not working** like it's supposed to, try to use [PKC direct paths](https://github.com/croneter/PlexKodiConnect/wiki/Direct-Paths)
2016-12-05 00:53:17 +11:00
3. If you post logs, your **Plex tokens** might be included. Be sure to double and triple check for tokens before posting any logs anywhere by searching for `token`
2016-04-10 22:18:18 +10:00
2016-12-05 00:53:17 +11:00
### Donations
I'm not in any way affiliated with Plex. Thank you very much for a small donation via ko-fi.com and PayPal if you appreciate PKC.
**Full disclaimer:** I will see your name and address on my PayPal account. Rest assured that I will not share this with anyone.
2016-04-10 22:18:18 +10:00
2016-12-05 00:53:17 +11:00
[ ![Download](https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a|alt=Buy Me a Coffee)](https://ko-fi.com/A8182EB)
2016-04-08 23:35:03 +10:00
2016-07-16 23:00:06 +10:00
### What is currently supported?
2016-04-08 23:35:03 +10:00
2016-07-16 23:00:06 +10:00
PKC currently provides the following features:
- All Plex library types
+ Movies and Home Videos
+ TV Shows
+ Music
+ Pictures and Photos
- Different PKC interface languages:
+ English
+ German
2017-02-01 19:23:49 +11:00
+ Czech (thanks @Pavuucek)
2016-07-16 23:00:06 +10:00
+ More coming up
- [Plex Watch Later / Plex It!](https://support.plex.tv/hc/en-us/sections/200211783-Plex-It-)
- [Plex Companion](https://support.plex.tv/hc/en-us/sections/200276908-Plex-Companion): fling Plex media (or anything else) from other Plex devices to PlexKodiConnect
2016-07-16 23:00:06 +10:00
- [Plex Transcoding](https://support.plex.tv/hc/en-us/articles/200250377-Transcoding-Media)
- Automatically download more artwork from [Fanart.tv](https://fanart.tv/), just like the Kodi addon [Artwork Downloader](http://kodi.wiki/view/Add-on:Artwork_Downloader)
2016-05-01 18:43:55 +10:00
+ Banners
+ Disc art
2016-05-01 18:45:32 +10:00
+ Clear logos
+ Landscapes
2016-05-01 18:43:55 +10:00
+ Clear art
2016-05-01 18:45:32 +10:00
+ Extra fanart backgrounds
2016-07-16 23:00:06 +10:00
- Automatically group movies into [movie sets](http://kodi.wiki/view/movie_sets)
- Direct play from network paths (e.g. "\\\\server\\Plex\\movie.mkv") instead of streaming from slow HTTP (e.g. "192.168.1.1:32400"). You have to setup all your Plex libraries to point to such network paths. Do have a look at [the wiki here](https://github.com/croneter/PlexKodiConnect/wiki/Direct-Paths)
2016-12-05 00:38:03 +11:00
- Delete PMS items from the Kodi context menu
2015-03-26 05:11:48 +11:00
2016-07-16 23:00:06 +10:00
### Known Larger Issues
2016-03-25 04:55:17 +11:00
2016-03-24 03:16:32 +11:00
Solutions are unlikely due to the nature of these issues
2016-12-05 00:38:03 +11:00
- A Plex Media Server "bug" leads to frequent and slow syncs, see [here for more info](https://github.com/croneter/PlexKodiConnect/issues/135)
2016-05-01 18:43:55 +10:00
- *Plex Music when using Addon paths instead of Native Direct Paths:* Kodi tries to scan every(!) single Plex song on startup. This leads to errors in the Kodi log file and potentially even crashes. See the [Github issue](https://github.com/croneter/PlexKodiConnect/issues/14) for more details
- *Plex Music when using Addon paths instead of Native Direct Paths:* You must have a static IP address for your Plex media server if you plan to use Plex Music features
2016-05-01 18:43:55 +10:00
- External Plex subtitles (in separate files, e.g. mymovie.srt) can be used, but it is impossible to label them correctly and tell what language they are in. However, this is not the case if you use direct paths
2016-04-08 23:35:03 +10:00
*Background Sync:*
2016-07-16 23:00:06 +10:00
The Plex Server does not tell anyone of the following changes. Hence PKC cannot detect these changes instantly but will notice them only on full/delta syncs (standard settings is every 60 minutes)
2016-04-08 23:35:03 +10:00
- Toggle the viewstate of an item to (un)watched outside of Kodi
2016-04-22 23:32:32 +10:00
- Changing details of an item, e.g. replacing a poster
2016-05-01 18:45:32 +10:00
2016-04-08 23:35:03 +10:00
However, some changes to individual items are instantly detected, e.g. if you match a yet unrecognized movie.
2016-03-24 03:16:32 +11:00
2016-07-16 23:00:06 +10:00
### Issues being worked on
2016-12-05 01:07:34 +11:00
Have a look at the [Github Issues Page](https://github.com/croneter/PlexKodiConnect/issues). Before you open your own issue, please read [How to report a bug](https://github.com/croneter/PlexKodiConnect/wiki/How-to-Report-A-Bug).
2016-07-16 23:00:06 +10:00
2016-03-04 02:58:00 +11:00
2016-07-16 23:00:06 +10:00
### What could be in the pipeline for future development?
2016-03-24 03:16:32 +11:00
2016-12-05 00:53:17 +11:00
- Plex channels
2016-12-05 00:38:03 +11:00
- Movie extras (trailers already work)
2016-03-16 19:35:13 +11:00
- Playlists
2016-03-08 03:34:50 +11:00
- Music Videos
2015-03-26 05:11:48 +11:00
2016-12-05 01:07:34 +11:00
### Checkout the PKC Wiki
The [Wiki can be found here](https://github.com/croneter/PlexKodiConnect/wiki) and will hopefully answer all your questions. You can even edit the wiki yourself!
2016-07-16 23:00:06 +10:00
### Credits
2015-03-26 05:11:48 +11:00
2016-04-08 23:35:03 +10:00
- PlexKodiConnect shamelessly uses pretty much all the code of "Emby for Kodi" by the awesome Emby team (see https://github.com/MediaBrowser/plugin.video.emby). Thanks for sharing guys!!
- Plex Companion ("PlexBMC Helper") and other stuff were adapted from @Hippojay 's great work (see https://github.com/hippojay).
2016-07-16 23:00:06 +10:00
- The foundation of the Plex API is all iBaa's work (https://github.com/iBaa/PlexConnect).