Troplo/PlexKodiConnect
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated readme

Browse source
This commit is contained in:
tomkat83 2016-03-03 16:58:00 +01:00
parent 126f1ae81c
commit 6b8783c095
1 changed files with 38 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
README.md
View file

@ -1,43 +1,57 @@
### Welcome to Emby for Kodi ### This is an early BETA Version, so Beware of the Dragons
**A whole new way to manage and view your media library.** **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!!
- Plex Companion ("PlexBMC Helper") and other stuff was adapted from Hippojay's great work (see https://github.com/hippojay).
- The foundation of the Plex API is all iBaa's work (https://github.com/iBaa/PlexConnect).
The Emby addon for Kodi combines the best of Kodi - ultra smooth navigation, beautiful UIs and playback of any file under the sun, and Emby - the most powerful fully open source multi-client media metadata indexer and server. **Installation in Kodi**
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
2. Simply fire up Kodi and Install from ZIP from here on.
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/tag/1.0.0 and https://github.com/croneter/plugin.video.plexkodiconnect.movies/releases/tag/1.0.0
5. Then install PlexKodiConnect, again the additional release file from here.
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.
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 take approximately 5 minutes.
9. Once the full sync is done, you can browse your media in Kodi, syncs will be automatically done in the background.
Again, this is beta. You have been warned. It's a given that you will need to fully resync and reset your setup on a regular basis.
### 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.
**What does it do?** **What does it do?**
With the old MediaBrowser addon for Kodi we have a couple of issues because you browse your media as a "video addon": With other addons for Kodi there are a couple of issues:
- 3rd party addons such as NextAired, remote apps etc. won't work - 3rd party addons such as NextAired, remote apps etc. won't work
- Speed: when browsing the data has to be retrieved from the server. Especially on slower devices this can take too much time. - Speed: when browsing the data has to be retrieved from the server. Especially on slower devices this can take too much time.
- All kinds of workaround were needed to get the best experience on Kodi clients - All kinds of workaround were needed to get the best experience on Kodi clients
The new Emby addon synchronizes your media on your Emby 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 and all other Kodi addons will be able to "see" your media. 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 and all other Kodi addons will be able to "see" your media.
**What is currently supported ?** **What is currently supported ?**
We're still in beta stage of development. Currently these features are working: Guess what, this is BETA. Currently these features are working:
- Movies - Movies
- Sets
- TV Shows - TV Shows
- MusicVideos - 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.
- 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 every couple of minutes.
- Deletions are supported: Items that are deleted on the Emby server will be deleted on the Kodi database. Deletions done from the Kodi client TO the Emby server is only supported if you enable file deletions in the Kodi settings. An additional warning will be diaplayed if you really want to remove the item from the Emby server.
- 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. - 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.
- Possibility to copy Theme Music locally for use with the TVTunes addon
- Possibility to copy ExtraFanart (rotating backgrounds) across for use with skins that support it
**To get started with the Emby addon for Kodi, first follow these guides to set up Emby and Kodi:**
1. To prevent any conflicts, remove the "old" MediaBrowser addon from your Kodi setup.
2. If you were using a modded skin for the MediaBrowser addon, make sure to set it in "normal Kodi mode" or just install the unmodded version of the skin.
3. Install the MediaBrowser/Emby BETA repository for Kodi, from the repo install the Emby addon.
4. Within a few seconds you should be prompted for your server-details (or auto discovered). If not, try to restart Kodi
5. Once you're succesfully authenticated to your Emby server, the initial sync will start.
6. The first sync of the Emby server to local Kodi database may take some time. On a powerful machine and fast network, expect around 15-45 minutes. On a slow machine (such as a Raspberry Pi) the first sync may take up to two hours.
7. Once the full sync is done, you can browse your media in Kodi, syncs will be automatically done in the background.
**Known Issues:** **Known Issues:**
- Windows users: Kodi Helix 14.2 RC1 required - other versions will result in errors with recently added items etc. - Windows users: Kodi Helix 14.2 RC1 required - other versions will result in errors with recently added items etc.
- 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.
- This is a BETA version and could potentially set fire to your Raspi
**What could be in the pipeline?**
- Watch later
- MusicVideos
- TV Shows Theme Music (ultra-low prio)
**Important note about MySQL database in kodi** **Important note about MySQL database in kodi**
@ -45,8 +59,6 @@ The addon is not (and will not be) compatible with the MySQL database replacemen
**Important note about user collections/nodes** **Important note about user collections/nodes**
Emby has the ability to create custom nodes/folders for your Media, such as having a seperate 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 Emby 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. 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.
At this point, please hold on to your feature requests and report bugs only. Report bugs or pictures of your burning raspi on the forums
Report bugs or any usefull feedback on the forums