PlexKodiConnect/README.md

94 lines
7.2 KiB
Markdown
Raw Normal View History

2016-03-04 02:58:00 +11:00
**Credits**
- 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!!
2016-03-16 19:35:13 +11:00
- Plex Companion ("PlexBMC Helper") and other stuff was adapted from @Hippojay 's great work (see https://github.com/hippojay).
2016-03-04 02:58:00 +11:00
- The foundation of the Plex API is all iBaa's work (https://github.com/iBaa/PlexConnect).
2015-03-26 05:11:48 +11:00
2016-03-04 02:58:00 +11:00
**Installation in Kodi**
2016-03-04 03:00:02 +11:00
2016-03-16 19:35:13 +11:00
1. You might want to uninstall everything else Plex related first, e.g. PlexBMC and PlexBMC Helper. Starting with a fresh Kodi install might be a good idea. Be sure to use a "normal", unmodded Skin in Kodi to start with.
2016-03-16 20:10:48 +11:00
If you're updating, you might also want to do a complete reset of the plugin: Settings -> Advanced -> "Perform local database reset (full resync)". Choose "Yes" for all questions.
2016-03-04 02:58:00 +11:00
2. Simply fire up Kodi and Install from ZIP from here on.
2016-03-10 18:06:50 +11:00
3. Install the 2 needed dependencies first (be sure to NOT download the sources but the additional release files): https://github.com/croneter/plugin.video.plexkodiconnect.tvshows/releases/ and https://github.com/croneter/plugin.video.plexkodiconnect.movies/releases/
2016-03-04 03:09:51 +11:00
5. Then install PlexKodiConnect, again the additional release file from here: https://github.com/croneter/PlexKodiConnect/releases/
2016-03-04 02:58:00 +11:00
6. Within a few seconds you should be prompted to log into plex.tv. This is mandatory for Plex Home, otherwise you can skip. If nothing happens, try to restart Kodi
7. Once you're succesfully authenticated to your Plex server, the initial sync will start.
2016-03-10 18:06:50 +11:00
8. The first sync of the Plex server to local Kodi database may take a LONG time. With my setup (~400 movies, ~600 episodes, couple of Test music albums and a very powerful NAS), sync takes approximately 5 minutes.
2016-03-04 02:58:00 +11:00
9. Once the full sync is done, you can browse your media in Kodi, syncs will be automatically done in the background.
2016-03-16 19:35:13 +11:00
10. Restart Kodi!
2016-03-04 02:58:00 +11:00
2016-03-16 19:35:13 +11:00
This software is yet in a Beta version. You have been warned. It's very probable that you will need to fully resync and reset your setup on a regular basis.
2016-03-04 02:58:00 +11:00
2016-03-04 23:34:30 +11:00
**Having Problems? Then thanks for your log files**
2016-03-16 20:10:48 +11:00
It's always a good idea to try resetting the Addon: Settings -> Advanced -> "Perform local database reset (full resync)"
2016-03-04 23:34:30 +11:00
1. Activate a more detailed logging for KodiPlexConnect: Settings -> Advanced -> "Debug"
2. Follow the instructions here: http://kodi.wiki/view/Log_file/Easy
2016-03-16 19:35:13 +11:00
3. Don't forget to delete all references to any of your Plex tokens!! You don't want others to have access to your Plex installation
4. Post the link to your log (that you posted e.g. here: http://xbmclogs.com/) on https://forums.plex.tv/discussion/210023/plexkodiconnect-supercharge-your-plex-kodi-connection (or send a private message)
2016-03-04 23:34:30 +11:00
2016-03-04 02:58:00 +11:00
### Welcome to PlexKodiConnect
**Connect your Plex Media Server to a Kodi Front End**
PlexKodiConnect combines the best of Kodi - ultra smooth navigation, beautiful UIs and playback of any file under the sun, and Plex.
2015-03-26 05:11:48 +11:00
**What does it do?**
2016-03-04 02:58:00 +11:00
With other addons for Kodi there are a couple of issues:
- 3rd party addons such as NextAired, remote apps etc. won't work
2015-03-26 05:11:48 +11:00
- Speed: when browsing the data has to be retrieved from the server. Especially on slower devices this can take too much time.
2016-03-16 19:35:13 +11:00
- You can only use special Kodi skins
2015-03-26 05:11:48 +11:00
- All kinds of workaround were needed to get the best experience on Kodi clients
2016-03-16 19:35:13 +11:00
This addon synchronizes your media on your Plex server to the native Kodi database. Because we use the native Kodi database with this new approach the above limitations are gone!
- You can browse your media full speed
- All other Kodi addons will be able to "see" your media, thinking it's normal Kodi stuff
- Use any Kodi skin you want!
2015-03-26 05:11:48 +11:00
**What is currently supported ?**
2016-03-16 19:35:13 +11:00
Currently these features are working:
2015-03-26 05:11:48 +11:00
- Movies
- TV Shows
2016-03-04 02:58:00 +11:00
- Full sync at first run (import), background syncs configurable by the user in the addonsetting. The current default is that it will do a full sync on the background approximately every 30min and continuous incremential syncs.
2015-03-26 05:31:53 +11:00
- Watched state/resume status sync: This is a 2-way synchronisation. Any watched state or resume status will be instantly (within seconds) reflected to or from Kodi and the server.
2016-03-16 19:35:13 +11:00
- Plex Companion: you can fling Plex media from other Plex devices to PlexKodiConnect
- Play directly from network paths (e.g. "\\\\server\\Plex\\movie.mkv" on Windows or SMB paths "smb://server/Plex/movie.mkv") instead of slow HTTP (e.g. "192.168.1.1:32400"). You have to setup all your Plex libraries to point to such network paths.
2015-03-26 05:11:48 +11:00
2016-03-24 03:16:32 +11: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-03-23 04:20:18 +11:00
- **Plex Music:** You must have a static IP address for your Plex media server if you plan to use Plex Music features. This is due to the way Kodi works and cannot be helped.
- **Plex Music:** Kodi tries to scan every(!) single Plex song on startup. This leads to errors in the Kodi log file and potentially even crashes. (Plex puts each song in a "dedicated folder", e.g. 'http://192.168.1.1:32400/library/parts/749450/'. Kodi unsuccessfully tries to scan these folders)
- **Plex updates:** PlexKodiConnect continuously polls the Plex Media Server for changes. If something on the PMS has changed, this change is synced to Kodi. Hence if you rescan your entire library, a long PlexKodiConnect re-sync is triggered.
2016-03-24 03:16:32 +11:00
- **Subtitles**: external Plex subtitles (separate file, e.g. mymovie.srt) can be used, but it is impossible to label them correctly/tell what language they are in
- **Direct Paths:** If you use direct paths, your (initial) sync will be slower
2016-03-30 05:17:07 +11:00
- **Background Sync:** If you toggle the viewstate of an item to (un)watched somewhere else outside of Kodi/PKC, this change is only synched with a full sync. Plex does not communicate this toggling to anyone.
2016-03-24 03:16:32 +11:00
**Known Bugs:**
- **Plex Music:** Plex Music for direct paths does not work yet.
2016-03-17 04:52:00 +11:00
- **Video Nodes**: some nodes, e.g. "On Deck", are customized/hacked. Hence no access to movie metadata is possible, because Kodi does not know it's a library item
2016-03-04 02:58:00 +11:00
2016-03-24 03:16:32 +11:00
**What could be in the pipeline for future development?**
2016-03-16 19:35:13 +11:00
- Watch Later
- Playlists
2016-03-08 03:34:50 +11:00
- Homevideos
- Pictures
- Music Videos
2016-03-23 04:20:18 +11:00
- Automatic updates
- Simultaneously connecting to several PMS
2016-03-04 02:58:00 +11:00
- TV Shows Theme Music (ultra-low prio)
2015-03-26 05:11:48 +11:00
**Important note about MySQL database in kodi**
2016-03-04 03:02:08 +11:00
The addon is not (and will not be) compatible with the MySQL database replacement in Kodi. In fact, PlexKodiConnect takes over the point of having a MySQL database because it acts as a "man in the middle" for your entire media library.
2015-03-26 05:11:48 +11:00
**Important note about user collections/nodes**
2016-03-04 02:58:00 +11:00
Plex has the ability to create custom libraries for your Media, such as having a separate folder for your "Kids Movies" etc. In Kodi this isn't supported, you just have "movies" or "tvshows". But... Kodi let's you create your own playlists and tags to get this same experience. During the sync the foldernode from the Plex server is added to the movies that are imported. In Kodi you can browse to Movie library --> tags and you will have a filtered result that points at your custom node. If you have a skin that let's you create any kind of shortcut on the homescreen you can simply create a shortcut to that tag. Another possibility is to create a "smart playlist" with Kodi and set it to show the content of a certain tag.
2015-03-26 05:11:48 +11:00
2016-03-04 02:58:00 +11:00
Report bugs or pictures of your burning raspi on the forums